hydroxide
hydroxide
Docker app from anna's Repository
Overview
A third-party, open-source ProtonMail bridge.
Hydroxide supports CardDAV, IMAP, and SMTP protocols.
Key Features:
No GUI, only CLI
Standards-compliant (not optimized for Microsoft Outlook)
Fully open-source
What is Hydroxide?
Hydroxide is a server that translates standard protocols (SMTP, IMAP, CardDAV) into ProtonMail API requests. It allows you to use your favorite email clients (like Apple Mail or Thunderbird) or tools like git-send-email with ProtonMail.
Commands:
auth username Login to ProtonMail via hydroxide
carddav Run hydroxide as a CardDAV server
export-secret-keys username Export secret keys
imap Run hydroxide as an IMAP server
import-messages username [file] Import messages
export-messages [options...] username Export messages
sendmail username -- args... sendmail(1) interface
serve Run all servers
smtp Run hydroxide as an SMTP server
status View hydroxide status
Global options:
-debug
Enable debug logs
-api-endpoint url
ProtonMail API endpoint
-app-version version
ProtonMail application version
-smtp-host example.com
Allowed SMTP email hostname on which hydroxide listens, defaults to 127.0.0.1
-imap-host example.com
Allowed IMAP email hostname on which hydroxide listens, defaults to 127.0.0.1
-carddav-host example.com
Allowed SMTP email hostname on which hydroxide listens, defaults to 127.0.0.1
-smtp-port example.com
SMTP port on which hydroxide listens, defaults to 1025
-imap-port example.com
IMAP port on which hydroxide listens, defaults to 1143
-carddav-port example.com
CardDAV port on which hydroxide listens, defaults to 8080
-disable-imap
Disable IMAP for hydroxide serve
-disable-smtp
Disable SMTP for hydroxide serve
-disable-carddav
Disable CardDAV for hydroxide serve
-tls-cert /path/to/cert.pem
Path to the certificate to use for incoming connections (Optional)
-tls-key /path/to/key.pem
Path to the certificate key to use for incoming connections (Optional)
-tls-client-ca /path/to/ca.pem
If set, clients must provide a certificate signed by the given CA (Optional)
Requirements
- Authentication
Before running the container, you must authenticate with your ProtonMail account. You have two options:
Run this command:
docker run -it --rm -v /mnt/user/appdata/hydroxide:/root/.config/hydroxide docker.io/heywoodlh/hydroxide auth user
Replace user with your ProtonMail username or email address.
Alternatively, if you already have a Bridge Password, set it using the HYDROXIDE_BRIDGE_PASS environment variable.
2. Host Configuration
Ensure the listening hosts (-imap-host, -smtp-host, and -carddav-host) are correctly set to match your desired hostname in the post arguments.
If you don’t wish to use a custom network, set the network type to bridge. For this to work, port 8080 (used for CardDAV) must be available.
If port 8080 is already in use (e.g., by Nginx Proxy Manager), you can also disable CardDAV entirely by adding -disable-carddav to the post arguments.
Runtime arguments
- Network
br0- Shell
sh- Privileged
- false
Template configuration
Port 1Porttcp
The SMTP port.
- Target
- 1025
- Default
- 1025
- Value
- 1025
Port 2Porttcp
The IMAP port.
- Target
- 1143
- Default
- 1143
- Value
- 1143
Port 3Porttcp
The CalDAV port.
- Target
- 8080
- Default
- 8080
- Value
- 8080
Path 1Pathrw
- Target
- /root/.config/hydroxide
- Value
- /mnt/user/appdata/hydroxide
HYDROXIDE_BRIDGE_PASSVariable
Use this variable only if you already have an existing Bridge Password. If not, you must first run the authentication command described above.
Categories
Download Statistics
11,088
Total Downloads
Details
Repository
heywoodlh/hydroxideLast Updated2026-05-03
First Seen2025-02-11
Run Hydroxide on Unraid.
Hydroxide is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.