Files
AdventureLog/documentation/docs/configuration/updating.md
Sean Morley d22c55e182 Refactor deployment configurations and update documentation
- Replaced the All-in-One (AIO) deployment setup with a Standard Deployment configuration, introducing .env.advanced.example for advanced settings.
- Updated .dockerignore to reflect the new environment file structure.
- Removed .env.aio.example and associated references from documentation and workflows.
- Enhanced installation instructions to clarify the new Standard Deployment process.
- Updated GitHub Actions workflows to align with the new deployment structure, including smoke tests and image builds.
- Improved documentation for environment variable references and deployment options.
2026-06-12 21:49:01 -04:00

2.1 KiB

Updating AdventureLog

Keep your self-hosted instance current with the latest images and database migrations. Always back up before updating.

From your install directory (where scripts/deploy.sh and your compose file live):

bash scripts/deploy.sh --backup
bash scripts/deploy.sh --logs   # optional: follow logs after deploy

scripts/deploy.sh validates your env file, creates a backup, pulls images, and runs docker compose up -d --wait.

For Standard Deployment installs:

COMPOSE_FILE=docker/docker-compose.advanced.yml bash scripts/deploy.sh --backup

See Operations & Maintenance for compose auto-detection details.

Option 2: Manual compose

bash scripts/backup.sh

# Standard Deployment
docker compose --env-file .env -f docker/docker-compose.yml pull
docker compose --env-file .env -f docker/docker-compose.yml up -d --wait

# Advanced Deployment
docker compose --env-file .env.advanced -f docker/docker-compose.advanced.yml pull
docker compose --env-file .env.advanced -f docker/docker-compose.advanced.yml up -d --wait

Option 3: Guided installer menu

If you used the Quick Start Installer, re-run it to open the management menu:

curl -sSL https://get.adventurelog.app | bash

Choose Update to latest images (with optional backup).

Restore from backup

bash scripts/restore.sh backups/YYYYMMDD-HHMMSS

Updating region data

Country and region reference data comes from dr5hn/countries-states-cities-database. To refresh it manually:

docker exec -it <backend-container> bash
python manage.py download-countries --force

Region data version is pinned per AdventureLog release in settings.py and is not auto-updated on every deploy.

What happens during an update

  1. New container images are pulled
  2. Containers restart with your existing env and volumes
  3. Database migrations run automatically on backend startup
  4. The /health endpoint confirms the stack is ready