swaylock: document the need for host PAM configuration
This commit is contained in:
parent
ae2cc6a88c
commit
5171f5ef65
|
@ -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" { };
|
||||||
|
|
Loading…
Reference in a new issue