bitwarden-estensione-browser/README.md

52 lines
3.2 KiB
Markdown
Raw Normal View History

2017-03-21 23:05:18 +01:00
[![appveyor build](https://ci.appveyor.com/api/projects/status/github/bitwarden/browser?branch=master&svg=true)](https://ci.appveyor.com/project/bitwarden/browser)
2017-05-20 23:23:46 +02:00
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-browser/localized.svg)](https://crowdin.com/project/bitwarden-browser)
2016-10-14 04:03:11 +02:00
[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)
2016-09-11 06:22:18 +02:00
# bitwarden Browser Extension
2017-03-30 02:35:26 +02:00
<a href="https://chrome.google.com/webstore/detail/bitwarden-free-password-m/nngceckbapebfimnlniiiahkandclblb" target="_blank"><img src="https://imgur.com/3C4iKO0.png" width="64" height="64"></a>
<a href="https://addons.mozilla.org/firefox/addon/bitwarden-password-manager/" target="_blank"><img src="http://imgur.com/JXP9jir.png" width="64" height="64"></a>
2017-10-03 21:44:07 +02:00
<a href="https://www.microsoft.com/store/p/bitwarden-free-password-manager/9p6kxl0svnnl" target="_blank"><img src="https://imgur.com/RlmwPGO.png" width="64" height="64"></a>
2017-03-30 02:35:26 +02:00
<a href="https://addons.opera.com/extensions/details/bitwarden-free-password-manager/" target="_blank"><img src="http://imgur.com/nSJ9htU.png" width="64" height="64"></a>
<a href="https://chrome.google.com/webstore/detail/bitwarden-free-password-m/nngceckbapebfimnlniiiahkandclblb" target="_blank"><img src="https://imgur.com/j8qsZ5q.png" width="64" height="64"></a>
<a href="https://brave.com/" target="_blank"><img src="https://imgur.com/bWzsEN8.png" width="64" height="64"></a>
2017-04-01 05:51:34 +02:00
<a href="https://addons.mozilla.org/firefox/addon/bitwarden-password-manager/" target="_blank"><img src="https://imgur.com/uhb8M86.png" width="64" height="64"></a>
2016-09-11 06:22:18 +02:00
2016-10-10 04:50:58 +02:00
The bitwarden browser extension is written using the Chrome Web Extension API and AngularJS.
2016-09-11 06:22:18 +02:00
2016-11-10 03:24:38 +01:00
![Alt text](http://imgur.com/C9p87nk.png "My Vault")
2016-12-24 06:13:36 +01:00
# Build/Run
**Requirements**
2016-12-29 05:53:58 +01:00
- [Node.js](https://nodejs.org/en/)
- [Gulp](http://gulpjs.com/) (`npm install --global gulp-cli`)
2016-12-24 06:13:36 +01:00
- Chrome (preferred), Opera, or Firefox browser
2016-12-29 05:53:58 +01:00
By default the extension is targeting the production API. If you are running the [Core](https://github.com/bitwarden/core) API locally,
you'll need to switch the extension to target your local API. Open `src/services/apiService.js` and set `this.baseUrl` to your local
API instance (ex. `http://localhost:4000`).
2016-12-24 06:13:36 +01:00
Then run the following commands:
2017-01-04 06:17:49 +01:00
- `npm install`
2016-12-24 06:13:36 +01:00
- `gulp build`
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 `src` 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 `src/manifest.json` file, and "Open".
2016-09-11 06:22:18 +02:00
# 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`](CONTRIBUTING.md) file.
2016-09-11 06:22:18 +02:00
2017-05-19 19:27:57 +02:00
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`](SECURITY.md) file.