{"id":15034649,"url":"https://github.com/protonmail/proton-bridge","last_synced_at":"2025-05-14T01:11:55.459Z","repository":{"id":37844619,"uuid":"253829924","full_name":"ProtonMail/proton-bridge","owner":"ProtonMail","description":"Proton Mail Bridge application","archived":false,"fork":false,"pushed_at":"2025-05-06T14:51:35.000Z","size":17535,"stargazers_count":1262,"open_issues_count":104,"forks_count":174,"subscribers_count":51,"default_branch":"master","last_synced_at":"2025-05-06T15:56:56.909Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ProtonMail.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING_NOTES.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".gitlab/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-07T15:09:57.000Z","updated_at":"2025-05-06T14:51:39.000Z","dependencies_parsed_at":"2023-02-10T10:15:17.570Z","dependency_job_id":"d1d7815b-384d-4d9c-8f92-878fc652b966","html_url":"https://github.com/ProtonMail/proton-bridge","commit_stats":{"total_commits":2650,"total_committers":33,"mean_commits":80.3030303030303,"dds":0.8218867924528301,"last_synced_commit":"df78e292341043b196c2aba812fc48d2c2e8501b"},"previous_names":[],"tags_count":139,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProtonMail%2Fproton-bridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProtonMail%2Fproton-bridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProtonMail%2Fproton-bridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProtonMail%2Fproton-bridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ProtonMail","download_url":"https://codeload.github.com/ProtonMail/proton-bridge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254049537,"owners_count":22006080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T20:25:51.856Z","updated_at":"2025-05-14T01:11:50.419Z","avatar_url":"https://github.com/ProtonMail.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Proton Mail Bridge\nCopyright (c) 2025 Proton AG\n\nThis repository holds the Proton Mail Bridge application.\nFor a detailed build information see [BUILDS](./BUILDS.md).\nThe license can be found in [LICENSE](./LICENSE) file, for more licensing information see [COPYING_NOTES](./COPYING_NOTES.md).\nFor contribution policy see [CONTRIBUTING](./CONTRIBUTING.md).\n\n\n## Description Bridge\nProton Mail Bridge for e-mail clients.\n\nWhen launched, Bridge will initialize local IMAP/SMTP servers and render \nits GUI.\n\nTo configure an e-mail client, first log in using your Proton Mail credentials. \nOpen your e-mail client and add a new account using the settings which are \nlocated in the Bridge GUI. The client will only be able to sync with \nyour Proton Mail account when the Bridge is running, thus the option \nto start Bridge on startup is enabled by default.\n\nWhen the main window is closed, Bridge will continue to run in the\nbackground.\n\nMore details [on the public website](https://proton.me/mail/bridge).\n\n## Launcher\nThe launcher is a binary used to run the Proton Mail Bridge.\n\nThe Official distribution of the Proton Mail Bridge application contains\nboth a launcher and the app itself. The launcher is installed in a protected\narea of the system (i.e. an area accessible only with admin privileges) and is\nused to run the app. The launcher ensures that nobody tampered with the app's\nfiles by verifying their signature using a hardcoded public key. App files are\nplaced in regular userspace and are signed by Proton's private key. This\nfeature enables the app to securely update itself automatically without asking\nthe user for a password.\n\n## Keychain\nYou need to have a keychain in order to run Proton Mail Bridge. On Mac or\nWindows, Bridge uses native credential managers. On Linux, use `secret-service` freedesktop.org API\n(e.g. [Gnome keyring](https://wiki.gnome.org/Projects/GnomeKeyring/))\nor\n[pass](https://www.passwordstore.org/). We are working on allowing other secret\nservices (e.g. KeepassXC), but for now only gnome-keyring is usable without\nmajor problems.\n\n\n## Environment Variables\n\n### Dev build or run\n- `APP_VERSION`: set the bridge app version used during testing or building\n- `PROTONMAIL_ENV`: when set to `dev` it is not using Sentry to report crashes\n- `VERBOSITY`: set log level used during test time and by the makefile\n\n### Integration testing\n- `TEST_ENV`: set which env to use (fake or live)\n- `TEST_ACCOUNTS`: set JSON file with configured accounts\n- `TAGS`: set build tags for tests\n- `FEATURES`: set feature dir, file or scenario to test\n\n## Folders\n\nThere are now three types of system folders which Bridge recognises:\n\n|        | Windows                             | Mac                                                 | Linux                               | Linux (XDG)                           |\n|--------|-------------------------------------|-----------------------------------------------------|-------------------------------------|---------------------------------------|\n| config | %APPDATA%\\protonmail\\bridge-v3      | ~/Library/Application Support/protonmail/bridge-v3  | ~/.config/protonmail/bridge-v3      | $XDG_CONFIG_HOME/protonmail/bridge-v3 |\n| cache  | %LOCALAPPDATA%\\protonmail\\bridge-v3 | ~/Library/Caches/protonmail/bridge-v3               | ~/.cache/protonmail/bridge-v3       | $XDG_CACHE_HOME/protonmail/bridge-v3  |\n| data\t  | %APPDATA%\\protonmail\\bridge-v3      | ~/Library/Application Support/protonmail/bridge-v3  | ~/.local/share/protonmail/bridge-v3 | $XDG_DATA_HOME/protonmail/bridge-v3   |\n| temp   | %LOCALAPPDATA%\\Temp                 | $TMPDIR if non-empty, else /tmp                     | $TMPDIR if non-empty, else /tmp     | $TMPDIR if non-empty, else /tmp       |\n\n\n\n## Files\n\n|                        | Base Dir | Path                       |\n|------------------------|----------|----------------------------|\n| bridge lock file       | cache    | bridge.lock                |\n| bridge-gui lock file   | cache    | bridge-gui.lock            |\n| vault                  | config   | vault.enc                  |\n| gRPC server json       | config   | grpcServerConfig.json      |\n| gRPC client json       | config   | grpcClientConfig_\u003cid\u003e.json |\n| gRPC Focus server json | config   | grpcFocusServerConfig.json |\n| Logs                   | data     | logs                       |\n| gluon DB               | data     | gluon/backend/db           |\n| gluon messages         | data     | gluon/backend/store        |\n| Update files           | data     | updates                    |\n| sentry cache           | data     | sentry_cache               |\n| Mac/Linux File Socket  | temp     | bridge{4_DIGITS}           |\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotonmail%2Fproton-bridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprotonmail%2Fproton-bridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotonmail%2Fproton-bridge/lists"}