diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/networking/coturn.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/networking/coturn.nix | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/nixpkgs/nixos/modules/services/networking/coturn.nix b/nixpkgs/nixos/modules/services/networking/coturn.nix index 2f34a72377ce..3166c0dfb578 100644 --- a/nixpkgs/nixos/modules/services/networking/coturn.nix +++ b/nixpkgs/nixos/modules/services/networking/coturn.nix @@ -40,11 +40,11 @@ ${cfg.extraConfig} in { options = { services.coturn = { - enable = mkEnableOption (lib.mdDoc "coturn TURN server"); + enable = mkEnableOption "coturn TURN server"; listening-port = mkOption { type = types.int; default = 3478; - description = lib.mdDoc '' + description = '' TURN listener port for UDP and TCP. Note: actually, TLS and DTLS sessions can connect to the "plain" TCP and UDP port(s), too - if allowed by configuration. @@ -53,7 +53,7 @@ in { tls-listening-port = mkOption { type = types.int; default = 5349; - description = lib.mdDoc '' + description = '' TURN listener port for TLS. Note: actually, "plain" TCP and UDP sessions can connect to the TLS and DTLS port(s), too - if allowed by configuration. The TURN server @@ -69,7 +69,7 @@ in { type = types.int; default = cfg.listening-port + 1; defaultText = literalExpression "listening-port + 1"; - description = lib.mdDoc '' + description = '' Alternative listening port for UDP and TCP listeners; default (or zero) value means "listening port plus one". This is needed for RFC 5780 support @@ -84,7 +84,7 @@ in { type = types.int; default = cfg.tls-listening-port + 1; defaultText = literalExpression "tls-listening-port + 1"; - description = lib.mdDoc '' + description = '' Alternative listening port for TLS and DTLS protocols. ''; }; @@ -92,7 +92,7 @@ in { type = types.listOf types.str; default = []; example = [ "203.0.113.42" "2001:DB8::42" ]; - description = lib.mdDoc '' + description = '' Listener IP addresses of relay server. If no IP(s) specified in the config file or in the command line options, then all IPv4 and IPv6 system IPs will be used for listening. @@ -102,7 +102,7 @@ in { type = types.listOf types.str; default = []; example = [ "203.0.113.42" "2001:DB8::42" ]; - description = lib.mdDoc '' + description = '' Relay address (the local IP address that will be used to relay the packets to the peer). Multiple relay addresses may be used. @@ -118,28 +118,28 @@ in { min-port = mkOption { type = types.int; default = 49152; - description = lib.mdDoc '' + description = '' Lower bound of UDP relay endpoints ''; }; max-port = mkOption { type = types.int; default = 65535; - description = lib.mdDoc '' + description = '' Upper bound of UDP relay endpoints ''; }; lt-cred-mech = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Use long-term credential mechanism. ''; }; no-auth = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' This option is opposite to lt-cred-mech. (TURN Server with no-auth option allows anonymous access). If neither option is defined, and no users are defined, @@ -151,7 +151,7 @@ in { use-auth-secret = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' TURN REST API flag. Flag that sets a special authorization option that is based upon authentication secret. This feature can be used with the long-term authentication mechanism, only. @@ -175,7 +175,7 @@ in { static-auth-secret = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' 'Static' authentication secret value (a string) for TURN REST API only. If not set, then the turn server will try to use the 'dynamic' value in turn_secret table @@ -186,7 +186,7 @@ in { static-auth-secret-file = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Path to the file containing the static authentication secret. ''; }; @@ -195,7 +195,7 @@ in { default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; example = "example.com"; - description = lib.mdDoc '' + description = '' The default realm to be used for the users when no explicit origin/realm relationship was found in the database, or if the TURN server is not using any database (just the commands-line settings @@ -207,7 +207,7 @@ in { type = types.nullOr types.str; default = null; example = "/var/lib/acme/example.com/fullchain.pem"; - description = lib.mdDoc '' + description = '' Certificate file in PEM format. ''; }; @@ -215,21 +215,21 @@ in { type = types.nullOr types.str; default = null; example = "/var/lib/acme/example.com/key.pem"; - description = lib.mdDoc '' + description = '' Private key file in PEM format. ''; }; dh-file = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Use custom DH TLS key, stored in PEM format in the file. ''; }; secure-stun = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Require authentication of the STUN Binding request. By default, the clients are allowed anonymous access to the STUN Binding functionality. ''; @@ -237,28 +237,28 @@ in { no-cli = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Turn OFF the CLI support. ''; }; cli-ip = mkOption { type = types.str; default = "127.0.0.1"; - description = lib.mdDoc '' + description = '' Local system IP address to be used for CLI server endpoint. ''; }; cli-port = mkOption { type = types.int; default = 5766; - description = lib.mdDoc '' + description = '' CLI server port. ''; }; cli-password = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' CLI access password. For the security reasons, it is recommended to use the encrypted for of the password (see the -P command in the turnadmin utility). @@ -267,37 +267,37 @@ in { no-udp = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Disable UDP client listener"; + description = "Disable UDP client listener"; }; no-tcp = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Disable TCP client listener"; + description = "Disable TCP client listener"; }; no-tls = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Disable TLS client listener"; + description = "Disable TLS client listener"; }; no-dtls = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Disable DTLS client listener"; + description = "Disable DTLS client listener"; }; no-udp-relay = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Disable UDP relay endpoints"; + description = "Disable UDP relay endpoints"; }; no-tcp-relay = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Disable TCP relay endpoints"; + description = "Disable TCP relay endpoints"; }; extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc "Additional configuration options"; + description = "Additional configuration options"; }; }; }; |