Btrbk

`services.btrbk.extraPackages`

Extra packages for btrbk, like compression utilities for stream_compress.

Note: This option will get deprecated in future releases. Required compression programs will get automatically provided to btrbk depending on configured compression method in services.btrbk.instances.<name>.settings option.

Type: list of package

Default

[ ]

Example

[ pkgs.xz ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.instances`

Set of btrbk instances. The instance named btrbk is the default one. Type: attribute set of (submodule)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.instances.<name>.onCalendar`

How often this btrbk instance is started. See systemd.time(7) for more information about the format. Setting it to null disables the timer, thus this instance can only be started manually.

Type: null or string

Default

"daily"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.instances.<name>.settings`

configuration options for btrbk. Nested attrsets translate to subsections. Type: attribute set of (string or instances of this type recursively)

Default

{ }

Example

{snapshot_preserve = "14d";snapshot_preserve_min = "2d";volume = {"/mnt/btr_pool" = {subvolume = {home = {snapshot_create = "always";};rootfs = { };};target = "/mnt/btr_backup/mylaptop";};};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.instances.<name>.settings.stream_compress`

Compress the btrfs send stream before transferring it from/to remote locations using a compression command.

Type: one of "gzip", "pigz", "bzip2", "pbzip2", "bzip3", "xz", "lzo", "lz4", "zstd", "no"

Default

"no"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.ioSchedulingClass`

IO scheduling class for btrbk (see ionice(1) for a quick description). Applies to local instances, and remote ones connecting by ssh if set to idle. Type: one of "idle", "best-effort", "realtime"

Default

"best-effort"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.niceness`

Niceness for local instances of btrbk. Also applies to remote ones connecting via ssh when positive. Type: integer between -20 and 19 (both inclusive)

Default

10

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.sshAccess`

SSH keys that should be able to make or push snapshots on this system remotely with btrbk Type: list of (submodule)

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.sshAccess.*.key`

SSH public key allowed to login as user btrbk to run remote backups. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix

`services.btrbk.sshAccess.*.roles`

What actions can be performed with this SSH key. See ssh_filter_btrbk(1) for details Type: list of (one of "info", "source", "target", "delete", "snapshot", "send", "receive")

Example

["source""info""send"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/btrbk.nix