mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2026-07-30 23:38:02 -04:00
4cd6ab4fd2
- Commented out build configurations in docker-compose files for AIO, dev, and standard setups to simplify deployment. - Updated the documentation homepage with a new layout, including a hero section, features overview, and installation options. - Introduced new Vue components for enhanced user experience on the documentation site, including HomeHero, HomeFeatures, and HomeInstall. - Improved SEO metadata for better visibility and searchability of the documentation.
2.7 KiB
2.7 KiB
Install AdventureLog
AdventureLog runs on Docker in most setups. Pick the guide that matches your environment — from a one-line installer to platform-specific homelab and NAS instructions.
Quick start
::: tip Fastest install
curl -sSL https://get.adventurelog.app | bash
:::
The Quick Start Installer walks you through setup (AIO by default), writes your env files, and starts AdventureLog. Re-run the same command for updates, backups, and configuration changes.
Choose your setup
Docker
| I want to… | Guide |
|---|---|
| Guided install on a VPS or homelab | Quick Start Installer |
| One container, one port, minimal config | All-in-One Docker (AIO) |
| 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