pattertj/protonmail-bridge repository overview

⁠Proton Mail Bridge Docker

Docker container for Proton Mail Bridge⁠ with a web-based setup UI, optimized for Unraid.

Creates a local IMAP/SMTP server that decrypts your Proton Mail, allowing other containers and email clients on your network to send and receive email through your Proton account.

⁠Features

• Web UI for account setup and credential display -- no docker exec required
• Multi-arch images (amd64, arm64)
• Automated updates via CI that tracks upstream Proton Bridge releases
• Unraid Community Applications template for one-click install
• Security hardened: auth tokens, rate limiting, input sanitization, security headers

⁠Requirements

• A paid Proton plan (Mail Plus, Proton Unlimited, or Proton for Business). Free accounts cannot use Bridge.

⁠Quick Start

services:
  protonmail-bridge:
    image: pattertj/protonmail-bridge:latest
    container_name: protonmail-bridge
    restart: unless-stopped
    volumes:
      - ./data:/root
    ports:
      - "1025:25"     # SMTP
      - "1143:143"    # IMAP
      - "3080:3000"   # Web UI
    environment:
      - WEBUI_AUTH_TOKEN=your-secret-token

1. Start the container: docker compose up -d
2. Open the Web UI: http://localhost:3080
3. Enter your WEBUI_AUTH_TOKEN to authenticate
4. Sign in with your Proton credentials
5. Use the displayed IMAP/SMTP settings in your apps

⁠Configuration

⁠Ports

⁠Volumes

⁠Using with Other Containers

Point your apps at the bridge container's hostname/IP with the mapped ports:

Works with Nextcloud, Gitea, Home Assistant, Uptime Kuma, Paperless-ngx, and any service that supports SMTP/IMAP.

⁠Building from Source

docker compose up -d --build

⁠Running Tests

cd webui && go test ./handlers/ -v
bash tests/test_entrypoint.sh
bash tests/test_no_cdn.sh

⁠Security

• Set WEBUI_AUTH_TOKEN to protect the Web UI
• Use WEBUI_TLS_CERT/WEBUI_TLS_KEY for HTTPS on untrusted networks
• The bridge-generated password (not your Proton password) is used by email clients
• Credentials are stored in an encrypted GPG/pass keychain inside the container volume

⁠License

GPL-3.0 -- see LICENSE⁠