Skip to main content

Update your instance

You choose when to install updates. Version checks do not install them automatically. Updates interrupt service while the deployment restarts.

Prepare the update​

  1. Record the current image references with docker compose images.
  2. Read the target release notes.
  3. Back up the database and deployment configuration.
  4. Set IMAGE_TAG in .env to the target release tag.

Use a specific release tag for repeatable updates. Keep the MySQL and Redis tags unchanged during an application update.

Apply the update​

From the deployment directory, run:

./start.sh
docker compose ps

For an air-gapped installation, transfer the new images and use the offline startup command.

Verify the update​

  1. Verify that services run and available health checks pass.
  2. Open your HTTPS URL and verify a regex result.
  3. If accounts are enabled, sign in and reopen a saved workspace.
  4. Verify any API or MCP integration your team uses.

If startup fails, inspect the logs:

docker compose logs --tail=100 api

See Troubleshooting for errors.

Recover from an unsuccessful update​

Stop user access while you investigate. Keep the error logs and current image references. An older release can be incompatible with a database updated by a newer release. Restore the pre-update database and application release together with the restore procedure.