mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-07 07:55:16 +02:00
143 lines
6.9 KiB
Text
143 lines
6.9 KiB
Text
---
|
|
title: "Update"
|
|
description: "Update your self-hosted Dograh stack to a newer image version"
|
|
---
|
|
|
|
This guide covers updating a Dograh stack you've already deployed with [Docker](/deployment/docker) or a [custom domain](/deployment/custom-domain). You run commands from the same directory that contains your `docker-compose.yaml` (this is the `dograh/` directory if you used `setup_remote.sh`).
|
|
|
|
There are three update flows depending on how you deployed:
|
|
|
|
- **Remote, prebuilt mode** (most users) — use [`update_remote.sh`](#remote-prebuilt-mode-recommended) below.
|
|
- **Local Docker** — pull images and restart; see [Local deployment](#local-deployment).
|
|
- **Remote, build mode** (you have a `docker-compose.override.yaml`) — update via git; see [Updating a source build](#updating-a-source-build).
|
|
|
|
## Find an image version
|
|
|
|
Dograh publishes two images — `dograh-api` and `dograh-ui` — to both container registries:
|
|
|
|
- **GitHub Container Registry** — [github.com/orgs/dograh-hq/packages](https://github.com/orgs/dograh-hq/packages)
|
|
- **Docker Hub** — [hub.docker.com/u/dograhai](https://hub.docker.com/u/dograhai)
|
|
|
|
Each release is published under two kinds of tags. Note the formats differ between GitHub releases and the Docker image tags — `update_remote.sh` understands both and normalizes for you.
|
|
|
|
| Where | Tag format | Example | When to use |
|
|
|-------|-----------|---------|-------------|
|
|
| GitHub release tag | `dograh-vX.Y.Z` | `dograh-v1.28.0` | What you see at [github.com/dograh-hq/dograh/releases](https://github.com/dograh-hq/dograh/releases) |
|
|
| Docker image tag (semver) | `X.Y.Z` | `1.28.0` | Stable, recommended for production |
|
|
| Docker image tag (SHA) | short SHA | `a1b2c3d` | Bleeding edge — any commit merged to `main` |
|
|
| Docker image tag (`latest`) | `latest` | `latest` | Tracks the most recent release tag |
|
|
|
|
<Warning>
|
|
Always update **`dograh-api`** and **`dograh-ui`** to the **same tag**. The two images are built from the same commit and the UI expects API responses in a matching shape — mixing versions will break the app. `update_remote.sh` handles this for you automatically.
|
|
</Warning>
|
|
|
|
## Remote, prebuilt mode (recommended)
|
|
|
|
`update_remote.sh` is the supported path for updating a stack created with `setup_remote.sh`. In one shot it:
|
|
|
|
- Asks for a target version (defaults to the latest release tag on GitHub).
|
|
- Pulls `docker-compose.yaml` at that version and pins both `api` and `ui` images to it.
|
|
- Regenerates `nginx.conf` and `turnserver.conf` from the upstream templates, so newer features (like [multi-worker scaling](/deployment/scaling)) are wired up correctly without manual editing.
|
|
- Reads your existing `.env` and appends any new required keys with safe defaults — your `OSS_JWT_SECRET`, `TURN_SECRET`, and other values are never touched.
|
|
- Backs up every file it changes with a `.bak.<timestamp>` suffix.
|
|
|
|
From your install directory:
|
|
|
|
```bash
|
|
cd dograh
|
|
curl -o update_remote.sh https://raw.githubusercontent.com/dograh-hq/dograh/main/scripts/update_remote.sh
|
|
bash update_remote.sh
|
|
```
|
|
|
|
You'll be prompted for the target version, defaulting to the most recent release. Accepted forms: bare semver (`1.28.0`), v-prefixed (`v1.28.0`), the full GitHub tag (`dograh-v1.28.0`), or `main` for bleeding edge — the script normalizes them. Non-interactive callers can set it via environment variable and skip the confirmation prompt:
|
|
|
|
```bash
|
|
TARGET_VERSION=1.28.0 DOGRAH_UPDATE_YES=1 bash update_remote.sh
|
|
```
|
|
|
|
After the script finishes, apply the update by recreating the stack:
|
|
|
|
```bash
|
|
sudo docker compose --profile remote down
|
|
sudo docker compose --profile remote up -d --pull always
|
|
```
|
|
|
|
<Note>
|
|
The script overwrites `docker-compose.yaml`, `nginx.conf`, and `turnserver.conf` from upstream templates. If you've made local edits to any of these (extra environment variables, custom ports, modified nginx routes), check the `.bak.<timestamp>` files after the update and re-apply your edits.
|
|
</Note>
|
|
|
|
## Local deployment
|
|
|
|
For local Docker installs (the [Quick Start](/deployment/docker#quick-start) flow or `setup_local.sh` / `setup_local.ps1`), there are no host-side config files to refresh — pull new images and restart:
|
|
|
|
```bash
|
|
docker compose down
|
|
docker compose up --pull always
|
|
```
|
|
|
|
To pin a specific version instead of `latest`, edit `docker-compose.yaml` and change both `image:` lines for `api` and `ui` to the same tag (e.g. `:1.28.0` — Docker image tags use bare semver, no `v` prefix), then run the commands above.
|
|
|
|
## Verify the update
|
|
|
|
Check the running image tags:
|
|
|
|
```bash
|
|
docker compose ps --format "table {{.Service}}\t{{.Image}}"
|
|
```
|
|
|
|
You should see the API and UI both running the tag you pinned.
|
|
|
|
Hit the health endpoint to confirm the API is responding:
|
|
|
|
```bash
|
|
curl -k https://YOUR_SERVER_IP/api/v1/health # remote
|
|
curl http://localhost:8000/api/v1/health # local
|
|
```
|
|
|
|
## Roll back
|
|
|
|
`update_remote.sh` saves backups of every file it touched. To roll back, restore them and recreate the stack — the exact commands (including the timestamp it used) are printed at the end of the script's output. The generic form:
|
|
|
|
```bash
|
|
cd dograh
|
|
for f in docker-compose.yaml nginx.conf turnserver.conf .env; do
|
|
[[ -f "$f.bak.<timestamp>" ]] && cp "$f.bak.<timestamp>" "$f"
|
|
done
|
|
sudo docker compose --profile remote down
|
|
sudo docker compose --profile remote up -d
|
|
```
|
|
|
|
Your Postgres data volume persists across `down`/`up` cycles, so agents and call history are preserved.
|
|
|
|
<Warning>
|
|
Rolling back across a database migration is not always safe — if the newer release ran a schema migration, downgrading may leave the DB in a state the older API doesn't understand. If in doubt, [open an issue](https://github.com/dograh-hq/dograh/issues) before rolling back.
|
|
</Warning>
|
|
|
|
## Updating a source build
|
|
|
|
If you deployed in **build mode** (you'll have a `docker-compose.override.yaml` in your install directory), `update_remote.sh` deliberately refuses to run — you already have the full repo locally and update via git:
|
|
|
|
```bash
|
|
cd dograh
|
|
git fetch
|
|
|
|
# Track latest main:
|
|
git pull
|
|
# Or pin to a specific release (git tag format is dograh-vX.Y.Z):
|
|
git checkout dograh-v1.28.0
|
|
|
|
# Pick up pipecat and other submodule bumps
|
|
git submodule update --init --recursive
|
|
|
|
# Rebuild and restart
|
|
sudo docker compose --profile remote build
|
|
sudo docker compose --profile remote up -d
|
|
```
|
|
|
|
<Warning>
|
|
If you update the `pipecat` submodule, you **must** run `git submodule update --init --recursive` before rebuilding, or the Docker build will not pick up `pipecat` changes.
|
|
</Warning>
|
|
|
|
If you maintain a fork with local customizations on top of upstream, merging conflicts in `docker-compose.yaml`, `nginx.conf`, `turnserver.conf`, or `setup_remote.sh` is up to you — resolve them as you would any other git merge. Leave `OSS_JWT_SECRET` and `TURN_SECRET` in `.env` unchanged across updates to preserve sessions and WebRTC auth.
|
|
|
|
The same migration warning above applies: rolling back across a schema change can leave the DB in a state the older API can't read.
|