commit c60dd90d1f04f58ad631a546e732bd1e706dbdf2 · pyrox.dev/nixpkgs

+69 -51

nixos/modules/services/networking/adguardhome.nix

···

       4
        
       

     

       5
        
       let

     

       6
        
         cfg = config.services.adguardhome;

     

       0
        
       
     

       7
        
       

     

       8
        
         args = concatStringsSep " " ([

     

       9
        
           "--no-check-update"

     
···

       12
        
           "--config /var/lib/AdGuardHome/AdGuardHome.yaml"

     

       13
        
         ] ++ cfg.extraArgs);

     

       14
        
       

     

       15
       -
         configFile = pkgs.writeTextFile {

     

       16
       -
           name = "AdGuardHome.yaml";

     

       17
       -
           text = builtins.toJSON cfg.settings;

     

       18
       -
           checkPhase = "${pkgs.adguardhome}/bin/adguardhome -c $out --check-config";

     

       19
       -
         };

     

       20
       -
         defaultBindPort = 3000;

     

       21
       -
       

     

       22
       -
       in

     

       23
       -
       {

     

       24
       -
       

     

       25
       -
         imports =

     

       26
       -
           let cfgPath = [ "services" "adguardhome" ];

     

       27
       -
           in

     

       28
       -
           [

     

       29
       -
             (mkRenamedOptionModuleWith { sinceRelease = 2211; from = cfgPath ++ [ "host" ]; to = cfgPath ++ [ "settings" "bind_host" ]; })

     

       30
       -
             (mkRenamedOptionModuleWith { sinceRelease = 2211; from = cfgPath ++ [ "port" ]; to = cfgPath ++ [ "settings" "bind_port" ]; })

     

       31
       -
           ];

     

       32
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       33
        
         options.services.adguardhome = with types; {

     

       34
        
           enable = mkEnableOption "AdGuard Home network-wide ad blocker";

     

       35
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       36
        
           openFirewall = mkOption {

     

       37
        
             default = false;

     

       38
        
             type = bool;

     
···

       43
        
           };

     

       44
        
       

     

       45
        
           allowDHCP = mkOption {

     

       46
       -
             default = cfg.settings.dhcp.enabled or false;

     

       47
       -
             defaultText = literalExpression ''config.services.adguardhome.settings.dhcp.enabled or false'';

     

       48
        
             type = bool;

     

       49
        
             description = ''

     

       50
        
               Allows AdGuard Home to open raw sockets (`CAP_NET_RAW`), which is

     
···

       65
        
             '';

     

       66
        
           };

     

       67
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       68
        
           settings = mkOption {

     

       69
        
             default = null;

     

       70
        
             type = nullOr (submodule {

     

       71
       -
               freeformType = (pkgs.formats.yaml { }).type;

     

       72
        
               options = {

     

       73
        
                 schema_version = mkOption {

     

       74
       -
                   default = pkgs.adguardhome.schema_version;

     

       75
       -
                   defaultText = literalExpression "pkgs.adguardhome.schema_version";

     

       76
        
                   type = int;

     

       77
        
                   description = ''

     

       78
        
                     Schema version for the configuration.

     

       79
       -
                     Defaults to the `schema_version` supplied by `pkgs.adguardhome`.

     

       80
       -
                   '';

     

       81
       -
                 };

     

       82
       -
                 bind_host = mkOption {

     

       83
       -
                   default = "0.0.0.0";

     

       84
       -
                   type = str;

     

       85
       -
                   description = ''

     

       86
       -
                     Host address to bind HTTP server to.

     

       87
       -
                   '';

     

       88
       -
                 };

     

       89
       -
                 bind_port = mkOption {

     

       90
       -
                   default = defaultBindPort;

     

       91
       -
                   type = port;

     

       92
       -
                   description = ''

     

       93
       -
                     Port to serve HTTP pages on.

     

       94
        
                   '';

     

       95
        
                 };

     

       96
        
               };

     
···

       107
        
       

     

       108
        
               Set this to `null` (default) for a non-declarative configuration without any

     

       109
        
               Nix-supplied values.

     

       110
       -
               Declarative configurations are supplied with a default `schema_version`, `bind_host`, and `bind_port`.

     

       111
        
               :::

     

       112
        
             '';

     

       113
        
           };

     
···

       124
        
         config = mkIf cfg.enable {

     

       125
        
           assertions = [

     

       126
        
             {

     

       127
       -
               assertion = cfg.settings != null -> cfg.mutableSettings

     

       128
       -
                 || (hasAttrByPath [ "dns" "bind_host" ] cfg.settings)

     

       129
       -
                 || (hasAttrByPath [ "dns" "bind_hosts" ] cfg.settings);

     

       130
       -
               message =

     

       131
       -
                 "AdGuard setting dns.bind_host or dns.bind_hosts needs to be configured for a minimal working configuration";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       132
        
             }

     

       133
        
             {

     

       134
       -
               assertion = cfg.settings != null -> cfg.mutableSettings

     

       135
       -
                 || hasAttrByPath [ "dns" "bootstrap_dns" ] cfg.settings;

     

       136
       -
               message =

     

       137
       -
                 "AdGuard setting dns.bootstrap_dns needs to be configured for a minimal working configuration";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       138
        
             }

     

       139
        
           ];

     

       140
        
       

     
···

       147
        
               StartLimitBurst = 10;

     

       148
        
             };

     

       149
        
       

     

       150
       -
             preStart = optionalString (cfg.settings != null) ''

     

       151
        
               if    [ -e "$STATE_DIRECTORY/AdGuardHome.yaml" ] \

     

       152
        
                  && [ "${toString cfg.mutableSettings}" = "1" ]; then

     

       153
        
                 # Writing directly to AdGuardHome.yaml results in empty file

     
···

       161
        
       

     

       162
        
             serviceConfig = {

     

       163
        
               DynamicUser = true;

     

       164
       -
               ExecStart = "${pkgs.adguardhome}/bin/adguardhome ${args}";

     

       165
       -
               AmbientCapabilities = [ "CAP_NET_BIND_SERVICE" ] ++ optionals cfg.allowDHCP [ "CAP_NET_RAW" ];

     

       0
        
       
     

       166
        
               Restart = "always";

     

       167
        
               RestartSec = 10;

     

       168
        
               RuntimeDirectory = "AdGuardHome";

     
···

       170
        
             };

     

       171
        
           };

     

       172
        
       

     

       173
       -
           networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ cfg.settings.bind_port or defaultBindPort ];

     

       174
        
         };

     

       175
        
       }

