diff --git a/README.md b/README.md index 8305c67..9157c51 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,39 @@ The Huly platform source code is available on GitHub: **[hcengineering/platform] > For self-hosted deployments, use production versions (`v*` tags). For example: `v0.7.310`, `v0.7.307`, `v0.6.501` > See all available versions on [GitHub Releases](https://github.com/hcengineering/platform/releases). +## Updating to a new Huly version + +Before updating, **always review `MIGRATION.md`** in this repository: + +- **Open `MIGRATION.md`** and find the section for your target version (for example `v0.7.382`). +- **If the section says "No changes required"**, you can upgrade just by updating container versions. +- **If there are additional steps**, follow them carefully (backup, config changes, service additions/removals, etc.) **before** or **during** the update. +- **If you are upgrading from any 0.6.x version to 0.7.x**, you **must** follow the dedicated migration steps in the `v0.7` section of `MIGRATION.md` (especially `v0.7.204`) instead of doing a direct in-place upgrade. + +To update an existing self-hosted deployment to a new Huly version: + +1. **Stop the stack (optional but recommended for major upgrades):** + ```bash + cd huly-selfhost + docker compose down + ``` +2. **Update the `huly-selfhost` repository:** + ```bash + git pull + ``` +3. **Set the new Huly version in `.env`:** + - Edit the `.env` file in the project root and update: + - `HULY_VERSION` to the desired platform version tag (for example `v0.7.382`) + - `DESKTOP_CHANNEL` to the same version without the leading `v` (for example `0.7.382`) if you use the desktop app. +4. **Pull updated container images:** + ```bash + docker compose pull + ``` +5. **Start the updated stack:** + ```bash + docker compose up -d + ``` + ## Architecture Overview For detailed information about the Huly self-hosted architecture, services, and their interactions, see [ARCHITECTURE_OVERVIEW.md](ARCHITECTURE_OVERVIEW.md).