mirror of https://github.com/seanmorley15/AdventureLog.git synced 2026-07-31 15:59:34 -04:00

Files

Sean Morley d22c55e182 Refactor deployment configurations and update documentation

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

2026-06-12 21:49:01 -04:00

2.8 KiB

Raw Blame History

Quick Start Installer

The guided installer is an optional way to deploy Standard Deployment — 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 Standard Deployment setup with Docker Compose, see Standard Deployment.

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 compose files, 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
Standard Deployment (default)	`docker/docker-compose.yml`	`.env`	Simplest — one port, auto-derived URLs
Advanced Deployment	`docker/docker-compose.advanced.yml`	`.env.advanced`	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 -f docker/docker-compose.yml down -v
rm -rf adventurelog

Next steps

Standard Deployment — how the single-container setup works
Advanced Deployment — multi-container configuration
Environment Variables — full reference
Other install options

2.8 KiB Raw Blame History