bitwarden-desktop/README.md

[![Github Workflow build on master](https://github.com/bitwarden/desktop/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/bitwarden/desktop/actions/workflows/build.yml?query=branch:master)
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-desktop/localized.svg)](https://crowdin.com/project/bitwarden-desktop)
[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)

# Bitwarden Desktop Application

[![Platforms](https://imgur.com/SLv9paA.png "Windows, macOS, and Linux")](https://bitwarden.com/download/)

The Bitwarden desktop app is written using Electron and Angular. The application installs on Windows, macOS, and Linux distributions.

![Desktop Vault](https://github.com/bitwarden/brand/blob/f09f2fa594c8a020c315296074f18ce0a7b3f171/screenshots/desktop-macos-vault.png "My Vault")

# Build/Run

**Requirements**

- [Node.js](https://nodejs.org) v14.17 or greater
- NPM v7
- Windows users: To compile the native node modules used in the app you will need the *Visual C++ toolset*, available through the standard Visual Studio installer. You will also need to install the *Microsoft Build Tools 2015* and *Windows 10 SDK 17134* as additional dependencies in the Visual Studio installer.


**Run the app**

```bash
npm install
npm run electron
```

**Debug Native Messaging**

Native Messaging (communication with the browser extension) works by having the browser start a lightweight proxy application baked into our desktop binary. To setup an environment which allows
for easy debugging you will need to build the application for distribution, i.e. `npm run dist:<platform>`, start the dist version and enable desktop integration. This will write some manifests
to disk, Consult the [native manifests](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#Manifest_location) documentation for more details of the manifest
format, and the exact locations for the different platforms. *Note* that disabling the desktop integration will delete the manifests, and the files will need to be updated again.

The generated manifests are pre-configured with the production ID for the browser extensions. In order to use them with the development builds, the browser extension ID of the development build
needs to be added to the `allowed_extensions` section of the manifest. These IDs are generated by the browser, and can be found in the extension settings within the browser. 

It will then be possible to run the desktop application as usual using `npm run electron` and communicate with the browser.

# 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.
Removed appveyor.yml and replaced badge in README.md 2021-03-25 19:39:33 +01:00			`[![Github Workflow build on master](https://github.com/bitwarden/desktop/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/bitwarden/desktop/actions/workflows/build.yml?query=branch:master)`
Update README.md 2018-02-20 03:01:43 +01:00			`[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-desktop/localized.svg)](https://crowdin.com/project/bitwarden-desktop)`
Update README.md 2018-02-19 23:57:51 +01:00			`[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)`

			`# Bitwarden Desktop Application`

fix links 2020-07-29 04:51:49 +02:00			`[![Platforms](https://imgur.com/SLv9paA.png "Windows, macOS, and Linux")](https://bitwarden.com/download/)`
Update README.md 2018-02-19 23:57:51 +01:00
Update README.md 2018-02-20 02:56:13 +01:00			`The Bitwarden desktop app is written using Electron and Angular. The application installs on Windows, macOS, and Linux distributions.`
Update README.md 2018-02-19 23:57:51 +01:00
Update README.md (#1062) 2021-09-09 15:00:14 +02:00			`![Desktop Vault](https://github.com/bitwarden/brand/blob/f09f2fa594c8a020c315296074f18ce0a7b3f171/screenshots/desktop-macos-vault.png "My Vault")`
Update README.md 2018-02-19 23:57:51 +01:00
			`# Build/Run`

			`Requirements`

Adjust node version in README.md 2021-05-13 01:37:33 +02:00			`- [Node.js](https://nodejs.org) v14.17 or greater`
Bump NPM to v7 (#922) * Bump NPM to v7 * Bump npm in build * Add NPM v7 to readme * Update node-gyp 2021-05-26 22:44:48 +02:00			`- NPM v7`
Biometric support (#470) * Initial work on windows hello support * Hide login button if not enabled * Add windows.security.credentials.ui dependency to desktop as well. * Only enable biometric on windows. * Add support for dynamic biometric text. * Add untested darwin implementation * Ensure we support biometric before showing login with windows hello / touchid. * Ensure compatability with latest jslib * Only require module on use. * Add windows.security.credentials.ui to src/package.json. * Update requirements * Update consent messages for biometrics 2020-07-23 19:32:36 +02:00			`- Windows users: To compile the native node modules used in the app you will need the Visual C++ toolset, available through the standard Visual Studio installer. You will also need to install the Microsoft Build Tools 2015 and Windows 10 SDK 17134 as additional dependencies in the Visual Studio installer.`

Update README.md 2018-02-19 23:57:51 +01:00
Update README.md 2018-02-20 17:36:27 +01:00			`Run the app`
Update README.md 2018-02-19 23:57:51 +01:00
			```bash
			`npm install`
			`npm run electron`
			```

Make fingerprint validation optional, update readme with debug info for native messaging 2020-12-18 15:47:48 +01:00			`Debug Native Messaging`

			`Native Messaging (communication with the browser extension) works by having the browser start a lightweight proxy application baked into our desktop binary. To setup an environment which allows`
			for easy debugging you will need to build the application for distribution, i.e. `npm run dist:<platform>`, start the dist version and enable desktop integration. This will write some manifests
fixing typo in readme 2021-01-04 19:25:43 +01:00			`to disk, Consult the [native manifests](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#Manifest_location) documentation for more details of the manifest`
Make fingerprint validation optional, update readme with debug info for native messaging 2020-12-18 15:47:48 +01:00			`format, and the exact locations for the different platforms. Note that disabling the desktop integration will delete the manifests, and the files will need to be updated again.`

			`The generated manifests are pre-configured with the production ID for the browser extensions. In order to use them with the development builds, the browser extension ID of the development build`
			needs to be added to the `allowed_extensions` section of the manifest. These IDs are generated by the browser, and can be found in the extension settings within the browser.

			It will then be possible to run the desktop application as usual using `npm run electron` and communicate with the browser.

Update README.md 2018-02-19 23:57:51 +01: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.

			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.