diff --git a/README b/README index f435cb4d..bca3e00f 100644 --- a/README +++ b/README @@ -8,12 +8,50 @@ This module implements PAM over U2F and FIDO2, providing an easy way to integrat YubiKey (or other U2F/FIDO2 compliant authenticators) into your existing infrastructure. -[[building]] -== Building +== Releases -You may get signed release tarballs from Yubico's +You may get signed release source tarballs from Yubico's https://developers.yubico.com/pam-u2f/Releases[release page]. +== Installation + +pam-u2f comes readily packaged for a number of systems. A non-exhaustive +list is available below. + +=== Ubuntu + +[source, console] +---- +$ sudo apt install libpam-u2f pamu2fcfg +---- + +Additionally, Yubico maintains a PPA with up-to-date versions of pam-u2f. + +[source, console] +---- +$ sudo apt install software-properties-common +$ sudo apt-add-repository ppa:yubico/stable +$ sudo apt update +$ sudo apt install libpam-u2f pamu2fcfg +---- + +=== Fedora + +[source, console] +---- +$ sudo dnf install pam-u2f pamu2fcfg +---- + +=== macOS + +[source, console] +---- +$ brew install pam-u2f +---- + +[[building]] +== Building from a source tarball + This project uses 'autoconf', 'automake', 'pkg-config' and 'libtool' to achieve portability and ease of use. @@ -36,6 +74,13 @@ $ ./configure $ make ---- +Once the module is built, copy the file `pam_u2f.so` to the correct +directory for your system. Typically `/lib/security/` or +`/lib/x86_64-linux-gnu/security/`. This is automated by `make install` +assuming that the pam directory chosen by `configure` is correct. If +that is not the case it can be specified with `./configure +--with-pam-dir=`. + == Building from Git You may check out the sources using Git with the following command: @@ -78,16 +123,7 @@ Generate the build system using: $ autoreconf --install ---- -Then build as usual, see above under <>. - -== Installation - -Once the module is built, copy the file `pam_u2f.so` to the correct -directory for your system. Typically `/lib/security/` or -`/lib/x86_64-linux-gnu/security/`. This is automated by `make install` -assuming that the pam directory chosen by `configure` is correct. If -that is not the case it can be specified with `./configure ---with-pam-dir=`. +Then build as usual, see above under <>. == Service Configuration