Skip to content

README: document Nix home-manager usage #157

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README: document Nix home-manager usage #157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ Then add the following line to your `~/.zshrc` and restart the shell.
export SSH_AUTH_SOCK="$(brew --prefix)/var/run/yubikey-agent.sock"
```

If you use Nix on macOS, you can also install & manage the package, service, and shell configuration via
[home-manager](#nixos--home-manager--nixpkgs).

### Linux

#### Arch
Expand All @@ -44,19 +47,28 @@ systemctl --user enable --now yubikey-agent
export SSH_AUTH_SOCK="${XDG_RUNTIME_DIR}/yubikey-agent/yubikey-agent.sock"
```

#### NixOS / nixpkgs
#### NixOS / home-manager / nixpkgs

On NixOS unstable and 20.09 (unreleased at time of writing), you can
add this to your `/etc/nixos/configuration.nix`:
On NixOS, you can add this to your `/etc/nixos/configuration.nix`:

```
services.yubikey-agent.enable = true;
```

This installs `yubikey-agent` and sets up a systemd unit to start
yubikey-agent for you.
This installs `yubikey-agent` and sets up a systemd unit to start yubikey-agent for you.

Or, if you're using [home-manager](https://github.com/nix-community/home-manager), you can use the same
expression in your user's `home` configuration for a socket activated user service:

```
home-manager.users.example = {
services.yubikey-agent.enable = true;
};
```

This is available on both Linux and macOS systems.

On other systems using nix, you can also install from nixpkgs:
On other systems using Nix, you can also install from nixpkgs:

```
nix-env -iA nixpkgs.yubikey-agent
Expand Down