Update docs
This commit is contained in:
@@ -4,19 +4,19 @@ This folder contains alternative Docker configurations for AliasVault deployment
|
||||
|
||||
## Files
|
||||
|
||||
### `docker-compose.all-in-one.yml`
|
||||
This is a all-in-one single-container build of the AliasVault server stack for easy self-hosting, using s6-overlay to run multiple services (database, API, web, smtp, task runner) in one container.
|
||||
|
||||
This build is primarily intended for platforms with **limited management** such like NAS devices, Unraid, or other **small home-use scenarios** where simplicity is preferred over flexibility. All configuration is abstracted away as much as possible. You only need to start this one container and most settings will be auto-initialized for you during the container startup.
|
||||
|
||||
> **Note:** For more advanced setups and production purposes, we recommend using the default multi-container configuration available via [`../docker-compose.yml`](../docker-compose.yml).
|
||||
|
||||
### `docker-compose.build.yml`
|
||||
Used to locally build Docker images from source instead of retrieving pre-built images from GitHub Container Registry. Automatically used when running `./install.sh build`.
|
||||
|
||||
### `docker-compose.dev.yml`
|
||||
Contains containers for aiding in local development of AliasVault. Provides a separate PostgreSQL instance for development on port 5433, managed via `./install.sh configure-dev-db`.
|
||||
|
||||
### `docker-compose.all-in-one.yml`
|
||||
This is a all-in-one single-container build of the full AliasVault server stack for easy self-hosting, using s6-overlay to run multiple services (database, API, web, smtp, task runner) in one container.
|
||||
|
||||
This build is primarily intended for **limited platforms** like NAS devices, Unraid, or other **small home-use scenarios** where simplicity is preferred over flexibility. All configuration is abstracted away as much as possible. You only need to start this one container.
|
||||
|
||||
> **Note:** For production or more advanced setups, we recommend using the default multi-container configuration available via [`../docker-compose.yml`](../docker-compose.yml).
|
||||
|
||||
## Usage
|
||||
|
||||
- **Standard deployment**: `./install.sh install` (uses multi-container setup and ../docker-compose.yml)
|
||||
|
||||
@@ -88,7 +88,7 @@ AliasVault includes a built-in email server that allows you to generate email al
|
||||
|
||||
#### Verifying Port Access
|
||||
|
||||
Use `telnet` to confirm the ports are reachable on your public IP:
|
||||
While the AliasVault docker containers are running, use `telnet` to confirm your public IP allows access to the ports:
|
||||
|
||||
```bash
|
||||
# Test standard SMTP port
|
||||
|
||||
@@ -36,7 +36,7 @@ For most version updates, you can use the standard update process:
|
||||
## Version-Specific Upgrade Guides
|
||||
Upgrading from certain earlier versions require additional steps during upgrade. If you are upgrading from an older version, please check the relevant articles below if it applies to your server:
|
||||
|
||||
- [Updating from < 0.22.0](v0.22.0.html) - Move secrets from .env to file based secrets
|
||||
- [Updating to 0.22.0](v0.22.0.html) - Move secrets from .env to file based secrets
|
||||
|
||||
## Additional Update Options
|
||||
|
||||
|
||||
@@ -9,13 +9,13 @@ nav_order: 1
|
||||
# Updating to v0.22.0
|
||||
{: .no_toc }
|
||||
|
||||
Since v0.22.0, the AliasVault docker structure has changed due to the introduction of the new (optional) all-in-one docker image that simplifies self-hosting use for NAS/Unraid and other home use. However we still advice to keep using the multi-docker setup for more flexibility, and this method stays fully supported as it makes managing your AliasVault instance more easy and gives you more control.
|
||||
Since v0.22.0, the AliasVault docker structure has changed due to the introduction of the new (optional) all-in-one docker image that simplifies self-hosting use for NAS/Unraid and other home use. Data structure changes involve secrets that have moved from .env to a new `./secrets` bind mount, and several other .env params that are now optional and do not require to be explicitly set for a clean install.
|
||||
|
||||
## Update Methods
|
||||
|
||||
### 1. Using install.sh
|
||||
### 1. Installed via install.sh
|
||||
|
||||
If you have AliasVault deployed using the official `install.sh`, you don't need to do anything. The automatic `install.sh update` will take care of all necessary data migrations for you.
|
||||
If you have installed AliasVault using the official `install.sh` method, you don't need to do anything. Running the built-in `install.sh update` command will take care of all necessary data migrations for you.
|
||||
|
||||
```bash
|
||||
./install.sh update
|
||||
@@ -23,7 +23,7 @@ If you have AliasVault deployed using the official `install.sh`, you don't need
|
||||
|
||||
### 2. Manually installed
|
||||
|
||||
If you have manually installed AliasVault via a custom `docker-compose.yml` file or other stack such as Portainer, follow the following manual steps:
|
||||
If you have manually installed AliasVault via a custom `docker-compose.yml` file or other Docker management interface such as Portainer, follow the following manual steps:
|
||||
|
||||
#### Step 1: Move secrets from .env to ./secrets folder
|
||||
|
||||
@@ -92,9 +92,9 @@ services:
|
||||
|
||||
You can optionally remove the following environment variables from .env as they now fallback to default values:
|
||||
|
||||
- `HOSTNAME` = empty (defaults to auto-detection)
|
||||
- `PUBLIC_REGISTRATION_ENABLED` = true (defaults to enabled)
|
||||
- `IP_LOGGING_ENABLED` = true (defaults to enabled)
|
||||
- `HOSTNAME` (defaults to auto-detection)
|
||||
- `PUBLIC_REGISTRATION_ENABLED` (defaults to true/enabled)
|
||||
- `IP_LOGGING_ENABLED` (defaults to true/enabled)
|
||||
|
||||
#### Step 4: Update and restart
|
||||
|
||||
|
||||
Reference in New Issue
Block a user