mirror of
https://github.com/bitwarden/browser
synced 2024-12-20 06:28:26 +01:00
66bd8be2c9
* Set environment URLs in webpack config. * Provide non NULL dev server * QA env uses the pq TLD * Include icons in qa env * Move base configs to develop. local configurations should be done in the `./config/local.json` file. * Fix config override loading to default to development * Standardize url formatting * Limit QA settings to those set in production * Set self hosted in a config * Specify cloud instead of production Self hosted and cloud are both production environments. The ENV setting is used to specify the env type while NODE_ENV specifies whether development error handling and services. * Update config instructions * Remove invalid json * Change env `production` references to `cloud` * Fix formatting
74 lines
2.6 KiB
Markdown
74 lines
2.6 KiB
Markdown
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/bitwarden/brand/master/screenshots/web-vault-macbook.png" alt="" width="600" height="358" />
|
|
</p>
|
|
<p align="center">
|
|
The Bitwarden web project is an Angular application that powers the web vault (https://vault.bitwarden.com/).
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/bitwarden/web/actions?query=branch:master" target="_blank">
|
|
<img src="https://github.com/bitwarden/web/actions/workflows/build.yml/badge.svg?branch=master" alt="Github Workflow build on master" />
|
|
</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>
|
|
|
|
## Build/Run
|
|
|
|
### Requirements
|
|
|
|
- [Node.js](https://nodejs.org) v14.17 or greater
|
|
- NPM v7
|
|
|
|
### Run the app
|
|
|
|
For local development, run the app with:
|
|
|
|
```
|
|
npm install
|
|
npm run build:watch
|
|
```
|
|
|
|
You can now access the web vault in your browser at `https://localhost:8080`.
|
|
|
|
If you want to point the development web vault to the production APIs, you can run using:
|
|
|
|
```
|
|
npm install
|
|
ENV=production npm run build:watch
|
|
```
|
|
|
|
You can also manually adjusting your API endpoint settings by adding `config/local.json` overriding any of the following values:
|
|
|
|
```json
|
|
{
|
|
"proxyApi": "http://your-api-url",
|
|
"proxyIdentity": "http://your-identity-url",
|
|
"proxyEvents": "http://your-events-url",
|
|
"proxyNotifications": "http://your-notifications-url",
|
|
"proxyPortal": "http://your-portal-url",
|
|
"allowedHosts": ["hostnames-to-allow-in-webpack"],
|
|
"urls": {
|
|
|
|
}
|
|
}
|
|
```
|
|
|
|
Where the `urls` object is defined by the [Urls type in jslib](https://github.com/bitwarden/jslib/blob/master/common/src/abstractions/environment.service.ts). To pick up the overrides in the newly created `config/local.json` file, run the app with:
|
|
|
|
```
|
|
npm run build:dev:watch
|
|
```
|
|
|
|
## 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.
|
|
|
|
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.
|