/usr/bin/turnserver: unrecognized option '--help'
/usr/bin/turnserver: unrecognized option '--help'
Usage: turnserver [options]
Options:
-d, --listening-device <device-name> Listener interface device (NOT RECOMMENDED. Optional, Linux only).
-p, --listening-port <port> TURN listener port (Default: 3478).
Note: actually, TLS & DTLS sessions can connect to the "plain" TCP & UDP port(s), too,
if allowed by configuration.
--tls-listening-port <port> TURN listener port for TLS & DTLS listeners
(Default: 5349).
Note: actually, "plain" TCP & UDP sessions can connect to the TLS & DTLS port(s), too,
if allowed by configuration. The TURN server
"automatically" recognizes the type of traffic. Actually, two listening
endpoints (the "plain" one and the "tls" one) are equivalent in terms of
functionality; but we keep both endpoints to satisfy the RFC 5766 specs.
For secure TCP connections, we currently support SSL version 3 and
TLS versions 1.0, 1.1 and 1.2. For secure UDP connections, we support
DTLS version 1.
--alt-listening-port<port> <port> Alternative listening port for STUN CHANGE_REQUEST (in RFC 5780 sense,
or in old RFC 3489 sense, default is "listening port plus one").
--alt-tls-listening-port <port> Alternative listening port for TLS and DTLS,
the default is "TLS/DTLS port plus one".
--tcp-proxy-port <port> Support connections from TCP loadbalancer on this port. The loadbalancer should
use the binary proxy protocol (https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt)
-L, --listening-ip <ip> Listener IP address of relay server. Multiple listeners can be specified.
--aux-server <ip:port> Auxiliary STUN/TURN server listening endpoint.
Auxiliary servers do not have alternative ports and
they do not support RFC 5780 functionality (CHANGE REQUEST).
Valid formats are 1.2.3.4:5555 for IPv4 and [1:2::3:4]:5555 for IPv6.
--udp-self-balance (recommended for older Linuxes only) Automatically balance UDP traffic
over auxiliary servers (if configured).
The load balancing is using the ALTERNATE-SERVER mechanism.
The TURN client must support 300 ALTERNATE-SERVER response for this functionality.
-i, --relay-device <device-name> Relay interface device for relay sockets (NOT RECOMMENDED. Optional, Linux only).
-E, --relay-ip <ip> Relay address (the local IP address that will be used to relay the
packets to the peer).
Multiple relay addresses may be used.
The same IP(s) can be used as both listening IP(s) and relay IP(s).
If no relay IP(s) specified, then the turnserver will apply the default
policy: it will decide itself which relay addresses to be used, and it
will always be using the client socket IP address as the relay IP address
of the TURN session (if the requested relay address family is the same
as the family of the client socket).
-X, --external-ip <public-ip[/private-ip]> TURN Server public/private address mapping, if the server is behind NAT.
In that situation, if a -X is used in form "-X ip" then that ip will be reported
as relay IP address of all allocations of its own address family (a relay of the
other family is reported under its own address). This scenario works only in a simple case
when one single relay address is be used, and no STUN CHANGE_REQUEST
functionality is required.
That single relay address must be mapped by NAT to the 'external' IP.
For that 'external' IP, NAT must forward ports directly (relayed port 12345
must be always mapped to the same 'external' port 12345).
In more complex case when more than one IP address is involved,
that option must be used several times in the command line, each entry must
have form "-X public-ip/private-ip", to map all involved addresses.
--allow-loopback-peers Allow peers on the loopback addresses (127.x.x.x and ::1).
--no-multicast-peers Disallow peers on well-known broadcast addresses (224.0.0.0 and above, and FFXX:*).
-m, --relay-threads <number> Number of relay threads to handle the established connections
(in addition to authentication thread and the listener thread).
If explicitly set to 0 then application runs in single-threaded mode.
If not set then a default OS-dependent optimal algorithm will be employed.
The default thread number is the number of CPUs.
In older systems (pre-Linux 3.9) the number of UDP relay threads always equals
the number of listening endpoints (unless -m 0 is set).
--cpus <number> Override system CPU count detection. Use this number
instead of the auto-detected CPU count.
Useful in virtualized/containerized environments where
the system reports the host CPU count instead of
the allocated container CPUs.
--min-port <port> Lower bound of the UDP port range for relay endpoints allocation.
Default value is 49152, according to RFC 5766.
--max-port <port> Upper bound of the UDP port range for relay endpoints allocation.
Default value is 65535, according to RFC 5766.
--sock-buf-size <number> Size of the socket buffer for UDP sockets (in bytes).
-v, --verbose 'Moderate' verbose mode.
-V, --Verbose Extra verbose mode, very annoying (for debug purposes only).
-o, --daemon Start process as daemon (detach from current shell).
--no-software-attribute DEPRECATED Production mode: hide the software version.
--software-attribute Enable sending software attribute (for debugging).
-f, --fingerprint Use fingerprints in the TURN messages.
-a, --lt-cred-mech Use the long-term credential mechanism.
-z, --no-auth Do not use any credential mechanism, allow anonymous access.
-u, --user <user:pwd> User account, in form 'username:password', for long-term credentials.
Cannot be used with TURN REST API.
-r, --realm <realm> The default realm to be used for the users when no explicit
origin/realm relationship was found in the database.
Must be used with long-term credentials
mechanism or with TURN REST API.
--check-origin-consistency The flag that sets the origin consistency check:
across the session, all requests must have the same
main ORIGIN attribute value (if the ORIGIN was
initially used by the session).
-q, --user-quota <number> Per-user allocation quota: how many concurrent allocations a user can create.
This option can also be set through the database, for a particular realm.
-Q, --total-quota <number> Total allocations quota: global limit on concurrent allocations.
This option can also be set through the database, for a particular realm.
-s, --max-bps <number> Default max bytes-per-second bandwidth a TURN session is allowed to handle
(input and output network streams are treated separately). Anything above
that limit will be dropped or temporary suppressed
(within the available buffer limits).
This option can also be set through the database, for a particular realm.
-B, --bps-capacity <number> Maximum server capacity.
Total bytes-per-second bandwidth the TURN server is allowed to allocate
for the sessions, combined (input and output network streams are treated separately).
-c <filename> Configuration file name (default - turnserver.conf).
-b, , --db, --userdb <filename> SQLite database file name; default - /var/db/turndb or
/usr/local/var/db/turndb or /var/lib/turn/turndb.
-e, --psql-userdb, --sql-userdb <conn-string> PostgreSQL database connection string, if used (default - empty, no PostgreSQL DB used).
This database can be used for long-term credentials mechanism users,
and it can store the secret value(s) for secret-based timed authentication in TURN REST API.
See http://www.postgresql.org/docs/8.4/static/libpq-connect.html for 8.x PostgreSQL
versions format, see
http://www.postgresql.org/docs/9.2/static/libpq-connect.html#LIBPQ-CONNSTRING
for 9.x and newer connection string formats.
-M, --mysql-userdb <connection-string> MySQL database connection string, if used (default - empty, no MySQL DB used).
This database can be used for long-term credentials mechanism users,
and it can store the secret value(s) for secret-based timed authentication in TURN REST API.
The connection string my be space-separated list of parameters:
"host=<ip-addr> dbname=<database-name> user=<database-user> \
password=<database-user-password> port=<db-port> connect_timeout=<seconds> read_timeout=<seconds>".
The connection string parameters for the secure communications (SSL):
ca, capath, cert, key, cipher
(see http://dev.mysql.com/doc/refman/5.1/en/ssl-options.html for the
command options description).
All connection-string parameters are optional.
--secret-key-file <filename> This is the file path which contain secret key of aes encryption while using MySQL password encryption.
If you want to use in the MySQL connection string the password in encrypted format,
then set in this option the file path of the secret key. The key which is used to encrypt MySQL password.
Warning: If this option is set, then MySQL password must be set in "mysql-userdb" option in encrypted format!
If you want to use cleartext password then do not set this option!
-N, --redis-userdb <connection-string> Redis user database connection string, if used (default - empty, no Redis DB used).
This database can be used for long-term credentials mechanism users,
and it can store the secret value(s) for secret-based timed authentication in TURN REST API.
The connection string my be space-separated list of parameters:
"host=<ip-addr> dbname=<db-number> \
password=<database-user-password> port=<db-port> connect_timeout=<seconds>".
All connection-string parameters are optional.
-O, --redis-statsdb <connection-string> Redis status and statistics database connection string, if used
(default - empty, no Redis stats DB used).
This database keeps allocations status information, and it can be also used for publishing
and delivering traffic and allocation event notifications.
The connection string has the same parameters as redis-userdb connection string.
--prometheus Enable prometheus metrics. It is disabled by default. If it is enabled it will listen on port 9641 under the path /metrics
also the path / on this port can be used as a health check
--prometheus-port <port> Prometheus metrics port (Default: 9641).
--prometheus-address <address> Prometheus listening address (Default: any).
--prometheus-path <path> Prometheus serve path (Default: /metrics).
--prometheus-username-labels When metrics are enabled, add labels with client usernames.
--prometheus-tls Serve the metrics endpoint over HTTPS instead of HTTP (optional). Implies --prometheus. Requires libmicrohttpd built with TLS support.
--prometheus-cert <file> PEM certificate for the HTTPS metrics endpoint (Default: the server's --cert).
--prometheus-key <file> PEM private key for the HTTPS metrics endpoint (Default: the server's --pkey).
--use-auth-secret TURN REST API flag.
Flag that sets a special authorization option that is based upon authentication secret
(TURN Server REST API, see https://github.com/coturn/coturn/blob/master/README.turnserver).
This option is used with timestamp.
--static-auth-secret <secret> '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 in user database (if present).
That database value can be changed on-the-fly
by a separate program, so this is why it is 'dynamic'.
Multiple shared secrets can be used (both in the database and in the "static" fashion).
--no-auth-pings Disable periodic health checks to 'dynamic' auth secret tables.
--no-dynamic-ip-list Do not use dynamic allowed/denied peer ip list.
--no-dynamic-realms Do not use dynamic realm assignment and options.
--server-name Server name used for
the oAuth authentication purposes.
The default value is the realm name.
--oauth Support oAuth authentication.
-n Do not use configuration file, take all parameters from the command line only.
--cert <filename> Certificate file, PEM format. Same file search rules
applied as for the configuration file.
If --no-tls is specified and --dtls is not,
then this parameter is not needed.
--raw-public-keys[=<value>] Enable raw public keys support (RFC 7250). Off by default;
requires OpenSSL 3.2.1 or later.
--pkey <filename> Private key file, PEM format. Same file search rules
applied as for the configuration file.
If --no-tls is specified and --dtls is not,
then this parameter is not needed.
--pkey-pwd <password> If the private key file is encrypted, then this password to be used.
--cipher-list <cipher-string> Allowed OpenSSL cipher list for TLS/DTLS connections.
Default value is "DEFAULT" for TLS/DTLS versions up to TLSv1.2/DTLSv1.2,
and the library default ciphersuites for TLSv1.3.
--CA-file <filename> CA file in OpenSSL format.
Forces TURN server to verify the client SSL certificates.
By default, no CA is set and no client certificate check is performed.
--ec-curve-name <curve-name> Curve name for EC ciphers, if supported by OpenSSL
library (TLS and DTLS). The default value is prime256v1,
if pre-OpenSSL 1.0.2 is used. With OpenSSL 1.0.2+,
an optimal curve will be automatically calculated, if not defined
by this option.
--dh566 Use 566 bits predefined DH TLS key. Default size of the predefined key is 2066.
--dh1066 Use 1066 bits predefined DH TLS key. Default size of the predefined key is 2066.
--dh-file <dh-file-name> Use custom DH TLS key, stored in PEM format in the file.
Flags --dh566 and --dh1066 are ignored when the DH key is taken from a file.
--tlsv1 Set TLSv1 as a minimum supported protocol version.
--tlsv1_1 Set TLSv1.1 as a minimum supported protocol version.
--no-tlsv1_2 Set TLSv1.3/DTLSv1.2 as a minimum supported protocol version.
With openssl-1.0.2 and below, do not allow TLSv1.2/DTLSv1.2 protocols.
--no-udp Do not start UDP client listeners.
--no-tcp Do not start TCP client listeners.
--no-tls Do not start TLS client listeners.
--dtls Start DTLS client listeners. DTLS is not started by default.
--no-udp-relay Do not allow UDP relay endpoints, use only TCP relay option.
--no-tcp-relay Do not allow TCP relay endpoints, use only UDP relay options.
-l, --log-file <filename> Option to set the full path name of the log file.
By default, the turnserver tries to open a log file in
/var/log/turnserver/, /var/log, /var/tmp, /tmp and . (current) directories
(which open operation succeeds first that file will be used).
With this option you can set the definite log file name.
The special names are "stdout" and "-" - they will force everything
to the stdout; and "syslog" name will force all output to the syslog.
--no-stdout-log Flag to prevent stdout log messages.
By default, all log messages are going to both stdout and to
a log file. With this option everything will be going to the log file only
(unless the log file itself is stdout).
--syslog Output all log information into the system log (syslog), do not use the file output.
--syslog-facility <value> Set syslog facility for syslog messages. Default is ''.
--simple-log This flag means that no log file rollover will be used, and the log file
name will be constructed as-is, without PID and date appendage.
This option can be used, for example, together with the logrotate tool.
--log-min-level <level> Only emit log messages at or above this level: debug, info, warning,
or error. Default is debug (everything). An unrecognized level is
ignored with a warning.
--new-log-timestamp[=<value>] Use a full ISO-8601 timestamp in all logs. Enabled by default;
pass --new-log-timestamp=false for the legacy counter of
seconds since start.
--new-log-timestamp-format <format> Set timestamp format (in strftime(1) format). Depends on --new-log-timestamp to be enabled.
Besides the strftime(1) conversions, %f expands to milliseconds.
--log-binding Log STUN binding request. It is now disabled by default to avoid DoS attacks.
--stale-nonce[=<value>] Use extra security with nonce value having limited lifetime (default 600 secs).
--max-allocate-lifetime <value> Set the maximum value for the allocation lifetime. Default to 3600 secs.
--channel-lifetime <value> Set the lifetime for channel binding, default to 600 secs.
This value MUST not be changed for production purposes.
--permission-lifetime <value> Set the value for the lifetime of the permission. Default to 300 secs.
This MUST not be changed for production purposes.
-S, --stun-only Option to set standalone STUN operation only, all TURN requests will be ignored.
--no-stun Option to suppress STUN functionality, only TURN requests will be processed.
--alternate-server <ip:port> Set the TURN server to redirect the allocate requests (UDP and TCP services).
Multiple alternate-server options can be set for load balancing purposes.
See the docs for more information.
--tls-alternate-server <ip:port> Set the TURN server to redirect the allocate requests (DTLS and TLS services).
Multiple alternate-server options can be set for load balancing purposes.
See the docs for more information.
--udp-alternate-server <ip:port> Set the TURN server to redirect the allocate requests (UDP and DTLS services).
Takes precedence over --alternate-server and --udp-self-balance for UDP/DTLS clients.
Multiple alternate-server options can be set for load balancing purposes.
See the docs for more information.
--tcp-alternate-server <ip:port> Set the TURN server to redirect the allocate requests (TCP service).
Takes precedence over --alternate-server for TCP clients.
Multiple alternate-server options can be set for load balancing purposes.
See the docs for more information.
-C, --rest-api-separator <SYMBOL> This is the timestamp/username separator symbol (character) in TURN REST API.
The default value is ':'.
--max-allocate-timeout=<seconds> Max time, in seconds, allowed for full allocation establishment. Default is 60.
--drain-min-allocations=<number> In drain mode (SIGUSR1), shut down once the number of active allocations
drops to this value or below. Default is 0 (wait until all allocations are gone).
--allowed-peer-ip=<ip[-ip]> Specifies an ip or range of ips that are explicitly allowed to connect to the
turn server. Multiple allowed-peer-ip can be set.
--denied-peer-ip=<ip[-ip]> Specifies an ip or range of ips that are not allowed to connect to the turn server.
Multiple denied-peer-ip can be set.
--pidfile <"pid-file-name"> File name to store the pid of the process.
Default is /var/run/turnserver.pid (if superuser account is used) or
/var/tmp/turnserver.pid .
--acme-redirect <URL> Redirect ACME, i.e. HTTP GET requests matching '^/.well-known/acme-challenge/(.*)' to '<URL>$1'.
Default is '', i.e. no special handling for such requests.
--secure-stun Require authentication of the STUN Binding request.
By default, the clients are allowed anonymous access to the STUN Binding functionality.
--proc-user <user-name> User name to run the turnserver process.
After the initialization, the turnserver process
will make an attempt to change the current user ID to that user.
--proc-group <group-name> Group name to run the turnserver process.
After the initialization, the turnserver process
will make an attempt to change the current group ID to that group.
--mobility Mobility with ICE (MICE) specs support.
-K, --keep-address-family Deprecated in favor of --allocation-default-address-family!!
TURN server allocates address family according TURN
Client <=> Server communication address family.
!! It breaks RFC6156 section-4.2 (violates default IPv4) !!
-A --allocation-default-address-family=<ipv4|ipv6|keep> Default is IPv4
TURN server allocates address family according TURN client requested address family.
If address family is not requested explicitly by client, then it falls back to this default.
The standard RFC explicitly define actually that this default must be IPv4,
so use other option values with care!
--cli Turn ON the CLI support. By default it is always OFF.
--cli-ip=<IP> Local system IP address to be used for CLI server endpoint. Default value
is 127.0.0.1.
--cli-port=<port> CLI server port. Default is 5766.
--cli-password=<password> CLI access password. Default is empty (no password).
For the security reasons, it is recommended to use the encrypted
for of the password (see the -P command in the turnadmin utility).
The dollar signs in the encrypted form must be escaped.
--web-admin Enable Turn Web-admin support. By default it is disabled.
--web-admin-ip=<IP> Local system IP address to be used for Web-admin server endpoint. Default value
is 127.0.0.1.
--web-admin-port=<port> Web-admin server port. Default is 8080.
--web-admin-listen-on-workers Enable for web-admin server to listens on STUN/TURN workers STUN/TURN ports.
By default it is disabled for security reasons!
(This behavior used to be the default behavior, and was enabled by default.)
--server-relay Server relay. NON-STANDARD AND DANGEROUS OPTION. Only for those applications
when we want to run server applications on the relay endpoints.
This option eliminates the IP permissions check on the packets
incoming to the relay endpoints.
--cli-max-output-sessions Maximum number of output sessions in ps CLI command.
This value can be changed on-the-fly in CLI. The default value is 256.
--no-rfc5780 DEPRECATED and now default, see --rfc5780.
--rfc5780 Enable RFC5780 (NAT behavior discovery).
Originally, if there are more than one listener address from the same
address family, then by default the NAT behavior discovery feature enabled.
This option enables this original behavior (downside is that the NAT behavior discovery
adds attributes to response, and this increase the possibility of an amplification attack.)
Strongly encouraged to keep it off to decrease gain factor in STUN binding responses.
--stun-backward-compatibility Add the deprecated MAPPED-ADDRESS attribute to STUN Binding
responses, alongside XOR-MAPPED-ADDRESS, for clients that cannot parse
the latter. Strongly encouraged to keep it off to decrease gain factor in
STUN binding responses.
--rfc3489-compatibility DEPRECATED. Enable handling of obsolete RFC 3489 ("classic" STUN)
Binding requests, which carry no magic cookie. Scheduled for removal in
the next major release; there is no replacement.
--rfc5766-channel-numbers Accept ChannelBind channel numbers from the obsolete RFC 5766 range 0x5000-0x7FFF,
which RFC 8656 reserves for multiplexing collision avoidance (RFC 7983). Only for
compatibility with legacy clients; ChannelData on those channels may be dropped by
conformant demultiplexing endpoints.
--respond-http-unsupported Return an HTTP reponse with a 400 status code to HTTP connections made to ports not
supporting HTTP. The default behaviour is to immediately close the connection.
--drop-invalid-packets-log Log invalid packets. The default behaviour is to not log invalid packets.
--udp-recvmmsg Linux-only batched UDP receive via recvmmsg() on the shared fan-in sockets (the client listener and, when --multiplex-peer is set, the per-thread relay socket). Enabled by default; disable with --udp-recvmmsg=false. Independent of --multiplex-peer and worth keeping on for high client concurrency. Per-session relay sockets are left on the single-recv path, where batching would only add buffer churn.
--udp-recvmmsg-log Log Linux recvmmsg batch occupancy stats every 10 seconds.
--udp-sendmmsg-log Log Linux sendmmsg/UDP-GSO egress batch occupancy and GSO-engagement stats every 10 seconds. Only meaningful with --multiplex-peer (which enables sendmmsg batching).
--udp-gso Enable Linux UDP-GSO (UDP_SEGMENT cmsg) when a sendmmsg batch shares destination and size; collapses N datagrams into one network-stack traversal. Requires --multiplex-peer (which enables sendmmsg batching).
--multiplex-peer
Enable peer-side multiplexing relay mode (non-standard, optional).
Each relay thread opens one UDP socket pair (IPv4+IPv6) shared
across all TURN sessions on that thread. Sessions are demultiplexed
by exact peer IP:port lookup. Port layout (B=--multiplex-peer-port):
thread 0: IPv4=B+0, IPv6=B+1
thread 1: IPv4=B+2, IPv6=B+3 ...
Eliminates port-range exhaustion. Incompatible with EVEN-PORT.
Implies sendmmsg batching on Linux. --udp-recvmmsg (on by default)
provides the recvmmsg window the batching piggybacks on.
--multiplex-peer-port <port>
Base UDP port for multiplex-peer relay sockets. Default: 3480.
Total ports consumed = relay_threads * 2.
--multiplex-peer-max-peers <number>
Maximum distinct peer IP:port endpoints one allocation may keep in
the shared demux table. Further endpoints are refused with 508.
Default: 256. Only meaningful with --multiplex-peer.
--include-reason-string Include descriptive reason strings in STUN/TURN error responses.
By default, only the standard reason phrase for the error code is
sent. Enabling this option adds detailed error descriptions which
may aid debugging but can also leak internal server information.
--unauthorized-ratelimit Enable per-source rate-limiting of 401
Unauthorized responses on UDP. Mitigates
reflection/amplification abuse where attackers
spoof a victim's source address to bounce 401
challenges off the server. Off by default.
--unauthorized-ratelimit-rps=<count> Max 401 Unauthorized responses to send per
source IP per second (default 10).
--stateless-nonce Issue 401/438 challenge nonces as authenticated
timestamp cookies (issue time + HMAC over the
client address, keyed by a per-process secret)
instead of storing a random nonce in the
session. Unauthenticated UDP requests are then
answered without allocating per-client session
state, bounding memory under spoofed-source floods
of structurally valid STUN messages. On by default;
disable with --stateless-nonce=false.
--stateless-nonce-secret=<secret> Derive the stateless-nonce signing key from this
secret instead of a random per-process key, so
servers sharing the secret (and NTP-synced clocks)
validate each other's nonces across restarts and
load-balanced fleets. Use a high-entropy string.
Implies --stateless-nonce.
--version Print version (and exit).
-h Help
2026-11-09T14:37:46.761+0000 WARNING Cannot find config file: turnserver.conf. Default and command-line settings will be used.
2026-11-09T14:37:46.761+0000 INFO log file opened: /tmp/turn_2_2026-11-09.log
Options (139)
| Option | Description | Source |
|---|---|---|
-d, --listening-device | <device-name> Listener interface device (NOT RECOMMENDED. | help |
-p, --listening-port | <port> TURN listener port (Default: 3478). | help |
--tls-listening-port | <port> TURN listener port for TLS & DTLS listeners (Default: 5349). | help |
--alt-listening-port port | <port> Alternative listening port for STUN CHANGE_REQUEST (in RFC 5780 sense, or in old RFC 3489 sense, default is "listening port plus one"). | help |
--alt-tls-listening-port | <port> Alternative listening port for TLS and DTLS, the default is "TLS/DTLS port plus one". | help |
--tcp-proxy-port | <port> Support connections from TCP loadbalancer on this port. | help |
-L, --listening-ip | <ip> Listener IP address of relay server. | help |
--aux-server | <ip:port> Auxiliary STUN/TURN server listening endpoint. | help |
--udp-self-balance | (recommended for older Linuxes only) Automatically balance UDP traffic over auxiliary servers (if configured). | help |
-i, --relay-device | <device-name> Relay interface device for relay sockets (NOT RECOMMENDED. | help |
-E, --relay-ip | <ip> Relay address (the local IP address that will be used to relay the packets to the peer). | help |
-X, --external-ip | <public-ip[/private-ip]> TURN Server public/private address mapping, if the server is behind NAT. | help |
--allow-loopback-peers | Allow peers on the loopback addresses (127.x.x.x and ::1). | help |
--no-multicast-peers | Disallow peers on well-known broadcast addresses (224.0.0.0 and above, and FFXX:*). | help |
-m, --relay-threads | <number> Number of relay threads to handle the established connections (in addition to authentication thread and the listener thread). | help |
--cpus | <number> Override system CPU count detection. | help |
--min-port | <port> Lower bound of the UDP port range for relay endpoints allocation. | help |
--max-port | <port> Upper bound of the UDP port range for relay endpoints allocation. | help |
--sock-buf-size | <number> Size of the socket buffer for UDP sockets (in bytes). | help |
-v, --verbose | 'Moderate' verbose mode. | help |
-V, --Verbose | Extra verbose mode, very annoying (for debug purposes only). | help |
-o, --daemon | Start process as daemon (detach from current shell). | help |
--no-software-attribute | DEPRECATED Production mode: hide the software version. | help |
--software-attribute | Enable sending software attribute (for debugging). | help |
-f, --fingerprint | Use fingerprints in the TURN messages. | help |
-a, --lt-cred-mech | Use the long-term credential mechanism. | help |
-z, --no-auth | Do not use any credential mechanism, allow anonymous access. | help |
-u, --user | <user:pwd> User account, in form 'username:password', for long-term credentials. | help |
-r, --realm | <realm> The default realm to be used for the users when no explicit origin/realm relationship was found in the database. | help |
--check-origin-consistency | The flag that sets the origin consistency check: across the session, all requests must have the same main ORIGIN attribute value (if the ORIGIN was initially used by the session). | help |
-q, --user-quota | <number> Per-user allocation quota: how many concurrent allocations a user can create. | help |
-Q, --total-quota | <number> Total allocations quota: global limit on concurrent allocations. | help |
-s, --max-bps | <number> Default max bytes-per-second bandwidth a TURN session is allowed to handle (input and output network streams are treated separately). | help |
-B, --bps-capacity | <number> Maximum server capacity. | help |
-c | <filename> Configuration file name (default - turnserver.conf). | help |
-b, --db, --userdb | <filename> SQLite database file name; | help |
-e, --psql-userdb, --sql-userdb conn-string | PostgreSQL database connection string, if used (default - empty, no PostgreSQL DB used). | help |
-M, --mysql-userdb | <connection-string> MySQL database connection string, if used (default - empty, no MySQL DB used). | help |
--secret-key-file | <filename> This is the file path which contain secret key of aes encryption while using MySQL password encryption. | help |
-N, --redis-userdb | <connection-string> Redis user database connection string, if used (default - empty, no Redis DB used). | help |
-O, --redis-statsdb | <connection-string> Redis status and statistics database connection string, if used (default - empty, no Redis stats DB used). | help |
--prometheus | Enable prometheus metrics. | help |
--prometheus-port | <port> Prometheus metrics port (Default: 9641). | help |
--prometheus-address | <address> Prometheus listening address (Default: any). | help |
--prometheus-path | <path> Prometheus serve path (Default: /metrics). | help |
--prometheus-username-labels | When metrics are enabled, add labels with client usernames. | help |
--prometheus-tls | Serve the metrics endpoint over HTTPS instead of HTTP (optional). | help |
--prometheus-cert | <file> PEM certificate for the HTTPS metrics endpoint (Default: the server's --cert). | help |
--prometheus-key | <file> PEM private key for the HTTPS metrics endpoint (Default: the server's --pkey). | help |
--use-auth-secret | TURN REST API flag. | help |
--static-auth-secret | <secret> 'Static' authentication secret value (a string) for TURN REST API only. | help |
--no-auth-pings | Disable periodic health checks to 'dynamic' auth secret tables. | help |
--no-dynamic-ip-list | Do not use dynamic allowed/denied peer ip list. | help |
--no-dynamic-realms | Do not use dynamic realm assignment and options. | help |
--server-name | Server name used for the oAuth authentication purposes. | help |
--oauth | Support oAuth authentication. | help |
-n | Do not use configuration file, take all parameters from the command line only. | help |
--cert | <filename> Certificate file, PEM format. | help |
--raw-public-keys value | Enable raw public keys support (RFC 7250). | help |
--pkey | <filename> Private key file, PEM format. | help |
--pkey-pwd | <password> If the private key file is encrypted, then this password to be used. | help |
--cipher-list | <cipher-string> Allowed OpenSSL cipher list for TLS/DTLS connections. | help |
--CA-file | <filename> CA file in OpenSSL format. | help |
--ec-curve-name | <curve-name> Curve name for EC ciphers, if supported by OpenSSL library (TLS and DTLS). | help |
--dh566 | Use 566 bits predefined DH TLS key. | help |
--dh1066 | Use 1066 bits predefined DH TLS key. | help |
--dh-file | <dh-file-name> Use custom DH TLS key, stored in PEM format in the file. | help |
--tlsv1 | Set TLSv1 as a minimum supported protocol version. | help |
--tlsv1_1 | Set TLSv1.1 as a minimum supported protocol version. | help |
--no-tlsv1_2 | Set TLSv1.3/DTLSv1.2 as a minimum supported protocol version. | help |
--no-udp | Do not start UDP client listeners. | help |
--no-tcp | Do not start TCP client listeners. | help |
--no-tls | Do not start TLS client listeners. | help |
--dtls | Start DTLS client listeners. | help |
--no-udp-relay | Do not allow UDP relay endpoints, use only TCP relay option. | help |
--no-tcp-relay | Do not allow TCP relay endpoints, use only UDP relay options. | help |
-l, --log-file | <filename> Option to set the full path name of the log file. | help |
--no-stdout-log | Flag to prevent stdout log messages. | help |
--syslog | Output all log information into the system log (syslog), do not use the file output. | help |
--syslog-facility | <value> Set syslog facility for syslog messages. | help |
--simple-log | This flag means that no log file rollover will be used, and the log file name will be constructed as-is, without PID and date appendage. | help |
--log-min-level | <level> Only emit log messages at or above this level: debug, info, warning, or error. | help |
--new-log-timestamp value | Use a full ISO-8601 timestamp in all logs. | help |
--new-log-timestamp-format | <format> Set timestamp format (in strftime(1) format). | help |
--log-binding | Log STUN binding request. | help |
--stale-nonce value | Use extra security with nonce value having limited lifetime (default 600 secs). | help |
--max-allocate-lifetime | <value> Set the maximum value for the allocation lifetime. | help |
--channel-lifetime | <value> Set the lifetime for channel binding, default to 600 secs. | help |
--permission-lifetime | <value> Set the value for the lifetime of the permission. | help |
-S, --stun-only | Option to set standalone STUN operation only, all TURN requests will be ignored. | help |
--no-stun | Option to suppress STUN functionality, only TURN requests will be processed. | help |
--alternate-server | <ip:port> Set the TURN server to redirect the allocate requests (UDP and TCP services). | help |
--tls-alternate-server | <ip:port> Set the TURN server to redirect the allocate requests (DTLS and TLS services). | help |
--udp-alternate-server | <ip:port> Set the TURN server to redirect the allocate requests (UDP and DTLS services). | help |
--tcp-alternate-server | <ip:port> Set the TURN server to redirect the allocate requests (TCP service). | help |
-C, --rest-api-separator | <SYMBOL> This is the timestamp/username separator symbol (character) in TURN REST API. | help |
--max-allocate-timeout seconds | Max time, in seconds, allowed for full allocation establishment. | help |
--drain-min-allocations number | In drain mode (SIGUSR1), shut down once the number of active allocations drops to this value or below. | help |
--allowed-peer-ip ip[-ip | Specifies an ip or range of ips that are explicitly allowed to connect to the turn server. | help |
--denied-peer-ip ip[-ip | Specifies an ip or range of ips that are not allowed to connect to the turn server. | help |
--pidfile "pid-file-name" | File name to store the pid of the process. | help |
--acme-redirect URL | Redirect ACME, i.e. HTTP GET requests matching '^/.well-known/acme-challenge/(.*)' to '<URL>$1'. | help |
--secure-stun | Require authentication of the STUN Binding request. | help |
--proc-user user-name | User name to run the turnserver process. | help |
--proc-group group-name | Group name to run the turnserver process. | help |
--mobility | Mobility with ICE (MICE) specs support. | help |
-K, --keep-address-family | Deprecated in favor of --allocation-default-address-family!! TURN server allocates address family according TURN Client <=> Server communication address family. | help |
-A | Default is IPv4 TURN server allocates address family according TURN client requested address family. | help |
--cli | Turn ON the CLI support. | help |
--cli-ip IP | Local system IP address to be used for CLI server endpoint. | help |
--cli-port port | CLI server port. | help |
--cli-password password | CLI access password. | help |
--web-admin | Enable Turn Web-admin support. | help |
--web-admin-ip IP | Local system IP address to be used for Web-admin server endpoint. | help |
--web-admin-port port | Web-admin server port. | help |
--web-admin-listen-on-workers | Enable for web-admin server to listens on STUN/TURN workers STUN/TURN ports. | help |
--server-relay | Server relay. | help |
--cli-max-output-sessions | Maximum number of output sessions in ps CLI command. | help |
--no-rfc5780 | DEPRECATED and now default, see --rfc5780. | help |
--rfc5780 | Enable RFC5780 (NAT behavior discovery). | help |
--stun-backward-compatibility | Add the deprecated MAPPED-ADDRESS attribute to STUN Binding responses, alongside XOR-MAPPED-ADDRESS, for clients that cannot parse the latter. | help |
--rfc3489-compatibility | DEPRECATED. | help |
--rfc5766-channel-numbers | Accept ChannelBind channel numbers from the obsolete RFC 5766 range 0x5000-0x7FFF, which RFC 8656 reserves for multiplexing collision avoidance (RFC 7983). | help |
--respond-http-unsupported | Return an HTTP reponse with a 400 status code to HTTP connections made to ports not supporting HTTP. | help |
--drop-invalid-packets-log | Log invalid packets. | help |
--udp-recvmmsg | Linux-only batched UDP receive via recvmmsg() on the shared fan-in sockets (the client listener and, when --multiplex-peer is set, the per-thread relay socket). | help |
--udp-recvmmsg-log | Log Linux recvmmsg batch occupancy stats every 10 seconds. | help |
--udp-sendmmsg-log | Log Linux sendmmsg/UDP-GSO egress batch occupancy and GSO-engagement stats every 10 seconds. | help |
--udp-gso | Enable Linux UDP-GSO (UDP_SEGMENT cmsg) when a sendmmsg batch shares destination and size; | help |
--multiplex-peer | Enable peer-side multiplexing relay mode (non-standard, optional). | help |
--multiplex-peer-port port | Base UDP port for multiplex-peer relay sockets. | help |
--multiplex-peer-max-peers number | Maximum distinct peer IP:port endpoints one allocation may keep in the shared demux table. | help |
--include-reason-string | Include descriptive reason strings in STUN/TURN error responses. | help |
--unauthorized-ratelimit | Enable per-source rate-limiting of 401 Unauthorized responses on UDP. | help |
--unauthorized-ratelimit-rps count | Max 401 Unauthorized responses to send per source IP per second (default 10). | help |
--stateless-nonce | Issue 401/438 challenge nonces as authenticated timestamp cookies (issue time + HMAC over the client address, keyed by a per-process secret) instead of storing a random nonce in the session. | help |
--stateless-nonce-secret secret | Derive the stateless-nonce signing key from this secret instead of a random per-process key, so servers sharing the secret (and NTP-synced clocks) validate each other's nonces across restarts and… | help |
--version | Print version (and exit). | help |
-h | Help | help |