Guide d'installation et d'auto-hébergement de courrier électronique transféré pour Debian

Ce guide fournit des instructions étape par étape pour installer la solution auto-hébergée de Forward Email sur les systèmes Debian. Ce guide est spécialement conçu pour Debian 11 (Bullseye) et Debian 12 (Bookworm).

Avant de commencer l'installation, assurez-vous d'avoir :

  • Serveur Debian:Version 11 (Bullseye) ou 12 (Bookworm)
  • Accès root: Vous devez pouvoir exécuter des commandes en tant que root (accès sudo)
  • Nom de domaine:Un domaine que vous contrôlez avec un accès de gestion DNS
  • Nettoyer le serveur: Il est recommandé d'utiliser une nouvelle installation Debian
  • Connexion Internet:Requis pour télécharger des packages et des images Docker

  • RAM: Minimum 2 Go (4 Go recommandés pour la production)
  • Stockage: Minimum 20 Go d'espace disponible (50 Go+ recommandés pour la production)
  • CPU: 1 vCPU minimum (2+ vCPU recommandés pour la production)
  • Réseau: Adresse IP publique avec les ports suivants accessibles :
    • 22 (SSH)
    • 25 (SMTP)
    • 80 (HTTP)
    • 443 (HTTPS)
    • 465 (SMTPS)
    • 993 (IMAPS)
    • 995 (POP3S)

Étape 1 : Configuration initiale du système

Tout d’abord, assurez-vous que votre système est à jour et passez en utilisateur root :

# Update system packages
sudo apt update && sudo apt upgrade -y

Switch to root user (required for the installation)


sudo su -

Étape 2 : Configurer les résolveurs DNS

Configurez votre système pour utiliser les serveurs DNS de Cloudflare pour une génération de certificats fiable :

# Stop and disable systemd-resolved if running
if systemctl is-active --quiet systemd-resolved; then
    rm /etc/resolv.conf
    systemctl stop systemd-resolved
    systemctl disable systemd-resolved
    systemctl mask systemd-resolved
fi

Configure Cloudflare DNS resolvers


tee /etc/resolv.conf > /dev/null <<EOF
nameserver 1.1.1.1
nameserver 2606:4700:4700::1111
nameserver 1.0.0.1
nameserver 2606:4700:4700::1001
nameserver 8.8.8.8
nameserver 2001:4860:4860::8888
nameserver 8.8.4.4
nameserver 2001:4860:4860::8844
EOF

Étape 3 : installer les dépendances système

Installez les paquets requis pour Forward Email sur Debian :

# Update package list
apt-get update -y

Install basic dependencies (Debian-specific package list)


apt-get install -y 

ca-certificates 

curl 

gnupg 

git 

openssl 

lsb-release 

apt-transport-https 

software-properties-common

Étape 4 : Installer et configurer Snapd

Debian n'inclut pas snapd par défaut, nous devons donc l'installer et le configurer :

# Install snapd
apt-get install -y snapd

Enable and start snapd service


systemctl enable snapd
systemctl start snapd


Create symlink for snap to work properly


ln -sf /var/lib/snapd/snap /snap


Wait for snapd to be ready


sleep 10


Verify snapd is working


snap version

Étape 5 : Installer les packages Snap

Installez AWS CLI et Certbot via snap :

# Install AWS CLI
snap install aws-cli --classic

Install Certbot and DNS plugin


snap install certbot --classic
snap set certbot trust-plugin-with-root=ok
snap install certbot-dns-cloudflare


Verify installations


aws --version
certbot --version

Étape 6 : Installer Docker

Installer Docker CE et Docker Compose sur Debian :

# Add Docker's official GPG key (Debian-specific)
install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/debian/gpg | tee /etc/apt/keyrings/docker.asc
chmod a+r /etc/apt/keyrings/docker.asc

Add Docker repository (Debian-specific)


echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list


Update package index and install Docker


apt-get update -y
apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin


