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.
 
 
Michal Horejsek 4806fa0808 Fix build on MacOS 6 years ago
ci mirror master and tags 6 years ago
cmd/Desktop-Bridge We build too many walls and not enough bridges 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 Optimalization of initAddress 6 years ago
pkg We build too many walls and not enough bridges 6 years ago
release-notes We build too many walls and not enough bridges 6 years ago
test We build too many walls and not enough bridges 6 years ago
utils We build too many walls and not enough bridges 6 years ago
.gitattributes We build too many walls and not enough bridges 6 years ago
.gitignore We build too many walls and not enough bridges 6 years ago
.gitlab-ci.yml mirror master and tags 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 We build too many walls and not enough bridges 6 years ago
CONTRIBUTING.md We build too many walls and not enough bridges 6 years ago
COPYING.md We build too many walls and not enough bridges 6 years ago
Changelog.md Apply suggestion to Changelog.md 6 years ago
LICENSE We build too many walls and not enough bridges 6 years ago
Makefile Fix build on MacOS 6 years ago
README.md Update README.md 6 years ago
go.mod We build too many walls and not enough bridges 6 years ago
go.sum Optimalization of RebuildMailboxes 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 Desktop Bridge for e-mail clients.

When launched, the servers will be started and a GUI will show up. From this GUI, the server can be started and stopped and configuration for e-mail clients can be generated.

To configure an e-mail client, enter your ProtonMail credentials. Open your e-mail client and add a new account with the settings which are displayed. The client will be able to sync with your ProtonMail account only when the bridge is started, so enabling it on startup is recommended.

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

More details on the public website.

Keychain

You need to have 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

  • 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.
  • VERSION: set the bridge app version used during testing or building.

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