From 51c3be2ef9e72a070ece8be760ed49ca145e9fad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Peiffer?= Date: Thu, 6 Mar 2025 10:26:50 +0100 Subject: [PATCH 1/5] add AdGuardHome service --- modules/module-list.nix | 1 + modules/services/adguardhome.nix | 134 +++++++++++++++++++++++++++++++ 2 files changed, 135 insertions(+) create mode 100644 modules/services/adguardhome.nix diff --git a/modules/module-list.nix b/modules/module-list.nix index d01bbdb9..f5645936 100644 --- a/modules/module-list.nix +++ b/modules/module-list.nix @@ -57,6 +57,7 @@ ./power/sleep.nix ./services/activate-system ./services/aerospace + ./services/adguardhome.nix ./services/autossh.nix ./services/buildkite-agents.nix ./services/chunkwm.nix diff --git a/modules/services/adguardhome.nix b/modules/services/adguardhome.nix new file mode 100644 index 00000000..74a4dfa6 --- /dev/null +++ b/modules/services/adguardhome.nix @@ -0,0 +1,134 @@ +{ + config, + lib, + pkgs, + ... +}: + +with lib; + +let + cfg = config.services.adguardhome; + settingsFormat = pkgs.formats.yaml { }; + + settings = + if (cfg.settings != null) then + cfg.settings + // ( + if cfg.settings.schema_version < 23 then + { + bind_host = cfg.host; + bind_port = cfg.port; + } + else + { + http.address = "${cfg.host}:${toString cfg.port}"; + } + ) + else + { }; + + configFile = (settingsFormat.generate "AdGuardHome.yaml" settings).overrideAttrs (_: { + checkPhase = "${cfg.package}/bin/adguardhome -c $out --check-config"; + }); +in +{ + options.services.adguardhome = with lib.types; { + enable = lib.mkEnableOption "AdGuard Home network-wide ad blocker"; + + package = lib.mkOption { + type = package; + default = pkgs.adguardhome; + defaultText = lib.literalExpression "pkgs.adguardhome"; + description = '' + The package that runs adguardhome. + ''; + }; + + host = lib.mkOption { + default = "0.0.0.0"; + type = str; + description = '' + Host address to bind HTTP server to. + ''; + }; + + port = lib.mkOption { + default = 3000; + type = port; + description = '' + Port to serve HTTP pages on. + ''; + }; + + settings = lib.mkOption { + default = null; + type = nullOr (submodule { + freeformType = settingsFormat.type; + options = { + schema_version = lib.mkOption { + default = cfg.package.schema_version; + defaultText = lib.literalExpression "cfg.package.schema_version"; + type = int; + description = '' + Schema version for the configuration. + Defaults to the `schema_version` supplied by `cfg.package`. + ''; + }; + }; + }); + description = '' + AdGuard Home configuration. Refer to + + for details on supported values. + + ::: {.note} + On start and if {option}`mutableSettings` is `true`, + these options are merged into the configuration file on start, taking + precedence over configuration changes made on the web interface. + + Set this to `null` (default) for a non-declarative configuration without any + Nix-supplied values. + Declarative configurations are supplied with a default `schema_version`, and `http.address`. + ::: + ''; + }; + + extraArgs = lib.mkOption { + default = [ ]; + type = listOf str; + description = '' + Extra command line parameters to be passed to the adguardhome binary. + ''; + }; + + logFile = mkOption { + type = types.nullOr types.path; + default = "/var/log/adguardhome.log"; + description = '' + The logfile to use for the AdGuard Home service. Alternatively + {command}`sudo launchctl debug system/org.nixos.adguardhome --stderr` + can be used to stream the logs to a shell after restarting the service with + {command}`sudo launchctl kickstart -k system/org.nixos.adguardhome`. + ''; + }; + }; + + config = mkIf cfg.enable { + launchd.daemons.adguardhome = { + serviceConfig = { + ProgramArguments = [ + "${lib.getExe cfg.package}" + "-c" + "${configFile}" + "--no-check-update" + ] ++ cfg.extraArgs; + + KeepAlive = true; + RunAtLoad = true; + StandardErrorPath = cfg.logFile; + StandardOutPath = cfg.logFile; + }; + }; + }; +} From eef5cb66fb1afe5aedca9dcdf112417f4fac37a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Peiffer?= Date: Thu, 6 Mar 2025 16:54:47 +0100 Subject: [PATCH 2/5] fix: add Label --- modules/services/adguardhome.nix | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/services/adguardhome.nix b/modules/services/adguardhome.nix index 74a4dfa6..968c54fb 100644 --- a/modules/services/adguardhome.nix +++ b/modules/services/adguardhome.nix @@ -117,6 +117,7 @@ in config = mkIf cfg.enable { launchd.daemons.adguardhome = { serviceConfig = { + Label = "AdGuardHome"; ProgramArguments = [ "${lib.getExe cfg.package}" "-c" From 3b08b3de04f9a1631f8aeba15bab7cad84b70ec2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Peiffer?= Date: Thu, 6 Mar 2025 17:00:57 +0100 Subject: [PATCH 3/5] fix: remove Label --- modules/services/adguardhome.nix | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/services/adguardhome.nix b/modules/services/adguardhome.nix index 968c54fb..74a4dfa6 100644 --- a/modules/services/adguardhome.nix +++ b/modules/services/adguardhome.nix @@ -117,7 +117,6 @@ in config = mkIf cfg.enable { launchd.daemons.adguardhome = { serviceConfig = { - Label = "AdGuardHome"; ProgramArguments = [ "${lib.getExe cfg.package}" "-c" From 659cbfd30c6612412670f5643cb1a812a2d2ec95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Peiffer?= Date: Thu, 6 Mar 2025 21:37:57 +0100 Subject: [PATCH 4/5] improve startup resiliency : wait for systems.determinate.nix to mount /nix --- modules/services/adguardhome.nix | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/modules/services/adguardhome.nix b/modules/services/adguardhome.nix index 74a4dfa6..18aa9963 100644 --- a/modules/services/adguardhome.nix +++ b/modules/services/adguardhome.nix @@ -116,14 +116,14 @@ in config = mkIf cfg.enable { launchd.daemons.adguardhome = { + script = '' + # Wait for /nix/store to be mounted + while [ ! -x "${lib.getExe cfg.package}" ]; do + sleep 1 + done + exec ${lib.getExe cfg.package} -c ${configFile} --no-check-update ${builtins.concatStringsSep " " cfg.extraArgs} + ''; serviceConfig = { - ProgramArguments = [ - "${lib.getExe cfg.package}" - "-c" - "${configFile}" - "--no-check-update" - ] ++ cfg.extraArgs; - KeepAlive = true; RunAtLoad = true; StandardErrorPath = cfg.logFile; From a5bb9072ee30959e2b6a6c244f03342896501373 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Peiffer?= Date: Sat, 8 Mar 2025 10:40:27 +0100 Subject: [PATCH 5/5] use command because it uses wait4path --- modules/services/adguardhome.nix | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/modules/services/adguardhome.nix b/modules/services/adguardhome.nix index 18aa9963..ffb1fe96 100644 --- a/modules/services/adguardhome.nix +++ b/modules/services/adguardhome.nix @@ -116,13 +116,7 @@ in config = mkIf cfg.enable { launchd.daemons.adguardhome = { - script = '' - # Wait for /nix/store to be mounted - while [ ! -x "${lib.getExe cfg.package}" ]; do - sleep 1 - done - exec ${lib.getExe cfg.package} -c ${configFile} --no-check-update ${builtins.concatStringsSep " " cfg.extraArgs} - ''; + command = "${lib.getExe cfg.package} -c ${configFile} --no-check-update ${builtins.concatStringsSep " " cfg.extraArgs}"; serviceConfig = { KeepAlive = true; RunAtLoad = true;