colin/browserpass-native
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: clarify install instructions (#36)

Browse Source
This commit is contained in:
Maxim Baz
2019-04-01 14:09:35 +02:00
committed by GitHub
parent b36f01d204
commit c75931976c
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -26,8 +26,8 @@ This is a host application for [browserpass](https://github.com/browserpass/brow
The following operating systems provide a browserpass package that can be installed using a package manager:
- TODO
- TODO
- [Arch Linux](https://aur.archlinux.org/packages/browserpass/)
- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/security/browserpass/default.nix) - also read [Install on Nix / NixOS](#install-on-nix--nixos)
Once the package is installed, **refer to the section [Configure browsers](#configure-browsers)**.
@@ -52,7 +52,21 @@ Primary key fingerprint: EB4F 9E5A 60D3 2232 BB52 150C 12C8 7A28 FEAC 6B20
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.
Configure the hosts json files using `make configure` and then install the app using `sudo make install` (if you compiled it using `make browserpass`) or `sudo make BIN=browserpass-XXXX install` (if you downloaded a release with pre-built binary). Both `configure` and `install` targets respect `PREFIX` and `DESTDIR` parameters if you want to customize the install location (e.g. to avoid `sudo`).
If you downloaded a release archive with pre-compiled binary, follow these steps to install the app:
```
make BIN=browserpass-XXXX configure # Configure the hosts json files, XXXX refers to archive name, e.g. "linux64"
sudo make BIN=browserpass-XXXX install # Install the app, XXXX refers to archive name, e.g. "linux64"
```
If you compiled the app yourself, you can omit `BIN` parameter:
```
make configure # Configure the hosts json files
sudo make install # Install the app
```
In addition, both `configure` and `install` targets respect `PREFIX`, `DESTDIR` parameters if you want to customize the install location (e.g. to install to a `$HOME` dir to avoid using `sudo`).
Finally proceed to the [Configure browsers](#configure-browsers) section.