1
0
Fork 0
mirror of https://github.com/seanmorley15/AdventureLog.git synced 2025-07-19 12:59:36 +02:00
AdventureLog/documentation/docs/install/quick_start.md

972 B

🚀 Quick Start Install

Install AdventureLog in seconds using our automated script.

🧪 One-Liner Install

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

This will:

  • Check dependencies (Docker, Docker Compose)
  • Set up project directory
  • Download required files
  • Prompt for basic configuration (like domain name)
  • Start AdventureLog with Docker Compose

Requirements

  • Docker + Docker Compose
  • Linux server or VPS
  • Optional: Domain name for HTTPS

🔍 What It Does

The script automatically:

  1. Verifies Docker is installed and running
  2. Downloads docker-compose.yml and .env
  3. Prompts you for domain and port settings
  4. Waits for services to start
  5. Prints success info with next steps

🧼 Uninstall

To remove everything:

cd adventurelog
docker compose down -v
rm -rf adventurelog

Need more control? Explore other install options like Docker, Proxmox, Synology NAS, and more.