History

Michał Chęciński bd6cdf3aa3 Devops 829 Add electron beta channels (#2838 ) * Add option for beta channels in package.json for electron * Change placement of build settings * Add version * Revert "Add version" This reverts commit `2e09cc7d5e`. * Add electron version to package.json * Move build to higher level * Add upload beta autoupdate * Revert version * Updating the release workflow with the new channels * restrict GitHub Release to only 'latest' * fixing electron-builder configuration * version bump test * fixing words * Commenting out the npm cache in the windows build job * Adding back in the caching for the future * Revert "version bump test" This reverts commit `b732d00841`. Co-authored-by: Joseph Flinn <joseph.s.flinn@gmail.com>		2022-06-07 15:44:25 +02:00
..
.vscode	Move desktop into apps/desktop	2022-05-05 17:20:34 +02:00
desktop_native	Move desktop into apps/desktop	2022-05-05 17:20:34 +02:00
resources	Move desktop into apps/desktop	2022-05-05 17:20:34 +02:00
scripts	Update repo urls for desktop, remove download-legacy-safari (#2664 )	2022-05-09 17:49:59 +02:00
src	Autosync the updated translations (#2818 )	2022-06-07 14:54:13 +02:00
stores	Update bitwarden.nuspec (#2668 )	2022-05-10 09:13:47 -04:00
.eslintrc.json	[EC-184] Desktop cleanup (#2553 )	2022-05-05 19:03:56 +02:00
.gitignore	Add instructions on how to migrate desktop PRs (#2636 )	2022-05-05 21:59:17 +02:00
README.md	Update repo urls for desktop, remove download-legacy-safari (#2664 )	2022-05-09 17:49:59 +02:00
SECURITY.md	Move desktop into apps/desktop	2022-05-05 17:20:34 +02:00
crowdin.yml	Fix Crowdin Pull workflow (#2667 )	2022-05-10 10:20:32 -04:00
electron-builder.json	Devops 829 Add electron beta channels (#2838 )	2022-06-07 15:44:25 +02:00
package.json	[EC-236] Move dependencies to root package.json (#2720 )	2022-06-02 15:18:29 +02:00
sign.js	Move desktop into apps/desktop	2022-05-05 17:20:34 +02:00
tsconfig.json	Add support for migrated jslib (#2826 )	2022-06-03 18:01:07 +02:00
tsconfig.renderer.json	Add support for migrated jslib (#2826 )	2022-06-03 18:01:07 +02:00
webpack.main.js	Move desktop into apps/desktop	2022-05-05 17:20:34 +02:00
webpack.renderer.js	Add support for migrated jslib (#2826 )	2022-06-03 18:01:07 +02:00

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 v16.13.1 (LTS) or greater
NPM v8
Windows:
- 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.
Linux:
- The following packages build-essential libsecret-1-dev libglib2.0-dev

Run the app

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