Update email installation documentation (#428)

This commit is contained in:
Leendert de Borst
2024-11-27 12:51:25 +01:00
parent 1baea180aa
commit aa41cceff3
3 changed files with 16 additions and 12 deletions

3
.gitignore vendored
View File

@@ -390,6 +390,9 @@ src/Tests/AliasVault.E2ETests/appsettings.Development.json
# .env is generated by install.sh and therefore should be ignored
.env
# install.sh backup files are generated by install.sh self-update and therefore should be ignored
install.sh.backup
# Draw.io diagram temp files
*.drawio.*

View File

@@ -74,16 +74,16 @@ AliasVault includes a built-in email server that can handle multiple custom doma
To set up the email server, you need the following:
- Public IPv4 address
- Access to DNS record management for your domain
- Open ports (25 and 587) in server firewall for SMTP traffic
- Access to DNS record management for your domain
### a) DNS Configuration
Configure the following DNS records for your domain:
| Name | Type | Content | TTL |
|------|------|---------------------------|-----|
| mail | A | `<your-server-public-ip>` | 3600 |
| @ | MX | `mail.<your-domain>` | 3600 |
| Name | Type | Priority | Content | TTL |
|------|------|----------|---------------------------|-----|
| mail | A | | `<your-server-public-ip>` | 3600 |
| @ | MX | 10 | `mail.<your-domain>` | 3600 |
> Note: Replace `<your-server-public-ip>` and `<your-domain>` with your actual values.
@@ -118,6 +118,7 @@ If successful, you'll see a connection establishment message. Press Ctrl+C to ex
3. Once configured, you can:
- Create new aliases in the AliasVault client
- Use your custom domain(s) for email addresses
- Note: you can configure the default domain for new aliases in the AliasVault client in Menu > Settings > Email Settings > Default Email Domain
- Start receiving emails on your aliases
{: .note }

View File

@@ -266,8 +266,8 @@ print_logo() {
printf " _ _ _ __ __ _ _ \n"
printf " / \ | (_) __ _ ___ \ \ / /_ _ _ _| | |_\n"
printf " / _ \ | | |/ _\` / __| \ \/\/ / _\` | | | | | __|\n"
printf " / ___ \| | | (_| \__ \ \ / (_| | |_| | | |_ \n"
printf "/_/ \_\_|_|\__,_|___/ \/ \__,_|\__,_|_|\__|\n"
printf " / ___ \| | | (_| \__ \ \ / / (_| | |_| | | |_ \n"
printf "/_/ \_\_|_|\__,_|___/ \/ \__,__|\__,_|_|\__|\n"
printf "${NC}\n"
}
@@ -329,7 +329,7 @@ set_private_email_domains() {
private_email_domains=$(grep "^PRIVATE_EMAIL_DOMAINS=" "$ENV_FILE" | cut -d '=' -f2)
if [ "$private_email_domains" = "DISABLED.TLD" ]; then
printf " ${RED}Email server is disabled.${NC} Enable with /install.sh configure-email command.\n"
printf " ${RED}Email server is disabled.${NC} To enable use ./install.sh configure-email command.\n"
else
printf " ${GREEN}> PRIVATE_EMAIL_DOMAINS already exists. Email server is enabled.${NC}\n"
fi
@@ -1050,8 +1050,8 @@ handle_update() {
exit 1
fi
printf "${CYAN}> Current version: ${current_version}${NC}\n"
printf "${CYAN}> Latest version: ${latest_version}${NC}\n"
printf "${CYAN}> Current AliasVault version: ${current_version}${NC}\n"
printf "${CYAN}> Latest AliasVault version: ${latest_version}${NC}\n"
printf "\n"
if [ "$current_version" = "$latest_version" ]; then
@@ -1140,8 +1140,8 @@ check_install_script_update() {
return 0
fi
else
printf "${CYAN}> Current version: ${current_version}${NC}\n"
printf "${CYAN}> Latest version: ${new_version}${NC}\n"
printf "${CYAN}> Current install script version: ${current_version}${NC}\n"
printf "${CYAN}> Latest install script version: ${new_version}${NC}\n"
# Compare versions using semver comparison
if [ "$current_version" = "$new_version" ]; then