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

Update README

Browse Source
This commit is contained in:
Xiaonan Shen 2020-06-01 09:14:29 -07:00
parent 72c40c7a05
commit 0aa5c67bbc
No known key found for this signature in database
GPG Key ID: 211BF560D12417F5
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,7 +1,7 @@
# ProtonMail IMAP/SMTP Bridge Docker Container # ProtonMail IMAP/SMTP Bridge Docker Container
![version badge](https://img.shields.io/docker/v/shenxn/protonmail-bridge) ![version badge](https://img.shields.io/docker/v/shenxn/protonmail-bridge)
![image size badge](https://img.shields.io/docker/image-size/shenxn/protonmail-bridge/latest) ![image size badge](https://img.shields.io/docker/image-size/shenxn/protonmail-bridge/build)
![docker pulls badge](https://img.shields.io/docker/pulls/shenxn/protonmail-bridge) ![docker pulls badge](https://img.shields.io/docker/pulls/shenxn/protonmail-bridge)
![build badge](https://github.com/shenxn/protonmail-bridge-docker/workflows/.github/workflows/main.yaml/badge.svg) ![build badge](https://github.com/shenxn/protonmail-bridge-docker/workflows/.github/workflows/main.yaml/badge.svg)
@ -11,6 +11,20 @@ Docker Hub: [https://hub.docker.com/r/shenxn/protonmail-bridge](https://hub.dock
GitHub: [https://github.com/shenxn/protonmail-bridge-docker](https://github.com/shenxn/protonmail-bridge-docker) GitHub: [https://github.com/shenxn/protonmail-bridge-docker](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](https://protonmail.com/bridge/install)
`[version]` | images based on .deb release
`build` | latest image built from [source](https://github.com/ProtonMail/proton-bridge)
`[version]-build` | images built from source
`dev`, `[version]-dev`, `[version]-build-dev` | images built from dev branch (not recommend)
## Initialization ## Initialization
To initialize and add account to the bridge, run the following command. To initialize and add account to the bridge, run the following command.
@ -21,7 +35,6 @@ 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. 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 ## Run
To run the container, use the following command. To run the container, use the following command.
@ -30,15 +43,6 @@ 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 docker run -d --name=protonmail-bridge -v protonmail:/root -p 1025:25/tcp -p 1143:143/tcp --restart=unless-stopped shenxn/protonmail-bridge
``` ```
## Compatability ## 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. 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](https://protonmail.com/blog/bridge-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.