commit cae154a67eb8e0605464896ea53c87d5634020f1 · pyrox.dev/nixpkgs

+103 -1

nixos/modules/system/boot/systemd/tmpfiles.nix

···

       20
       20
        
             '';

     

       21
       21
        
           };

     

       22
       22
        
       

     

       23
       23
       +
           systemd.tmpfiles.settings = mkOption {

     

       24
       24
       +
             description = lib.mdDoc ''

     

       25
       25
       +
               Declare systemd-tmpfiles rules to create, delete, and clean up volatile

     

       26
       26
       +
               and temporary files and directories.

     

       27
       27
       +
       

     

       28
       28
       +
               Even though the service is called `*tmp*files` you can also create

     

       29
       29
       +
               persistent files.

     

       30
       30
       +
             '';

     

       31
       31
       +
             example = {

     

       32
       32
       +
               "10-mypackage" = {

     

       33
       33
       +
                 "/var/lib/my-service/statefolder".d = {

     

       34
       34
       +
                   mode = "0755";

     

       35
       35
       +
                   user = "root";

     

       36
       36
       +
                   group = "root";

     

       37
       37
       +
                 };

     

       38
       38
       +
               };

     

       39
       39
       +
             };

     

       40
       40
       +
             default = {};

     

       41
       41
       +
             type = types.attrsOf (types.attrsOf (types.attrsOf (types.submodule ({ name, config, ... }: {

     

       42
       42
       +
               options.type = mkOption {

     

       43
       43
       +
                 type = types.str;

     

       44
       44
       +
                 default = name;

     

       45
       45
       +
                 example = "d";

     

       46
       46
       +
                 description = lib.mdDoc ''

     

       47
       47
       +
                   The type of operation to perform on the file.

     

       48
       48
       +
       

     

       49
       49
       +
                   The type consists of a single letter and optionally one or more

     

       50
       50
       +
                   modifier characters.

     

       51
       51
       +
       

     

       52
       52
       +
                   Please see the upstream documentation for the available types and

     

       53
       53
       +
                   more details:

     

       54
       54
       +
                   <https://www.freedesktop.org/software/systemd/man/tmpfiles.d>

     

       55
       55
       +
                 '';

     

       56
       56
       +
               };

     

       57
       57
       +
               options.mode = mkOption {

     

       58
       58
       +
                 type = types.str;

     

       59
       59
       +
                 default = "-";

     

       60
       60
       +
                 example = "0755";

     

       61
       61
       +
                 description = lib.mdDoc ''

     

       62
       62
       +
                   The file access mode to use when creating this file or directory.

     

       63
       63
       +
                 '';

     

       64
       64
       +
               };

     

       65
       65
       +
               options.user = mkOption {

     

       66
       66
       +
                 type = types.str;

     

       67
       67
       +
                 default = "-";

     

       68
       68
       +
                 example = "root";

     

       69
       69
       +
                 description = lib.mdDoc ''

     

       70
       70
       +
                   The user of the file.

     

       71
       71
       +
       

     

       72
       72
       +
                   This may either be a numeric ID or a user/group name.

     

       73
       73
       +
       

     

       74
       74
       +
                   If omitted or when set to `"-"`, the user and group of the user who

     

       75
       75
       +
                   invokes systemd-tmpfiles is used.

     

       76
       76
       +
                 '';

     

       77
       77
       +
               };

     

       78
       78
       +
               options.group = mkOption {

     

       79
       79
       +
                 type = types.str;

     

       80
       80
       +
                 default = "-";

     

       81
       81
       +
                 example = "root";

     

       82
       82
       +
                 description = lib.mdDoc ''

     

       83
       83
       +
                   The group of the file.

     

       84
       84
       +
       

     

       85
       85
       +
                   This may either be a numeric ID or a user/group name.

     

       86
       86
       +
       

     

       87
       87
       +
                   If omitted or when set to `"-"`, the user and group of the user who

     

       88
       88
       +
                   invokes systemd-tmpfiles is used.

     

       89
       89
       +
                 '';

     

       90
       90
       +
               };

     

       91
       91
       +
               options.age = mkOption {

     

       92
       92
       +
                 type = types.str;

     

       93
       93
       +
                 default = "-";

     

       94
       94
       +
                 example = "10d";

     

       95
       95
       +
                 description = lib.mdDoc ''

     

       96
       96
       +
                   Delete a file when it reaches a certain age.

     

       97
       97
       +
       

     

       98
       98
       +
                   If a file or directory is older than the current time minus the age

     

       99
       99
       +
                   field, it is deleted.

     

       100
       100
       +
       

     

       101
       101
       +
                   If set to `"-"` no automatic clean-up is done.

     

       102
       102
       +
                 '';

     

       103
       103
       +
               };

     

       104
       104
       +
               options.argument = mkOption {

     

       105
       105
       +
                 type = types.str;

     

       106
       106
       +
                 default = "";

     

       107
       107
       +
                 example = "";

     

       108
       108
       +
                 description = lib.mdDoc ''

     

       109
       109
       +
                   An argument whose meaning depends on the type of operation.

     

       110
       110
       +
       

     

       111
       111
       +
                   Please see the upstream documentation for the meaning of this

     

       112
       112
       +
                   parameter in different situations:

     

       113
       113
       +
                   <https://www.freedesktop.org/software/systemd/man/tmpfiles.d>

     

       114
       114
       +
                 '';

     

       115
       115
       +
               };

     

       116
       116
       +
             }))));

     

       117
       117
       +
           };

     

       118
       118
       +
       

     

       23
       119
        
           systemd.tmpfiles.packages = mkOption {

     

       24
       120
        
             type = types.listOf types.package;

     

       25
       121
        
             default = [];

     
···

       100
       196
        
                 ${concatStringsSep "\n" cfg.rules}

     

       101
       197
        
               '';

     

       102
       198
        
             })

     

       103
       103
       -
           ];

     

       199
       199
       +
           ] ++ (mapAttrsToList (name: paths:

     

       200
       200
       +
             pkgs.writeTextDir "lib/tmpfiles.d/${name}.conf" (concatStrings (mapAttrsToList (path: types:

     

       201
       201
       +
               concatStrings (mapAttrsToList (_type: entry: ''

     

       202
       202
       +
                 '${entry.type}' '${path}' '${entry.mode}' '${entry.user}' '${entry.group}' '${entry.age}' ${entry.argument}

     

       203
       203
       +
               '') types)

     

       204
       204
       +
             ) paths ))

     

       205
       205
       +
           ) cfg.settings);

     

       104
       206
        
       

     

       105
       207
        
           systemd.tmpfiles.rules = [

     

       106
       208
        
             "d  /nix/var                           0755 root root - -"

nixos/tests/misc.nix

···

       13
       13
        
             environment.variables.EDITOR = lib.mkOverride 0 "emacs";

     

       14
       14
        
             documentation.nixos.enable = lib.mkOverride 0 true;

     

       15
       15
        
             systemd.tmpfiles.rules = [ "d /tmp 1777 root root 10d" ];

     

       16
       16
       +
             systemd.tmpfiles.settings."10-test"."/tmp/somefile".d = {};

     

       16
       17
        
             virtualisation.fileSystems = { "/tmp2" =

     

       17
       18
        
               { fsType = "tmpfs";

     

       18
       19
        
                 options = [ "mode=1777" "noauto" ];

     
···

       116
       117
        
                     "systemctl start systemd-tmpfiles-clean",

     

       117
       118
        
                 )

     

       118
       119
        
                 machine.fail("[ -e /tmp/foo ]")

     

       120
       120
       +
       

     

       121
       121
       +
             with subtest("whether systemd-tmpfiles settings works"):

     

       122
       122
       +
                 machine.succeed("[ -e /tmp/somefile ]")

     

       119
       123
        
       

     

       120
       124
        
             with subtest("whether automounting works"):

     

       121
       125
        
                 machine.fail("grep '/tmp2 tmpfs' /proc/mounts")