about summary refs log tree commit diff
path: root/modules/services/backup.nix
blob: a513d182ade83a43f1c5e61fbd087edb9fb2dcc7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{ config, lib, ... }:

with lib;
let
  cfg = config.modules.services.backup;
in
{
  options.modules.services.backup = {
    enable = mkEnableOption "borg-based backup solution";
    name = lib.mkOption {
      type = lib.types.str;
      default = "${config.networking.hostName}-rolling";
      description = ''
        Name of the backup job
      '';
    };

    paths = lib.mkOption {
      type = lib.types.listOf lib.types.str;
      description = ''
        Paths to back up
      '';
    };
    exclude = lib.mkOption {
      type = lib.types.listOf lib.types.str;
      default = [ ];
      description = ''
        Paths to exclude
      '';
    };
    repo = lib.mkOption {
      type = lib.types.str;
      description = ''
        Path to the repository to back up to
      '';
    };
    repoKeyPath = lib.mkOption {
      type = lib.types.str;
      description = ''
        Path to the repository key
      '';
    };
    sshKeyPath = lib.mkOption {
      type = lib.types.str;
      description = ''
        Path to the ssh key
      '';
    };
    rsyncNet = lib.mkOption {
      type = lib.types.bool;
      default = false;
      description = ''
        Whether to enable rsync.net specific patches
      '';
    };
  };

  config = mkIf cfg.enable {
    services.borgbackup.jobs.${cfg.name} = {
      inherit (cfg) paths exclude repo;


      encryption.mode = "repokey-blake2";
      encryption.passCommand = "cat ${cfg.repoKeyPath}";

      environment.BORG_RSH = "ssh -i ${cfg.sshKeyPath}";
      environment.BORG_REMOTE_PATH = lib.mkIf cfg.rsyncNet "/usr/local/bin/borg1/borg1";
      # use borg 1.0+ on rsync.net
      extraCreateArgs = "--verbose --stats --checkpoint-interval 600";
      compression = "auto,zstd";
      startAt = "daily";
      persistentTimer = true;
    };
  };
}