aboutsummaryrefslogtreecommitdiff
path: root/nixpkgs/nixos/modules/services/misc/nix-gc.nix
diff options
context:
space:
mode:
Diffstat (limited to 'nixpkgs/nixos/modules/services/misc/nix-gc.nix')
-rw-r--r--nixpkgs/nixos/modules/services/misc/nix-gc.nix61
1 files changed, 61 insertions, 0 deletions
diff --git a/nixpkgs/nixos/modules/services/misc/nix-gc.nix b/nixpkgs/nixos/modules/services/misc/nix-gc.nix
new file mode 100644
index 00000000000..12bed05757a
--- /dev/null
+++ b/nixpkgs/nixos/modules/services/misc/nix-gc.nix
@@ -0,0 +1,61 @@
+{ config, lib, ... }:
+
+with 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.str;
+ description = ''
+ Specification (in the format described by
+ <citerefentry><refentrytitle>systemd.time</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry>) of the time at
+ which the garbage collector will run.
+ '';
+ };
+
+ options = mkOption {
+ default = "";
+ example = "--max-freed $((64 * 1024**3))";
+ type = types.str;
+ 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";
+ script = "exec ${config.nix.package.out}/bin/nix-collect-garbage ${cfg.options}";
+ startAt = optional cfg.automatic cfg.dates;
+ };
+
+ };
+
+}