Home Manager Manual

programs.swaylock.enable

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:

security.pam.services.swaylock = {};

On non-NixOS, it is easiest to avoid incompatibility involving PAM by

1. stopping Home Manager from installing swaylock by setting programs.swaylock.package to null; and

2. instead installing swaylock from your distribution’s repository.

Type: boolean

Default:

true  if state version < 23.05 and settings ≠ { },
false otherwise

Example:

true

Declared by:

• <home-manager/modules/programs/swaylock.nix>

programs.swaylock.package

The swaylock package to use.

Type: null or package

Default:

pkgs.swaylock

Declared by:

• <home-manager/modules/programs/swaylock.nix>

programs.swaylock.settings

Default arguments to swaylock. An empty set disables configuration generation.

Type: attribute set of (boolean or floating point number or signed integer or absolute path or string)

Default:

{ }

Example:

{
  color = "808080";
  font-size = 24;
  indicator-idle-visible = false;
  indicator-radius = 100;
  line-color = "ffffff";
  show-failed-attempts = true;
}

Declared by:

• <home-manager/modules/programs/swaylock.nix>