Borgmatic
services.borgmatic.configurations
Set of borgmatic configurations, see https://torsion.org/borgmatic/docs/reference/configuration/
Type: attribute set of (YAML value)
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.configurations.<name>.repositories
A required list of local or remote repositories with paths and optional labels (which can be used with the --repository flag to select a repository). Tildes are expanded. Multiple repositories are backed up to in sequence. Borg placeholders can be used. See the output of "borg help placeholders" for details. See ssh_command for SSH options like identity file or port. If systemd service is used, then add local repository paths in the systemd service file to the ReadWritePaths list.
Type: null or (list of (submodule))
Default
null
Example
[{label = "backupserver";path = "ssh://user@backupserver/./sourcehostname.borg";}{label = "local";path = "/mnt/backup";}]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.configurations.<name>.repositories.*.label
Label to the repository
Type: string
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.configurations.<name>.repositories.*.path
Path to the repository
Type: string
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.configurations.<name>.source_directories
List of source directories and files to backup. Globs and tildes are expanded. Do not backslash spaces in path names.
Type: null or (list of string)
Default
null
Example
["/home""/etc""/var/log/syslog*""/home/user/path with spaces"]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.enable
Whether to enable borgmatic.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.settings
See https://torsion.org/borgmatic/docs/reference/configuration/
Type: null or (YAML value)
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.settings.repositories
A required list of local or remote repositories with paths and optional labels (which can be used with the --repository flag to select a repository). Tildes are expanded. Multiple repositories are backed up to in sequence. Borg placeholders can be used. See the output of "borg help placeholders" for details. See ssh_command for SSH options like identity file or port. If systemd service is used, then add local repository paths in the systemd service file to the ReadWritePaths list.
Type: null or (list of (submodule))
Default
null
Example
[{label = "backupserver";path = "ssh://user@backupserver/./sourcehostname.borg";}{label = "local";path = "/mnt/backup";}]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.settings.repositories.*.label
Label to the repository
Type: string
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.settings.repositories.*.path
Path to the repository
Type: string
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix
services.borgmatic.settings.source_directories
List of source directories and files to backup. Globs and tildes are expanded. Do not backslash spaces in path names.
Type: null or (list of string)
Default
null
Example
["/home""/etc""/var/log/syslog*""/home/user/path with spaces"]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/borgmatic.nix