noe/pihole-flake
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

module(pihole-container): improve the module's options by adding better defaults and the environment variable names which are controlled by the options

Browse source
This commit is contained in:
Christopher Bacher 2022-10-14 01:33:19 +02:00
parent 1f8b3f5d1a
commit c1ab2461ac
2 changed files with 73 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
flake.nix
View file

@ -35,7 +35,7 @@
default = piholeImage; default = piholeImage;
}; };
nixosModules.default = (import ./modules/pihole-container.factory.nix) { piholeFlake = self; }; nixosModules.default = (import ./modules/pihole-container.factory.nix) { piholeFlake = self; inherit util; };
devShells.default = let devShells.default = let
updatePiholeImageInfoScript = pkgs.writeShellScriptBin "update-pihole-image-info" '' updatePiholeImageInfoScript = pkgs.writeShellScriptBin "update-pihole-image-info" ''

107
modules/pihole-container.factory.nix
View file

@ -1,8 +1,16 @@
{ piholeFlake }: { config, pkgs, lib, ... }: with lib; let { piholeFlake, util }: { config, pkgs, lib, ... }: with lib; with builtins; let
inherit (util) collectAttrFragments accessValueOfFragment;
cfg = config.services.pihole; cfg = config.services.pihole;
systemTimeZone = config.time.timeZone;
defaultPiholeVolumesDir = "${config.users.users.${cfg.hostConfig.user}.home}/pihole-volumes";
mkContainerEnvOption = { envVar, ... }@optionAttrs:
(mkOption (removeAttrs optionAttrs [ "envVar" ]))
// { inherit envVar; };
mkHostPortsOption = { service, publicDefaultPort }: { mkHostPortsOption = { service, publicDefaultPort }: {
host-internal-port = mkOption { hostInternalPort = mkOption {
type = types.port; type = types.port;
description = '' description = ''
The internal port on the host on which the ${service} port of the pihole container should be exposed. The internal port on the host on which the ${service} port of the pihole container should be exposed.
@ -11,16 +19,16 @@
''; '';
}; };
host-public-port = mkOption { hostPublicPort = mkOption {
type = types.port; type = types.port;
description = description =
"The public port on the host on which the ${service} port of the pihole container should be forwared to."; "The public port on the host on which the ${service} port of the pihole container should be forwared to.";
default = publicDefaultPort; default = publicDefaultPort;
}; };
forward-public-to-internal = mkOption { forwardPublicToInternal = mkOption {
type = types.bool; type = types.bool;
descripton = '' description = ''
Enable port-forwarding between the public & the internal port of the host. Enable port-forwarding between the public & the internal port of the host.
This effectively makes pihole's ${service} port available on the network to which the host is connected to. This effectively makes pihole's ${service} port available on the network to which the host is connected to.
''; '';
@ -28,7 +36,7 @@
}; };
}; };
in { in rec {
options = { options = {
services.pihole = { services.pihole = {
enable = mkEnableOption "PiHole as a rootless podman container"; enable = mkEnableOption "PiHole as a rootless podman container";
@ -42,14 +50,21 @@ in {
''; '';
}; };
persistVolumes = mkOption {
type = types.bool;
description = "Whether to use podman volumes to persist pihole's ad-hoc configuration across restarts.";
default = false;
};
volumesPath = mkOption { volumesPath = mkOption {
type = types.path; type = types.str;
description = '' description = ''
The path where the persistent data of the pihole container should be stored. The path where the persistent data of the pihole container should be stored.
The different used volumes are created automatically. The different used volumes are created automatically.
Needs to be writable by the user running the pihole container. Needs to be writable by the user running the pihole container.
''; '';
example = /home/pihole-user/pihole-volumes; default = defaultPiholeVolumesDir;
example = "/home/pihole-user/pihole-volumes";
}; };
dns = mkHostPortsOption { dns = mkHostPortsOption {
@ -70,44 +85,49 @@ in {
piholeConfiguration = { piholeConfiguration = {
tz = mkOption { tz = mkContainerEnvOption {
type = types.str; type = types.str;
description = "Set your timezone to make sure logs rotate at local midnight instead of at UTC midnight."; description = "Set your timezone to make sure logs rotate at local midnight instead of at UTC midnight.";
default = config.time.timeZone; default = systemTimeZone;
envVar = "TZ";
}; };
web = { web = {
password = mkOption { password = mkContainerEnvOption {
type = with types; nullOr str; type = with types; nullOr str;
description = '' description = ''
The password for the pihole admin interface. The password for the pihole admin interface.
If not given a random password will be generated an can be retrieved from the service logs. If not given a random password will be generated an can be retrieved from the service logs.
''; '';
default = null; default = null;
envVar = "WEBPASSWORD";
}; };
# password-file # TODO password-file
virtual-host = mkOption { virtualHost = mkContainerEnvOption {
type = type.str; type = types.str;
description = "What your web server 'virtual host' is, accessing admin through this Hostname/IP allows you to make changes to the whitelist/blacklists in addition to the default 'http://pi.hole/admin/' address"; description = "What your web server 'virtual host' is, accessing admin through this Hostname/IP allows you to make changes to the whitelist/blacklists in addition to the default 'http://pi.hole/admin/' address";
envVar = "VIRTUAL_HOST";
}; };
layout = mkOption { layout = mkContainerEnvOption {
type = types.enum [ "boxed" "traditional" ]; type = types.enum [ "boxed" "traditional" ];
description = "Use boxed layout (helpful when working on large screens)"; description = "Use boxed layout (helpful when working on large screens)";
default = "boxed"; default = "boxed";
envVar = "WEBUIBOXEDLAYOUT";
}; };
theme = mkOption { theme = mkContainerEnvOption {
type = types.enum [ "default-dark" "default-darker" "default-light" "default-auto" "lcars" ]; type = types.enum [ "default-dark" "default-darker" "default-light" "default-auto" "lcars" ];
description = "User interface theme to use."; description = "User interface theme to use.";
default = "default-light"; default = "default-light";
envVar = "WEBTHEME";
}; };
}; };
dns = { dns = {
upstreamServers = mkOption { upstreamServers = mkContainerEnvOption {
type = with types; nullOr (listOf str); type = with types; nullOr (listOf str);
description = '' description = ''
Upstream DNS server(s) for Pi-hole to forward queries to. Upstream DNS server(s) for Pi-hole to forward queries to.
@ -118,120 +138,137 @@ in {
Upstream DNS added via the web interface will be overwritten on container restart/recreation. Upstream DNS added via the web interface will be overwritten on container restart/recreation.
''; '';
default = null; default = null;
envVar = "PIHOLE_DNS_";
}; };
dnssec = mkOption { dnssec = mkContainerEnvOption {
type = types.bool; type = types.bool;
description = "Enable DNSSEC support"; description = "Enable DNSSEC support";
default = false; default = false;
envVar = "DNSSEC";
}; };
bogusPriv = mkOption { bogusPriv = mkContainerEnvOption {
type = types.bool; type = types.bool;
description = "Never forward reverse lookups for private ranges."; description = "Never forward reverse lookups for private ranges.";
default = true; default = true;
envVar = "DNS_BOGUS_PRIV";
}; };
fqdnRequired = mkOption { fqdnRequired = mkContainerEnvOption {
type = types.bool; type = types.bool;
description = "Never forward non-FQDNs."; description = "Never forward non-FQDNs.";
default = true; default = true;
envVar = "DNS_FQDN_REQUIRED";
}; };
}; };
revServer = { revServer = {
enable = mkOption { enable = mkContainerEnvOption {
type = types.bool; type = types.bool;
description = "Enable DNS conditional forwarding for device name resolution."; description = "Enable DNS conditional forwarding for device name resolution.";
default = false; default = false;
envVar = "REV_SERVER";
}; };
domain = mkOption { domain = mkContainerEnvOption {
type = with types; nullOr str; type = with types; nullOr str;
description = "If conditional forwarding is enabled, set the domain of the local network router."; description = "If conditional forwarding is enabled, set the domain of the local network router.";
default = null; default = null;
envVar = "REV_SERVER_DOMAIN";
}; };
target = mkOption { target = mkContainerEnvOption {
type = with types; nullOr str; type = with types; nullOr str;
description = "If conditional forwarding is enabled, set the IP of the local network router."; description = "If conditional forwarding is enabled, set the IP of the local network router.";
default = null; default = null;
envVar = "REV_SERVER_TARGET";
}; };
cidr = mkOption { cidr = mkContainerEnvOption {
type = with types; nullOr str; type = with types; nullOr str;
description = "If conditional forwarding is enabled, set the reverse DNS zone (e.g. 192.168.0.0/24)"; description = "If conditional forwarding is enabled, set the reverse DNS zone (e.g. 192.168.0.0/24)";
default = null; default = null;
envVar = "REV_SERVER_CIDR";
}; };
}; };
dhcp = { dhcp = {
enable = mkOption { enable = mkContainerEnvOption {
type = types.bool; type = types.bool;
description = '' description = ''
Enable DHCP server. Enable DHCP server.
Static DHCP leases can be configured with a custom /etc/dnsmasq.d/04-pihole-static-dhcp.conf Static DHCP leases can be configured with a custom /etc/dnsmasq.d/04-pihole-static-dhcp.conf
''; '';
default = false; default = false;
envVar = "DHCP_ACTIVE";
}; };
start = mkContainerEnvOption {
start = mkOption {
type = with types; nullOr str; type = with types; nullOr str;
description = "Start of the range of IP addresses to hand out by the DHCP server (mandatory if DHCP server is enabled)."; description = "Start of the range of IP addresses to hand out by the DHCP server (mandatory if DHCP server is enabled).";
default = null; default = null;
example = "192.168.0.10"; example = "192.168.0.10";
envVar = "DHCP_START";
}; };
end = mkOption { end = mkContainerEnvOption {
type = with types; nullOr str; type = with types; nullOr str;
description = "End of the range of IP addresses to hand out by the DHCP server (mandatory if DHCP server is enabled)."; description = "End of the range of IP addresses to hand out by the DHCP server (mandatory if DHCP server is enabled).";
default = null; default = null;
example = "192.168.0.20"; example = "192.168.0.20";
envVar = "DHCP_END";
}; };
router = mkOption { router = mkContainerEnvOption {
type = with types; nullOr str; type = with types; nullOr str;
description = "Router (gateway) IP address sent by the DHCP server (mandatory if DHCP server is enabled)."; description = "Router (gateway) IP address sent by the DHCP server (mandatory if DHCP server is enabled).";
default = null; default = null;
example = "192.168.0.1"; example = "192.168.0.1";
envVar = "DHCP_ROUTER";
}; };
leasetime = mkOption { leasetime = mkContainerEnvOption {
type = types.int; type = types.int;
description = "DHCP lease time in hours."; description = "DHCP lease time in hours.";
default = 24; default = 24;
envVar = "DHCP_LEASETIME";
}; };
domain = mkOption { domain = mkContainerEnvOption {
type = types.str; type = types.str;
description = "Domain name sent by the DHCP server."; description = "Domain name sent by the DHCP server.";
default = "lan"; default = "lan";
envVar = "PIHOLE_DOMAIN";
}; };
ipv6 = mkOption { ipv6 = mkContainerEnvOption {
type = types.bool; type = types.bool;
description = "Enable DHCP server IPv6 support (SLAAC + RA)."; description = "Enable DHCP server IPv6 support (SLAAC + RA).";
default = false; default = false;
envVar = "DHCP_IPv6";
}; };
rapid-commit = mkOption { rapid-commit = mkContainerEnvOption {
type = types.bool; type = types.bool;
description = "Enable DHCPv4 rapid commit (fast address assignment)."; description = "Enable DHCPv4 rapid commit (fast address assignment).";
default = false; default = false;
envVar = "DHCP_rapid_commit";
}; };
}; };
queryLogging = mkOption { queryLogging = mkContainerEnvOption {
type = types.bool; type = types.bool;
description = "Enable query logging or not."; description = "Enable query logging or not.";
default = true; default = true;
envVar = "QUERY_LOGGING";
}; };
temperatureUnit = mkOption { temperatureUnit = mkContainerEnvOption {
type = types.enum [ "c" "k" "f" ]; type = types.enum [ "c" "k" "f" ];
description = "Set preferred temperature unit to c: Celsius, k: Kelvin, or f Fahrenheit units."; description = "Set preferred temperature unit to c: Celsius, k: Kelvin, or f Fahrenheit units.";
default = "c"; default = "c";
envVar = "TEMPERATUREUNIT";
}; };
}; };
}; };