diff --git a/docs/installation/docker/index.md b/docs/installation/docker/index.md index 4089a5458..a1f941826 100644 --- a/docs/installation/docker/index.md +++ b/docs/installation/docker/index.md @@ -1,12 +1,12 @@ --- layout: default -title: All-In-One Docker Image +title: Manual Setup (single container) parent: Self-hosting nav_order: 2 --- # Self-host via All-In-One Docker image -Instead of using the `install.sh` script with multi-docker container setup, AliasVault is also available as a standalone all-in-one container that uses `s6-overlay` to combine all AliasVault's services into one image for convenience. This setup is suitable for home and internal use. +The following guide will walk you through the steps to install AliasVault via the All-In-One Docker container. This container uses `s6-overlay` to combine all AliasVault's services into one image for convenience. The only downside compared to the `install.sh` installer is that this version does NOT come with SSL support, so you'll have to make the container available through your own SSL proxy. **Prerequisites:** diff --git a/docs/installation/index.md b/docs/installation/index.md index 49b299be0..c82bdd4fb 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -6,11 +6,9 @@ nav_order: 2 # Self-hosting -AliasVault can be self-hosted on your own servers in two ways. -Both options use Docker, but the workflows differ in flexibility and convenience. -Choose the one that best matches your environment: +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: -[Option 1: install.sh](./installation/install){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } +[Option 1: Install.sh](./installation/install){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } [Option 2: All-In-One Docker Image](https://github.com/aliasvault/aliasvault){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 } --- @@ -18,26 +16,19 @@ Choose the one that best matches your environment: ## Option 1: `install.sh` (Managed Multi-Container Stack) > **Best for:** -> - Proxmox CT/VM -> - DigitalOcean Droplet -> - Hetzner VPS -> - AWS / Azure VM +> - VM or LXC (Proxmox, DigitalOcean Droplet, VPS, AWS/Azure VM) > - Any other host that is directly accessible from the internet and/or has ports 80/443 forwarded to it, **without existing SSL termination** This option installs the **full AliasVault stack** (client, API, Postgres, task runner, SMTP, admin, reverse proxy) as multiple Docker containers in the background. The `install.sh` script provides: -- **Pulling of all required Docker images** and configures Docker Compose automatically +- **Automatic configuration of docker-compose.yml with multiple containers** - **Built-in reverse proxy with Let's Encrypt SSL** - **Easy updates and migrations** via a custom CLI - **Start/stop/uninstall commands** for convenience - Allows to build Docker containers from source (optional) - Opinionated defaults for a secure, production-ready setup -{: .note } -ℹī¸ This method is more suitable for **less experienced Linux users**. It still requires some basic knowledge, but the script provides guidance and automates many steps. -👉 Use this option if you want a **managed experience** with automatic SSL and CLI tools. - [Installation guide →](install-vm.md) --- @@ -45,20 +36,19 @@ The `install.sh` script provides: ## Option 2: All-in-One Docker Image > **Best for:** -> - Home servers (Synology, Unraid, Raspberry Pi, local Docker) +> - Home servers / NAS (Synology, Unraid, Raspberry Pi, local Docker) > - Advanced users with their own SSL termination (Traefik, Nginx, HAProxy, Caddy, etc.) > - Environments where AliasVault runs **behind an existing reverse proxy** This option runs AliasVault as a **single bundled container** (client, API, Postgres, task runner, SMTP, etc. included). -Unlike `install.sh`, it does **not provide**: -- SSL termination (you must handle HTTPS separately) -- A CLI for updates, migrations, or configuration -Instead, everything is managed via **standard Docker commands**: +Everything is managed via **standard Docker commands**: - Updates are done manually with `docker pull` - In some cases, future updates may require **manual migration steps** (these will be documented) - Certain admin actions (e.g. resetting a password) require **manual container access via SSH** +- SSL termination not included (you must handle HTTPS yourself separately) -👉 Use this option if you **already manage SSL**, have an existing host where you are running other Docker apps already, and/or prefer to run AliasVault inside your own reverse proxy setup. + +👉 Use this option if you **already manage SSL**, have an existing host where you are running other Docker apps already, and/or prefer to run AliasVault behind your own reverse proxy setup. [Docker guide →](install-docker.md) diff --git a/docs/installation/install.sh/index.md b/docs/installation/install.sh/index.md index 6526f2b2c..13802e019 100644 --- a/docs/installation/install.sh/index.md +++ b/docs/installation/install.sh/index.md @@ -1,12 +1,12 @@ --- layout: default -title: Install.sh +title: Installer Script (managed) parent: Self-hosting nav_order: 1 --- # Self-host via install.sh -The following guide will walk you through the steps to install AliasVault on your own server using `install.sh`. Minimum experience with Docker and Linux is required. Estimated time: 5-15 minutes. +The following guide will walk you through the steps to install AliasVault on your own server using the AliasVault installer script: `install.sh`. Minimum experience with Docker and Linux is required. Estimated time: 5-15 minutes. {: .toc } * TOC