commit 0d5fa1cff3e683ba371e7a5c0112a50f591bbcb2 · pyrox.dev/nixpkgs

+73 -18
nixos/modules/services/backup/duplicity.nix
···

       1
       1
       -
       { config, lib, pkgs, ...}:

     

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
        
       

     

       3
       3
        
       with lib;

     

       4
       4
       -
       

     

       5
       4
        
       let

     

       6
       5
        
         cfg = config.services.duplicity;

     

       7
       6
        
       

     

       8
       7
        
         stateDirectory = "/var/lib/duplicity";

     

       9
       8
        
       

     

       10
       10
       -
         localTarget = if hasPrefix "file://" cfg.targetUrl

     

       9
       9
       +
         localTarget =

     

       10
       10
       +
           if hasPrefix "file://" cfg.targetUrl

     

       11
       11
        
           then removePrefix "file://" cfg.targetUrl else null;

     

       12
       12
        
       

     

       13
       13
       -
       in {

     

       13
       13
       +
       in

     

       14
       14
       +
       {

     

       14
       15
        
         options.services.duplicity = {

     

       15
       16
        
           enable = mkEnableOption "backups with duplicity";

     

       16
       17
        
       

     
···

       24
       25
        
       

     

       25
       26
        
           include = mkOption {

     

       26
       27
        
             type = types.listOf types.str;

     

       27
       27
       -
             default = [];

     

       28
       28
       +
             default = [ ];

     

       28
       29
        
             example = [ "/home" ];

     

       29
       30
        
             description = ''

     

       30
       31
        
               List of paths to include into the backups. See the FILE SELECTION

     
···

       35
       36
        
       

     

       36
       37
        
           exclude = mkOption {

     

       37
       38
        
             type = types.listOf types.str;

     

       38
       38
       -
             default = [];

     

       39
       39
       +
             default = [ ];

     

       39
       40
        
             description = ''

     

       40
       41
        
               List of paths to exclude from backups. See the FILE SELECTION section in

     

       41
       42
        
               <citerefentry><refentrytitle>duplicity</refentrytitle>

     
···

       82
       83
        
       

     

       83
       84
        
           extraFlags = mkOption {

     

       84
       85
        
             type = types.listOf types.str;

     

       85
       85
       -
             default = [];

     

       86
       86
       -
             example = [ "--full-if-older-than" "1M" ];

     

       86
       86
       +
             default = [ ];

     

       87
       87
       +
             example = [ "--backend-retry-delay" "100" ];

     

       87
       88
        
             description = ''

     

       88
       89
        
               Extra command-line flags passed to duplicity. See

     

       89
       90
        
               <citerefentry><refentrytitle>duplicity</refentrytitle>

     

       90
       91
        
               <manvolnum>1</manvolnum></citerefentry>.

     

       91
       92
        
             '';

     

       92
       93
        
           };

     

       94
       94
       +
       

     

       95
       95
       +
           fullIfOlderThan = mkOption {

     

       96
       96
       +
             type = types.str;

     

       97
       97
       +
             default = "never";

     

       98
       98
       +
             example = "1M";

     

       99
       99
       +
             description = ''

     

       100
       100
       +
               If <literal>"never"</literal> (the default) always do incremental

     

       101
       101
       +
               backups (the first backup will be a full backup, of course).  If

     

       102
       102
       +
               <literal>"always"</literal> always do full backups.  Otherwise, this

     

       103
       103
       +
               must be a string representing a duration. Full backups will be made

     

       104
       104
       +
               when the latest full backup is older than this duration. If this is not

     

       105
       105
       +
               the case, an incremental backup is performed.

     

       106
       106
       +
             '';

     

       107
       107
       +
           };

     

       108
       108
       +
       

     

       109
       109
       +
           cleanup = {

     

       110
       110
       +
             maxAge = mkOption {

     

       111
       111
       +
               type = types.nullOr types.str;

     

       112
       112
       +
               default = null;

     

       113
       113
       +
               example = "6M";

     

       114
       114
       +
               description = ''

     

       115
       115
       +
                 If non-null, delete all backup sets older than the given time.  Old backup sets

     

       116
       116
       +
                 will not be deleted if backup sets newer than time depend on them.

     

       117
       117
       +
               '';

     

       118
       118
       +
             };

     

       119
       119
       +
             maxFull = mkOption {

     

       120
       120
       +
               type = types.nullOr types.int;

     

       121
       121
       +
               default = null;

     

       122
       122
       +
               example = 2;

     

       123
       123
       +
               description = ''

     

       124
       124
       +
                 If non-null, delete all backups sets that are older than the count:th last full

     

       125
       125
       +
                 backup (in other words, keep the last count full backups and

     

       126
       126
       +
                 associated incremental sets).

     

       127
       127
       +
               '';

     

       128
       128
       +
             };

     

       129
       129
       +
             maxIncr = mkOption {

     

       130
       130
       +
               type = types.nullOr types.int;

     

       131
       131
       +
               default = null;

     

       132
       132
       +
               example = 1;

     

       133
       133
       +
               description = ''

     

       134
       134
       +
                 If non-null, delete incremental sets of all backups sets that are

     

       135
       135
       +
                 older than the count:th last full backup (in other words, keep only

     

       136
       136
       +
                 old full backups and not their increments).

     

       137
       137
       +
               '';

     

       138
       138
       +
             };

     

       139
       139
       +
           };

     

       93
       140
        
         };

     

       94
       141
        
       

     

       95
       142
        
         config = mkIf cfg.enable {

     
···

       99
       146
        
       

     

       100
       147
        
               environment.HOME = stateDirectory;

     

       101
       148
        
       

     

       102
       102
       -
               serviceConfig = {

     

       103
       103
       -
                 ExecStart = ''

     

       104
       104
       -
                   ${pkgs.duplicity}/bin/duplicity ${escapeShellArgs (

     

       105
       105
       -
                     [

     

       106
       106
       -
                       cfg.root

     

       107
       107
       -
                       cfg.targetUrl

     

       108
       108
       -
                       "--archive-dir" stateDirectory

     

       109
       109
       -
                     ]

     

       149
       149
       +
               script =

     

       150
       150
       +
                 let

     

       151
       151
       +
                   target = escapeShellArg cfg.targetUrl;

     

       152
       152
       +
                   extra = escapeShellArgs ([ "--archive-dir" stateDirectory ] ++ cfg.extraFlags);

     

       153
       153
       +
                   dup = "${pkgs.duplicity}/bin/duplicity";

     

       154
       154
       +
                 in

     

       155
       155
       +
                 ''

     

       156
       156
       +
                   set -x

     

       157
       157
       +
                   ${dup} cleanup ${target} --force ${extra}

     

       158
       158
       +
                   ${lib.optionalString (cfg.cleanup.maxAge != null) "${dup} remove-older-than ${lib.escapeShellArg cfg.cleanup.maxAge} ${target} --force ${extra}"}

     

       159
       159
       +
                   ${lib.optionalString (cfg.cleanup.maxFull != null) "${dup} remove-all-but-n-full ${toString cfg.cleanup.maxFull} ${target} --force ${extra}"}

     

       160
       160
       +
                   ${lib.optionalString (cfg.cleanup.maxIncr != null) "${dup} remove-all-incr-but-n-full ${toString cfg.cleanup.maxIncr} ${target} --force ${extra}"}

     

       161
       161
       +
                   exec ${dup} ${if cfg.fullIfOlderThan == "always" then "full" else "incr"} ${lib.escapeShellArgs (

     

       162
       162
       +
                     [ cfg.root cfg.targetUrl ]

     

       110
       163
        
                     ++ concatMap (p: [ "--include" p ]) cfg.include

     

       111
       164
        
                     ++ concatMap (p: [ "--exclude" p ]) cfg.exclude

     

       112
       112
       -
                     ++ cfg.extraFlags)}

     

       165
       165
       +
                     ++ (lib.optionals (cfg.fullIfOlderThan != "never" && cfg.fullIfOlderThan != "always") [ "--full-if-older-than" cfg.fullIfOlderThan ])

     

       166
       166
       +
                     )} ${extra}

     

       113
       167
        
                 '';

     

       168
       168
       +
               serviceConfig = {

     

       114
       169
        
                 PrivateTmp = true;

     

       115
       170
        
                 ProtectSystem = "strict";

     

       116
       171
        
                 ProtectHome = "read-only";

     
···

       130
       185
        
           assertions = singleton {

     

       131
       186
        
             # Duplicity will fail if the last file selection option is an include. It

     

       132
       187
        
             # is not always possible to detect but this simple case can be caught.

     

       133
       133
       -
             assertion = cfg.include != [] -> cfg.exclude != [] || cfg.extraFlags != [];

     

       188
       188
       +
             assertion = cfg.include != [ ] -> cfg.exclude != [ ] || cfg.extraFlags != [ ];

     

       134
       189
        
             message = ''

     

       135
       190
        
               Duplicity will fail if you only specify included paths ("Because the

     

       136
       191
        
               default is to include all files, the expression is redundant. Exiting