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.7 KiB

Raw Blame History

Quick Start Installer

The guided installer is an optional way to deploy All-in-One (AIO) Docker — the setup most people use. It walks you through configuration interactively, writes your env files, and includes a management menu for updates and backups.

For manual AIO setup with Docker Compose, see All-in-One Docker.

One-line install

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

What the installer does

Checks dependencies (Docker, Compose v2, RAM, CPU architecture)
Detects ARM hosts and configures a compatible PostGIS image automatically
Creates the ./adventurelog project directory (configurable via INSTALL_DIR)
Downloads docker-compose.aio.yml or docker-compose.yml, env files, and management scripts
Walks you through site URL, admin credentials, and optional features (S3, email, integrations)
Starts containers and waits for the /health endpoint
Saves credentials to credentials.txt when generated

Requirements

Requirement	Details
Docker + Compose v2	Required
RAM	2 GB recommended on first boot; ~1 GB afterward
OS	Linux server, VPS, or macOS with Docker Desktop
Domain	Optional — set `SITE_URL` for HTTPS behind a reverse proxy

::: tip ARM / Apple Silicon The installer automatically uses imresamu/postgis:16-3.5-alpine on ARM hosts. AdventureLog images are multi-arch. :::

Setup modes

During installation you can choose:

Mode	Compose file	Env file	When to use
All-in-One (default)	`docker-compose.aio.yml`	`.env.aio`	Simplest — one port, auto-derived URLs
Standard	`docker-compose.yml`	`.env`	Full env control, separate frontend/backend ports

Re-run the installer when an install already exists:

curl -sSL https://get.adventurelog.app | bash
# or from the install directory:
bash install_adventurelog.sh --manage

Options include status, update, reconfigure, backup, restore, logs, restart, and uninstall. See Operations & Maintenance.

Dry run

Preview what the installer would do without making changes:

ADVENTURELOG_SKIP_GUM=1 bash install_adventurelog.sh --dry-run --force-install

Uninstall

From the management menu, choose Uninstall, or manually:

cd adventurelog
docker compose --env-file .env.aio -f docker-compose.aio.yml down -v
rm -rf adventurelog

Next steps

All-in-One Docker — how the AIO container works
Standard Docker — multi-container configuration
Environment Variables — full reference
Other install options

2.7 KiB Raw Blame History