···

       4
        
       

     

       5
        
       let

     

       6
        
         cfg = config.services.adguardhome;

     

       7
       +
         settingsFormat = pkgs.formats.yaml { };

     

       8
        
       

     

       9
        
         args = concatStringsSep " " ([

     

       10
        
           "--no-check-update"

     
···

       13
        
           "--config /var/lib/AdGuardHome/AdGuardHome.yaml"

     

       14
        
         ] ++ cfg.extraArgs);

     

       15
        
       

     

       16
       +
         settings = if (cfg.settings != null) then

     

       17
       +
           cfg.settings // (if cfg.settings.schema_version < 23 then {

     

       18
       +
             bind_host = cfg.host;

     

       19
       +
             bind_port = cfg.port;

     

       20
       +
           } else {

     

       21
       +
             http.address = "${cfg.host}:${toString cfg.port}";

     

       22
       +
           })

     

       23
       +
         else

     

       24
       +
           null;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       25
        
       

     

       26
       +
         configFile =

     

       27
       +
           (settingsFormat.generate "AdGuardHome.yaml" settings).overrideAttrs (_: {

     

       28
       +
             checkPhase = "${cfg.package}/bin/adguardhome -c $out --check-config";

     

       29
       +
           });

     

       30
       +
       in {

     

       31
        
         options.services.adguardhome = with types; {

     

       32
        
           enable = mkEnableOption "AdGuard Home network-wide ad blocker";

     

       33
        
       

     

       34
       +
           package = mkOption {

     

       35
       +
             type = package;

     

       36
       +
             default = pkgs.adguardhome;

     

       37
       +
             defaultText = literalExpression "pkgs.adguardhome";

     

       38
       +
             description = ''

     

       39
       +
               The package that runs adguardhome.

     

       40
       +
             '';

     

       41
       +
           };

     

       42
       +
       

     

       43
        
           openFirewall = mkOption {

     

       44
        
             default = false;

     

       45
        
             type = bool;

     
···

       50
        
           };

     

       51
        
       

     

       52
        
           allowDHCP = mkOption {

     

       53
       +
             default = settings.dhcp.enabled or false;

     

       54
       +
             defaultText = literalExpression "config.services.adguardhome.settings.dhcp.enabled or false";

     

       55
        
             type = bool;

     

       56
        
             description = ''

     

       57
        
               Allows AdGuard Home to open raw sockets (`CAP_NET_RAW`), which is

     
···

       72
        
             '';

     

       73
        
           };

     

       74
        
       

     

       75
       +
           host = mkOption {

     

       76
       +
             default = "0.0.0.0";

     

       77
       +
             type = str;

     

       78
       +
             description = ''

     

       79
       +
               Host address to bind HTTP server to.

     

       80
       +
             '';

     

       81
       +
           };

     

       82
       +
       

     

       83
       +
           port = mkOption {

     

       84
       +
             default = 3000;

     

       85
       +
             type = port;

     

       86
       +
             description = ''

     

       87
       +
               Port to serve HTTP pages on.

     

       88
       +
             '';

     

       89
       +
           };

     

       90
       +
       

     

       91
        
           settings = mkOption {

     

       92
        
             default = null;

     

       93
        
             type = nullOr (submodule {

     

       94
       +
               freeformType = settingsFormat.type;

     

       95
        
               options = {

     

       96
        
                 schema_version = mkOption {

     

       97
       +
                   default = cfg.package.schema_version;

     

       98
       +
                   defaultText = literalExpression "cfg.package.schema_version";

     

       99
        
                   type = int;

     

       100
        
                   description = ''

     

       101
        
                     Schema version for the configuration.

     

       102
       +
                     Defaults to the `schema_version` supplied by `cfg.package`.

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       103
        
                   '';

     

       104
        
                 };

     

       105
        
               };

     
···

       116
        
       

     

       117
        
               Set this to `null` (default) for a non-declarative configuration without any

     

       118
        
               Nix-supplied values.

     

       119
       +
               Declarative configurations are supplied with a default `schema_version`, and `http.address`.

     

       120
        
               :::

     

       121
        
             '';

     

       122
        
           };

     
···

       133
        
         config = mkIf cfg.enable {

     

       134
        
           assertions = [

     

       135
        
             {

     

       136
       +
               assertion = cfg.settings != null

     

       137
       +
                 -> !(hasAttrByPath [ "bind_host" ] cfg.settings);

     

       138
       +
               message = "AdGuard option `settings.bind_host' has been superseded by `services.adguardhome.host'";

     

       139
       +
             }

     

       140
       +
             {

     

       141
       +
               assertion = cfg.settings != null

     

       142
       +
                 -> !(hasAttrByPath [ "bind_port" ] cfg.settings);

     

       143
       +
               message = "AdGuard option `settings.bind_host' has been superseded by `services.adguardhome.port'";

     

       144
        
             }

     

       145
        
             {

     

       146
       +
               assertion = settings != null -> cfg.mutableSettings

     

       147
       +
                 || hasAttrByPath [ "dns" "bootstrap_dns" ] settings;

     

       148
       +
               message = "AdGuard setting dns.bootstrap_dns needs to be configured for a minimal working configuration";

     

       149
       +
             }

     

       150
       +
             {

     

       151
       +
               assertion = settings != null -> cfg.mutableSettings

     

       152
       +
                 || hasAttrByPath [ "dns" "bootstrap_dns" ] settings

     

       153
       +
                 && isList settings.dns.bootstrap_dns;

     

       154
       +
               message = "AdGuard setting dns.bootstrap_dns needs to be a list";

     

       155
        
             }

     

       156
        
           ];

     

       157
        
       

     
···

       164
        
               StartLimitBurst = 10;

     

       165
        
             };

     

       166
        
       

     

       167
       +
             preStart = optionalString (settings != null) ''

     

       168
        
               if    [ -e "$STATE_DIRECTORY/AdGuardHome.yaml" ] \

     

       169
        
                  && [ "${toString cfg.mutableSettings}" = "1" ]; then

     

       170
        
                 # Writing directly to AdGuardHome.yaml results in empty file

     
···

       178
        
       

     

       179
        
             serviceConfig = {

     

       180
        
               DynamicUser = true;

     

       181
       +
               ExecStart = "${cfg.package}/bin/adguardhome ${args}";

     

       182
       +
               AmbientCapabilities = [ "CAP_NET_BIND_SERVICE" ]

     

       183
       +
                 ++ optionals cfg.allowDHCP [ "CAP_NET_RAW" ];

     

       184
        
               Restart = "always";

     

       185
        
               RestartSec = 10;

     

       186
        
               RuntimeDirectory = "AdGuardHome";

     
···

       188
        
             };

     

       189
        
           };

     

       190
        
       

     

       191
       +
           networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ cfg.port ];

     

       192
        
         };

     

       193
        
       }

