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.
52 lines
1.8 KiB
52 lines
1.8 KiB
# ProtonMail Bridge |
|
Copyright (c) 2020 Proton Technologies AG |
|
|
|
This repository holds the ProtonMail Bridge application. |
|
For a detailed build information see [BUILDS](./BUILDS.md). |
|
For licensing information see [COPYING](./COPYING.md). |
|
For contribution policy see [CONTRIBUTING](./CONTRIBUTING.md). |
|
|
|
## 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](https://protonmail.com/bridge). |
|
|
|
|
|
## 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](https://wiki.gnome.org/Projects/GnomeKeyring/) |
|
or |
|
[pass](https://www.passwordstore.org/). |
|
|
|
## 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 |
|
|
|
|
|
|
|
|
|
|