protonmail-bridge-nextcoud-.../README.md

57 lines
2.8 KiB
Markdown
Raw Normal View History

2020-04-15 03:52:57 +00:00
# ProtonMail IMAP/SMTP Bridge Docker Container
2020-04-15 04:12:55 +00:00
![version badge](https://img.shields.io/docker/v/shenxn/protonmail-bridge)
2020-06-01 16:14:29 +00:00
![image size badge](https://img.shields.io/docker/image-size/shenxn/protonmail-bridge/build)
2020-06-01 05:03:22 +00:00
![docker pulls badge](https://img.shields.io/docker/pulls/shenxn/protonmail-bridge)
2020-04-15 07:37:29 +00:00
![build badge](https://github.com/shenxn/protonmail-bridge-docker/workflows/.github/workflows/main.yaml/badge.svg)
2020-04-15 04:12:55 +00:00
2020-04-15 03:52:57 +00:00
This is an unofficial Docker container of the [ProtonMail Bridge](https://protonmail.com/bridge/). Some of the scripts are based on [Hendrik Meyer's work](https://gitlab.com/T4cC0re/protonmail-bridge-docker).
2020-05-18 09:46:49 +00:00
Docker Hub: [https://hub.docker.com/r/shenxn/protonmail-bridge](https://hub.docker.com/r/shenxn/protonmail-bridge)
GitHub: [https://github.com/shenxn/protonmail-bridge-docker](https://github.com/shenxn/protonmail-bridge-docker)
2020-06-01 16:14:29 +00:00
## 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)
2020-04-15 03:52:57 +00:00
## 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
```
2020-11-02 06:08:04 +00:00
## Kubernetes
If you want to run this image in a Kubernetes environment, [#6](https://github.com/shenxn/protonmail-bridge-docker/issues/6) can be helpful.
2020-11-20 00:19:03 +00:00
## Compatibility
2020-04-15 03:52:57 +00:00
2020-11-02 06:08:04 +00:00
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.
2020-11-20 00:19:03 +00:00
## 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](https://protonmail.com/support/knowledge-base/bridge-cli-guide/) gives more information on to use the CLI.