Docker/AdventureLog
Docker/AdventureLog
1
0
Fork 0
mirror of https://github.com/seanmorley15/AdventureLog.git synced 2025-07-19 04:49:37 +02:00
Code Issues Releases Activity
AdventureLog/documentation/docs/install/quick_start.md
Sean Morley 5f9d0cd207 chore: update dependencies and improve script execution condition 
- Updated vitepress from version 1.5.0 to 1.6.3 in package.json and pnpm-lock.yaml.
- Updated various dependencies in pnpm-lock.yaml including @docsearch/css, @docsearch/js, @iconify-json/simple-icons, @shikijs/core, and others to their latest versions.
- Modified install_adventurelog.sh to improve script execution condition by allowing it to run when piped input is detected.
2025-06-05 16:24:43 -04:00

944 B
Raw Blame History

🚀 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. Launches AdventureLog
  5. Waits for services to start
  6. 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.