mirror of https://github.com/seanmorley15/AdventureLog.git synced 2026-07-30 15:28:30 -04:00

Files

Sean Morley 7179babc50 Update documentation and enhance installation options

- Reorganized the documentation homepage layout, adding a new hero section and installation options.
- Updated installation instructions to emphasize the All-in-One Docker setup as the default choice.
- Improved the Quick Start Installer description to clarify its role as a guided setup for AIO.
- Enhanced SEO metadata for better visibility and searchability of the documentation.
- Added new Vue components for improved user experience in the installation section.
- Refined installation paths and descriptions for clarity and ease of use.

2026-06-07 12:53:47 -04:00

2.4 KiB

Raw Blame History

Install AdventureLog

AdventureLog runs on Docker in most setups. Pick the guide that matches your environment — from All-in-One Docker to platform-specific homelab and NAS instructions.

Choose your setup

Docker

I want to…	Guide
One container, one port	Recommended All-in-One Docker (AIO)
Interactive walkthrough that deploys AIO	Quick Start Installer
Separate frontend, backend, and database	Standard Docker
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-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

2.4 KiB Raw Blame History