From 23630e6479935105dd0067c8a39c80d28abdd8e6 Mon Sep 17 00:00:00 2001 From: NFSL2001 <33471049+NightFurySL2001@users.noreply.github.com> Date: Tue, 27 Jan 2026 23:33:31 +0800 Subject: [PATCH 1/4] Update installation guide with admin panel password warning Added warning about recording admin panel password and changing it after service restart. --- docs/installation/docker-compose/index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/installation/docker-compose/index.md b/docs/installation/docker-compose/index.md index 8d240584b..7573af9b8 100644 --- a/docs/installation/docker-compose/index.md +++ b/docs/installation/docker-compose/index.md @@ -66,6 +66,9 @@ services: - API: http://localhost/api - Used for configuring the browser extension and mobile app to connect to your server +{: .warning } +Ensure you have recorded down the admin panel password and change it! The password will stay on the page until the service is restarted, of which after that the password will not show anymore. If you have missed this step, follow the guide on the admin panel or the steps in [the troubleshooting guide on resetting admin panel password](./troubleshooting.md#3-forgot-aliasvault-admin-password). + --- ## 2. SSL/TLS configuration @@ -188,4 +191,4 @@ Afterwards, when you login to the AliasVault web app, you should now be able to {: .note } Important: DNS propagation can take up to 24-48 hours. During this time, email delivery might be inconsistent. -If you encounter any issues, feel free to join the [Discord chat](https://discord.gg/DsaXMTEtpF) to get help from other users and maintainers. \ No newline at end of file +If you encounter any issues, feel free to join the [Discord chat](https://discord.gg/DsaXMTEtpF) to get help from other users and maintainers. From 0760588c85c6d3270363171f1ce8764f37702d37 Mon Sep 17 00:00:00 2001 From: NFSL2001 <33471049+NightFurySL2001@users.noreply.github.com> Date: Tue, 27 Jan 2026 23:44:32 +0800 Subject: [PATCH 2/4] fix missing link and use css class notes --- docs/installation/script/index.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/installation/script/index.md b/docs/installation/script/index.md index ff4081d16..f13ab8be4 100644 --- a/docs/installation/script/index.md +++ b/docs/installation/script/index.md @@ -37,13 +37,19 @@ chmod +x install.sh ```bash ./install.sh install ``` -> **Note**: AliasVault binds to ports 80 and 443 by default. If you want to change the default AliasVault ports you can do so in the `.env` file. Afterwards re-run the `./install.sh install` command to restart the containers with the new port settings. + +{: .note } +AliasVault binds to ports 80 and 443 by default. If you want to change the default AliasVault ports you can do so in the `.env` file. Afterwards re-run the `./install.sh install` command to restart the containers with the new port settings. 3. After the script completes, you can access AliasVault at: - Client: `https://localhost` - Admin: `https://localhost/admin` -> Note: if you do not wish to run the `install.sh` wizard but prefer to use Docker commands directly, follow the [manual setup guide](../manual) instead. +{: .note } +If you do not wish to run the `install.sh` wizard but prefer to run a single Docker container directly, follow the [Docker Compose setup guide](../docker-compose) instead. + +{: .warning } +Ensure you have recorded down the admin panel password and change it! The password will stay on the page until the service is restarted, of which after that the password will not show anymore. If you have missed this step, follow the guide on the admin panel or the steps in [the troubleshooting guide on resetting admin panel password](./troubleshooting.md#3-forgot-aliasvault-admin-password). --- @@ -182,7 +188,8 @@ If you want to disable public registration, you can do so by running the install ./install.sh configure-registration ``` -> Note: disabling public registration means the ability to create new accounts in the AliasVault client is disabled for everyone, including administrators. Accounts cannot be created outside of the client because of the end-to-end encryption employed by AliasVault. So make sure you have created your own account(s) before disabling public registration. +{: .note } +Disabling public registration means the ability to create new accounts in the AliasVault client is disabled for everyone, including administrators. Accounts cannot be created outside of the client because of the end-to-end encryption employed by AliasVault. So make sure you have created your own account(s) before disabling public registration. --- @@ -196,7 +203,8 @@ If you want to entirely disable IP logging, you can do so by running the install ./install.sh configure-ip-logging ``` -> Note: disabling IP logging means the ability to monitor and track abusive users on your AliasVault server is disabled. +{: .note } +Disabling IP logging means the ability to monitor and track abusive users on your AliasVault server is disabled. --- From d03593d5f7eb4ff4685fc5bbced30a034ffe159f Mon Sep 17 00:00:00 2001 From: NFSL2001 <33471049+NightFurySL2001@users.noreply.github.com> Date: Tue, 27 Jan 2026 23:46:08 +0800 Subject: [PATCH 3/4] fix link --- docs/installation/script/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/script/index.md b/docs/installation/script/index.md index f13ab8be4..ddcde7305 100644 --- a/docs/installation/script/index.md +++ b/docs/installation/script/index.md @@ -49,7 +49,7 @@ AliasVault binds to ports 80 and 443 by default. If you want to change the defau If you do not wish to run the `install.sh` wizard but prefer to run a single Docker container directly, follow the [Docker Compose setup guide](../docker-compose) instead. {: .warning } -Ensure you have recorded down the admin panel password and change it! The password will stay on the page until the service is restarted, of which after that the password will not show anymore. If you have missed this step, follow the guide on the admin panel or the steps in [the troubleshooting guide on resetting admin panel password](./troubleshooting.md#3-forgot-aliasvault-admin-password). +Ensure you have recorded down the admin panel password and change it! The password will stay on the page until the service is restarted, of which after that the password will not show anymore. If you have missed this step, follow the guide on the admin panel or the steps in [the troubleshooting guide on resetting admin panel password](./troubleshooting.md#4-forgot-aliasvault-admin-password). --- From 1ed2c254a0ff8c389550550f71ef91251c6520c6 Mon Sep 17 00:00:00 2001 From: Leendert de Borst Date: Tue, 27 Jan 2026 20:46:38 +0100 Subject: [PATCH 4/4] Update docs --- docs/installation/docker-compose/index.md | 3 - docs/installation/script/index-bak.md | 73 ----------------------- docs/installation/script/index.md | 12 +--- 3 files changed, 2 insertions(+), 86 deletions(-) delete mode 100644 docs/installation/script/index-bak.md diff --git a/docs/installation/docker-compose/index.md b/docs/installation/docker-compose/index.md index 7573af9b8..e54d700b6 100644 --- a/docs/installation/docker-compose/index.md +++ b/docs/installation/docker-compose/index.md @@ -66,9 +66,6 @@ services: - API: http://localhost/api - Used for configuring the browser extension and mobile app to connect to your server -{: .warning } -Ensure you have recorded down the admin panel password and change it! The password will stay on the page until the service is restarted, of which after that the password will not show anymore. If you have missed this step, follow the guide on the admin panel or the steps in [the troubleshooting guide on resetting admin panel password](./troubleshooting.md#3-forgot-aliasvault-admin-password). - --- ## 2. SSL/TLS configuration diff --git a/docs/installation/script/index-bak.md b/docs/installation/script/index-bak.md deleted file mode 100644 index 068e54638..000000000 --- a/docs/installation/script/index-bak.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -layout: default -title: Installer Script (multi-container) -parent: Self-host Installs -nav_order: 1 -has_children: true ---- - -# Installer Script (multi-container) - -The installer script provides a managed, production-ready deployment of AliasVault using multiple Docker containers. This method includes automatic SSL certificates, built-in reverse proxy, and CLI-based management tools. - -{: .important } -> **Best for:** VPS, cloud hosting (AWS, Azure, DigitalOcean), dedicated servers with direct internet access - -1. **New Installation?** Start with the [Installation Guide](./installation) -2. **Upgrading?** Check the [Update Guide](./update/) -3. **Need Help?** Visit [Troubleshooting](./troubleshooting) or join our [Discord](https://discord.gg/DsaXMTEtpF) - -## 📚 Documentation - -
- -
-

