borgbackup-static

Statically configure borgbackup with sane defaults.

Categories

Uncategorized

---

Deprecated

Use borgbackup instead.

Don't use borgbackup-static through inventory.

This module implements the borgbackup backend and implements sane defaults for backup management through borgbackup for members of the clan.

Configure target machines where the backups should be sent to through targets.

Configure machines that should be backuped either through includeMachines which will exclusively add the included machines to be backuped, or through excludeMachines, which will add every machine except the excluded machine to the backup.

Usage via Inventory

This module cannot be used via the inventory interface.

Usage via Nix

This module can be also imported directly in your nixos configuration. Although it is recommended to use the inventory interface if available.

Some modules are considered 'low-level' or 'expert modules' and are not available via the inventory interface.

{config, lib, inputs, ...}: {
    imports = [ inputs.clan-core.clanModules.borgbackup-static ];
    # ...
}

Module Options

The following options are available for this module.

clan.borgbackup-static.excludeMachines

Machines that should not be backuped. Mutually exclusive with includeMachines. If this is not empty, every other machine except the targets in the clan will be backuped by this module. If includeMachines is set, only the included machines will be backuped.

Type: list of string

Default:

[ ]

Example

[
  "nixos"
]

borgbackup-static

clan.borgbackup-static.includeMachines

Machines that should be backuped. Mutually exclusive with excludeMachines.

Type: list of string

Default:

[ ]

Example

[
  "nixos"
]

borgbackup-static

clan.borgbackup-static.targets

Machines that should act as target machines for backups.

Type: list of string

Default:

[ ]

borgbackup-static