mirror of
https://github.com/lanedirt/AliasVault.git
synced 2025-12-05 19:07:26 -06:00
Update installation docs (#1280)
This commit is contained in:
Leendert de Borst
committed by
Leendert de Borst
Leendert de Borst
parent
18ee97f6e5
commit
cf90721197
@@ -75,6 +75,18 @@ To use AliasVault securely, HTTPS is required in the following situations:
|
||||
|
||||
You must set up and configure your own TLS/SSL infrastructure (such as Traefik, Nginx, HAProxy, or Cloudflare Tunnel) to make the AliasVault container accessible over HTTPS with a valid SSL/TLS certificate. For example: `https://aliasvault.yourdomain.com`.
|
||||
|
||||
### Troubleshooting
|
||||
#### Enabling WebSockets
|
||||
If you're accessing the Admin page through a reverse proxy and encounter errors after login, check that the Upgrade header is allowed and forwarded. This is required because the Admin app is built with .NET Blazor Server, which uses WebSockets for client-server communication. For example, when using nginx:
|
||||
|
||||
```nginx
|
||||
# Add WebSocket support for Blazor server
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
proxy_read_timeout 86400;
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Email Server Setup
|
||||
@@ -83,9 +95,7 @@ AliasVault includes a built-in email server that allows you to generate email al
|
||||
|
||||
{: .note }
|
||||
If you skip this step, AliasVault will default to use public email domains offered by SpamOK. While this still works for creating aliases, it has privacy limitations. For complete privacy and control, we recommend setting up your own domain.
|
||||
[Learn more about the differences between private and public email domains](../misc/private-vs-public-email.md).
|
||||
|
||||
---
|
||||
[Learn more about the differences between private and public email domains](../../misc/private-vs-public-email.md).
|
||||
|
||||
### Requirements
|
||||
- A **public IPv4 address** with ports 25 and 587 forwarded to your AliasVault server
|
||||
@@ -103,9 +113,8 @@ telnet <your-server-public-ip> 25
|
||||
telnet <your-server-public-ip> 587
|
||||
```
|
||||
|
||||
### Choose your configuration: primary domain vs subdomain
|
||||
|
||||
AliasVault can be configured under:
|
||||
### DNS configuration
|
||||
Choose your configuration: primary domain vs subdomain. AliasVault can be configured under:
|
||||
|
||||
- **A primary (top-level) domain**
|
||||
Example: `your-aliasvault.net`. This allows you to receive email on `%alias%@your-aliasvault.net`.
|
||||
@@ -117,8 +126,6 @@ AliasVault can be configured under:
|
||||
|
||||
#### a) Setup using a primary domain
|
||||
|
||||
##### DNS Configuration
|
||||
|
||||
Configure the following DNS records **on your primary domain** (e.g. `your-aliasvault.net`):
|
||||
|
||||
| Name | Type | Priority | Content | TTL |
|
||||
@@ -137,8 +144,6 @@ Configure the following DNS records **on your primary domain** (e.g. `your-alias
|
||||
|
||||
#### b) Setup using a subdomain
|
||||
|
||||
##### DNS Configuration
|
||||
|
||||
Configure the following DNS records **on your subdomain setup** (for example, `aliasvault.example.com`):
|
||||
|
||||
| Name | Type | Priority | Content | TTL |
|
||||
@@ -161,7 +166,7 @@ This keeps the email configuration of your primary domain (`example.com`) comple
|
||||
|
||||
---
|
||||
|
||||
### Configuring AliasVault
|
||||
### AliasVault server email domain configuration
|
||||
After setting up your DNS, you have to configure AliasVault to let it know which email domains it should support. Update the `docker-compose.yml` file:
|
||||
|
||||
```bash
|
||||
|
||||
@@ -15,6 +15,48 @@ This guide covers common issues and troubleshooting steps for AliasVault encount
|
||||
|
||||
---
|
||||
|
||||
## Common Issues
|
||||
Below are some common issues you might encounter and how to troubleshoot them.
|
||||
|
||||
### 1. No emails being received
|
||||
If you are not receiving emails on your aliases, check the following:
|
||||
- Verify DNS records are correctly configured
|
||||
- Ensure ports 25 and 587 are accessible
|
||||
- Check your server's firewall settings
|
||||
- Verify that your ISP/hosting provider allows SMTP traffic and does not block port 25
|
||||
|
||||
Refer to the [installation guide](./#3-email-server-setup) for more information on how to configure your DNS records and ports.
|
||||
|
||||
### 2. Admin app not working via your own reverse proxy
|
||||
If you're accessing the Admin page through your own reverse proxy and encounter errors after login, check that the Upgrade header is allowed and forwarded. This is required because the Admin app is built with .NET Blazor Server, which uses WebSockets for client-server communication. For example, when using nginx:
|
||||
|
||||
```nginx
|
||||
# Add WebSocket support for Blazor server
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
proxy_read_timeout 86400;
|
||||
```
|
||||
|
||||
### 3. Forgot AliasVault admin password
|
||||
If you have lost your admin password, you can reset it by running the `aliasvault reset-admin-password` option. This will generate a new random password and update the secret. After that it will restart the AliasVault containers to apply the changes.
|
||||
|
||||
1. SSH into the aliasvault container:
|
||||
```bash
|
||||
$ docker compose exec -it aliasvault /bin/bash
|
||||
```
|
||||
2. Run the reset-admin-password.sh script:
|
||||
```bash
|
||||
$ aliasvault reset-admin-password
|
||||
```
|
||||
3. Remember the password outputted by the step above. Then quit out of the SSH session (ctrl+C) and then restart the container:
|
||||
```bash
|
||||
$ docker compose restart
|
||||
```
|
||||
4. You can now login to the admin panel (/admin) with the new password.
|
||||
|
||||
---
|
||||
|
||||
## Check Docker Container Status
|
||||
For any issues you might encounter, the first step is to check the Docker containers health. This will give you a quick insight into the status of the individual containers which will help you identify the root cause of the issue.
|
||||
|
||||
@@ -42,37 +84,6 @@ All AliasVault services log information and errors to text files. These files ar
|
||||
$ cat logs/[service-name].txt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Issues
|
||||
Below are some common issues you might encounter and how to troubleshoot them.
|
||||
|
||||
### 1. No emails being received
|
||||
If you are not receiving emails on your aliases, check the following:
|
||||
- Verify DNS records are correctly configured
|
||||
- Ensure ports 25 and 587 are accessible
|
||||
- Check your server's firewall settings
|
||||
- Verify that your ISP/hosting provider allows SMTP traffic and does not block port 25
|
||||
|
||||
Refer to the [installation guide](./#3-email-server-setup) for more information on how to configure your DNS records and ports.
|
||||
|
||||
|
||||
### 2. Forgot AliasVault Admin Password
|
||||
If you have lost your admin password, you can reset it by running the `aliasvault reset-admin-password` option. This will generate a new random password and update the secret. After that it will restart the AliasVault containers to apply the changes.
|
||||
|
||||
1. SSH into the aliasvault container:
|
||||
```bash
|
||||
$ docker compose exec -it aliasvault /bin/bash
|
||||
```
|
||||
2. Run the reset-admin-password.sh script:
|
||||
```bash
|
||||
$ aliasvault reset-admin-password
|
||||
```
|
||||
3. Remember the password outputted by the step above. Then quit out of the SSH session (ctrl+C) and then restart the container:
|
||||
```bash
|
||||
$ docker compose restart
|
||||
```
|
||||
4. You can now login to the admin panel (/admin) with the new password.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -75,9 +75,7 @@ and then in the prompt choose option 2.
|
||||
AliasVault includes a built-in email server that allows you to generate email aliases on-the-fly for every website you use, and receive + read the emails straight in AliasVault.
|
||||
|
||||
{: .note }
|
||||
If you skip this step, AliasVault will default to use public email domains offered by SpamOK. While this still works for creating aliases, it has privacy limitations. For complete privacy and control, we recommend setting up your own domain. [Learn more about the differences between private and public email domains](../misc/private-vs-public-email.md).
|
||||
|
||||
---
|
||||
If you skip this step, AliasVault will default to use public email domains offered by SpamOK. While this still works for creating aliases, it has privacy limitations. For complete privacy and control, we recommend setting up your own domain. [Learn more about the differences between private and public email domains](../../misc/private-vs-public-email.md).
|
||||
|
||||
### Requirements
|
||||
- A **public IPv4 address** with ports 25 and 587 forwarded to your AliasVault server
|
||||
@@ -97,9 +95,8 @@ telnet <your-server-public-ip> 587
|
||||
|
||||
If successful, you'll see a connection establishment message. Press Ctrl+C to exit the telnet session.
|
||||
|
||||
### Choose your configuration: primary domain vs subdomain
|
||||
|
||||
AliasVault can be configured under:
|
||||
### DNS configuration
|
||||
Choose your configuration: primary domain vs subdomain. AliasVault can be configured under:
|
||||
|
||||
- **A primary (top-level) domain**
|
||||
Example: `your-aliasvault.net`. This allows you to receive email on `%alias%@your-aliasvault.net`.
|
||||
@@ -111,8 +108,6 @@ AliasVault can be configured under:
|
||||
|
||||
#### a) Setup using a primary domain
|
||||
|
||||
##### DNS Configuration
|
||||
|
||||
Configure the following DNS records **on your primary domain** (e.g. `your-aliasvault.net`):
|
||||
|
||||
| Name | Type | Priority | Content | TTL |
|
||||
@@ -131,8 +126,6 @@ Configure the following DNS records **on your primary domain** (e.g. `your-alias
|
||||
|
||||
#### b) Setup using a subdomain
|
||||
|
||||
##### DNS Configuration
|
||||
|
||||
Configure the following DNS records **on your subdomain setup** (for example, `aliasvault.example.com`):
|
||||
|
||||
| Name | Type | Priority | Content | TTL |
|
||||
@@ -155,7 +148,7 @@ This keeps the email configuration of your primary domain (`example.com`) comple
|
||||
|
||||
---
|
||||
|
||||
### Configuring AliasVault
|
||||
### AliasVault server email domain configuration
|
||||
After setting up your DNS, continue with configuring AliasVault to let it know which email domains it should support.
|
||||
|
||||
1. Run the email configuration script:
|
||||
|
||||
@@ -38,7 +38,7 @@ The following public email domains are currently available through SpamOK:
|
||||
## Important Disclaimers
|
||||
Public email domains do have limitations, please be aware of them:
|
||||
|
||||
1. **Public Nature**: These are fully public domains - anyone can access any email address as long as they know the name of the alias. The benefit is that this makes these domains fully anonymous because usage cannot be tied back to a specific user. But this also means that there is no privacy guarantee, as your emails can be read by anyone who knows the email address.
|
||||
1. **Public Nature**: These are fully public domains - anyone can access any email address as long as they know the name of the alias. The benefit is that this makes these domains fully anonymous because there is no ownership that could be traced back to a specific user. But this also means that there is no privacy guarantee, as your emails can be read by anyone who knows the email address.
|
||||
|
||||
2. **No Service Level Agreement**: SpamOK is provided as a free service without any SLA or warranty. Email delivery and service availability are not guaranteed and can be interrupted at any time without notice.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user