summary refs log tree commit diff
path: root/modules/services/misc/nix-gc.nix
blob: 435326e87fb8c926eb691f8bbc2a8492c660cb35 (plain) (blame)
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
{ config, pkgs, ... }:

with pkgs.lib;

let
  cfg = config.nix.gc;
in

{

  ###### interface

  options = {
    nix.gc = {

      automatic = mkOption {
        default = false;
        type = types.bool;
        description = "
          Automatically run the garbage collector at specified dates.
        ";
      };

      dates = mkOption {
        default = "15 03 * * *";
        type = types.string;
        description = "
          Run the garbage collector at specified dates to avoid full
          hard-drives.
        ";
      };

      options = mkOption {
        default = "";
        example = "--max-freed $((64 * 1024**3))";
        type = types.string;
        description = "
          Options given to <filename>nix-collect-garbage</filename> when the
          garbage collector is run automatically.
        ";
      };

    };
  };


  ###### implementation

  config = {

    services.cron.systemCronJobs = mkIf cfg.automatic (singleton
      "${cfg.dates} root ${config.system.build.systemd}/bin/systemctl start nix-gc.service");

    boot.systemd.services."nix-gc" =
      { description = "Nix Garbage Collector";
        path  = [ config.environment.nix ];
        script = "exec nix-collect-garbage ${cfg.options}";
      };

  };

}