aboutsummaryrefslogtreecommitdiff
path: root/modules/services/backup/default.nix
diff options
context:
space:
mode:
Diffstat (limited to 'modules/services/backup/default.nix')
-rw-r--r--modules/services/backup/default.nix83
1 files changed, 83 insertions, 0 deletions
diff --git a/modules/services/backup/default.nix b/modules/services/backup/default.nix
new file mode 100644
index 0000000..52378d3
--- /dev/null
+++ b/modules/services/backup/default.nix
@@ -0,0 +1,83 @@
+{ config, pkgs, lib, ... }:
+let cfg = config.my.services.backup;
+in {
+ options.my.services.backup = with lib; {
+ enable = mkEnableOption "Enable backups for this host";
+
+ repository = mkOption {
+ type = types.str;
+ example = "/data/slow/backups/system";
+ description = "The repository to back up to";
+ };
+
+ passwordFile = mkOption {
+ type = types.str;
+ example = "/var/lib/restic/password.txt";
+ description = "Read the repository's password from this path";
+ };
+
+ paths = mkOption {
+ type = with types; listOf str;
+ default = [ ];
+ example = [ "/var/lib" "/home" ];
+ description = "Paths to backup";
+ };
+
+ exclude = mkOption {
+ type = with types; listOf str;
+ default = [ ];
+ example = [
+ # very large paths
+ "/var/lib/docker"
+ "/var/lib/systemd"
+ "/var/lib/libvirt"
+
+ # temporary files created by `cargo` and `go build`
+ "**/target"
+ "/home/*/go/bin"
+ "/home/*/go/pkg"
+ ];
+ description = "Paths to exclude from backup";
+ };
+
+ pruneOpts = mkOption {
+ type = with types; listOf str;
+ default = [
+ "--keep-last 10"
+ "--keep-hourly 24"
+ "--keep-daily 7"
+ "--keep-weekly 5"
+ "--keep-monthly 12"
+ "--keep-yearly 100"
+ ];
+ example = [ "--keep-last 5" "--keep-weekly 2" ];
+ description = ''
+ List of options to give to the `forget` subcommand after a backup.
+ '';
+ };
+
+ timerConfig = mkOption {
+ # NOTE: I do not know how to cleanly set the type
+ default = { OnCalendar = "daily"; };
+ example = {
+ OnCalendar = "00:05";
+ RandomizedDelaySec = "5h";
+ };
+ description = ''
+ When to run the backup. See man systemd.timer for details.
+ '';
+ };
+ };
+
+ config = lib.mkIf cfg.enable {
+ services.restic.backups = {
+ # Take care of included and excluded files
+ paths = cfg.paths;
+ extraBackupArgs = [ "--verbose=2" ]
+ ++ lib.optional (builtins.length cfg.exclude != 0) excludeArg;
+ # Take care of creating the repository if it doesn't exist
+ initialize = true;
+ inherit (cfg) passwordFile pruneOpts timerConfig repository;
+ };
+ };
+}