b1da228c36 | ||
---|---|---|
src | ||
store | ||
.editorconfig | ||
.gitignore | ||
CONTRIBUTING.md | ||
LICENSE.txt | ||
README.md | ||
SECURITY.md | ||
bitwarden-browser.sln | ||
crowdin.yml | ||
gulpfile.js | ||
package.json | ||
tsconfig.json | ||
tslint.json | ||
webfonts.list | ||
webpack.common.js | ||
webpack.dev.js | ||
webpack.prod.js |
README.md
bitwarden Browser Extension
The bitwarden browser extension is written using the Chrome Web Extension API and AngularJS.
Build/Run
Requirements
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:
- Type
chrome://extensions
in your address bar to bring up the extensions page. - Enable developer mode (checkbox)
- Click the "Load unpacked extension" button, navigate to the
dist
folder of your local extension instance, and click "Ok".
- Type
- Firefox
- Type
about:debugging
in your address bar to bring up the add-ons page. - Click the
Load Temporary Add-on
button, navigate to thedist/manifest.json
file, and "Open".
- Type
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.