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

modules(pihole-container): extend the description for port configuration on the host

Browse source
This commit is contained in:
Christopher Bacher 2022-10-16 18:38:18 +02:00
parent a1214c99d2
commit 575c4ae0dc
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -16,13 +16,19 @@
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.
Only needs to be specified if he container port should be exposed Only needs to be specified if he container port should be exposed
or if the port-forwarding for this service is enabled. or if the port-forwarding for this service is enabled.
As the pihole container is running rootless this cannot be a privileged port (<1024).
''; '';
}; };
hostPublicPort = 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.
This option can be used to together with the according `forwardPublicToInternal` to expose a pihole subservice on a privileged port,
e.g., if you want to expose the DNS service on port 53.
'';
default = publicDefaultPort; default = publicDefaultPort;
}; };
@ -31,6 +37,8 @@
description = '' 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.
Use this option together with the according `hostPublicPort` to expose a pihole subservice on a privileged port.
''; '';
default = false; default = false;
}; };