Mouws/protonmail-bridge-nextcoud-podman
1
0
Fork 1
mirror of https://github.com/shenxn/protonmail-bridge-docker.git synced 2025-12-06 08:27:08 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
ProtonMail IMAP/SMTP Bridge Docker container
261 Commits 1 Branch 0 Tags 400 KiB
Shell 47.3%
Dockerfile 34.9%
Python 17.8%
7ef9657e54
Go to file
Simon Ungar Felding 7ef9657e54 fix missing if statement closing
2025-06-12 16:57:11 +02:00
.github Merge branch 'shenxn:master' into support-rootless 2025-04-25 00:21:13 +02:00
build fix missing if statement closing 2025-06-12 16:57:11 +02:00
deb Merge branch 'master' into support-rootless 2025-04-24 23:49:32 +02:00
.gitignore Add riscv64 support to docker builds 2022-11-20 23:32:58 +08:00
docker-compose.yml Improve Docker Compose documentation and example (#95) 2024-02-08 11:06:43 +08:00
LICENSE Update LICENSE 2020-04-23 17:23:13 -07:00
README.md simplified some stuff. it should work now! 2025-06-12 16:49:33 +02:00
SECURITY.md Create SECURITY.md 2020-11-19 23:38:33 -08:00
update-check.py improve build readability and speed (by parallelization) (#117) 2025-04-24 23:03:50 +02:00
VERSION improve build readability and speed (by parallelization) (#117) 2025-04-24 23:03:50 +02:00

README.md

ProtonMail IMAP/SMTP Bridge Docker Container

version badge image size badge docker pulls badge deb 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

There are two types of images.

  • deb: Images based on the official .deb release. It only supports the amd64 architecture.
  • build: Images based on the source code. It supports amd64, arm64, arm/v7 and riscv64. Supporting to more architectures is possible. PRs are welcome.
tag description
latest latest deb image
[version] deb images
build latest build image
[version]-build build images

Starting the container

To initialize and add account to the bridge, run the following steps:

  1. Start the container with a named volume (protonmail) for persistent storage.
docker run -it -v protonmail:/root shenxn/protonmail-bridge

Setting up the bridge

If you have not set up an account, you need to do the folliwing steps in the protonmail-bridge CLI interface:

  1. Use the add command to add your ProtonMail account. You will be prompted to enter your ProtonMail username and password.
  2. After adding your account, use the info command to see the configuration information (username and password).

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. You can also use the following command to publish the port to only localhost, which is the same behavior as the official bridge package.

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

Besides, you can publish only port 25 (SMTP) if you don't need to receive any email (e.g. as a email notification service).

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.