The desktop vault (Windows, macOS, & Linux).

bitwarden javascript typescript electron angular

Joseph Flinn 4f77f12552 Updating the Crowin sync process (#1144 )		4 years ago
.github	Updating the Crowin sync process (#1144 )	4 years ago
.vscode	persist and restore window state	8 years ago
jslib@2db9e1ce0d	[Linked fields] Add Linked Field as custom field type (#1091 )	4 years ago
resources	Write native messaging manifests for Chromium (#862 )	5 years ago
scripts	Ensure safari extension is included in mas and not only darwin (#1128 )	4 years ago
src	[Linked fields] Add Linked Field as custom field type (#1091 )	4 years ago
stores	new screenshots	5 years ago
.editorconfig	update settings	8 years ago
.gitignore	Add script for downloading legacy safari extension (#796 )	5 years ago
.gitmodules	submodule via https	8 years ago
.nvmrc	Update .nvmrc from 10.13.0 to 14.17.0	5 years ago
CONTRIBUTING.md	fix typo	5 years ago
LICENSE.txt	license and contrib	8 years ago
README.md	Update README.md (#1062 )	4 years ago
SECURITY.md	uppercase Bitwarden	8 years ago
crowdin.yml	Updating the Crowin sync process (#1144 )	4 years ago
package-lock.json	Bump signalr to 5.0.10 (#1093 )	4 years ago
package.json	Add Universal DMG Artifact (#1136 )	4 years ago
sign.js	Pinning ast version (#1080 )	4 years ago
tsconfig.json	Add jslib as a "real" dependency (#941 )	5 years ago
tsconfig.renderer.json	Fix VS code ts language server no longer working after #866 (#872 )	5 years ago
tslint.json	Remove empty catch blocks and remove allow-empty-catch tslint rule (#1117 )	4 years ago
webpack.main.js	Default to development environment settings	5 years ago
webpack.renderer.js	Cleanup tsconfig (#866 )	5 years ago

README.md

Bitwarden Desktop Application

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

Build/Run

Requirements

Node.js 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

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