diff options
Diffstat (limited to 'nixos/modules/services/networking')
| -rw-r--r-- | nixos/modules/services/networking/bind.nix | 18 | ||||
| -rw-r--r-- | nixos/modules/services/networking/create_ap.nix | 6 | ||||
| -rw-r--r-- | nixos/modules/services/networking/firefox-syncserver.nix | 46 | ||||
| -rw-r--r-- | nixos/modules/services/networking/ghostunnel.nix | 6 | ||||
| -rw-r--r-- | nixos/modules/services/networking/hylafax/options.nix | 4 | ||||
| -rw-r--r-- | nixos/modules/services/networking/ircd-hybrid/default.nix | 16 | ||||
| -rw-r--r-- | nixos/modules/services/networking/kresd.nix | 2 | ||||
| -rw-r--r-- | nixos/modules/services/networking/mxisd.nix | 4 | ||||
| -rw-r--r-- | nixos/modules/services/networking/resilio.nix | 16 | ||||
| -rw-r--r-- | nixos/modules/services/networking/v2ray.nix | 6 | ||||
| -rw-r--r-- | nixos/modules/services/networking/yggdrasil.nix | 16 |
11 files changed, 70 insertions, 70 deletions
diff --git a/nixos/modules/services/networking/bind.nix b/nixos/modules/services/networking/bind.nix index aaa1cc2f1000..630d1b20733b 100644 --- a/nixos/modules/services/networking/bind.nix +++ b/nixos/modules/services/networking/bind.nix @@ -129,7 +129,7 @@ in blockedNetworks = mkOption { default = [ ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' What networks are just blocked. ''; }; @@ -137,7 +137,7 @@ in ipv4Only = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Only use ipv4, even if the host supports ipv6. ''; }; @@ -146,7 +146,7 @@ in default = config.networking.nameservers; defaultText = literalExpression "config.networking.nameservers"; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of servers we should forward requests to. ''; }; @@ -154,7 +154,7 @@ in forward = mkOption { default = "first"; type = types.enum ["first" "only"]; - description = '' + description = lib.mdDoc '' Whether to forward 'first' (try forwarding but lookup directly if forwarding fails) or 'only'. ''; }; @@ -162,7 +162,7 @@ in listenOn = mkOption { default = [ "any" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Interfaces to listen on. ''; }; @@ -170,7 +170,7 @@ in listenOnIpv6 = mkOption { default = [ "any" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Ipv6 interfaces to listen on. ''; }; @@ -184,7 +184,7 @@ in zones = mkOption { default = [ ]; type = with types; coercedTo (listOf attrs) bindZoneCoerce (attrsOf (types.submodule bindZoneOptions)); - description = '' + description = lib.mdDoc '' List of zones we claim authority over. ''; example = { @@ -201,7 +201,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra lines to be added verbatim to the generated named configuration file. ''; }; @@ -219,7 +219,7 @@ in type = types.path; default = confFile; defaultText = literalExpression "confFile"; - description = '' + description = lib.mdDoc '' Overridable config file to use for named. By default, that generated by nixos. ''; diff --git a/nixos/modules/services/networking/create_ap.nix b/nixos/modules/services/networking/create_ap.nix index 258ce9501a54..2fcf9b8a5419 100644 --- a/nixos/modules/services/networking/create_ap.nix +++ b/nixos/modules/services/networking/create_ap.nix @@ -12,9 +12,9 @@ in { settings = mkOption { type = with types; attrsOf (oneOf [ int bool str ]); default = {}; - description = '' - Configuration for <literal>create_ap</literal>. - See <link xlink:href="https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf">upstream example configuration</link> + description = lib.mdDoc '' + Configuration for `create_ap`. + See [upstream example configuration](https://raw.githubusercontent.com/lakinduakash/linux-wifi-hotspot/master/src/scripts/create_ap.conf) for supported values. ''; example = { diff --git a/nixos/modules/services/networking/firefox-syncserver.nix b/nixos/modules/services/networking/firefox-syncserver.nix index 254d5c1dc670..2944124b1043 100644 --- a/nixos/modules/services/networking/firefox-syncserver.nix +++ b/nixos/modules/services/networking/firefox-syncserver.nix @@ -55,7 +55,7 @@ in type = lib.types.package; default = pkgs.syncstorage-rs; defaultText = lib.literalExpression "pkgs.syncstorage-rs"; - description = '' + description = lib.mdDoc '' Package to use. ''; }; @@ -66,16 +66,16 @@ in # behavior ever change. type = lib.types.strMatching "[a-z_][a-z0-9_]*"; default = defaultDatabase; - description = '' + description = lib.mdDoc '' Database to use for storage. Will be created automatically if it does not exist - and <literal>config.${opt.database.createLocally}</literal> is set. + and `config.${opt.database.createLocally}` is set. ''; }; database.user = lib.mkOption { type = lib.types.str; default = defaultUser; - description = '' + description = lib.mdDoc '' Username for database connections. ''; }; @@ -83,8 +83,8 @@ in database.host = lib.mkOption { type = lib.types.str; default = "localhost"; - description = '' - Database host name. <literal>localhost</literal> is treated specially and inserts + description = lib.mdDoc '' + Database host name. `localhost` is treated specially and inserts systemd dependencies, other hostnames or IP addresses of the local machine do not. ''; }; @@ -92,7 +92,7 @@ in database.createLocally = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to create database and user on the local machine if they do not exist. This includes enabling unix domain socket authentication for the configured user. ''; @@ -101,19 +101,19 @@ in logLevel = lib.mkOption { type = lib.types.str; default = "error"; - description = '' - Log level to run with. This can be a simple log level like <literal>error</literal> - or <literal>trace</literal>, or a more complicated logging expression. + description = lib.mdDoc '' + Log level to run with. This can be a simple log level like `error` + or `trace`, or a more complicated logging expression. ''; }; secrets = lib.mkOption { type = lib.types.path; - description = '' + description = lib.mdDoc '' A file containing the various secrets. Should be in the format expected by systemd's - <literal>EnvironmentFile</literal> directory. Two secrets are currently available: - <literal>SYNC_MASTER_SECRET</literal> and - <literal>SYNC_TOKENSERVER__FXA_METRICS_HASH_SECRET</literal>. + `EnvironmentFile` directory. Two secrets are currently available: + `SYNC_MASTER_SECRET` and + `SYNC_TOKENSERVER__FXA_METRICS_HASH_SECRET`. ''; }; @@ -126,7 +126,7 @@ in hostname = lib.mkOption { type = lib.types.str; - description = '' + description = lib.mdDoc '' Host name to use for this service. ''; }; @@ -134,7 +134,7 @@ in capacity = lib.mkOption { type = lib.types.ints.unsigned; default = 10; - description = '' + description = lib.mdDoc '' How many sync accounts are allowed on this server. Setting this value equal to or less than the number of currently active accounts will effectively deny service to accounts not yet registered here. @@ -147,7 +147,7 @@ in defaultText = lib.literalExpression '' ''${if cfg.singleNode.enableTLS then "https" else "http"}://''${config.${opt.singleNode.hostname}} ''; - description = '' + description = lib.mdDoc '' URL of the host. If you are not using the automatic webserver proxy setup you will have to change this setting or your sync server may not be functional. ''; @@ -162,7 +162,7 @@ in port = lib.mkOption { type = lib.types.port; default = 5000; - description = '' + description = lib.mdDoc '' Port to bind to. ''; }; @@ -170,21 +170,21 @@ in tokenserver.enabled = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable the token service as well. ''; }; }; }; default = { }; - description = '' + description = lib.mdDoc '' Settings for the sync server. These take priority over values computed from NixOS options. - See the doc comments on the <literal>Settings</literal> structs in - <link xlink:href="https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/settings.rs" /> + See the doc comments on the `Settings` structs in + <https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/settings.rs> and - <link xlink:href="https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/tokenserver/settings.rs" /> + <https://github.com/mozilla-services/syncstorage-rs/blob/master/syncstorage/src/tokenserver/settings.rs> for available options. ''; }; diff --git a/nixos/modules/services/networking/ghostunnel.nix b/nixos/modules/services/networking/ghostunnel.nix index 79cf80e57bef..4b9620cea214 100644 --- a/nixos/modules/services/networking/ghostunnel.nix +++ b/nixos/modules/services/networking/ghostunnel.nix @@ -37,12 +37,12 @@ let }; keystore = mkOption { - description = '' + description = lib.mdDoc '' Path to keystore (combined PEM with cert/key, or PKCS12 keystore). - NB: storepass is not supported because it would expose credentials via <literal>/proc/*/cmdline</literal>. + NB: storepass is not supported because it would expose credentials via `/proc/*/cmdline`. - Specify this or <literal>cert</literal> and <literal>key</literal>. + Specify this or `cert` and `key`. ''; type = types.nullOr types.str; default = null; diff --git a/nixos/modules/services/networking/hylafax/options.nix b/nixos/modules/services/networking/hylafax/options.nix index bc289132a760..79275d628b60 100644 --- a/nixos/modules/services/networking/hylafax/options.nix +++ b/nixos/modules/services/networking/hylafax/options.nix @@ -235,9 +235,9 @@ in InternationalPrefix = "00"; LongDistancePrefix = "0"; }; - description = '' + description = lib.mdDoc '' Attribute set of default values for - modem config files <filename>etc/config.*</filename>. + modem config files {file}`etc/config.*`. ${commonDescr} Think twice before changing paths of fax-processing scripts. diff --git a/nixos/modules/services/networking/ircd-hybrid/default.nix b/nixos/modules/services/networking/ircd-hybrid/default.nix index 53357abce949..44fadde1fbb7 100644 --- a/nixos/modules/services/networking/ircd-hybrid/default.nix +++ b/nixos/modules/services/networking/ircd-hybrid/default.nix @@ -41,7 +41,7 @@ in serverName = mkOption { default = "hades.arpa"; type = types.str; - description = '' + description = lib.mdDoc '' IRCD server name. ''; }; @@ -49,7 +49,7 @@ in sid = mkOption { default = "0NL"; type = types.str; - description = '' + description = lib.mdDoc '' IRCD server unique ID in a net of servers. ''; }; @@ -57,7 +57,7 @@ in description = mkOption { default = "Hybrid-7 IRC server."; type = types.str; - description = '' + description = lib.mdDoc '' IRCD server description. ''; }; @@ -66,7 +66,7 @@ in default = null; example = literalExpression "/root/certificates/irc.key"; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' IRCD server RSA key. ''; }; @@ -75,7 +75,7 @@ in default = null; example = literalExpression "/root/certificates/irc.pem"; type = types.nullOr types.path; - description = '' + description = lib.mdDoc '' IRCD server SSL certificate. There are some limitations - read manual. ''; }; @@ -84,7 +84,7 @@ in default = "<bit-bucket@example.com>"; type = types.str; example = "<name@domain.tld>"; - description = '' + description = lib.mdDoc '' IRCD server administrator e-mail. ''; }; @@ -93,7 +93,7 @@ in default = []; example = ["127.0.0.1"]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Extra IP's to bind. ''; }; @@ -101,7 +101,7 @@ in extraPort = mkOption { default = "7117"; type = types.str; - description = '' + description = lib.mdDoc '' Extra port to avoid filtering. ''; }; diff --git a/nixos/modules/services/networking/kresd.nix b/nixos/modules/services/networking/kresd.nix index 601a88176ec2..55af6abd5e01 100644 --- a/nixos/modules/services/networking/kresd.nix +++ b/nixos/modules/services/networking/kresd.nix @@ -59,7 +59,7 @@ in { }; package = mkOption { type = types.package; - description = '' + description = lib.mdDoc '' knot-resolver package to use. ''; default = pkgs.knot-resolver; diff --git a/nixos/modules/services/networking/mxisd.nix b/nixos/modules/services/networking/mxisd.nix index dc0196360c3b..571326c5aced 100644 --- a/nixos/modules/services/networking/mxisd.nix +++ b/nixos/modules/services/networking/mxisd.nix @@ -49,9 +49,9 @@ in { environmentFile = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path to an environment-file which may contain secrets to be - substituted via <literal>envsubst</literal>. + substituted via `envsubst`. ''; }; diff --git a/nixos/modules/services/networking/resilio.nix b/nixos/modules/services/networking/resilio.nix index eca5f5ccfe93..d21f108024e5 100644 --- a/nixos/modules/services/networking/resilio.nix +++ b/nixos/modules/services/networking/resilio.nix @@ -199,25 +199,25 @@ in ]; } ]; - description = '' + description = lib.mdDoc '' Shared folder list. If enabled, web UI must be - disabled. Secrets can be generated using <literal>rslsync --generate-secret</literal>. + disabled. Secrets can be generated using `rslsync --generate-secret`. Note that this secret will be put inside the Nix store, so it is realistically not very secret. If you would like to be able to modify the contents of this directories, it is recommended that you make your user a - member of the <literal>rslsync</literal> group. + member of the `rslsync` group. Directories in this list should be in the - <literal>rslsync</literal> group, and that group must have + `rslsync` group, and that group must have write access to the directory. It is also recommended that - <literal>chmod g+s</literal> is applied to the directory + `chmod g+s` is applied to the directory so that any sub directories created will also belong to - the <literal>rslsync</literal> group. Also, - <literal>setfacl -d -m group:rslsync:rwx</literal> and - <literal>setfacl -m group:rslsync:rwx</literal> should also + the `rslsync` group. Also, + `setfacl -d -m group:rslsync:rwx` and + `setfacl -m group:rslsync:rwx` should also be applied so that the sub directories are writable by the group. ''; diff --git a/nixos/modules/services/networking/v2ray.nix b/nixos/modules/services/networking/v2ray.nix index df4b41eecbd4..1ff1feed8f47 100644 --- a/nixos/modules/services/networking/v2ray.nix +++ b/nixos/modules/services/networking/v2ray.nix @@ -51,12 +51,12 @@ with lib; protocol = "freedom"; }]; }; - description = '' + description = lib.mdDoc '' The configuration object. - Either <literal>configFile</literal> or <literal>config</literal> must be specified. + Either `configFile` or `config` must be specified. - See <link xlink:href="https://www.v2fly.org/en_US/config/overview.html"/>. + See <https://www.v2fly.org/en_US/config/overview.html>. ''; }; }; diff --git a/nixos/modules/services/networking/yggdrasil.nix b/nixos/modules/services/networking/yggdrasil.nix index d29ec55807bd..e7513c5627c8 100644 --- a/nixos/modules/services/networking/yggdrasil.nix +++ b/nixos/modules/services/networking/yggdrasil.nix @@ -31,27 +31,27 @@ in { "tcp://0.0.0.0:xxxxx" ]; }; - description = '' + description = lib.mdDoc '' Configuration for yggdrasil, as a Nix attribute set. Warning: this is stored in the WORLD-READABLE Nix store! Therefore, it is not appropriate for private keys. If you - wish to specify the keys, use <option>configFile</option>. + wish to specify the keys, use {option}`configFile`. - If the <option>persistentKeys</option> is enabled then the + If the {option}`persistentKeys` is enabled then the keys that are generated during activation will override - those in <option>config</option> or - <option>configFile</option>. + those in {option}`config` or + {option}`configFile`. If no keys are specified then ephemeral keys are generated and the Yggdrasil interface will have a random IPv6 address each time the service is started, this is the default. - If both <option>configFile</option> and <option>config</option> + If both {option}`configFile` and {option}`config` are supplied, they will be combined, with values from - <option>configFile</option> taking precedence. + {option}`configFile` taking precedence. - You can use the command <literal>nix-shell -p yggdrasil --run "yggdrasil -genconf"</literal> + You can use the command `nix-shell -p yggdrasil --run "yggdrasil -genconf"` to generate default configuration values with documentation. ''; }; |