You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Pavel Škoda 30425d5fcd Fix few typos 6 years ago
.github/ISSUE_TEMPLATE Update issue templates 6 years ago
ci mirror master and tags 6 years ago
cmd/Desktop-Bridge chore: bump linter 6 years ago
doc We build too many walls and not enough bridges 6 years ago
icon.iconset We build too many walls and not enough bridges 6 years ago
internal Simplify references parsing 6 years ago
pkg Fix few typos 6 years ago
release-notes Bump version 1.2.7 and release notes 6 years ago
test Fix few typos 6 years ago
utils Merge commit comments 6 years ago
.gitattributes We build too many walls and not enough bridges 6 years ago
.gitignore Add build-files into .gitignore 6 years ago
.gitlab-ci.yml Merge commit comments 6 years ago
.gitmodules We build too many walls and not enough bridges 6 years ago
.golangci.yml We build too many walls and not enough bridges 6 years ago
BUILDS.md Update BUILDS.md to list libsecret dev files 6 years ago
CONTRIBUTING.md We build too many walls and not enough bridges 6 years ago
COPYING.md fix 404 errors by using absolute urls 6 years ago
Changelog.md Fix few typos 6 years ago
LICENSE We build too many walls and not enough bridges 6 years ago
Makefile chore: bump linter 6 years ago
README.md fix: variable name in readme 6 years ago
go.mod test: add test with changing address order 6 years ago
go.sum test: add test with changing address order 6 years ago

README.md

ProtonMail Bridge

Copyright (c) 2020 Proton Technologies AG

This repository holds the ProtonMail Bridge application. For a detailed build information see BUILDS. For licensing information see COPYING. For contribution policy see CONTRIBUTING.

Description

ProtonMail Bridge for e-mail clients.

When launched, Bridge will initialize local IMAP/SMTP servers and render its GUI.

To configure an e-mail client, firstly log in using your ProtonMail credentials. Open your e-mail client and add a new account using the settings which are located in the Bridge GUI. The client will only be able to sync with your ProtonMail account when the Bridge is running, thus the option to start Bridge on startup is enabled by default.

When the main window is closed, Bridge will continue to run in the background.

More details on the public website.

Keychain

You need to have a keychain in order to run the ProtonMail Bridge. On Mac or Windows, Bridge uses native credential managers. On Linux, use Gnome keyring or pass.

Environment Variables

Bridge application

  • BRIDGESTRICTMODE: tells bridge to turn on bbolt's "strict mode" which checks the database after every Commit. Set to 1 to enable.

Dev build or run

  • BRIDGE_VERSION: set the bridge app version used during testing or building
  • PROTONMAIL_ENV: when set to dev it is not using Sentry to report crashes
  • VERBOSITY: set log level used during test time and by the makefile

Integration testing

  • TEST_ENV: set which env to use (fake or live)
  • TEST_ACCOUNTS: set JSON file with configured accounts
  • TAGS: set build tags for tests
  • FEATURES: set feature dir, file or scenario to test