1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-06 09:20:43 +01:00
bitwarden-browser/README.md
Matt Gibson 66bd8be2c9
Set urls from config file (#1151)
* 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
2021-08-25 13:15:31 -05:00

2.6 KiB

The Bitwarden web project is an Angular application that powers the web vault (https://vault.bitwarden.com/).

Github Workflow build on master Crowdin DockerHub gitter chat

Build/Run

Requirements

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:

{
    "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. 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 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.