Upgrade, backup, removal

Upgrade

Schema first, API second:

git pull                                   # or unpack the new release
docker compose build --pull
docker compose run --rm migrate            # schema first, the API is not started yet
docker compose up -d

The installed version is shown on AarView’s About page.

Back up

Everything that matters is in two places:

1. the .env file: it holds the secrets and the instance id. Keep it with the backup, encrypted;
2. the PostgreSQL volume.

docker compose exec -T postgres pg_dumpall -U aarview | gzip > aarview-$(date +%F).sql.gz

If the installer created a private authority, also keep ca-key.DO-NOT-DEPLOY.pem, offline: it signs the certificate’s renewal.

Start, stop, inspect

docker compose up -d          # start, or apply a change to .env
docker compose ps             # container state
docker compose logs api       # a service's logs
docker compose down           # stop the stack

Remove

docker compose down stops the stack. docker compose down -v also deletes the data volumes, which cannot be undone.

docker compose down -v