nixpkgs/modules/services/misc/nix-gc.nix
Eelco Dolstra 36079454e5 Make it easier to define timer units for services
Systemd services now have a startAt attribute.  If set, NixOS will
automatically emit a timer unit that causes the service to start at
the specified time.  For example:

  systemd.services.foo =
    { script = "... bla bla ...";
      startAt = "02:15";
    };

causes the given script to be started at 02:15 every day.
2013-10-09 14:28:35 +02:00

62 lines
1.3 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 = {
systemd.services.nix-gc =
{ description = "Nix Garbage Collector";
serviceConfig.ExecStart = "${config.environment.nix}/bin/nix-collect-garbage ${cfg.options}";
startAt = optionalString cfg.automatic cfg.dates;
};
};
}