Upgrades

Check the release notes on GitHub first: anything you need to know is under Upgrade notes. Before v1.0.0, a minor version (v0.2.0) may include breaking changes.

Database changes are applied automatically when Ingle starts. Take a backup before each upgrade, so you can go back.

With Docker Compose

docker compose exec ingle /ingle backup
git pull
docker compose pull
docker compose up -d

git pull picks up any changes to compose.yaml and the Caddy files.

To stay on a release instead of following latest, set INGLE_TAG=v0.2.0 (for example) in .env.

To build from the checkout instead of pulling, uncomment build: .. in compose.yaml, then run git pull && docker compose up -d --build.

Without Docker

sudo systemctl start ingle-backup
# download and unpack the new release, then:
sudo install -m 0755 ingle /usr/local/bin/ingle
sudo systemctl restart ingle

See Without Docker.

Going back

Database changes only go forwards, and an older version may not work with a database a newer one has changed. To go back, restore the backup you took before upgrading, then run the older version. See Backups and restore.

Upgrading from Domus

Ingle used to be called Domus, and v0.2.0 is the first release with the new name. Your household, devices, photos, backups and HTTPS certificate all carry over, and nobody needs to sign in again.

Your DOMUS_* settings still work when the INGLE_* one isn’t set. The log lists any you’re still using, so you can rename them when it suits you: sed -i.bak 's/DOMUS_/INGLE_/g' .env.
An existing domus.db keeps being used as long as there’s no ingle.db beside it.
New backups are ingle-….tar.gz. Older domus-….tar.gz ones still count towards the number kept, and restore the same way.
Releases also go out as ghcr.io/lukeskelhorn/domus until v1.0, so an install that still pulls the old image keeps getting updates.
Home-screen apps on iPads keep the name Domus until they’re removed and added again.

With Docker Compose

The project and its containers are now called ingle, but the volumes keep their old names, so your data and certificates carry over. Stop the old stack before pulling the new files:

docker compose exec domus /domus backup   # one last backup, with the old version
docker compose down                       # stops the old containers; your data volume stays
git pull
docker compose up -d

If you pulled first, stop the old stack by its old name instead: docker compose -p domus down.