Skip to content

Commit c25e4ed

Browse files
davidbarrattmaximbaz
authored andcommitted
Update & Simplify the Windows WSL installation instructions (#84)
1 parent 6f25eae commit c25e4ed

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This is a host application for [browserpass](https://github.com/browserpass/brow
1010
- [Install via package manager](#install-via-package-manager)
1111
- [Install manually](#install-manually)
1212
- [Install on Nix / NixOS](#install-on-nix--nixos)
13+
- [Install on Windows](#install-on-windows)
1314
- [Install on Windows through WSL](#install-on-windows-through-wsl)
1415
- [Configure browsers](#configure-browsers)
1516
- [Building the app](#building-the-app)
@@ -62,8 +63,6 @@ Primary key fingerprint: EB4F 9E5A 60D3 2232 BB52 150C 12C8 7A28 FEAC 6B20
6263
Subkey fingerprint: 8053 EB88 879A 68CB 4873 D32B 011F DC52 DA83 9335
6364
```
6465

65-
If you are on Windows, just run the installer, it will install all the necessary files in `C:\Program Files\Browserpass` and it will also [configure browsers](#configure-browsers). You are done!
66-
6766
Unpack the archive. If you decided to compile the application yourself, refer to the [Building the app](#building-the-app) section on how to do so. Once complete, continue with the steps below.
6867

6968
If you are on macOS, first install the necessary tools: `brew install coreutils gnu-sed`.
@@ -119,18 +118,22 @@ $ nix-env -iA nixpkgs.browserpass # Or nix-env -iA nixos.browserpass on NixOS
119118
$ DESTDIR=~/.nix-profile make -f ~/.nix-profile/lib/browserpass/Makefile <desired make goal>
120119
```
121120

122-
#### Install on Windows through WSL
121+
#### Install on Windows
122+
Download [the latest Github release](https://github.com/browserpass/browserpass-native/releases/latest) for `windows64`.
123+
124+
Run the installer, it will install all the necessary files in `C:\Program Files\Browserpass` and it will also [configure browsers](#configure-browsers).
123125

124-
If you want to use WSL instead, follow Linux installation steps, then create `%localappdata%\Browserpass\browserpass-wsl.bat` with the following contents:
126+
#### Install on Windows through WSL
125127

128+
If you want to use WSL instead
129+
1) Follow the [installation](#installation) steps for the WSL distribution you are using. There is no need to configure the browser as your browser does not run in WSL.
130+
2) Follow the then [installation](#install-on-windows) steps for installing on Windows.
131+
3) Create `C:\Program Files\Browserpass\browserpass-wsl.bat` with the following contents:
126132
```
127133
@echo off
128134
bash -c "/usr/bin/browserpass-linux64 2>/dev/null"
129135
```
130-
131-
Then edit the hosts json files (in our example `C:\Program Files\Browserpass\browser-files\*-host.json`) and replace `%%replace%%` with a full path to `browserpass-wsl.bat` you've just created.
132-
133-
Finally proceed to the [Configure browsers on Windows](#configure-browsers-on-windows) section.
136+
4) Edit the hosts json files (in our example `C:\Program Files\Browserpass\browser-files\*-host.json`) and replace `browserpass-windows64.exe` with `browserpass-wsl.bat` you've just created.
134137

135138
Remember to check [Hints for configuring gpg](#hints-for-configuring-gpg) on how to configure pinentry to unlock your PGP key.
136139

0 commit comments

Comments
 (0)