protonmail-bridge-nextcoud-.../README.md
2020-05-31 22:03:22 -07:00

2.2 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

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

Compatability

The bridge currently only supports some of the email clients and can only run on amd64 architecture. 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.

TODO

Since the protonmail bridge is now open source, there is more thing we can do here.

  • Build an ARM version so that it can run on things like Raspberry Pi.
  • Remove GUI dependencies to reduce the docker image size.