mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2025-07-19 04:49:37 +02:00
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.
This commit is contained in:
parent
36a2e59d52
commit
5f9d0cd207
7 changed files with 480 additions and 172 deletions
|
@ -1,15 +1,26 @@
|
|||
# Install Options for AdventureLog
|
||||
# 🚀 Install Options for AdventureLog
|
||||
|
||||
AdventureLog can be installed in a variety of ways. The following are the most common methods:
|
||||
AdventureLog can be installed in a variety of ways, depending on your platform or preference.
|
||||
|
||||
- [Docker](docker.md) 🐳
|
||||
- [Proxmox LXC](proxmox_lxc.md) 🐧
|
||||
- [Synology NAS](synology_nas.md) ☁️
|
||||
- [Kubernetes and Kustomize](kustomize.md) 🌐
|
||||
- [Unraid](unraid.md) 🧡
|
||||
## 📦 Docker Quick Start
|
||||
|
||||
### Other Options
|
||||
::: tip Quick Start Script
|
||||
**The fastest way to get started:**
|
||||
[Install AdventureLog with a single command →](quick_start.md)
|
||||
Perfect for most users. Zero guesswork. Maximum adventure. 🚀
|
||||
:::
|
||||
|
||||
- [Nginx Proxy Manager](nginx_proxy_manager.md) 🛡
|
||||
- [Traefik](traefik.md) 🚀
|
||||
- [Caddy](caddy.md) 🔒
|
||||
## 🐳 Popular Installation Methods
|
||||
|
||||
- [Docker](docker.md) — Simple containerized setup
|
||||
- [Proxmox LXC](proxmox_lxc.md) — Lightweight virtual environment
|
||||
- [Synology NAS](synology_nas.md) — Self-host on your home NAS
|
||||
- [Kubernetes + Kustomize](kustomize.md) — Advanced, scalable deployment
|
||||
- [Unraid](unraid.md) — Easy integration for homelabbers
|
||||
- [Umbrel](https://apps.umbrel.com/app/adventurelog) — Home server app store
|
||||
|
||||
## ⚙️ Advanced & Alternative Setups
|
||||
|
||||
- [Nginx Proxy Manager](nginx_proxy_manager.md) — Easy reverse proxy config
|
||||
- [Traefik](traefik.md) — Dynamic reverse proxy with automation
|
||||
- [Caddy](caddy.md) — Automatic HTTPS with a clean config
|
||||
|
|
46
documentation/docs/install/quick_start.md
Normal file
46
documentation/docs/install/quick_start.md
Normal file
|
@ -0,0 +1,46 @@
|
|||
# 🚀 Quick Start Install
|
||||
|
||||
Install **AdventureLog** in seconds using our automated script.
|
||||
|
||||
## 🧪 One-Liner Install
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
cd adventurelog
|
||||
docker compose down -v
|
||||
rm -rf adventurelog
|
||||
```
|
||||
|
||||
Need more control? Explore other [install options](install.md).
|
Loading…
Add table
Add a link
Reference in a new issue