mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2026-07-31 07:49:07 -04:00
d22c55e182
- 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.
2.4 KiB
2.4 KiB
Install AdventureLog
AdventureLog runs on Docker in most setups. Pick the guide that matches your environment — from Standard Deployment to platform-specific homelab and NAS instructions.
Choose your setup
Docker
| I want to… | Guide |
|---|---|
| One container, one port | Recommended Standard Deployment |
| Interactive walkthrough that deploys Standard Deployment | Quick Start Installer |
| Separate frontend, backend, and database | Advanced Deployment |
| HTTPS on a custom domain | Reverse proxy guides |
Homelab & NAS platforms
| Platform | Guide |
|---|---|
| Proxmox LXC | Proxmox LXC |
| Synology NAS | Synology NAS |
| Unraid | Unraid |
| Umbrel | Umbrel — community app |
| TrueNAS SCALE | TrueNAS — community app |
These guides use the same AdventureLog Docker images, adapted for each platform.
Kubernetes
| Platform | Guide |
|---|---|
| Kubernetes cluster | Kubernetes + Kustomize |
Development
| Use case | Guide |
|---|---|
| Local development on Windows / WSL | Dev Container + WSL |
Reverse proxy
Use these when AdventureLog sits behind HTTPS on a custom domain:
| Proxy | Guide |
|---|---|
| Nginx Proxy Manager | Nginx Proxy Manager |
| Traefik | Traefik — includes docker/docker-compose.traefik.yaml |
| Caddy | Caddy |
Set SITE_URL to your public HTTPS URL so Django CSRF and SvelteKit origins stay correct. See Environment Variables.
After installation
- Log in with your admin credentials (default
admin/admin— change immediately) - Review How to Use AdventureLog
- Configure optional features in Configuration
- Set up backups before going to production
Requirements
- Docker Engine + Docker Compose v2 (for Docker-based installs)
- 2 GB RAM on first boot (world geography import); ~1 GB afterward
- Linux server, VPS, homelab, or macOS with Docker Desktop
- Optional: domain name and reverse proxy for HTTPS