Update

How to know a new version is out, update, and go back if needed.

Knowing a new version is out

When a newer release exists, the footer shows vX.Y.Z is available. Its See what’s new link opens a window with the changelog entries of every version since the installed one: features, fixes, and the breaking changes gathered on top under Read before updating. Administrators also see the update command there. The entries are read from the project’s CHANGELOG.md on GitHub; when GitHub cannot be reached, the window links to the release page instead.

Read the breaking changes before updating: they say what to do by hand, if anything.

Update the published image (Docker)

docker compose pull
docker compose up -d
docker image prune -f

The running version is in the footer, or:

docker exec myastroboard cat /app/VERSION

Images are tagged latest, X.Y.Z, X.Y and X. To stay on a minor line and only receive its fixes, set for example image: myastroboard/myastroboard:1.8 in docker-compose.yml.

Update the Home Assistant app

Home Assistant shows the update in Settings -> Updates once the app repository has picked up the new image. See 1.INSTALLATION.md.

Back up before updating

Data lives in data/. Either download a backup ZIP from App settings -> Backup / Restore (CONFIGURATION.md), or copy the directory with the container stopped - a copy of a SQLite database taken while it is being written can be unusable:

docker compose stop
cp -r data data.backup
docker compose start

Upgrading to 1.7 (database)

1.7 moves the data from JSON files to a SQLite database. The first start does the migration on its own: it archives the 1.6 files into data/backups/pre-1.7-<date>.zip, imports them, checks them, and only then removes them. If anything goes wrong, nothing is removed and the instance shows a maintenance page until the cause is fixed - see DATABASE.md.

The migration is one-way: to go back to 1.6 afterwards, unzip the pre-1.7 archive into data/ before starting the 1.6 image (changes made since the upgrade are not in it).

Roll back to a previous version

Pin the version in docker-compose.yml, then restart:

    image: myastroboard/myastroboard:1.8.2

docker compose up -d

The database schema is upgraded at startup and never downgraded. Going back to a version older than the last schema change needs the backup taken before the update. Each schema change is one file in backend/db/migrations/versions/.

Development build

git pull
docker compose -f docker-compose-dev.yml up -d --build

Contributors: releasing a version is described in 4.RELEASE.md, rebuilding the catalogue dataset in SKYTONIGHT.md.

Last updated 2026-11-13