Provisions and migrates the MySQL database used by WProofreader server and App-manager
458
Docker image with db-manager, the tool that creates and migrates the cloud_service MySQL database used by WProofreader Server and App-manager. It wraps Liquibase Community Edition in a small CLI and is meant to run once, before the application containers start: as a one-shot Compose service, a Kubernetes Job or an init container. Re-running it is safe, changesets that are already applied are skipped.
Images are tagged with the WProofreader Server version they belong to, for example 6.17.1.0. latest points to the newest release. Use the same version as your webspellchecker/wproofreader image, since each release carries the schema changes for that version. Images are built for linux/amd64 and linux/arm64.
The simplest setup is the Docker Compose stack in the WProofreader Docker repository: MySQL, db-manager, WProofreader Server and App-manager on one host. On Kubernetes, the WProofreader and App-manager Helm charts run db-manager for you.
To run it on its own against an existing MySQL server:
docker run --rm --network <mysql_network> \
-e DB_HOST=mysql \
-e DB_USER=root \
-e DB_PASSWORD=<root password> \
-e PROVISION_PREDEFINED_USERS=true \
-e APPSERVER_PASSWORD=<password for the appserver user> \
-e APP_MANAGER_PASSWORD=<password for the app_manager user> \
webspellchecker/db-manager:6.17.1.0 migrate
This creates the cloud_service database, applies the schema and seed data, and creates the two application users with the grants they need. status shows applied and pending changesets; db-manager --help lists the other commands (rollback, backup, health-check, users).
| Variable | Default | Description |
|---|---|---|
DB_HOST | localhost | MySQL host |
DB_PORT | 3306 | MySQL port |
DB_NAME | cloud_service | Database to create and migrate |
DB_USER | root | Account that can create the database and users |
DB_PASSWORD | Password for DB_USER | |
DB_CONTEXTS | external,seed | Migration contexts to apply |
MIGRATION_MODE | bootstrap | bootstrap, adopt or `schema-only |
CREATE_BACKUP | false | Dump the database before migrating (mount /backups to keep it) |
AUTO_ROLLBACK_ON_FAILURE | false | Restore that dump if the migration fails |
PROVISION_PREDEFINED_USERS | false | Create or update the `appserrs |
APPSERVER_USERNAME, APPSERVER_PASSWORD | appserver, none | Credentials for WProofreader Server |
APP_MANAGER_USERNAME, APP_MANAGER_PASSWORD | app_manager, none | Credentials for App-manager |
DB_MAX_RETRIES, DB_RETRY_INTERVAL | 30, 2 | How long to wait |
LOG_LEVEL | INFO | ERROR, WARN, INFO, DEBUG or TRACE |
Holders of a trial or commercial license have access to technical assistance from the WebSpellChecker team. Contact us here.
db-manager is part of WProofreader Server, commercial software developed by WebSpellChecker (https://webspellchecker.com/).
Content type
Image
Digest
sha256:5987f0b41…
Size
97.3 MB
Last updated
15 days ago
docker pull webspellchecker/db-manager