| .github | ||
| .husky | ||
| jslib@3ec0f6977a | ||
| src | ||
| store | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .git-blame-ignore-revs | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .prettierignore | ||
| .prettierrc.json | ||
| CONTRIBUTING.md | ||
| crowdin.yml | ||
| gulpfile.js | ||
| karma.conf.js | ||
| LICENSE.txt | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| SECURITY.md | ||
| tsconfig.json | ||
| webpack.config.js | ||
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:
- Type
chrome://extensionsin your address bar to bring up the extensions page. - Enable developer mode (toggle switch)
- Click the "Load unpacked extension" button, navigate to the
buildfolder of your local extension instance, and click "Ok".
- Type
- Firefox
- Type
about:debuggingin your address bar to bring up the add-ons page. - Click the
Load Temporary Add-onbutton, navigate to thebuild/manifest.jsonfile, and "Open".
- Type
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:
- Check out your local Branch
- Run
git merge cebee8aa81b87cc26157e5bd0f879db254db9319 - Resolve any merge conflicts, commit.
- Run
npm run prettier - Commit
- Run
git merge -Xours 8fe821b9a3f9728bcb02d607ca75add468d380c1 - Push
Git blame
We also recommend that you configure git to ignore the prettier revision using:
git config blame.ignoreRevsFile .git-blame-ignore-revs