+42 -43

nixos/tests/adguardhome.nix

···

       2
        
         name = "adguardhome";

     

       3
        
       

     

       4
        
         nodes = {

     

       5
       -
           nullConf = { ... }: { services.adguardhome = { enable = true; }; };

     

       6
        
       

     

       7
       -
           emptyConf = { lib, ... }: {

     

       8
        
             services.adguardhome = {

     

       9
        
               enable = true;

     

       0
        
       
     

       0
        
       
     

       10
        
             };

     

       11
        
           };

     

       12
        
       

     

       13
       -
           declarativeConf = { ... }: {

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       14
        
             services.adguardhome = {

     

       15
        
               enable = true;

     

       16
        
       

     

       17
        
               mutableSettings = false;

     

       18
       -
               settings = {

     

       19
       -
                 schema_version = 0;

     

       20
       -
                 dns = {

     

       21
       -
                   bind_host = "0.0.0.0";

     

       22
       -
                   bootstrap_dns = "127.0.0.1";

     

       23
       -
                 };

     

       24
       -
               };

     

       25
        
             };

     

       26
        
           };

     

       27
        
       

     

       28
       -
           mixedConf = { ... }: {

     

       29
        
             services.adguardhome = {

     

       30
        
               enable = true;

     

       31
        
       

     

       32
        
               mutableSettings = true;

     

       33
       -
               settings = {

     

       34
       -
                 schema_version = 0;

     

       35
       -
                 dns = {

     

       36
       -
                   bind_host = "0.0.0.0";

     

       37
       -
                   bootstrap_dns = "127.0.0.1";

     

       38
       -
                 };

     

       39
       -
               };

     

       40
        
             };

     

       41
        
           };

     

       42
        
       

     
···

       70
        
               allowDHCP = true;

     

       71
        
               mutableSettings = false;

     

       72
        
               settings = {

     

       73
       -
                 schema_version = 0;

     

       74
       -
                 dns = {

     

       75
       -
                   bind_host = "0.0.0.0";

     

       76
       -
                   bootstrap_dns = "127.0.0.1";

     

       77
       -
                 };

     

       78
        
                 dhcp = {

     

       79
        
                   # This implicitly enables CAP_NET_RAW

     

       80
        
                   enabled = true;

     
···

       104
        
       

     

       105
        
         testScript = ''

     

       106
        
           with subtest("Minimal (settings = null) config test"):

     

       107
       -
               nullConf.wait_for_unit("adguardhome.service")

     

       0
        
       
     

       108
        
       

     

       109
        
           with subtest("Default config test"):

     

       110
       -
               emptyConf.wait_for_unit("adguardhome.service")

     

       111
       -
               emptyConf.wait_for_open_port(3000)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       112
        
       

     

       113
        
           with subtest("Declarative config test, DNS will be reachable"):

     

       114
       -
               declarativeConf.wait_for_unit("adguardhome.service")

     

       115
       -
               declarativeConf.wait_for_open_port(53)

     

       116
       -
               declarativeConf.wait_for_open_port(3000)

     

       117
        
       

     

       118
        
           with subtest("Mixed config test, check whether merging works"):

     

       119
       -
               mixedConf.wait_for_unit("adguardhome.service")

     

       120
       -
               mixedConf.wait_for_open_port(53)

     

       121
       -
               mixedConf.wait_for_open_port(3000)

     

       122
       -
               # Test whether merging works properly, even if nothing is changed

     

       123
       -
               mixedConf.systemctl("restart adguardhome.service")

     

       124
       -
               mixedConf.wait_for_unit("adguardhome.service")

     

       125
       -
               mixedConf.wait_for_open_port(3000)

     

       126
        
       

     

       127
        
           with subtest("Testing successful DHCP start"):

     

       128
       -
               dhcpConf.wait_for_unit("adguardhome.service")

     

       129
       -
               client.systemctl("start network-online.target")

     

       130
       -
               client.wait_for_unit("network-online.target")

     

       131
       -
               # Test IP assignment via DHCP

     

       132
       -
               dhcpConf.wait_until_succeeds("ping -c 5 10.0.10.100")

     

       133
       -
               # Test hostname resolution over DHCP-provided DNS

     

       134
       -
               dhcpConf.wait_until_succeeds("ping -c 5 client.lan")

     

       135
        
         '';

     

       136
        
       }

···

       2
        
         name = "adguardhome";

     

       3
        
       

     

       4
        
         nodes = {

     

       5
       +
           nullConf = { services.adguardhome.enable = true; };

     

       6
        
       

     

       7
       +
           emptyConf = {

     

       8
        
             services.adguardhome = {

     

       9
        
               enable = true;

     

       10
       +
       

     

       11
       +
               settings = { };

     

       12
        
             };

     

       13
        
           };

     

       14
        
       

     

       15
       +
           schemaVersionBefore23 = {

     

       16
       +
             services.adguardhome = {

     

       17
       +
               enable = true;

     

       18
       +
       

     

       19
       +
               settings.schema_version = 20;

     

       20
       +
             };

     

       21
       +
           };

     

       22
       +
       

     

       23
       +
           declarativeConf = {

     

       24
        
             services.adguardhome = {

     

       25
        
               enable = true;

     

       26
        
       

     

       27
        
               mutableSettings = false;

     

       28
       +
               settings.dns.bootstrap_dns = [ "127.0.0.1" ];

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       29
        
             };

     

       30
        
           };

     

       31
        
       

     

       32
       +
           mixedConf = {

     

       33
        
             services.adguardhome = {

     

       34
        
               enable = true;

     

       35
        
       

     

       36
        
               mutableSettings = true;

     

       37
       +
               settings.dns.bootstrap_dns = [ "127.0.0.1" ];

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       38
        
             };

     

       39
        
           };

     

       40
        
       

     
···

       68
        
               allowDHCP = true;

     

       69
        
               mutableSettings = false;

     

       70
        
               settings = {

     

       71
       +
                 dns.bootstrap_dns = [ "127.0.0.1" ];

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       72
        
                 dhcp = {

     

       73
        
                   # This implicitly enables CAP_NET_RAW

     

       74
        
                   enabled = true;

     
···

       98
        
       

     

       99
        
         testScript = ''

     

       100
        
           with subtest("Minimal (settings = null) config test"):

     

       101
       +
             nullConf.wait_for_unit("adguardhome.service")

     

       102
       +
             nullConf.wait_for_open_port(3000)

     

       103
        
       

     

       104
        
           with subtest("Default config test"):

     

       105
       +
             emptyConf.wait_for_unit("adguardhome.service")

     

       106
       +
             emptyConf.wait_for_open_port(3000)

     

       107
       +
       

     

       108
       +
           with subtest("Default schema_version 23 config test"):

     

       109
       +
             schemaVersionBefore23.wait_for_unit("adguardhome.service")

     

       110
       +
             schemaVersionBefore23.wait_for_open_port(3000)

     

       111
        
       

     

       112
        
           with subtest("Declarative config test, DNS will be reachable"):

     

       113
       +
             declarativeConf.wait_for_unit("adguardhome.service")

     

       114
       +
             declarativeConf.wait_for_open_port(53)

     

       115
       +
             declarativeConf.wait_for_open_port(3000)

     

       116
        
       

     

       117
        
           with subtest("Mixed config test, check whether merging works"):

     

       118
       +
             mixedConf.wait_for_unit("adguardhome.service")

     

       119
       +
             mixedConf.wait_for_open_port(53)

     

       120
       +
             mixedConf.wait_for_open_port(3000)

     

       121
       +
             # Test whether merging works properly, even if nothing is changed

     

       122
       +
             mixedConf.systemctl("restart adguardhome.service")

     

       123
       +
             mixedConf.wait_for_unit("adguardhome.service")

     

       124
       +
             mixedConf.wait_for_open_port(3000)

     

       125
        
       

     

       126
        
           with subtest("Testing successful DHCP start"):

     

       127
       +
             dhcpConf.wait_for_unit("adguardhome.service")

     

       128
       +
             client.systemctl("start network-online.target")

     

       129
       +
             client.wait_for_unit("network-online.target")

     

       130
       +
             # Test IP assignment via DHCP

     

       131
       +
             dhcpConf.wait_until_succeeds("ping -c 5 10.0.10.100")

     

       132
       +
             # Test hostname resolution over DHCP-provided DNS

     

       133
       +
             dhcpConf.wait_until_succeeds("ping -c 5 client.lan")

     

       134
        
         '';

     

       135
        
       }