Install standalone docker-compose as fallback (if plugin doesn't work)


if ! command -v docker-compose &> /dev/null; then
apt-get install -y docker-compose
fi


Verify Docker installation


docker --version
docker compose version || docker-compose --version

Étape 7 : Configurer le service Docker

Assurez-vous que Docker démarre automatiquement et est en cours d’exécution :

# Enable and start Docker service
systemctl unmask docker
systemctl enable docker
systemctl start docker

Verify Docker is running


docker info

Si Docker ne démarre pas, essayez de le démarrer manuellement :

# Alternative startup method if systemctl fails
nohup dockerd >/dev/null 2>/dev/null &
sleep 5
docker info

Étape 8 : Installer et configurer le pare-feu UFW

Les installations minimales de Debian peuvent ne pas inclure UFW, alors installez-le d'abord :

# Install UFW if not present
if ! command -v ufw &> /dev/null; then
    apt-get update -y
    apt-get install -y ufw
fi

Set default policies


ufw default deny incoming
ufw default allow outgoing


Allow SSH (important - don't lock yourself out!)


ufw allow 22/tcp


Allow email-related ports


ufw allow 25/tcp    # SMTP
ufw allow 80/tcp    # HTTP (for Let's Encrypt)
ufw allow 443/tcp   # HTTPS
ufw allow 465/tcp   # SMTPS
ufw allow 993/tcp   # IMAPS
ufw allow 995/tcp   # POP3S
ufw allow 2993/tcp  # IMAP (alternative port)
ufw allow 2995/tcp  # POP3 (alternative port)
ufw allow 3456/tcp  # Custom service port
ufw allow 4000/tcp  # Custom service port
ufw allow 5000/tcp  # Custom service port


Allow local database connections


ufw allow from 127.0.0.1 to any port 27017  # MongoDB
ufw allow from 127.0.0.1 to any port 6379   # Redis


Enable firewall


echo "y" | ufw enable


Check firewall status


ufw status numbered

Étape 9 : Cloner le référentiel de courrier électronique transféré

Téléchargez le code source de Forward Email :

# Set up variables
REPO_FOLDER_NAME="forwardemail.net"
REPO_URL="https://github.com/forwardemail/forwardemail.net.git"
ROOT_DIR="/root/$REPO_FOLDER_NAME"

Clone the repository


git clone "$REPO_URL" "$ROOT_DIR"
cd "$ROOT_DIR"


Verify the clone was successful


ls -la

Étape 10 : Configurer l'environnement

Préparez la configuration de l'environnement :

# Set up directory variables
SELF_HOST_DIR="$ROOT_DIR/self-hosting"
ENV_FILE_DEFAULTS=".env.defaults"
ENV_FILE=".env"

Copy default environment file


cp "$ROOT_DIR/$ENV_FILE_DEFAULTS" "$SELF_HOST_DIR/$ENV_FILE"


Create SSL directory


mkdir -p "$SELF_HOST_DIR/ssl"


Create database directories


mkdir -p "$SELF_HOST_DIR/sqlite-data"
mkdir -p "$SELF_HOST_DIR/mongo-backups"
mkdir -p "$SELF_HOST_DIR/redis-backups"

Étape 11 : Configurez votre domaine

Définissez votre nom de domaine et mettez à jour les variables d’environnement :

# Replace 'yourdomain.com' with your actual domain
DOMAIN="yourdomain.com"

Function to update environment file


update_env_file() {
local key="$1"
local value="$2"


if grep -qE "^${key}=" "$SELF_HOST_DIR/$ENV_FILE"; then
sed -i -E "s|^${key}=.*|${key}=${value}|" "$SELF_HOST_DIR/$ENV_FILE"
else
echo "${key}=${value}" >> "$SELF_HOST_DIR/$ENV_FILE"
fi
}


Update domain-related environment variables


update_env_file "DOMAIN" "$DOMAIN"
update_env_file "NODE_ENV" "production"
update_env_file "HTTP_PROTOCOL" "https"
update_env_file "WEB_HOST" "$DOMAIN"
update_env_file "WEB_PORT" "443"
update_env_file "CALDAV_HOST" "caldav.$DOMAIN"
update_env_file "CARDDAV_HOST" "carddav.$DOMAIN"
update_env_file "API_HOST" "api.$DOMAIN"
update_env_file "APP_NAME" "$DOMAIN"
update_env_file "SMTP_HOST" "smtp.$DOMAIN"
update_env_file "SMTP_PORT" "465"
update_env_file "IMAP_HOST" "imap.$DOMAIN"
update_env_file "IMAP_PORT" "993"
update_env_file "POP3_HOST" "pop3.$DOMAIN"
update_env_file "POP3_PORT" "995"
update_env_file "MX_HOST" "mx.$DOMAIN"
update_env_file "SMTP_EXCHANGE_DOMAINS" "mx.$DOMAIN"
update_env_file "SELF_HOSTED" "true"
update_env_file "WEBSITE_URL" "$DOMAIN"
update_env_file "AUTH_BASIC_ENABLED" "true"

Étape 12 : Générer des certificats SSL

# Generate certificates using manual DNS challenge
certbot certonly \
  --manual \
  --agree-tos \
  --preferred-challenges dns \
  -d "*.$DOMAIN" \
  -d "$DOMAIN"

ImportantLorsque vous y êtes invité, vous devrez créer des enregistrements TXT dans votre DNS. Plusieurs problèmes peuvent survenir pour un même domaine : créez-les TOUSNe supprimez pas le premier enregistrement TXT lors de l'ajout du second.

Option B : DNS Cloudflare (si vous utilisez Cloudflare)

Si votre domaine utilise Cloudflare pour DNS, vous pouvez automatiser la génération de certificats :

# Create Cloudflare credentials file
cat > /root/.cloudflare.ini <<EOF
dns_cloudflare_email = "your-email@example.com"
dns_cloudflare_api_key = "your-cloudflare-global-api-key"
EOF

Set proper permissions


chmod 600 /root/.cloudflare.ini


Generate certificates automatically


certbot certonly 

--dns-cloudflare 

--dns-cloudflare-credentials /root/.cloudflare.ini 

-d "$DOMAIN" 

-d "*.$DOMAIN" 

--non-interactive 

--agree-tos 

--email "your-email@example.com"

Copie des certificats

Après la génération du certificat, copiez-le dans le répertoire de l'application :

# Copy certificates to application SSL directory
cp /etc/letsencrypt/live/$DOMAIN*/* "$SELF_HOST_DIR/ssl/"

Verify certificates were copied


ls -la "$SELF_HOST_DIR/ssl/"

Étape 13 : Générer des clés de chiffrement

Créez les différentes clés de chiffrement nécessaires à un fonctionnement sécurisé :

# Generate helper encryption key
helper_encryption_key=$(openssl rand -base64 32 | tr -d /=+ | cut -c -32)
update_env_file "HELPER_ENCRYPTION_KEY" "$helper_encryption_key"

Generate SRS secret for email forwarding


srs_secret=$(openssl rand -base64 32 | tr -d /=+ | cut -c -32)
update_env_file "SRS_SECRET" "$srs_secret"


Generate TXT encryption key


txt_encryption_key=$(openssl rand -hex 16)
update_env_file "TXT_ENCRYPTION_KEY" "$txt_encryption_key"


Generate DKIM private key for email signing


openssl genrsa -f4 -out "$SELF_HOST_DIR/ssl/dkim.key" 2048
update_env_file "DKIM_PRIVATE_KEY_PATH" "/app/ssl/dkim.key"


Generate webhook signature key


webhook_signature_key=$(openssl rand -hex 16)
update_env_file "WEBHOOK_SIGNATURE_KEY" "$webhook_signature_key"


Set SMTP transport password


update_env_file "SMTP_TRANSPORT_PASS" "$(openssl rand -base64 32)"


echo "✅ All encryption keys generated successfully"

Étape 14 : Mettre à jour les chemins SSL dans la configuration

Configurez les chemins d’accès au certificat SSL dans le fichier d’environnement :

# Update SSL paths to point to the correct certificate files
sed -i -E \
  -e 's|^(.*_)?SSL_KEY_PATH=.*|\1SSL_KEY_PATH=/app/ssl/privkey.pem|' \
  -e 's|^(.*_)?SSL_CERT_PATH=.*|\1SSL_CERT_PATH=/app/ssl/fullchain.pem|' \
  -e 's|^(.*_)?SSL_CA_PATH=.*|\1SSL_CA_PATH=/app/ssl/chain.pem|' \
  "$SELF_HOST_DIR/$ENV_FILE"

Étape 15 : Configurer l’authentification de base

Créer des informations d’authentification de base temporaires :

# Generate a secure random password
PASSWORD=$(openssl rand -base64 16)

Update environment file with basic auth credentials


update_env_file "AUTH_BASIC_USERNAME" "admin"
update_env_file "AUTH_BASIC_PASSWORD" "$PASSWORD"


Display credentials (save these!)


echo ""
echo "🔐 IMPORTANT: Save these login credentials!"
echo "=================================="
echo "Username: admin"
echo "Password: $PASSWORD"
echo "=================================="
echo ""
echo "You'll need these to access the web interface after installation."
echo ""

Étape 16 : Déployer avec Docker Compose

Démarrez tous les services de transfert de courrier électronique :

# Set Docker Compose file path
DOCKER_COMPOSE_FILE="$SELF_HOST_DIR/docker-compose-self-hosted.yml"

Stop any existing containers


if command -v docker-compose &> /dev/null; then
docker-compose -f "$DOCKER_COMPOSE_FILE" down
else
docker compose -f "$DOCKER_COMPOSE_FILE" down
fi


Pull the latest images


if command -v docker-compose &> /dev/null; then
docker-compose -f "$DOCKER_COMPOSE_FILE" pull
else
docker compose -f "$DOCKER_COMPOSE_FILE" pull
fi


Start all services in detached mode


if command -v docker-compose &> /dev/null; then
docker-compose -f "$DOCKER_COMPOSE_FILE" up -d
else
docker compose -f "$DOCKER_COMPOSE_FILE" up -d
fi


Wait a moment for services to start


sleep 10


Check service status


if command -v docker-compose &> /dev/null; then
docker-compose -f "$DOCKER_COMPOSE_FILE" ps
else
docker compose -f "$DOCKER_COMPOSE_FILE" ps
fi

Étape 17 : Vérifier l'installation

Vérifiez que tous les services fonctionnent correctement :

# Check Docker containers
docker ps

Check service logs for any errors


if command -v docker-compose &> /dev/null; then
docker-compose -f "$DOCKER_COMPOSE_FILE" logs --tail=50
else
docker compose -f "$DOCKER_COMPOSE_FILE" logs --tail=50
fi


Test web interface connectivity


curl -I https://$DOMAIN


Check if ports are listening


ss -tlnp | grep -E ':(25|80|443|465|587|993|995)'

Configuration des enregistrements DNS

Vous devez configurer les enregistrements DNS suivants pour votre domaine :

Enregistrement MX

@ MX 10 mx.yourdomain.com

A Records

@ A YOUR_SERVER_IP
mx A YOUR_SERVER_IP
smtp A YOUR_SERVER_IP
imap A YOUR_SERVER_IP
pop3 A YOUR_SERVER_IP
api A YOUR_SERVER_IP
caldav A YOUR_SERVER_IP
carddav A YOUR_SERVER_IP

Enregistrement SPF

@ TXT "v=spf1 mx ~all"

Enregistrements DKIM

Obtenez votre clé publique DKIM :

# Extract DKIM public key
openssl rsa -in "$SELF_HOST_DIR/ssl/dkim.key" -pubout -outform DER | openssl base64 -A

Créer un enregistrement DNS DKIM :

default._domainkey TXT "v=DKIM1; k=rsa; p=YOUR_DKIM_PUBLIC_KEY"

Enregistrement DMARC

_dmarc TXT "v=DMARC1; p=quarantine; rua=mailto:dmarc@yourdomain.com"

Première connexion

  1. Ouvrez votre navigateur Web et accédez à https://yourdomain.com
  2. Saisissez les informations d’authentification de base que vous avez enregistrées précédemment
  3. Terminez l'assistant de configuration initiale
  4. Créez votre premier compte de messagerie

Configurer une sauvegarde compatible S3

Configurer des sauvegardes automatisées sur un stockage compatible S3 :

# Create AWS credentials directory
mkdir -p ~/.aws

Configure AWS credentials


cat > ~/.aws/credentials <<EOF
[default]
aws_access_key_id = YOUR_ACCESS_KEY_ID
aws_secret_access_key = YOUR_SECRET_ACCESS_KEY
EOF


Configure AWS settings


cat > ~/.aws/config <<EOF
[default]
region = auto
output = json
EOF


For non-AWS S3 (like Cloudflare R2), add endpoint URL


echo "endpoint_url = YOUR_S3_ENDPOINT_URL" >> ~/.aws/config

Configurer les tâches de sauvegarde Cron

# Make backup scripts executable
chmod +x "$ROOT_DIR/self-hosting/scripts/backup-mongo.sh"
chmod +x "$ROOT_DIR/self-hosting/scripts/backup-redis.sh"

Add MongoDB backup cron job (runs daily at midnight)


(crontab -l 2>/dev/null; echo "0 0 * * * $ROOT_DIR/self-hosting/scripts/backup-mongo.sh >> /var/log/mongo-backup.log 2>&1") | crontab -


Add Redis backup cron job (runs daily at midnight)


(crontab -l 2>/dev/null; echo "0 0 * * * $ROOT_DIR/self-hosting/scripts/backup-redis.sh >> /var/log/redis-backup.log 2>&1") | crontab -


Verify cron jobs were added


crontab -l

Configurer les mises à jour automatiques pour votre installation Forward Email :

# Create auto-update command (use appropriate docker compose command)
if command -v docker-compose &> /dev/null; then
    DOCKER_UPDATE_CMD="docker-compose -f $DOCKER_COMPOSE_FILE pull && docker-compose -f $DOCKER_COMPOSE_FILE up -d"
else
    DOCKER_UPDATE_CMD="docker compose -f $DOCKER_COMPOSE_FILE pull && docker compose -f $DOCKER_COMPOSE_FILE up -d"
fi

Add auto-update cron job (runs daily at 1 AM)


(crontab -l 2>/dev/null; echo "0 1 * * * $DOCKER_UPDATE_CMD >> /var/log/autoupdate.log 2>&1") | crontab -


Verify the cron job was added


crontab -l

Différences dans la gestion des paquets

  • Snapd: Non installé par défaut sur Debian, nécessite une installation manuelle
  • Docker: Utilise les référentiels spécifiques à Debian et les clés GPG
  • UFW: Ne peut pas être inclus dans les installations Debian minimales
  • systemd: Le comportement peut différer légèrement de celui d'Ubuntu

Gestion des services

# Check service status (Debian-specific commands)
systemctl status snapd
systemctl status docker
systemctl status ufw

Restart services if needed


systemctl restart snapd
systemctl restart docker

Configuration du réseau

Debian peut avoir des noms ou des configurations d'interface réseau différents :

# Check network interfaces
ip addr show

Check routing


ip route show


Check DNS resolution


nslookup google.com

Emplacements des journaux

  • Journaux Docker Compose:Utilisez la commande Docker Compose appropriée en fonction de l'installation
  • Journaux système: /var/log/syslog
  • Journaux de sauvegarde: /var/log/mongo-backup.log, /var/log/redis-backup.log
  • Journaux de mise à jour automatique: /var/log/autoupdate.log
  • Journaux Snapd: journalctl -u snapd

Tâches de maintenance régulières

  1. Surveiller l'espace disque: df -h
  2. Vérifier l'état du service: Utilisez la commande Docker Compose appropriée
  3. Réviser les journaux: Vérifiez les journaux d'application et système
  4. Mettre à jour les packages système: apt update && apt upgrade
  5. Surveiller snapd: snap list et snap refresh

Renouvellement du certificat

Les certificats doivent se renouveler automatiquement, mais vous pouvez les renouveler manuellement si nécessaire :

# Manual certificate renewal
certbot renew

Copy renewed certificates


cp /etc/letsencrypt/live/$DOMAIN*/* "$SELF_HOST_DIR/ssl/"


Restart services to use new certificates


if command -v docker-compose &> /dev/null; then
docker-compose -f "$DOCKER_COMPOSE_FILE" restart
else
docker compose -f "$DOCKER_COMPOSE_FILE" restart
fi

Problèmes spécifiques à Debian

1. Snapd ne fonctionne pas

# Check snapd status
systemctl status snapd

Restart snapd


systemctl restart snapd


Check snap path


echo $PATH | grep snap


Add snap to PATH if missing


echo 'export PATH=$PATH:/snap/bin' >> ~/.bashrc
source ~/.bashrc

2. Commande Docker Compose introuvable

# Check which docker compose command is available
command -v docker-compose
command -v docker

Use the appropriate command in scripts


if command -v docker-compose &> /dev/null; then
echo "Using docker-compose"
else
echo "Using docker compose"
fi

3. Problèmes d'installation de packages

# Update package cache
apt update

Fix broken packages


apt --fix-broken install


Check for held packages


apt-mark showhold

Problèmes courants

1. Le service Docker ne démarre pas

# Check Docker status
systemctl status docker

Check Docker logs


journalctl -u docker


Try alternative startup


nohup dockerd >/dev/null 2>/dev/null &

2. La génération du certificat échoue

  • Assurez-vous que les ports 80 et 443 sont accessibles
  • Vérifiez que les enregistrements DNS pointent vers votre serveur
  • Vérifiez les paramètres du pare-feu avec ufw status

3. Problèmes de livraison des e-mails

  • Vérifier que les enregistrements MX sont corrects
  • Vérifiez les enregistrements SPF, DKIM et DMARC
  • Assurez-vous que le port 25 n'est pas bloqué par votre hébergeur

Obtenir de l'aide

  1. Maintenir le système à jour: Mettre à jour régulièrement Debian et les paquets
  2. Journaux de surveillance: Configurer la surveillance et les alertes des journaux
  3. Sauvegarder régulièrement: Tester les procédures de sauvegarde et de restauration
  4. Utilisez des mots de passe forts: Générer des mots de passe forts pour tous les comptes
  5. Activer Fail2Ban: Pensez à installer fail2ban pour plus de sécurité
  6. Audits de sécurité réguliers:Révisez périodiquement votre configuration
  7. Surveiller Snapd: Gardez les packages Snap à jour avec snap refresh

Votre installation auto-hébergée de Forward Email devrait maintenant être terminée et opérationnelle sur Debian. N'oubliez pas :

  1. Configurez correctement vos enregistrements DNS
  2. Tester l'envoi et la réception d'e-mails
  3. Configurer des sauvegardes régulières
  4. Surveillez régulièrement votre système
  5. Maintenez votre installation à jour
  6. Surveiller les packages snapd et snap

Les principales différences avec Ubuntu résident dans l'installation de snapd et la configuration du dépôt Docker. Une fois ces éléments correctement configurés, l'application Forward Email se comporte de manière identique sur les deux systèmes.

Pour des options de configuration supplémentaires et des fonctionnalités avancées, reportez-vous à la documentation officielle de Forward Email à l'adresse https://forwardemail.net/self-hosted#configuration.