Snapper

`services.snapper.cleanupInterval`

Cleanup interval.

The format is described in {manpage}systemd.time(7).

Type: string

Default

"1d"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs`

Subvolume configuration. Any option mentioned in man:snapper-configs(5) is valid here, even if NixOS doesn't document it.

Type: attribute set of (attribute set of ((list of (string without line breaks or quotes)) or boolean or string without line breaks or quotes or signed integer or floating point number))

Default

{ }

Example

{home = {SUBVOLUME = "/home";ALLOW_USERS = [ "alice" ];TIMELINE_CREATE = true;TIMELINE_CLEANUP = true;};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.ALLOW_GROUPS`

List of groups allowed to operate with the config.

Also see the PERMISSIONS section in man:snapper(8).

Type: list of (string without line breaks or quotes)

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.ALLOW_USERS`

List of users allowed to operate with the config. "root" is always implicitly included.

Also see the PERMISSIONS section in man:snapper(8).

Type: list of (string without line breaks or quotes)

Default

[ ]

Example

["alice"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.FSTYPE`

Filesystem type. Only btrfs is stable and tested.

Type: value "btrfs" (singular enum)

Default

"btrfs"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.SUBVOLUME`

Path of the subvolume or mount point. This path is a subvolume and has to contain a subvolume named .snapshots. See also man:snapper(8) section PERMISSIONS.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.TIMELINE_CLEANUP`

Defines whether the timeline cleanup algorithm should be run for the config.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.TIMELINE_CREATE`

Defines whether hourly snapshots should be created.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.TIMELINE_LIMIT_DAILY`

Limits for timeline cleanup.

Type: signed integer

Default

10

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.TIMELINE_LIMIT_HOURLY`

Limits for timeline cleanup.

Type: signed integer

Default

10

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.TIMELINE_LIMIT_MONTHLY`

Limits for timeline cleanup.

Type: signed integer

Default

10

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.TIMELINE_LIMIT_QUARTERLY`

Limits for timeline cleanup.

Type: signed integer

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.TIMELINE_LIMIT_WEEKLY`

Limits for timeline cleanup.

Type: signed integer

Default

0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.configs.<name>.TIMELINE_LIMIT_YEARLY`

Limits for timeline cleanup.

Type: signed integer

Default

10

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.filters`

Global display difference filter. See man:snapper(8) for more details.

Type: null or strings concatenated with "\n"

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.persistentTimer`

Set the Persistent option for the {manpage}systemd.timer(5) which triggers the snapshot immediately if the last trigger was missed (e.g. if the system was powered down).

Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.snapshotInterval`

Snapshot interval.

The format is described in {manpage}systemd.time(7).

Type: string

Default

"hourly"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix

`services.snapper.snapshotRootOnBoot`

Whether to snapshot root on boot

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/snapper.nix