🚀 Getting Started

-

Initial installation and configuration

- -
- -
-

🔄 Updates & Maintenance

-

Keep your instance up-to-date

- -
- -
-

❓ Help & Support

-

Troubleshooting and assistance

- -
- -
- ---- - -## Architecture Overview - -The installer script deploys AliasVault as a multi-container application: - -| Container | Purpose | -|-----------|---------| -| **reverse-proxy** | Nginx reverse proxy with SSL termination | -| **client** | Web interface (Blazor WebAssembly) | -| **api** | REST API backend | -| **admin** | Admin portal | -| **postgres** | PostgreSQL database | -| **smtp** | Email server for aliases | -| **task-runner** | Background jobs and maintenance | - -All containers are managed via `./install.sh` (which uses `docker compose` in the background) and configured through a centralized `.env` file. diff --git a/docs/installation/script/index.md b/docs/installation/script/index.md index ddcde7305..61b36c7dd 100644 --- a/docs/installation/script/index.md +++ b/docs/installation/script/index.md @@ -37,20 +37,12 @@ chmod +x install.sh ```bash ./install.sh install ``` +> **Note**: AliasVault binds to ports 80 and 443 by default. If you want to change the default AliasVault ports you can do so in the `.env` file. Afterwards re-run the `./install.sh install` command to restart the containers with the new port settings. -{: .note } -AliasVault binds to ports 80 and 443 by default. If you want to change the default AliasVault ports you can do so in the `.env` file. Afterwards re-run the `./install.sh install` command to restart the containers with the new port settings. - -3. After the script completes, you can access AliasVault at: +4. After the script completes, you can access AliasVault at: - Client: `https://localhost` - Admin: `https://localhost/admin` -{: .note } -If you do not wish to run the `install.sh` wizard but prefer to run a single Docker container directly, follow the [Docker Compose setup guide](../docker-compose) instead. - -{: .warning } -Ensure you have recorded down the admin panel password and change it! The password will stay on the page until the service is restarted, of which after that the password will not show anymore. If you have missed this step, follow the guide on the admin panel or the steps in [the troubleshooting guide on resetting admin panel password](./troubleshooting.md#4-forgot-aliasvault-admin-password). - --- ## 2. TLS/SSL configuration