swaylock: document the need for host PAM configuration

This commit is contained in:
Tristan Daniël Maat 2023-09-07 17:13:10 +02:00 committed by Robert Helgesson
parent ae2cc6a88c
commit 5171f5ef65
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89

View file

@ -16,7 +16,21 @@ in {
false otherwise false otherwise
''; '';
example = true; example = true;
description = "Whether to enable swaylock."; description = ''
Whether to enable swaylock.
Note that PAM must be configured to enable swaylock to perform
authentication. The package installed through home-manager
will *not* be able to unlock the session without this
configuration.
On NixOS, this is by default enabled with the sway module, but
for other compositors it can currently be enabled using:
```nix
security.pam.services.swaylock = {};
```
'';
}; };
package = mkPackageOption pkgs "swaylock" { }; package = mkPackageOption pkgs "swaylock" { };