mlab docs

Update

Pull the latest images, restart, done. Migrations run on boot.

Update to latest

docker-compose pull app executor
docker-compose up -d app executor

Database schema migrations apply automatically on first request after boot. Data in Docker volumes is preserved.

Pin a version

Replace latest in docker-compose.yml with a tag:

image: ghcr.io/mlab-sh/ir.mlab.sh:1.1.0

Upgrading to 1.1.0

  • Migration V52 applies at boot and adds the signed-license columns.
  • The license check needs mlab.sh 1.21.5 or later. The first check after the upgrade binds the license to this instance. If an old instance still holds the key, an administrator moves it with Use this instance on the locked page, or it moves on its own once the old instance has been silent for 3 hours. See Licensing.
  • The mlab.sh key under Settings > Integrations needs the scan.lookup and scan.domain scopes. Keys created before mlab.sh introduced scopes carry all of them; a key created since without them is refused.

Rollback

If a release introduces a regression: re-pin to the previous tag, docker-compose up -d app executor. Schema rollbacks are not automatic - restore the MySQL/ClickHouse volumes from backup if a migration is involved.

Always back up before major upgrades. Snapshot the mysql_data and clickhouse_data volumes (or run the logical dump from the installation page) before bumping a major version.

Release notifications

Subscribe to the changelog. Major releases announce breaking changes at least one minor version ahead.

On this page