Update a self-hosted installation
This guide walks you through updating a self-hosted installation of Operately to a newer version.
Before you start#
Section titled “Before you start#”Log in to the server running Operately and navigate to the directory where Operately is running. By default this location is ~/operately.
Updating Operately#
Section titled “Updating Operately#”The update process depends on your current version:
- Version 1.4.0 or later: Use the
operatelyupdate script - Before version 1.4.0: Manually update the Docker Compose configuration
If you’re on version 1.4.0 or later#
Section titled “If you’re on version 1.4.0 or later#”Using the operately script#
Section titled “Using the operately script#”To update to the latest official release without specifying a version:
./operately updateTo update to a specific version:
./operately update <version>Replace <version> with the version you want to upgrade to. For example:
./operately update 1.4.0./operately update 1.5.0You can also update to nightly builds:
./operately update nightly-build-20260116-070020-49842cd04If the script is not available#
Section titled “If the script is not available#”Depending on the Operately version you installed for the first time, the operately script might not be available. In that case, you need to generate it first:
docker compose run --rm app sh -c "/opt/operately/bin/generate-script" > operatelychmod +x operatelyAfter generating the script, you can use the update commands above.
If you’re on a version before 1.4.0#
Section titled “If you’re on a version before 1.4.0#”You need to manually update the Docker Compose file.
Update the Docker Compose file#
Section titled “Update the Docker Compose file#”Edit the docker-compose.yml file and update the Operately version tag:
# From this:image: operately/operately:vOLD
# To this:image: operately/operately:vNEWReplace vOLD with your current version and vNEW with the target version you want to upgrade to.
Examples:
# From this:image: operately/operately:1.2.0
# To this:image: operately/operately:1.3.0# From this:image: operately/operately:1.2.0
# To this:image: operately/operately:nightly-build-20260116-070020-49842cd04Run database migrations#
Section titled “Run database migrations#”docker compose run --rm app sh -c "/opt/operately/bin/migrate"Restart the server#
Section titled “Restart the server#”docker compose up --wait --detachAvailable versions#
Section titled “Available versions#”- Official releases: https://github.com/operately/operately/releases
- Nightly releases: https://github.com/operately/nightly/releases