Deployment and upgrade

DMS runs as a containerized FastAPI application behind nginx, with Redis, MySQL, the worker, and optional object storage and search backends.

Build and deploy

1. Build the frontend assets (frontend Vite build).
2. Build the application image.
3. Apply database migrations with Alembic.
4. Start the application and the worker.
5. Verify /health, /version, and /metrics.
6. Sign in and check a document, the Explorer, search, and the task queue.

The runtime version is generated into version.txt at build time. The Vite build output is not committed, so a raw checkout does not render the UI until the frontend is built.

Upgrade

1. Back up the database and storage.
2. Review the changelog and migrations.
3. Deploy the new image.
4. Run migrations.
5. Check health, the worker, search, and BPM integration.
6. Keep the previous image available for rollback.

Secrets and TLS

Store secrets in the deployment's secret manager. Use TLS in production and do not expose the API, metrics, or webhook namespace directly.

Related

• Health and metrics
• Worker and cron
• Configuration
• Troubleshooting