121 lines
2.9 KiB
Nix
121 lines
2.9 KiB
Nix
|
{ config, lib, pkgs, ... }:
|
||
|
|
|
||
|
|
with lib;
|
||
|
|
|
||
|
|
let
|
||
|
|
cfg = config.nix.gc;
|
||
|
|
|
||
|
|
mkCalendarInterval = frequency:
|
||
|
|
let
|
||
|
|
freq = {
|
||
|
|
"hourly" = [{ Minute = 0; }];
|
||
|
|
"weekly" = [{
|
||
|
|
Weekday = 1;
|
||
|
|
Hour = 0;
|
||
|
|
Minute = 0;
|
||
|
|
}];
|
||
|
|
"monthly" = [{
|
||
|
|
Day = 1;
|
||
|
|
Hour = 0;
|
||
|
|
Minute = 0;
|
||
|
|
}];
|
||
|
|
"semiannually" = [
|
||
|
|
{
|
||
|
|
Month = 1;
|
||
|
|
Day = 1;
|
||
|
|
Hour = 0;
|
||
|
|
Minute = 0;
|
||
|
|
}
|
||
|
|
{
|
||
|
|
Month = 7;
|
||
|
|
Day = 1;
|
||
|
|
Hour = 0;
|
||
|
|
Minute = 0;
|
||
|
|
}
|
||
|
|
];
|
||
|
|
"annually" = [{
|
||
|
|
Month = 1;
|
||
|
|
Day = 1;
|
||
|
|
Hour = 0;
|
||
|
|
Minute = 0;
|
||
|
|
}];
|
||
|
|
};
|
||
|
|
in freq.${frequency};
|
||
|
|
|
||
|
|
nixPackage = if config.nix.enable && config.nix.package != null then
|
||
|
|
config.nix.package
|
||
|
|
else
|
||
|
|
pkgs.nix;
|
||
|
|
in {
|
||
|
|
meta.maintainers = [ maintainers.shivaraj-bh ];
|
||
|
|
|
||
|
|
options = {
|
||
|
|
nix.gc = {
|
||
|
|
automatic = mkOption {
|
||
|
|
type = types.bool;
|
||
|
|
default = false;
|
||
|
|
description = ''
|
||
|
|
Automatically run the garbage collector at a specific time.
|
||
|
|
|
||
|
|
Note: This will only garbage collect the current user's profiles.
|
||
|
|
'';
|
||
|
|
};
|
||
|
|
|
||
|
|
frequency = mkOption {
|
||
|
|
type =
|
||
|
|
types.enum [ "hourly" "weekly" "monthly" "semiannually" "annually" ];
|
||
|
|
default = "weekly";
|
||
|
|
example = "monthly";
|
||
|
|
description = ''
|
||
|
|
The frequency at which to run the garbage collector.
|
||
|
|
|
||
|
|
These enums are based on special expressions from the
|
||
|
|
{manpage}`systemd.time(7)`
|
||
|
|
'';
|
||
|
|
};
|
||
|
|
|
||
|
|
options = mkOption {
|
||
|
|
type = types.nullOr types.str;
|
||
|
|
default = null;
|
||
|
|
example = "--max-freed $((64 * 1024**3))";
|
||
|
|
description = ''
|
||
|
|
Options given to {file}`nix-collect-garbage` when the
|
||
|
|
garbage collector is run automatically.
|
||
|
|
'';
|
||
|
|
};
|
||
|
|
};
|
||
|
|
};
|
||
|
|
|
||
|
|
config = lib.mkIf cfg.automatic (mkMerge [
|
||
|
|
(mkIf pkgs.stdenv.isLinux {
|
||
|
|
systemd.user.services.nix-gc = {
|
||
|
|
Unit = { Description = "Nix Garbage Collector"; };
|
||
|
|
Service = {
|
||
|
|
ExecStart = "${nixPackage}/bin/nix-collect-garbage ${
|
||
|
|
lib.optionalString (cfg.options != null) cfg.options
|
||
|
|
}";
|
||
|
|
};
|
||
|
|
};
|
||
|
|
systemd.user.timers.nix-gc = {
|
||
|
|
Unit = { Description = "Nix Garbage Collector"; };
|
||
|
|
Timer = {
|
||
|
|
OnCalendar = "${cfg.frequency}";
|
||
|
|
Unit = "nix-gc.service";
|
||
|
|
};
|
||
|
|
Install = { WantedBy = [ "timers.target" ]; };
|
||
|
|
};
|
||
|
|
})
|
||
|
|
|
||
|
|
(mkIf pkgs.stdenv.isDarwin {
|
||
|
|
launchd.agents.nix-gc = {
|
||
|
|
enable = true;
|
||
|
|
config = {
|
||
|
|
ProgramArguments = [ "${nixPackage}/bin/nix-collect-garbage" ]
|
||
|
|
++ lib.optional (cfg.options != null) cfg.options;
|
||
|
|
StartCalendarInterval = mkCalendarInterval cfg.frequency;
|
||
|
|
};
|
||
|
|
};
|
||
|
|
})
|
||
|
|
]);
|
||
|
|
}
|