mirror/aliasvault
1
0
Fork 0
mirror of https://github.com/aliasvault/aliasvault.git synced 2025-12-23 22:28:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update instructions (#1181)

Browse Source
This commit is contained in:
Leendert de Borst
2025-09-09 10:08:57 +02:00
parent 7e4a0f6e07
commit 58d6b4c67c
1 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/installation/index.md
View File

@@ -8,6 +8,14 @@ nav_order: 2
AliasVault can be self-hosted on your own servers using two different installation methods. Both use Docker, but they differ in how much is automated versus how much you manage yourself.
## Which Installation Method to Choose?
### 🚀 **Option 1: Install Script**
The installer script is a **fully managed solution** that handles everything for you. Simply run it on a clean VM/LXC with Docker installed, and it will set up all required containers, configure SSL certificates and provide CLI helpers for easy updates and maintenance.
### 🛠️ **Option 2: Docker Compose**
If you prefer manual setup and **have existing SSL infrastructure**, use the all-in-one Docker image via Docker Compose. It works with your existing SSL proxy (Traefik, HAProxy, Caddy, etc.) and gives you full control over the configuration. Note: because this install method does not include a CLI, future updates may require some manual migrations.
| | **Option 1: Install Script (multi-container)** | **Option 2: Docker Compose (single container)** |
|--------------------------|---------------------------------------------------|-----------------------------------------------|
| **Best for** | ☁️ VPS/VM/Proxmox, cloud hosts, DigitalOcean, AWS/Azure | 🏠 NAS/Synology/Unraid, Raspberry Pi, home servers |
@@ -18,34 +26,29 @@ AliasVault can be self-hosted on your own servers using two different installati
| **Updates** | `install.sh` assisted updates & migrations | `docker pull` (manual); occasional manual migrations |
| **Admin actions** | `install.sh` helpers for admin password reset | SSH into container for certain tasks (e.g. password reset) |
| **Setup style** | Managed, opinionated, production-ready defaults | Fits into existing homelab/stack tools (Portainer compatible) |
| **Build from source** | Optional (supported) | Pre-built container only |
| **Build from source** | Supported | Pre-built container only |
| **Choose if…** | You want auto SSL and a managed stack | You already have TLS and prefer manual control |
| | [**Self-host via Install Script →**](./script){: .btn .btn-primary } | [**Self-host via Docker →**](./docker-compose){: .btn .btn-primary } |
### Quick Decision Guide
**Go with the Install Script if:**
- ✅ You have a fresh VM or VPS dedicated to AliasVault
- ✅ You want automatic SSL setup without hassle
- ✅ You prefer managed updates and maintenance
- ✅ You're new to Docker or want the simplest setup
**Go with Docker Compose if:**
- ✅ You're already running other Docker containers on this host
- ✅ You have existing SSL infrastructure (reverse proxy)
- ✅ You want to integrate with your homelab tools (Portainer, etc.)
- ✅ You prefer manual control over the configuration
---
## Frequently Asked Questions
<details style="margin-bottom: 10px;">
<summary style="background-color: #4a5568; color: #ffffff; padding: 10px; border-radius: 5px; cursor: pointer;">Which installation method should I choose?</summary>
<div style="background-color: #2d3748; color: #ffffff; padding: 15px; border-left: 3px solid #4299e1;" markdown="1">
**Choose the Installer Script if:**
- You have a dedicated VM or VPS for AliasVault
- Your server is directly accessible from the internet
- You want automatic SSL certificates via Let's Encrypt
- You prefer a managed, production-ready setup with CLI helpers
**Choose Manual Setup if:**
- You're running a home server or NAS (Synology, Unraid, etc.)
- You already have a reverse proxy handling SSL (Traefik, Nginx, Caddy)
- You want to manage AliasVault alongside other Docker containers
- You prefer using standard Docker commands and tools like Portainer
</div>
</details>
<details style="margin-bottom: 10px;">
<summary style="background-color: #4a5568; color: #ffffff; padding: 10px; border-radius: 5px; cursor: pointer;">What's the difference between multi-container and single container?</summary>
<div style="background-color: #2d3748; color: #ffffff; padding: 15px; border-left: 3px solid #4299e1;" markdown="1">