ProtonMail
/
proton-bridge
mirror of https://github.com/ProtonMail/proton-bridge
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
13 Commits 6 Branches 129 Tags 19 MiB
Go 50.8%
C++ 18.7%
Gherkin 17.7%
QML 9.1%
Shell 1.1%
Other 2.6%
Go to file
cuthix 61c6867a15 Update issue templates 
General issue template
 		2020-04-29 07:50:30 +02:00
.github/ISSUE_TEMPLATE Update issue templates 2020-04-29 07:50:30 +02:00
ci mirror master and tags 2020-04-08 18:26:06 +02:00
cmd/Desktop-Bridge We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
doc We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
icon.iconset We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
internal IMAP extension Unselect 2020-04-15 07:01:28 +00:00
pkg We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
release-notes We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
test We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
utils We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
.gitattributes We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
.gitignore We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
.gitlab-ci.yml mirror master and tags 2020-04-08 18:26:06 +02:00
.gitmodules We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
.golangci.yml We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
BUILDS.md Update README.md 2020-04-15 17:14:18 +00:00
CONTRIBUTING.md We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
COPYING.md We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
Changelog.md IMAP extension Unselect 2020-04-15 07:01:28 +00:00
LICENSE We build too many walls and not enough bridges 2020-04-08 12:59:16 +02:00
Makefile Fix build on MacOS 2020-04-14 13:44:56 +00:00
README.md Update README.md 2020-04-15 17:14:18 +00:00
go.mod IMAP extension Unselect 2020-04-15 07:01:28 +00:00
go.sum IMAP extension Unselect 2020-04-15 07:01:28 +00:00

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

  • 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