Set up the databases with scripts on stock MariaDB/MongoDB images instead of custom images #1046

Replaces #1025. Instead of publishing custom MariaDB and MongoDB images, provide scripts that set up the databases on stock images and on any MariaDB/MySQL or MongoDB server. The Docker Compose quick start and self-hosting then share one setup path, and only owasp/security-shepherd is published.

Why

The custom images in docker/mariadb and docker/mongo are the stock images plus:

• the schema files coreSchema.sql, moduleSchemas.sql and moduleSchemas.js, copied into /docker-entrypoint-initdb.d;
• three text edits, done with sed at build time:
  • uncommenting the DELIMITER lines (docker/scripts/convert-sql-scripts.sh);
  • rewriting the challenge users' grants from '@localhost' to '@'%' (Docker - Establish communication with module schema #367);
  • removing the //REMOVE markers in the Mongo script;
• a small config file.

Publishing them would mean rebuilding and republishing for every upstream MariaDB/Mongo patch, or serving stale databases under the OWASP name. The quick start clones the repo anyway, so the scripts are already there.

Proposal

• Scripts such as scripts/db/setup-mariadb.sh and scripts/db/setup-mongo.sh that:
  • read the schema files from src/main/resources, and make the three edits when they run rather than at build time;
  • take the challenge users' grant host as a setting, defaulting to '%', so remote databases work;
  • work in a stock image's /docker-entrypoint-initdb.d, using that image's admin credentials;
  • also run against your own server, with host, port and admin credentials as arguments.
• docker-compose.yml uses the stock mariadb and mongo images and mounts the scripts and schema files.
• Remove docker/mariadb/Dockerfile, docker/mongo/Dockerfile, convert-sql-scripts.sh and the Maven steps that copy and convert the database files. mvn -Pdocker then only builds the WAR.
• Docs: the README's Docker section, plus a short "bring your own database" section covering supported versions and how to run the scripts.

Related

• Publish the MariaDB and MongoDB images to Docker Hub as owasp/security-shepherd-db and owasp/security-shepherd-mongo #1025: publishing the database images (closed in favour of this).
• Move database configuration from build-time to runtime environment variables #814: database configuration from environment variables at runtime.
• Upgrade MongoDB server 4.1.13 → 8.0 and Java driver 3.12 → 5.x #958: the MongoDB 8 upgrade, which affects the Mongo script (mongosh instead of mongo).
• it-test profile tags its Mongo build as mongo:${MONGODB_VERSION}, breaking the next local IT run #938 / build: give the it-test MongoDB image its own name (PR 3 of #958) #1009: the integration tests' own Mongo image.
• AGENTS.md: 'mvn -Pdocker validate' doesn't produce usable docker/mariadb init scripts #962: mvn -Pdocker validate and the database init scripts.