Update docs layout (#727)

This commit is contained in:
Leendert de Borst
2025-03-27 13:54:46 +01:00
committed by Leendert de Borst
parent fc0eb0e7e7
commit 716ef0b30c
2 changed files with 14 additions and 6 deletions

View File

@@ -9,6 +9,12 @@ nav_order: 1
If you prefer to manually set up AliasVault instead of using the `install.sh` script, this README provides step-by-step instructions.
{: .toc }
* TOC
{:toc}
---
## Prerequisites
- Docker and Docker Compose installed on your system
@@ -75,7 +81,7 @@ If you prefer to manually set up AliasVault instead of using the `install.sh` sc
7. **Configuring private email domains**
By default, the AliasVault private email domains feature is disabled. If you wish to enable this so you can use your own private domains to create email aliases with, please read the `Email Server Setup` section in the main installation guide [Basic Install](../install.md).
By default, the AliasVault private email domains feature is disabled. If you wish to enable this so you can use your own private domains to create email aliases with, please read the `Email Server Setup` section in the main installation guide [Basic Install](../install.md#3-email-server-setup).
For more information, read the article explaining the differences between AliasVault's [private and public domains](../../misc/private-vs-public-email.md).

View File

@@ -30,12 +30,14 @@ To get AliasVault up and running quickly, run the install script to pull pre-bui
# Download the install script
curl -o install.sh https://github.com/lanedirt/AliasVault/releases/latest/download/install.sh
```
2. Run the install script. This will create the .env file, pull the Docker images, and start the AliasVault containers. Follow the on-screen prompts to configure AliasVault.
```bash
# Make the install.sh script executable
chmod +x install.sh
# Run the installation wizard
2. Make the install script executable.
```bash
chmod +x install.sh
```
3. Run the installation wizard.
```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.