Skip to content

docs(proton-bridge): correct default mode to grpc #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mgarratt merged 1 commit into from
Jun 26, 2026
Merged

docs(proton-bridge): correct default mode to grpc #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions images/proton-bridge/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,12 @@ Then in the Bridge CLI prompt:

Use the generated Bridge credentials in your mail client, not your Proton account password.

After login is complete, restart the container with `BRIDGE_MODE=noninteractive` for normal long-running use.
After login is complete, restart the container in the default `grpc` mode for normal long-running use (or `BRIDGE_MODE=noninteractive` if you don't need the metrics exporter).

## Behavior Notes

- `bridge` clean exit (`code=0`) stops container by default. Set `BRIDGE_EXIT_ZERO_STOPS_CONTAINER=false` to allow restart instead.
- `bridge` runs in non-interactive mode by default to avoid EOF-driven exits. Set `BRIDGE_MODE=cli` only for interactive debugging.
- `bridge` runs in `grpc` mode by default (serves mail plus the gRPC API the metrics exporter scrapes). Use `BRIDGE_MODE=noninteractive` for a leaner run without metrics, or `BRIDGE_MODE=cli` only for interactive debugging.
- `gpg-agent` service handles Alpine stale socket/lock cleanup before launch and during service finish.
- Bridge may log DBus keychain warnings in headless environments without `dbus-launch`; this is expected when not using a desktop keyring.
- The bootstrap GPG key is generated with `%no-protection` and no passphrase. Protect mounted `/home/bridge` volumes and backups accordingly.
Expand Down
Loading