CMDash Help: Updating CMDash
This page explains how CMDash gets updated, which method applies to your deployment, and what happens when a release needs a database migration.
You can see the version you are running, and check for a newer one, at Settings → Updates.
Which update method applies to you
CMDash runs in three shapes, and each is updated differently. Settings → Updates already knows which one you are on — it shows an Apply update button only when your deployment can use it.
| Your deployment | How updates are applied | Who does it |
|---|---|---|
| Hosted (cloud) | Applied by the CMDash operator across the fleet | Us — no action needed |
| Self-hosted, updater enabled | One-click, from Settings → Updates | You |
| Self-hosted, updater disabled | Directly on the host by your operator | Your IT/ops team |
If Settings → Updates shows no Apply button and gives a reason, that reason is the answer — it reflects your live deployment, not a general rule.
Checking for a new version
- Go to Settings → Updates.
- Select Check now.
The page shows the version you are running and the latest published release. Release notes are linked from the page itself; the link points at the public CMDash releases index, which lists every published version.
Only workspace Owners and Admins can view or apply updates.
Applying a one-click update
When your deployment supports it and a normal release is available:
- Select Apply update.
- Type the version number to confirm.
- Watch the progress panel.
What happens: each application instance is updated in turn, behind a health check. If the new version fails its health check, it rolls back to your current version automatically. The app restarts briefly during the update, so expect a short interruption — seconds, not minutes.
Do not start an update while another one is running; the page will tell you if one is already in progress.
When an update needs a database migration
Some releases change the structure of the database. These cannot be applied with the one-click update, and CMDash will not offer the button for them. Instead you will see:
This update needs a database migration
This is a deliberate stop, not an error. The one-click updater deliberately runs with restricted database permissions, which is what stops a routine update from being able to alter your data. A schema change needs a higher-privilege credential and a backup taken first, so it is performed as an assisted upgrade rather than a button press.
What to do: select Request a migration on that screen. This opens a support case that already includes your current version and the target version. Support will contact you to schedule the upgrade at a time that suits you.
What not to do: don't try to force the update by other means. A partially applied schema change is far more disruptive than waiting for a scheduled one.
You can keep using CMDash normally while you wait — your current version continues to run untouched.
Self-hosted, with one-click updates turned off
If your operator has disabled in-app updates, or the update service is not running, Settings → Updates still shows you the version you are on and whether a newer one exists. Applying it is done directly on the host by whoever administers your installation, following the installation runbook supplied with your deployment package.
Report the version shown on the Updates page when you ask them to upgrade.
Troubleshooting
"No published releases were found yet"
The check could not reach the release index, or no release has been published. This is not an error in your installation. Try again later; if it persists, your network may block outbound access to GitHub, which is where CMDash publishes its release metadata.
The update failed and rolled back
Your previous version has been restored automatically — that is the designed behaviour, and the workspace is safe to keep using. The failure reason appears on the Updates page. Send that text to support.
The update seems stuck
Updates that stop making progress are marked stale automatically and can be canceled from the same page. If the progress panel has not changed for several minutes, cancel it and contact support rather than starting a second update.
Getting help
- Email: support@cmdash.com
- In-app: the feedback control on any page, which reaches the same place as the Request a migration button
Related: Troubleshooting Guide · FAQ