From 0aa5c67bbc20c398db28efa8c2d1c942d54529ac Mon Sep 17 00:00:00 2001 From: Xiaonan Shen Date: Mon, 1 Jun 2020 09:14:29 -0700 Subject: [PATCH] Update README --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f0d1bc8..e4ebb04 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # ProtonMail IMAP/SMTP Bridge Docker Container ![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) ![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) +## 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 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. - ## Run 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 ``` - ## 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](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.