Skip to content

README: reword install instructions #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LDVG merged 4 commits into from
Feb 27, 2025
Merged

README: reword install instructions #352

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3752620
README: create a Releases heading
LDVG Feb 26, 2025
386c9d3
README: move build-from-source installation steps
LDVG Feb 26, 2025
e150a47
README: add a heading for installing using a package manager
LDVG Feb 26, 2025
e3ad7e6
README: specify source tarballs for the Building heading
LDVG Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 49 additions & 13 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

@dacav dacav Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, better be explicit about it. People do use binary tarballs sometimes

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.

Expand All @@ -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:
Expand Down Expand Up @@ -78,16 +123,7 @@ Generate the build system using:
$ autoreconf --install
----

Then build as usual, see above under <<building,Building>>.

== 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 <<building,Building from a source tarball>>.

== Service Configuration

Expand Down
Loading