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

Files

Sean Morley 7f6bf1390a Add Docker and environment configuration files for AdventureLog

- Introduced .dockerignore to exclude unnecessary files from Docker context.
- Added .env.aio.example for minimal configuration of the AdventureLog All-in-One setup.
- Updated .env.example to include optional SITE_URL and GUNICORN_WORKERS settings.
- Enhanced deploy.sh script for improved deployment flexibility and backup options.
- Updated docker-compose files to use PostGIS 16-3.5 and added health checks for services.
- Created docker-compose.aio.yml for All-in-One deployment configuration.
- Improved health checks and service dependencies in docker-compose.dev.yml and docker-compose.yml.
- Added GitHub workflows for building and pushing Docker images, including smoke tests for AIO setup.

2026-06-06 18:54:25 -04:00

2.2 KiB

Raw Blame History

🚀 Quick Start Install

Install AdventureLog in seconds using our automated installer. The script defaults to the All-in-One (AIO) setup — one URL, one port, minimal configuration.

🧪 One-Liner Install

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

This will:

Check dependencies (Docker, Docker Compose, RAM, architecture)
Detect ARM hosts and configure a compatible PostGIS image automatically
Set up the ./adventurelog project directory
Download docker-compose.aio.yml, .env.aio, and management scripts
Walk you through core and optional configuration (S3, email, integrations, etc.)
Start AdventureLog and wait for the health check

✅ Requirements

Docker + Docker Compose v2
2 GB RAM recommended on first boot (world geography import); ~1 GB afterward
Linux server, VPS, or macOS with Docker Desktop
Optional: domain name for HTTPS (set SITE_URL to your public URL)

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

🔍 What It Does

The script automatically:

Verifies Docker is installed and running
Offers All-in-One (recommended) or Standard (separate frontend/backend) setup
Downloads compose files, .env.aio or .env, deploy.sh, and backup scripts
Prompts for site URL, admin credentials, and optional features
Waits for /health (first boot may take several minutes)
Saves optional credentials to credentials.txt

🔄 Management (Re-run the installer)

Re-run the same command to open the management menu when an install already exists:

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

Management options include:

Check status and health
Update to latest images (deploy.sh --backup)
Edit configuration
Backup and restore
View logs, restart, or uninstall

🧼 Uninstall

From the management menu, choose Uninstall, or manually:

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

Need more control? See All-in-One Docker, Standard Docker, or other install options.

2.2 KiB Raw Blame History