ProtonMail IMAP/SMTP Bridge Podman Container

This is an unofficial Docker container of the ProtonMail Bridge. Some of the scripts are based on Hendrik Meyer's work.

This nothing more than some small adjustments to the work shenxn did to make it easy to run with podman and adjusted for nextcloud mail. GitHub: https://github.com/shenxn/protonmail-bridge-docker

tag	description
latest	latest deb image
[version]	deb images
build	latest build image
[version]-build	build images

Initialization

To initialize and add account to the bridge, run the following command.

podman run --rm -it -v protonmail:/root shenxn/protonmail-bridge init

Wait for the bridge to startup, then you will see a prompt appear for Proton Mail Bridge interactive shell. Use the login command and follow the instructions to add your account into the bridge. Then use info to see the configuration information (username and password). After that, use exit to exit the bridge. You may need CTRL+C to exit the docker entirely.

Run

To run the container, use the following command.

docker run -d --name=protonmail-bridge -v protonmail:/root -p 1025:25/tcp -p 1143:143/tcp --restart=unless-stopped shenxn/protonmail-bridge

Kubernetes

If you want to run this image in a Kubernetes environment. You can use the Helm chart (https://github.com/k8s-at-home/charts/tree/master/charts/stable/protonmail-bridge) created by @Eagleman7. More details can be found in #23.

If you don't want to use Helm, you can also reference to the guide (#6) written by @ghudgins.

Security

Please be aware that running the command above will expose your bridge to the network. Remember to use firewall if you are going to run this in an untrusted network or on a machine that has public IP address.

Compatibility

The bridge currently only supports some of the email clients. More details can be found on the official website. I've tested this on a Synology DiskStation and it runs well. However, you may need ssh onto it to run the interactive docker command to add your account. The main reason of using this instead of environment variables is that it seems to be the best way to support two-factor authentication.

Bridge CLI Guide

The initialization step exposes the bridge CLI so you can do things like switch between combined and split mode, change proxy, etc. The official guide gives more information on to use the CLI.

Build

For anyone who want to build this container on your own (for development or security concerns), here is the guide to do so. First, you need to cd into the directory (deb or build, depending on which type of image you want). Then just run the docker build command

docker build .

That's it. The Dockerfile and bash scripts handle all the downloading, building, and packing. You can also add tags, push to your favorite docker registry, or use buildx to build multi architecture images.