Forward Email セルフホスティング インストールガイド for Debian

本ガイドは、Debianシステム上でForward Emailのセルフホスティングソリューションをインストールするためのステップバイステップの手順を提供します。本ガイドは特にDebian 11(Bullseye)およびDebian 12(Bookworm)向けに調整されています。

インストールを開始する前に、以下を確認してください:

  • Debianサーバー:バージョン11(Bullseye)または12(Bookworm)
  • rootアクセス:root権限(sudoアクセス)でコマンドを実行できること
  • ドメイン名:DNS管理アクセス権のある管理ドメイン
  • クリーンサーバー:新規のDebianインストールを推奨
  • インターネット接続:パッケージやDockerイメージのダウンロードに必要

  • RAM:最低2GB(本番環境では4GB推奨)
  • ストレージ:最低20GBの空き容量(本番環境では50GB以上推奨)
  • CPU:最低1 vCPU(本番環境では2以上推奨)
  • ネットワーク:以下のポートがアクセス可能なパブリックIPアドレス
    • 22 (SSH)
    • 25 (SMTP)
    • 80 (HTTP)
    • 443 (HTTPS)
    • 465 (SMTPS)
    • 993 (IMAPS)
    • 995 (POP3S)

ステップ 1: 初期システムセットアップ

まず、システムを最新の状態にし、rootユーザーに切り替えます:

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

# Switch to root user (required for the installation)
sudo su -

Step 2: Configure DNS Resolvers

信頼性の高い証明書生成のために、システムをCloudflareのDNSサーバーを使用するように設定します:

# 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

Step 3: Install System Dependencies

DebianでForward Emailに必要なパッケージをインストールします:

# 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

Step 4: Install and Configure Snapd

Debianにはデフォルトでsnapdが含まれていないため、インストールして設定する必要があります:

# 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

Step 5: Install Snap Packages

snapを使ってAWS CLIとCertbotをインストールします:

# 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

Step 6: Install Docker

DebianにDocker CEとDocker Composeをインストールします:

# 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

Step 7: Configure Docker Service

Dockerが自動起動し、稼働していることを確認します:

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

# Verify Docker is running
docker info

Dockerの起動に失敗した場合は、手動で起動を試みてください:

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

Step 8: Install and Configure UFW Firewall

Debianの最小インストールにはUFWが含まれていない場合があるため、まずインストールします:

# 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

Step 9: Forward Emailリポジトリをクローンする

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

Step 10: 環境設定を準備する

環境設定を準備します:

# 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"

Step 11: ドメインを設定する

ドメイン名を設定し、環境変数を更新します:

# 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"

Step 12: SSL証明書を生成する

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

重要:プロンプトが表示されたら、DNSにTXTレコードを作成する必要があります。同じドメインに対して複数のチャレンジが表示される場合がありますが、すべて作成してください。2つ目のTXTレコードを追加するときに最初のTXTレコードを削除しないでください。

オプションB: Cloudflare DNS(Cloudflareを使用している場合)

ドメインがCloudflareのDNSを使用している場合、証明書の生成を自動化できます:

# 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"

証明書をコピーする

証明書生成後、アプリケーションディレクトリにコピーします:

# 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/"

Step 13: 暗号化キーを生成する

安全な運用に必要な各種暗号化キーを作成します:

# 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"

Step 14: Update SSL Paths in Configuration

環境ファイルでSSL証明書のパスを設定します:

# 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"

Step 15: Set Up Basic Authentication

一時的なベーシック認証の資格情報を作成します:

# 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 ""

Step 16: Deploy with Docker Compose

Forward Emailのすべてのサービスを起動します:

# 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

Step 17: Verify Installation

すべてのサービスが正しく動作しているか確認します:

# 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)'

DNS Records Setup

ドメインのために以下のDNSレコードを設定する必要があります:

MX Record

@ 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

SPF Record

@ TXT "v=spf1 mx ~all"

DKIM Record

DKIM公開鍵を取得します:

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

DKIMのDNSレコードを作成します:

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

DMARC Record

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

First Login

  1. ウェブブラウザを開き、https://yourdomain.com にアクセスします
  2. 先ほど保存したベーシック認証の資格情報を入力します
  3. 初期セットアップウィザードを完了します
  4. 最初のメールアカウントを作成します

Set Up S3-Compatible Backup

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

バックアップCronジョブの設定

# バックアップスクリプトを実行可能にする
chmod +x "$ROOT_DIR/self-hosting/scripts/backup-mongo.sh"
chmod +x "$ROOT_DIR/self-hosting/scripts/backup-redis.sh"

# MongoDBバックアップのcronジョブを追加(毎日深夜に実行)
(crontab -l 2>/dev/null; echo "0 0 * * * $ROOT_DIR/self-hosting/scripts/backup-mongo.sh >> /var/log/mongo-backup.log 2>&1") | crontab -

# Redisバックアップのcronジョブを追加(毎日深夜に実行)
(crontab -l 2>/dev/null; echo "0 0 * * * $ROOT_DIR/self-hosting/scripts/backup-redis.sh >> /var/log/redis-backup.log 2>&1") | crontab -

# cronジョブが追加されたことを確認
crontab -l

