bitwarden-estensione-browser/README.md

86 lines
2.9 KiB
Markdown
Raw Normal View History

2018-07-26 16:02:04 +02:00
<p align="center">
2018-07-26 16:02:24 +02:00
<img src="https://raw.githubusercontent.com/bitwarden/brand/master/screenshots/web-vault-macbook.png" alt="" width="600" height="358" />
2018-07-26 16:02:04 +02:00
</p>
2018-07-26 15:54:36 +02:00
<p align="center">
2018-07-26 16:02:24 +02:00
The Bitwarden web project is an Angular application that powers the web vault (https://vault.bitwarden.com/).
2018-07-26 15:54:36 +02:00
</p>
<p align="center">
<a href="https://ci.appveyor.com/project/bitwarden/web/branch/master" target="_blank">
<img src="https://ci.appveyor.com/api/projects/status/github/bitwarden/web?branch=master&svg=true" alt="appveyor build" />
</a>
<a href="https://crowdin.com/project/bitwarden-web" target="_blank">
<img src="https://d322cqt584bo4o.cloudfront.net/bitwarden-web/localized.svg" alt="Crowdin" />
</a>
<a href="https://hub.docker.com/u/bitwarden/" target="_blank">
<img src="https://img.shields.io/docker/pulls/bitwarden/web.svg" alt="DockerHub" />
</a>
<a href="https://gitter.im/bitwarden/Lobby" target="_blank">
<img src="https://badges.gitter.im/bitwarden/Lobby.svg" alt="gitter chat" />
</a>
</p>
2016-10-14 04:02:46 +02:00
2018-07-26 16:02:04 +02:00
## Build/Run
2018-07-26 16:02:04 +02:00
### Requirements
2018-07-09 22:38:21 +02:00
- [Node.js](https://nodejs.org) v8.11 or greater
2018-07-26 16:02:04 +02:00
### Run the app
2017-07-14 14:32:30 +02:00
For local development, run the app with:
2018-07-09 22:38:21 +02:00
```
npm install
npm run build:watch
```
2018-07-09 23:01:15 +02:00
You can now access the web vault in your browser at `https://localhost:8080`. You can adjust your API endpoint settings in `src/app/services/services.module.ts` by altering the `apiService.setUrls` call. For example:
2018-07-09 23:02:03 +02:00
```typescript
2018-07-09 23:01:15 +02:00
await apiService.setUrls({
base: isDev ? null : window.location.origin,
api: isDev ? 'http://mylocalapi' : null,
identity: isDev ? 'http://mylocalidentity' : null,
events: isDev ? 'http://mylocalevents' : null,
2018-07-09 23:01:15 +02:00
});
```
2018-07-26 15:25:43 +02:00
If you want to point the development web vault to the production APIs, you can set:
2018-07-09 23:01:15 +02:00
2018-07-26 15:25:43 +02:00
```typescript
await apiService.setUrls({
base: null,
api: 'https://api.bitwarden.com',
identity: 'https://identity.bitwarden.com',
events: 'https://events.bitwarden.com',
2018-07-26 15:25:43 +02:00
});
2018-07-09 23:01:15 +02:00
```
2018-07-26 15:25:43 +02:00
And note to run the app with:
```
npm install
npm run build:prod:watch
```
## Common Issues:
### CORS
If you run the frontend and receive a notification after attempting to login that says:
```
An error has occurred.
NetworkError when attempting to fetch resource.
```
And in the console:
```
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://api.bitwarden.com/accounts/prelogin. (Reason: CORS header Access-Control-Allow-Origin missing).
```
This means that you are having a CORS header issue. This can be mitigated by using a CORS header changing extension in your browser such as [this one.](https://mybrowseraddon.com/access-control-allow-origin.html)
2018-07-26 16:02:04 +02:00
## Contribute
2016-10-02 05:32:12 +02:00
Code contributions are welcome! Please commit any pull requests against the `master` branch.
2017-05-19 19:27:22 +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.