Files
AdventureLog/documentation/docs/install/getting_started.md
Sean Morley 7f6bf1390a Add Docker and environment configuration files for AdventureLog
- Introduced .dockerignore to exclude unnecessary files from Docker context.
- Added .env.aio.example for minimal configuration of the AdventureLog All-in-One setup.
- Updated .env.example to include optional SITE_URL and GUNICORN_WORKERS settings.
- Enhanced deploy.sh script for improved deployment flexibility and backup options.
- Updated docker-compose files to use PostGIS 16-3.5 and added health checks for services.
- Created docker-compose.aio.yml for All-in-One deployment configuration.
- Improved health checks and service dependencies in docker-compose.dev.yml and docker-compose.yml.
- Added GitHub workflows for building and pushing Docker images, including smoke tests for AIO setup.
2026-06-06 18:54:25 -04:00

1.8 KiB

🚀 Install Options for AdventureLog

AdventureLog can be installed in a variety of ways, depending on your platform or preference.

Which setup should I use?

Your situation Recommended path
New homelab / quick install Quick start installer — AIO by default, interactive setup
Full env control, split containers, or custom integrations Standard Docker — full .env.example (also available in installer advanced mode)
Split domains or path-based reverse proxy (Traefik, NPM, Caddy) Standard Docker + reverse proxy docs
Kubernetes cluster Kubernetes + Kustomize — see k8s/base/

📦 Docker Quick Start

::: tip Quick Start Script The fastest way to get started:
Install AdventureLog with a single command →
Perfect for Docker beginners. :::

⚙️ Advanced & Alternative Setups