Provisions and migrates the MySQL database used by WProofreader Server and Admin-panel
904
Docker image with db-manager, the tool that creates and migrates the cloud_service MySQL database used by WProofreader Server and Admin-panel. 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.
On Kubernetes, the WProofreader and Admin-panel 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 ADMIN_PANEL_PASSWORD=<password for the Admin-panel user> \
webspellchecker/db-manager:6.18.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 the appserver and app_manager users, or set their passwords |
APPSERVER_USERNAME, APPSERVER_PASSWORD | appserver, none | Credentials for WProofreader Server |
ADMIN_PANEL_USERNAME, ADMIN_PANEL_PASSWORD | app_manager, none | Credentials for Admin-panel |
DB_MAX_RETRIES, DB_RETRY_INTERVAL | 30, 2 | How long to wait for MySQL: connection attempts and seconds between them |
LOG_LEVEL | INFO | ERROR, WARN, INFO, DEBUG or TRACE |
ADMIN_PANEL_USERNAME and ADMIN_PANEL_PASSWORD need db-manager 6.18.1.0 or later. If you pulled 6.18.1.0 before 2026-10-15, pull it again. Earlier versions use APP_MANAGER_USERNAME and APP_MANAGER_PASSWORD. db-manager still reads the old names when the new names are not set, but the old names are deprecated.
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:f352fc3cc…
Size
97.4 MB
Last updated
9 days ago
docker pull webspellchecker/db-manager