bitwarden-browser/README.md

Repository Reorganization in Progress

We are currently migrating some projects over to a mono repository. For existing PR's we will be providing documentation on how to move/migrate them. To minimize the overhead we are actively reviewing open PRs. If possible please ensure any pending comments are resolved as soon as possible.

New pull requests created during this transition period may not get addressed —if needed, please create a new PR after the reorganization is complete.

Bitwarden Browser Extension

The Bitwarden browser extension is written using the Web Extension API and Angular.

Build/Run

Requirements

• Node.js v16.13.1 or greater
• NPM v8
• Gulp (npm install --global gulp-cli)
• Chrome (preferred), Opera, or Firefox browser

Run the app

npm install
npm run build:watch

You can now load the extension into your browser through the browser's extension tools page:

• Chrome/Opera:
  1. Type chrome://extensions in your address bar to bring up the extensions page.
  2. Enable developer mode (toggle switch)
  3. Click the "Load unpacked extension" button, navigate to the build folder of your local extension instance, and click "Ok".
• Firefox
  1. Type about:debugging in your address bar to bring up the add-ons page.
  2. Click the Load Temporary Add-on button, navigate to the build/manifest.json file, and "Open".

Desktop communication

Native Messaging (communication between the desktop application and browser extension) works by having the browser start a lightweight proxy baked into our desktop application.

Out of the box, the desktop application can only communicate with the production browser extension. When you enable browser integration in the desktop application, the application generates manifests which contain the production IDs of the browser extensions. To enable communication between the desktop application and development versions of browser extensions, add the development IDs to the allowed_extensions section of the corresponding manifests.

Manifests are located in the browser subdirectory of the Bitwarden configuration directory. For instance, on Windows the manifests are located at C:\Users\<user>\AppData\Roaming\Bitwarden\browsers and on macOS these are in Application Support for various browsers (for example). Note that disabling the desktop integration will delete the manifests, and the files will need to be updated again.

We're Hiring!

Interested in contributing in a big way? Consider joining our team! We're hiring for many positions. Please take a look at our Careers page to see what opportunities are currently open as well as what it's like to work at Bitwarden.

Contribute

Code contributions are welcome! Please commit any pull requests against the master branch. Learn more about how to contribute by reading the CONTRIBUTING.md file.

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the SECURITY.md file.

Prettier

We recently migrated to using Prettier as code formatter. All previous branches will need to updated to avoid large merge conflicts using the following steps:

1. Check out your local Branch
2. Run git merge cebee8aa81b87cc26157e5bd0f879db254db9319
3. Resolve any merge conflicts, commit.
4. Run npm run prettier
5. Commit
6. Run git merge -Xours 8fe821b9a3f9728bcb02d607ca75add468d380c1
7. Push

Git blame

We also recommend that you configure git to ignore the prettier revision using:

git config blame.ignoreRevsFile .git-blame-ignore-revs