diff options
Diffstat (limited to 'nixos/modules/services/networking/nsd.nix')
| -rw-r--r-- | nixos/modules/services/networking/nsd.nix | 122 |
1 files changed, 61 insertions, 61 deletions
diff --git a/nixos/modules/services/networking/nsd.nix b/nixos/modules/services/networking/nsd.nix index a51fc534534..1102fc85d40 100644 --- a/nixos/modules/services/networking/nsd.nix +++ b/nixos/modules/services/networking/nsd.nix @@ -201,7 +201,7 @@ let allowAXFRFallback = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' If NSD as secondary server should be allowed to AXFR if the primary server does not allow IXFR. ''; @@ -243,7 +243,7 @@ let # to default values, breaking the parent inheriting function. type = types.attrsOf types.anything; default = {}; - description = '' + description = lib.mdDoc '' Children zones inherit all options of their parents. Attributes defined in a child will overwrite the ones of its parent. Only leaf zones will be actually served. This way it's possible to @@ -256,7 +256,7 @@ let data = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' The actual zone data. This is the content of your zone file. Use imports or pkgs.lib.readFile if you don't want this data in your config file. ''; @@ -268,17 +268,17 @@ let algorithm = mkOption { type = types.str; default = "RSASHA256"; - description = "Which algorithm to use for DNSSEC"; + description = lib.mdDoc "Which algorithm to use for DNSSEC"; }; keyttl = mkOption { type = types.str; default = "1h"; - description = "TTL for dnssec records"; + description = lib.mdDoc "TTL for dnssec records"; }; coverage = mkOption { type = types.str; default = "1y"; - description = '' + description = lib.mdDoc '' The length of time to ensure that keys will be correct; no action will be taken to create new keys to be activated after this time. ''; }; @@ -289,7 +289,7 @@ let postPublish = "1w"; rollPeriod = "1mo"; }; - description = "Key policy for zone signing keys"; + description = lib.mdDoc "Key policy for zone signing keys"; }; ksk = mkOption { type = keyPolicy; @@ -298,14 +298,14 @@ let postPublish = "1mo"; rollPeriod = "0"; }; - description = "Key policy for key signing keys"; + description = lib.mdDoc "Key policy for key signing keys"; }; }; maxRefreshSecs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Limit refresh time for secondary zones. This is the timer which checks to see if the zone has to be refetched when it expires. Normally the value from the SOA record is used, but this option @@ -316,7 +316,7 @@ let minRefreshSecs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Limit refresh time for secondary zones. ''; }; @@ -324,7 +324,7 @@ let maxRetrySecs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Limit retry time for secondary zones. This is the timeout after a failed fetch attempt for the zone. Normally the value from the SOA record is used, but this option restricts that value. @@ -334,7 +334,7 @@ let minRetrySecs = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Limit retry time for secondary zones. ''; }; @@ -362,7 +362,7 @@ let notifyRetry = mkOption { type = types.int; default = 5; - description = '' + description = lib.mdDoc '' Specifies the number of retries for failed notifies. Set this along with notify. ''; }; @@ -371,7 +371,7 @@ let type = types.nullOr types.str; default = null; example = "2000::1@1234"; - description = '' + description = lib.mdDoc '' This address will be used for zone-transfere requests if configured as a secondary server or notifications in case of a primary server. Supply either a plain IPv4 or IPv6 address with an optional port @@ -400,7 +400,7 @@ let rrlWhitelist = mkOption { type = with types; listOf (enum [ "nxdomain" "error" "referral" "any" "rrsig" "wildcard" "nodata" "dnskey" "positive" "all" ]); default = []; - description = '' + description = lib.mdDoc '' Whitelists the given rrl-types. ''; }; @@ -409,7 +409,7 @@ let type = types.nullOr types.str; default = null; example = "%s"; - description = '' + description = lib.mdDoc '' When set to something distinct to null NSD is able to collect statistics per zone. All statistics of this zone(s) will be added to the group specified by this given name. Use "%s" to use the zones @@ -424,19 +424,19 @@ let options = { keySize = mkOption { type = types.int; - description = "Key size in bits"; + description = lib.mdDoc "Key size in bits"; }; prePublish = mkOption { type = types.str; - description = "How long in advance to publish new keys"; + description = lib.mdDoc "How long in advance to publish new keys"; }; postPublish = mkOption { type = types.str; - description = "How long after deactivation to keep a key in the zone"; + description = lib.mdDoc "How long after deactivation to keep a key in the zone"; }; rollPeriod = mkOption { type = types.str; - description = "How frequently to change keys"; + description = lib.mdDoc "How frequently to change keys"; }; }; }; @@ -486,7 +486,7 @@ in dnssecInterval = mkOption { type = types.str; default = "1h"; - description = '' + description = lib.mdDoc '' How often to check whether dnssec key rollover is required ''; }; @@ -494,7 +494,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra nsd config. ''; }; @@ -502,7 +502,7 @@ in hideVersion = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether NSD should answer VERSION.BIND and VERSION.SERVER CHAOS class queries. ''; }; @@ -510,7 +510,7 @@ in identity = mkOption { type = types.str; default = "unidentified server"; - description = '' + description = lib.mdDoc '' Identify the server (CH TXT ID.SERVER entry). ''; }; @@ -518,7 +518,7 @@ in interfaces = mkOption { type = types.listOf types.str; default = [ "127.0.0.0" "::1" ]; - description = '' + description = lib.mdDoc '' What addresses the server should listen to. ''; }; @@ -526,7 +526,7 @@ in ipFreebind = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to bind to nonlocal addresses and interfaces that are down. Similar to ip-transparent. ''; @@ -535,7 +535,7 @@ in ipTransparent = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Allow binding to non local addresses. ''; }; @@ -543,7 +543,7 @@ in ipv4 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to listen on IPv4 connections. ''; }; @@ -551,7 +551,7 @@ in ipv4EDNSSize = mkOption { type = types.int; default = 4096; - description = '' + description = lib.mdDoc '' Preferred EDNS buffer size for IPv4. ''; }; @@ -559,7 +559,7 @@ in ipv6 = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to listen on IPv6 connections. ''; }; @@ -567,7 +567,7 @@ in ipv6EDNSSize = mkOption { type = types.int; default = 4096; - description = '' + description = lib.mdDoc '' Preferred EDNS buffer size for IPv6. ''; }; @@ -575,7 +575,7 @@ in logTimeAscii = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Log time in ascii, if false then in unix epoch seconds. ''; }; @@ -583,7 +583,7 @@ in nsid = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' NSID identity (hex string, or "ascii_somestring"). ''; }; @@ -591,7 +591,7 @@ in port = mkOption { type = types.int; default = 53; - description = '' + description = lib.mdDoc '' Port the service should bind do. ''; }; @@ -600,7 +600,7 @@ in type = types.bool; default = pkgs.stdenv.isLinux; defaultText = literalExpression "pkgs.stdenv.isLinux"; - description = '' + description = lib.mdDoc '' Whether to enable SO_REUSEPORT on all used sockets. This lets multiple processes bind to the same port. This speeds up operation especially if the server count is greater than one and makes fast restarts less @@ -611,7 +611,7 @@ in rootServer = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether this server will be a root server (a DNS root server, you usually don't want that). ''; @@ -622,7 +622,7 @@ in serverCount = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' Number of NSD servers to fork. Put the number of CPUs to use here. ''; }; @@ -630,7 +630,7 @@ in statistics = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Statistics are produced every number of seconds. Prints to log. If null no statistics are logged. ''; @@ -639,7 +639,7 @@ in tcpCount = mkOption { type = types.int; default = 100; - description = '' + description = lib.mdDoc '' Maximum number of concurrent TCP connections per server. ''; }; @@ -647,7 +647,7 @@ in tcpQueryCount = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Maximum number of queries served on a single TCP connection. 0 means no maximum. ''; @@ -656,7 +656,7 @@ in tcpTimeout = mkOption { type = types.int; default = 120; - description = '' + description = lib.mdDoc '' TCP timeout in seconds. ''; }; @@ -664,7 +664,7 @@ in verbosity = mkOption { type = types.int; default = 0; - description = '' + description = lib.mdDoc '' Verbosity level. ''; }; @@ -672,7 +672,7 @@ in version = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The version string replied for CH TXT version.server and version.bind queries. Will use the compiled package version on null. See hideVersion for enabling/disabling this responses. @@ -682,7 +682,7 @@ in xfrdReloadTimeout = mkOption { type = types.int; default = 1; - description = '' + description = lib.mdDoc '' Number of seconds between reloads triggered by xfrd. ''; }; @@ -690,7 +690,7 @@ in zonefilesCheck = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to check mtime of all zone files on start and sighup. ''; }; @@ -703,14 +703,14 @@ in algorithm = mkOption { type = types.str; default = "hmac-sha256"; - description = '' + description = lib.mdDoc '' Authentication algorithm for this key. ''; }; keyFile = mkOption { type = types.path; - description = '' + description = lib.mdDoc '' Path to the file which contains the actual base64 encoded key. The key will be copied into "${stateDir}/private" before NSD starts. The copied file is only accessibly by the NSD @@ -728,7 +728,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Define your TSIG keys here. ''; }; @@ -741,7 +741,7 @@ in ipv4PrefixLength = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' IPv4 prefix length. Addresses are grouped by netblock. ''; }; @@ -749,7 +749,7 @@ in ipv6PrefixLength = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' IPv6 prefix length. Addresses are grouped by netblock. ''; }; @@ -757,7 +757,7 @@ in ratelimit = mkOption { type = types.int; default = 200; - description = '' + description = lib.mdDoc '' Max qps allowed from any query source. 0 means unlimited. With an verbosity of 2 blocked and unblocked subnets will be logged. @@ -767,7 +767,7 @@ in slip = mkOption { type = types.nullOr types.int; default = null; - description = '' + description = lib.mdDoc '' Number of packets that get discarded before replying a SLIP response. 0 disables SLIP responses. 1 will make every response a SLIP response. ''; @@ -776,7 +776,7 @@ in size = mkOption { type = types.int; default = 1000000; - description = '' + description = lib.mdDoc '' Size of the hashtable. More buckets use more memory but lower the chance of hash hash collisions. ''; @@ -785,7 +785,7 @@ in whitelistRatelimit = mkOption { type = types.int; default = 2000; - description = '' + description = lib.mdDoc '' Max qps allowed from whitelisted sources. 0 means unlimited. Set the rrl-whitelist option for specific queries to apply this limit instead of the default to them. @@ -802,7 +802,7 @@ in controlCertFile = mkOption { type = types.path; default = "/etc/nsd/nsd_control.pem"; - description = '' + description = lib.mdDoc '' Path to the client certificate signed with the server certificate. This file is used by nsd-control and generated by nsd-control-setup. ''; @@ -811,7 +811,7 @@ in controlKeyFile = mkOption { type = types.path; default = "/etc/nsd/nsd_control.key"; - description = '' + description = lib.mdDoc '' Path to the client private key, which is used by nsd-control but not by the server. This file is generated by nsd-control-setup. ''; @@ -820,7 +820,7 @@ in interfaces = mkOption { type = types.listOf types.str; default = [ "127.0.0.1" "::1" ]; - description = '' + description = lib.mdDoc '' Which interfaces NSD should bind to for remote control. ''; }; @@ -828,7 +828,7 @@ in port = mkOption { type = types.int; default = 8952; - description = '' + description = lib.mdDoc '' Port number for remote control operations (uses TLS over TCP). ''; }; @@ -836,7 +836,7 @@ in serverCertFile = mkOption { type = types.path; default = "/etc/nsd/nsd_server.pem"; - description = '' + description = lib.mdDoc '' Path to the server self signed certificate, which is used by the server but and by nsd-control. This file is generated by nsd-control-setup. ''; @@ -845,7 +845,7 @@ in serverKeyFile = mkOption { type = types.path; default = "/etc/nsd/nsd_server.key"; - description = '' + description = lib.mdDoc '' Path to the server private key, which is used by the server but not by nsd-control. This file is generated by nsd-control-setup. ''; @@ -887,7 +887,7 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Define your zones here. Zones can cascade other zones and therefore inherit settings from parent zones. Look at the definition of children to learn about inheritance and child zones. |