protonmail-bridge-nextcoud-.../README.md
2020-11-02 13:08:04 +07:00

2.6 KiB

ProtonMail IMAP/SMTP Bridge Docker Container

version badge image size badge docker pulls badge build badge

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

Docker Hub: https://hub.docker.com/r/shenxn/protonmail-bridge

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

ARM Support

We now support ARM devices (arm64 and arm/v7)! Use the images tagged with build. See next section for details.

Tags

tag description
latest latest image based on .deb release
[version] images based on .deb release
build latest image built from source
[version]-build images built from source
dev, [version]-dev, [version]-build-dev images built from dev branch (not recommend)

Initialization

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

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

Wait for the bridge to startup, use 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, #6 can be helpful.

Compatability

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.