Upstream/bitwarden-browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser.git synced 2024-12-20 16:07:45 +01:00
Code Issues Projects Releases Wiki Activity
fed4793b1d
bitwarden-browser/README.md

3.5 KiB
Raw Blame History

appveyor build Crowdin Join the chat at https://gitter.im/bitwarden/Lobby

bitwarden Browser Extension

The bitwarden browser extension is written using the Chrome Web Extension API and AngularJS.

Alt text

Build/Run

Requirements

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

By default the extension is targeting the production API. If you are running the Core API locally, you'll need to switch the extension to target your local instance. Open src/services/apiService.js and set self.baseUrl and self.identityBaseUrl to your local API instance (ex. http://localhost:5000).

Then run the following commands:

npm install
npm run dev: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 (checkbox)
    3. Click the "Load unpacked extension" button, navigate to the dist 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 dist/manifest.json file, and "Open".

Release

To build the the extension for production the following commands should be run:

npm run prod
gulp dist:[browser]

Where [browser] is the web browser to target. Currently the following web browsers are supported: chrome, edge, firefox and opera.

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.