nixpkgs/modules/services/misc/nix-gc.nix
2013-03-28 13:35:07 +01:00

69 lines
1.4 KiB
Nix

{ 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 a specific time.";
};
dates = mkOption {
default = "03:15";
type = types.uniq types.string;
description = ''
Specification (in the format described by
<citerefentry><refentrytitle>systemd.time</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>) of the time at
which the garbage collector will run.
'';
};
options = mkOption {
default = "";
example = "--max-freed $((64 * 1024**3))";
type = types.uniq types.string;
description = ''
Options given to <filename>nix-collect-garbage</filename> when the
garbage collector is run automatically.
'';
};
};
};
###### implementation
config = mkMerge [
{ systemd.services.nix-gc =
{ description = "Nix Garbage Collector";
path = [ config.environment.nix ];
script = "exec nix-collect-garbage ${cfg.options}";
};
}
(mkIf cfg.automatic {
systemd.timers.nix-gc =
{ wantedBy = [ "timers.target" ];
timerConfig.OnCalendar = cfg.dates;
};
})
];
}