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

93 lines
3.0 KiB
Markdown
Raw Normal View History

2020-04-15 03:52:57 +00:00
# ProtonMail IMAP/SMTP Bridge Docker Container
2026-03-11 16:47:39 +00:00
> Fork of [shenxn/protonmail-bridge-docker](https://github.com/shenxn/protonmail-bridge-docker) with build fixes, updated dependencies, and GHCR publishing.
![build badge](https://github.com/trent-maetzold/protonmail-bridge-docker/workflows/build%20from%20source/badge.svg)
2020-04-15 04:12:55 +00:00
This is an unofficial Docker container of the [ProtonMail Bridge](https://protonmail.com/bridge/).
2020-04-15 03:52:57 +00:00
2026-03-11 16:47:39 +00:00
GHCR: `ghcr.io/trent-maetzold/protonmail-bridge`
## Changes from upstream
2020-05-18 09:46:49 +00:00
2026-03-11 16:47:39 +00:00
- Fixed build for proton-bridge v3.22+ (added `libfido2` dependency)
- Switched base image from `debian:sid` to `debian:trixie` (stable)
2026-03-11 16:47:39 +00:00
- Removed DockerHub publishing (GHCR only)
- Removed Gitee mirror workflow
- Merged version check into build workflow with scheduled auto-update
2026-03-11 16:47:39 +00:00
- Updated all GitHub Actions to current versions
- Replaced deprecated Anchore scan with Trivy
- Default docker-compose binds to localhost only (security)
- Updated maintainer labels and security policy
2020-05-18 09:46:49 +00:00
2020-06-01 16:14:29 +00:00
## ARM Support
2026-03-11 16:47:39 +00:00
ARM devices (`arm64` and `arm/v7`) are supported. Use the images tagged with `build`.
2020-06-01 16:14:29 +00:00
## Tags
2026-03-11 16:47:39 +00:00
There are two types of images:
- `deb`: Images based on the official [.deb release](https://protonmail.com/bridge/install). `amd64` only.
- `build`: Images compiled from [source code](https://github.com/ProtonMail/proton-bridge). Supports `amd64`, `arm64`, `arm/v7`, and `riscv64`.
2020-11-20 04:40:52 +00:00
2026-03-11 16:47:39 +00:00
| tag | description |
| -- | -- |
| `latest` | latest `build` image |
2026-03-11 16:47:39 +00:00
| `build` | latest `build` image |
| `[version]-build` | `build` images |
2020-06-01 16:14:29 +00:00
2020-04-15 03:52:57 +00:00
## Initialization
2026-03-11 16:47:39 +00:00
To initialize and add an account to the bridge:
2020-04-15 03:52:57 +00:00
```
2026-03-11 16:47:39 +00:00
docker run --rm -it -v protonmail:/root ghcr.io/trent-maetzold/protonmail-bridge:build init
2020-04-15 03:52:57 +00:00
```
2026-03-11 16:47:39 +00:00
Or with Docker Compose:
```
docker compose run protonmail-bridge init
```
2026-03-11 16:47:39 +00:00
Wait for the bridge to start, use `login` to add your account, `info` to see credentials, then `exit`. You may need `CTRL+C` to fully exit.
2020-04-15 03:52:57 +00:00
## Run
```
2026-03-11 16:47:39 +00:00
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 ghcr.io/trent-maetzold/protonmail-bridge:build
2020-04-15 03:52:57 +00:00
```
2026-03-11 16:47:39 +00:00
Or with Docker Compose:
```
docker compose up -d
```
2021-01-11 14:09:01 +00:00
## Security
2026-03-11 16:47:39 +00:00
The default configuration binds ports to localhost only. If you need network access, update the port bindings — but use a firewall on untrusted networks.
2020-11-20 00:19:03 +00:00
## Bridge CLI Guide
2026-03-11 16:47:39 +00:00
The initialization step exposes the bridge CLI for configuration (combined/split mode, proxy, etc.). See the [official guide](https://protonmail.com/support/knowledge-base/bridge-cli-guide/).
2020-11-20 04:40:52 +00:00
## Build
2026-03-11 16:47:39 +00:00
To build locally:
2020-11-20 04:40:52 +00:00
```
2026-03-11 16:47:39 +00:00
cd build
docker build --build-arg version=v3.22.0 .
2020-11-20 04:40:52 +00:00
```
## Acknowledgments
This project is a fork of [shenxn/protonmail-bridge-docker](https://github.com/shenxn/protonmail-bridge-docker) by [Xiaonan Shen](https://github.com/shenxn), which provided the original Dockerfiles, entrypoint scripts, and CI pipeline. Some scripts are based on [Hendrik Meyer's work](https://gitlab.com/T4cC0re/protonmail-bridge-docker).
## License
[GPLv3](LICENSE)