Upstream/bitwarden-browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-03 08:49:50 +01:00
Code Issues Projects Releases Wiki Activity
bd005ffeef
bitwarden-browser/README.md
Nihal Raj fed98c481e
Update README.md
2021-09-16 08:57:34 +05:30

4.4 KiB
Raw Blame History

Github Workflow build on master Crowdin Join the chat at https://gitter.im/bitwarden/Lobby

Bitwarden Browser Extension

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

Build/Run

Requirements

  • Node.js v14.17 or greater
  • NPM v7
  • 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.

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.