ProtonMail IMAP/SMTP Bridge Docker Container

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

Docker Hub: https://github.com/ImSingee/protonmail-bridge-docker/pkgs/container/protonmail-bridge-docker

GitHub: https://github.com/ImSingee/protonmail-bridge-docker

Tags

tag	description
master	latest dev image - do not use it in production
[version]	image for specific proton-bridge version

Note: There is no latest tag, and we don't accept PRs for adding it.

Initialization

Firstly, you need to initialize the required data before using it.

Run the following command to initialize the required data:

export VERSION=v3.21.2 # change it to the version you want to use
export DATA_DIR=./data # change it to the directory you want to store the data

docker run --rm -it -v ${DATA_DIR}:/root ghcr.io/imsingee/protonmail-bridge:${VERSION} bash

Then, you will enter the bash shell of the container.

Run the following command to initialize the bridge:

bash /protonmail/entrypoint.sh init

This will initialize some required data for the bridge and then open the interactive shell for the bridge.

Generally, you should 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.

The init command should only be run once. After that, if you want to access the bridge cli, you can use the following command:

/protonmail/proton-bridge --cli

Tip

If you have used Protonmail for a while, the sync process may be very slow (expect more than one day is possible). To avoid stopping the syncing process unintentionally, I suggest you run the init command in a tmux session.

Run

To run the container, use the following command.

# export VERSION=...
# export DATA_DIR=...

docker run -d --name=protonmail-bridge -v ${DATA_DIR}:/root -p 1025:1025 -p 1143:1143 --restart=unless-stopped ghcr.io/imsingee/protonmail-bridge:${VERSION}

The bridge will be running in a tmux session. You can use the following command to attach to the session:

docker exec -it protonmail-bridge tmux attach -t proton

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.