Forward Emailのインストールに対して自動更新を設定します:

# 自動更新コマンドを作成(適切なdocker composeコマンドを使用)
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

# 自動更新のcronジョブを追加(毎日午前1時に実行)
(crontab -l 2>/dev/null; echo "0 1 * * * $DOCKER_UPDATE_CMD >> /var/log/autoupdate.log 2>&1") | crontab -

# cronジョブが追加されたことを確認
crontab -l

パッケージ管理の違い

  • Snapd: Debianではデフォルトでインストールされておらず、手動でのインストールが必要
  • Docker: Debian固有のリポジトリとGPGキーを使用
  • UFW: 最小限のDebianインストールには含まれていない場合がある
  • systemd: Ubuntuとは動作が若干異なる場合がある

サービス管理

# サービスの状態を確認(Debian固有のコマンド)
systemctl status snapd
systemctl status docker
systemctl status ufw

# 必要に応じてサービスを再起動
systemctl restart snapd
systemctl restart docker

ネットワーク設定

Debianではネットワークインターフェース名や設定が異なる場合があります:

# ネットワークインターフェースを確認
ip addr show

# ルーティングを確認
ip route show

# DNS解決を確認
nslookup google.com

ログの場所

  • Docker Composeログ: インストールに応じた適切なdocker composeコマンドを使用
  • システムログ: /var/log/syslog
  • バックアップログ: /var/log/mongo-backup.log, /var/log/redis-backup.log
  • 自動更新ログ: /var/log/autoupdate.log
  • Snapdログ: journalctl -u snapd

定期メンテナンス作業

  1. ディスク容量の監視: df -h
  2. サービス状態の確認: 適切なdocker composeコマンドを使用
  3. ログの確認: アプリケーションとシステムの両方のログをチェック
  4. システムパッケージの更新: apt update && apt upgrade
  5. snapdの監視: snap listsnap refresh

証明書の更新

証明書は自動更新されますが、必要に応じて手動で更新できます:

# 手動で証明書を更新
certbot renew

# 更新された証明書をコピー
cp /etc/letsencrypt/live/$DOMAIN*/* "$SELF_HOST_DIR/ssl/"

# 新しい証明書を使用するためにサービスを再起動
if command -v docker-compose &> /dev/null; then
    docker-compose -f "$DOCKER_COMPOSE_FILE" restart
else
    docker compose -f "$DOCKER_COMPOSE_FILE" restart
fi

Debian固有の問題

1. Snapdが動作しない

# snapdの状態を確認
systemctl status snapd

# snapdを再起動
systemctl restart snapd

# snapのパスを確認
echo $PATH | grep snap

# PATHにsnapがなければ追加
echo 'export PATH=$PATH:/snap/bin' >> ~/.bashrc
source ~/.bashrc

2. Docker Composeコマンドが見つからない

# 利用可能なdocker composeコマンドを確認
command -v docker-compose
command -v docker

# スクリプト内で適切なコマンドを使用
if command -v docker-compose &> /dev/null; then
    echo "docker-composeを使用しています"
else
    echo "docker composeを使用しています"
fi

3. パッケージインストールの問題

# パッケージキャッシュを更新
apt update

# 壊れたパッケージを修復
apt --fix-broken install

# 保留中のパッケージを確認
apt-mark showhold

よくある問題

1. Dockerサービスが起動しない

# Dockerの状態を確認
systemctl status docker

# Dockerのログを確認
journalctl -u docker

# 代替起動を試す
nohup dockerd >/dev/null 2>/dev/null &

2. 証明書の生成に失敗する

  • ポート80と443がアクセス可能であることを確認
  • DNSレコードがサーバーを指していることを確認
  • ufw statusでファイアウォール設定を確認

3. メール配信の問題

  • MXレコードが正しいことを確認
  • SPF、DKIM、DMARCレコードを確認
  • ホスティングプロバイダーがポート25をブロックしていないことを確認

ヘルプを得る

  1. システムを最新に保つ: Debianとパッケージを定期的に更新する
  2. ログを監視する: ログ監視とアラート設定を行う
  3. 定期的にバックアップを取る: バックアップと復元手順をテストする
  4. 強力なパスワードを使う: すべてのアカウントに強力なパスワードを生成する
  5. Fail2Banを有効にする: 追加のセキュリティとしてfail2banの導入を検討する
  6. 定期的なセキュリティ監査: 設定を定期的に見直す
  7. Snapdを監視する: snap refreshでsnapパッケージを最新に保つ

Forward EmailのセルフホストインストールはDebian上で完了し、稼働しているはずです。以下を忘れずに行ってください:

  1. DNSレコードを正しく設定する
  2. メールの送受信をテストする
  3. 定期的なバックアップを設定する
  4. システムを定期的に監視する
  5. インストールを最新の状態に保つ
  6. snapdとsnapパッケージを監視する

Ubuntuとの主な違いはsnapdのインストールとDockerリポジトリの設定です。これらが正しく設定されれば、Forward Emailアプリケーションは両システムで同様に動作します。

追加の設定オプションや高度な機能については、公式Forward Emailドキュメント https://forwardemail.net/self-hosted#configuration を参照してください。