Getting Started
Updating
Update Kaya safely from images, tags or branches.
Before updating, back up data/, uploads/ and data/remote-recordings/, then read the release notes for migration steps.
Update the default image install
The default Compose file pulls the configured Kaya image.
docker compose pull
docker compose up -d
docker compose logs -f kaya
By default this tracks:
ghcr.io/antybubbs/kaya:latest
Update to the latest release tag
Use this path when the deployment tracks release tags.
git fetch --tags
LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
git checkout "$LATEST_TAG"
KAYA_IMAGE="ghcr.io/antybubbs/kaya:$LATEST_TAG" docker compose pull
KAYA_IMAGE="ghcr.io/antybubbs/kaya:$LATEST_TAG" docker compose up -d
docker compose logs -f kaya
At the time this page was last checked, the latest published Kaya tag was v0.21.4.
Update a branch-based install
Use this path when testing main, dev0.23.0 or another branch from source.
git checkout main
git pull --ff-only
docker build -t kaya:main .
KAYA_IMAGE=kaya:main docker compose up -d
docker compose logs -f kaya
For a different branch, replace main with the branch name and use a matching local image tag:
git checkout dev0.23.0
git pull --ff-only
docker build -t kaya:dev0.23.0 .
KAYA_IMAGE=kaya:dev0.23.0 docker compose up -d
Recommended update process
- Back up
data/,uploads/anddata/remote-recordings/. - Preserve
data/.runtime.env. - Pull the image, check out the release tag or pull the tracked branch.
- Rebuild only when using a source branch install.
- Restart the Compose stack.
- Open Kaya and confirm
/healthzresponds. - Sign in and check the dashboard, audit log and key modules.
- Review container logs for errors.
