turnserver.conf 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802
  1. # Coturn TURN SERVER configuration file
  2. #
  3. # Boolean values note: where a boolean value is supposed to be used,
  4. # you can use '0', 'off', 'no', 'false', or 'f' as 'false,
  5. # and you can use '1', 'on', 'yes', 'true', or 't' as 'true'
  6. # If the value is missing, then it means 'true' by default.
  7. #
  8. # Listener interface device (optional, Linux only).
  9. # NOT RECOMMENDED.
  10. #
  11. #listening-device=eth0
  12. # TURN listener port for UDP and TCP (Default: 3478).
  13. # Note: actually, TLS & DTLS sessions can connect to the
  14. # "plain" TCP & UDP port(s), too - if allowed by configuration.
  15. #
  16. #listening-port=3478
  17. # TURN listener port for TLS (Default: 5349).
  18. # Note: actually, "plain" TCP & UDP sessions can connect to the TLS & DTLS
  19. # port(s), too - if allowed by configuration. The TURN server
  20. # "automatically" recognizes the type of traffic. Actually, two listening
  21. # endpoints (the "plain" one and the "tls" one) are equivalent in terms of
  22. # functionality; but Coturn keeps both endpoints to satisfy the RFC 5766 specs.
  23. # For secure TCP connections, Coturn currently supports
  24. # TLS version 1.0, 1.1 and 1.2.
  25. # For secure UDP connections, Coturn supports DTLS version 1.
  26. #
  27. #tls-listening-port=5349
  28. # Alternative listening port for UDP and TCP listeners;
  29. # default (or zero) value means "listening port plus one".
  30. # This is needed for RFC 5780 support
  31. # (STUN extension specs, NAT behavior discovery). The TURN Server
  32. # supports RFC 5780 only if it is started with more than one
  33. # listening IP address of the same family (IPv4 or IPv6).
  34. # RFC 5780 is supported only by UDP protocol, other protocols
  35. # are listening to that endpoint only for "symmetry".
  36. #
  37. #alt-listening-port=0
  38. # Alternative listening port for TLS and DTLS protocols.
  39. # Default (or zero) value means "TLS listening port plus one".
  40. #
  41. #alt-tls-listening-port=0
  42. # Some network setups will require using a TCP reverse proxy in front
  43. # of the STUN server. If the proxy port option is set a single listener
  44. # is started on the given port that accepts connections using the
  45. # haproxy proxy protocol v2.
  46. # (https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt)
  47. #
  48. #tcp-proxy-port=5555
  49. # Listener IP address of relay server. Multiple listeners can be specified.
  50. # If no IP(s) specified in the config file or in the command line options,
  51. # then all IPv4 and IPv6 system IPs will be used for listening.
  52. #
  53. #listening-ip=172.17.19.101
  54. #listening-ip=10.207.21.238
  55. #listening-ip=2607:f0d0:1002:51::4
  56. listening-ip=0.0.0.0
  57. # Auxiliary STUN/TURN server listening endpoint.
  58. # Aux servers have almost full TURN and STUN functionality.
  59. # The (minor) limitations are:
  60. #
  61. # 1) Auxiliary servers do not have alternative ports and
  62. # they do not support STUN RFC 5780 functionality (CHANGE REQUEST).
  63. #
  64. # 2) Auxiliary servers also are never returning ALTERNATIVE-SERVER reply.
  65. #
  66. # Valid formats are 1.2.3.4:5555 for IPv4 and [1:2::3:4]:5555 for IPv6.
  67. #
  68. # There may be multiple aux-server options, each will be used for listening
  69. # to client requests.
  70. #
  71. #aux-server=172.17.19.110:33478
  72. #aux-server=[2607:f0d0:1002:51::4]:33478
  73. # (recommended for older Linuxes only)
  74. # Automatically balance UDP traffic over auxiliary servers (if configured).
  75. # The load balancing is using the ALTERNATE-SERVER mechanism.
  76. # The TURN client must support 300 ALTERNATE-SERVER response for this
  77. # functionality.
  78. #
  79. #udp-self-balance
  80. # Relay interface device for relay sockets (optional, Linux only).
  81. # NOT RECOMMENDED.
  82. #
  83. #relay-device=eth1
  84. # Relay address (the local IP address that will be used to relay the
  85. # packets to the peer).
  86. # Multiple relay addresses may be used.
  87. # The same IP(s) can be used as both listening IP(s) and relay IP(s).
  88. #
  89. # If no relay IP(s) specified, then the turnserver will apply the default
  90. # policy: it will decide itself which relay addresses to be used, and it
  91. # will always be using the client socket IP address as the relay IP address
  92. # of the TURN session (if the requested relay address family is the same
  93. # as the family of the client socket).
  94. #
  95. #relay-ip=172.17.19.105
  96. #relay-ip=2607:f0d0:1002:51::5
  97. # For Amazon EC2 users:
  98. #
  99. # TURN Server public/private address mapping, if the server is behind NAT.
  100. # In that situation, if a -X is used in form "-X <ip>" then that ip will be reported
  101. # as relay IP address of all allocations. This scenario works only in a simple case
  102. # when one single relay address is be used, and no RFC5780 functionality is required.
  103. # That single relay address must be mapped by NAT to the 'external' IP.
  104. # The "external-ip" value, if not empty, is returned in XOR-RELAYED-ADDRESS field.
  105. # For that 'external' IP, NAT must forward ports directly (relayed port 12345
  106. # must be always mapped to the same 'external' port 12345).
  107. #
  108. # In more complex case when more than one IP address is involved,
  109. # that option must be used several times, each entry must
  110. # have form "-X <public-ip/private-ip>", to map all involved addresses.
  111. # RFC5780 NAT discovery STUN functionality will work correctly,
  112. # if the addresses are mapped properly, even when the TURN server itself
  113. # is behind A NAT.
  114. #
  115. # By default, this value is empty, and no address mapping is used.
  116. #
  117. #external-ip=60.70.80.91
  118. #
  119. #OR:
  120. #
  121. #external-ip=60.70.80.91/172.17.19.101
  122. #external-ip=60.70.80.92/172.17.19.102
  123. # Number of the relay threads to handle the established connections
  124. # (in addition to authentication thread and the listener thread).
  125. # If explicitly set to 0 then application runs relay process in a
  126. # single thread, in the same thread with the listener process
  127. # (the authentication thread will still be a separate thread).
  128. #
  129. # If this parameter is not set, then the default OS-dependent
  130. # thread pattern algorithm will be employed. Usually the default
  131. # algorithm is optimal, so you have to change this option
  132. # if you want to make some fine tweaks.
  133. #
  134. # In the older systems (Linux kernel before 3.9),
  135. # the number of UDP threads is always one thread per network listening
  136. # endpoint - including the auxiliary endpoints - unless 0 (zero) or
  137. # 1 (one) value is set.
  138. #
  139. #relay-threads=0
  140. # Lower and upper bounds of the UDP relay endpoints:
  141. # (default values are 49152 and 65535)
  142. #
  143. #min-port=49152
  144. min-port=49100
  145. #max-port=65535
  146. max-port=49199
  147. # Uncomment to run TURN server in 'normal' 'moderate' verbose mode.
  148. # By default the verbose mode is off.
  149. #verbose
  150. # Uncomment to run TURN server in 'extra' verbose mode.
  151. # This mode is very annoying and produces lots of output.
  152. # Not recommended under normal circumstances.
  153. #
  154. #Verbose
  155. # Uncomment to use fingerprints in the TURN messages.
  156. # By default the fingerprints are off.
  157. #
  158. #fingerprint
  159. # Uncomment to use long-term credential mechanism.
  160. # By default no credentials mechanism is used (any user allowed).
  161. #
  162. #lt-cred-mech
  163. # This option is the opposite of lt-cred-mech.
  164. # (TURN Server with no-auth option allows anonymous access).
  165. # If neither option is defined, and no users are defined,
  166. # then no-auth is default. If at least one user is defined,
  167. # in this file, in command line or in usersdb file, then
  168. # lt-cred-mech is default.
  169. #
  170. #no-auth
  171. # Enable prometheus exporter
  172. # If enabled the turnserver will expose an endpoint with stats on a prometheus format
  173. # this endpoint is listening on a different port to not conflict with other configurations.
  174. #
  175. # You can simply run the turnserver and access the port 9641 and path /metrics
  176. #
  177. # For more info on the prometheus exporter and metrics
  178. # https://prometheus.io/docs/introduction/overview/
  179. # https://prometheus.io/docs/concepts/data_model/
  180. #
  181. #prometheus
  182. # TURN REST API flag.
  183. # (Time Limited Long Term Credential)
  184. # Flag that sets a special authorization option that is based upon authentication secret.
  185. #
  186. # This feature's purpose is to support "TURN Server REST API", see
  187. # "TURN REST API" link in the project's page
  188. # https://github.com/coturn/coturn/
  189. #
  190. # This option is used with timestamp:
  191. #
  192. # usercombo -> "timestamp:userid"
  193. # turn user -> usercombo
  194. # turn password -> base64(hmac(secret key, usercombo))
  195. #
  196. # This allows TURN credentials to be accounted for a specific user id.
  197. # If you don't have a suitable id, then the timestamp alone can be used.
  198. # This option is enabled by turning on secret-based authentication.
  199. # The actual value of the secret is defined either by the option static-auth-secret,
  200. # or can be found in the turn_secret table in the database (see below).
  201. #
  202. # Read more about it:
  203. # - https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00
  204. # - https://www.ietf.org/proceedings/87/slides/slides-87-behave-10.pdf
  205. #
  206. # Be aware that use-auth-secret overrides some parts of lt-cred-mech.
  207. # The use-auth-secret feature depends internally on lt-cred-mech, so if you set
  208. # this option then it automatically enables lt-cred-mech internally
  209. # as if you had enabled both.
  210. #
  211. # Note that you can use only one auth mechanism at the same time! This is because,
  212. # both mechanisms conduct username and password validation in different ways.
  213. #
  214. # Use either lt-cred-mech or use-auth-secret in the conf
  215. # to avoid any confusion.
  216. #
  217. #use-auth-secret
  218. # 'Static' authentication secret value (a string) for TURN REST API only.
  219. # If not set, then the turn server
  220. # will try to use the 'dynamic' value in the turn_secret table
  221. # in the user database (if present). The database-stored value can be changed on-the-fly
  222. # by a separate program, so this is why that mode is considered 'dynamic'.
  223. #
  224. #static-auth-secret=north
  225. # Server name used for
  226. # the oAuth authentication purposes.
  227. # The default value is the realm name.
  228. #
  229. #server-name=blackdow.carleon.gov
  230. # Flag that allows oAuth authentication.
  231. #
  232. #oauth
  233. # 'Static' user accounts for the long term credentials mechanism, only.
  234. # This option cannot be used with TURN REST API.
  235. # 'Static' user accounts are NOT dynamically checked by the turnserver process,
  236. # so they can NOT be changed while the turnserver is running.
  237. #
  238. #user=username1:key1
  239. #user=username2:key2
  240. # OR:
  241. #user=username1:password1
  242. #user=username2:password2
  243. user=username:password
  244. #
  245. # Keys must be generated by turnadmin utility. The key value depends
  246. # on user name, realm, and password:
  247. #
  248. # Example:
  249. # $ turnadmin -k -u ninefingers -r north.gov -p youhavetoberealistic
  250. # Output: 0xbc807ee29df3c9ffa736523fb2c4e8ee
  251. # ('0x' in the beginning of the key is what differentiates the key from
  252. # password. If it has 0x then it is a key, otherwise it is a password).
  253. #
  254. # The corresponding user account entry in the config file will be:
  255. #
  256. #user=ninefingers:0xbc807ee29df3c9ffa736523fb2c4e8ee
  257. # Or, equivalently, with open clear password (less secure):
  258. #user=ninefingers:youhavetoberealistic
  259. #
  260. # SQLite database file name.
  261. #
  262. # The default file name is /var/db/turndb or /usr/local/var/db/turndb or
  263. # /var/lib/turn/turndb.
  264. #
  265. #userdb=/var/db/turndb
  266. # PostgreSQL database connection string in the case that you are using PostgreSQL
  267. # as the user database.
  268. # This database can be used for the long-term credential mechanism
  269. # and it can store the secret value for secret-based timed authentication in TURN REST API.
  270. # See http://www.postgresql.org/docs/8.4/static/libpq-connect.html for 8.x PostgreSQL
  271. # versions connection string format, see
  272. # http://www.postgresql.org/docs/9.2/static/libpq-connect.html#LIBPQ-CONNSTRING
  273. # for 9.x and newer connection string formats.
  274. #
  275. #psql-userdb="host=<host> dbname=<database-name> user=<database-user> password=<database-user-password> connect_timeout=30"
  276. # MySQL database connection string in the case that you are using MySQL
  277. # as the user database.
  278. # This database can be used for the long-term credential mechanism
  279. # and it can store the secret value for secret-based timed authentication in TURN REST API.
  280. #
  281. # Optional connection string parameters for the secure communications (SSL):
  282. # ca, capath, cert, key, cipher
  283. # (see http://dev.mysql.com/doc/refman/5.1/en/ssl-options.html for the
  284. # command options description).
  285. #
  286. # Use the string format below (space separated parameters, all optional):
  287. #
  288. #mysql-userdb="host=<host> dbname=<database-name> user=<database-user> password=<database-user-password> port=<port> connect_timeout=<seconds> read_timeout=<seconds>"
  289. # If you want to use an encrypted password in the MySQL connection string,
  290. # then set the MySQL password encryption secret key file with this option.
  291. #
  292. # Warning: If this option is set, then the mysql password must be set in "mysql-userdb" in an encrypted format!
  293. # If you want to use a cleartext password then do not set this option!
  294. #
  295. # This is the file path for the aes encrypted secret key used for password encryption.
  296. #
  297. #secret-key-file=/path/
  298. # MongoDB database connection string in the case that you are using MongoDB
  299. # as the user database.
  300. # This database can be used for long-term credential mechanism
  301. # and it can store the secret value for secret-based timed authentication in TURN REST API.
  302. # Use the string format described at http://hergert.me/docs/mongo-c-driver/mongoc_uri.html
  303. #
  304. #mongo-userdb="mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]"
  305. # Redis database connection string in the case that you are using Redis
  306. # as the user database.
  307. # This database can be used for long-term credential mechanism
  308. # and it can store the secret value for secret-based timed authentication in TURN REST API.
  309. # Use the string format below (space separated parameters, all optional):
  310. #
  311. #redis-userdb="ip=<ip-address> dbname=<database-number> password=<database-user-password> port=<port> connect_timeout=<seconds>"
  312. # Redis status and statistics database connection string, if used (default - empty, no Redis stats DB used).
  313. # This database keeps allocations status information, and it can be also used for publishing
  314. # and delivering traffic and allocation event notifications.
  315. # The connection string has the same parameters as redis-userdb connection string.
  316. # Use the string format below (space separated parameters, all optional):
  317. #
  318. #redis-statsdb="ip=<ip-address> dbname=<database-number> password=<database-user-password> port=<port> connect_timeout=<seconds>"
  319. # The default realm to be used for the users when no explicit
  320. # origin/realm relationship is found in the database, or if the TURN
  321. # server is not using any database (just the commands-line settings
  322. # and the userdb file). Must be used with long-term credentials
  323. # mechanism or with TURN REST API.
  324. #
  325. # Note: If the default realm is not specified, then realm falls back to the host domain name.
  326. # If the domain name string is empty, or set to '(None)', then it is initialized as an empty string.
  327. #
  328. #realm=mycompany.org
  329. realm=coturn
  330. # This flag sets the origin consistency
  331. # check. Across the session, all requests must have the same
  332. # main ORIGIN attribute value (if the ORIGIN was
  333. # initially used by the session).
  334. #
  335. #check-origin-consistency
  336. # Per-user allocation quota.
  337. # default value is 0 (no quota, unlimited number of sessions per user).
  338. # This option can also be set through the database, for a particular realm.
  339. #
  340. #user-quota=0
  341. # Total allocation quota.
  342. # default value is 0 (no quota).
  343. # This option can also be set through the database, for a particular realm.
  344. #
  345. #total-quota=0
  346. # Max bytes-per-second bandwidth a TURN session is allowed to handle
  347. # (input and output network streams are treated separately). Anything above
  348. # that limit will be dropped or temporarily suppressed (within
  349. # the available buffer limits).
  350. # This option can also be set through the database, for a particular realm.
  351. #
  352. #max-bps=0
  353. #
  354. # Maximum server capacity.
  355. # Total bytes-per-second bandwidth the TURN server is allowed to allocate
  356. # for the sessions, combined (input and output network streams are treated separately).
  357. #
  358. # bps-capacity=0
  359. # Uncomment if no UDP client listener is desired.
  360. # By default UDP client listener is always started.
  361. #
  362. #no-udp
  363. # Uncomment if no TCP client listener is desired.
  364. # By default TCP client listener is always started.
  365. #
  366. #no-tcp
  367. # Uncomment if no TLS client listener is desired.
  368. # By default TLS client listener is always started.
  369. #
  370. #no-tls
  371. # Uncomment if no DTLS client listener is desired.
  372. # By default DTLS client listener is always started.
  373. #
  374. #no-dtls
  375. # Uncomment if no UDP relay endpoints are allowed.
  376. # By default UDP relay endpoints are enabled (like in RFC 5766).
  377. #
  378. #no-udp-relay
  379. # Uncomment if no TCP relay endpoints are allowed.
  380. # By default TCP relay endpoints are enabled (like in RFC 6062).
  381. #
  382. #no-tcp-relay
  383. # Uncomment if extra security is desired,
  384. # with nonce value having a limited lifetime.
  385. # The nonce value is unique for a session.
  386. # Set this option to limit the nonce lifetime.
  387. # Set it to 0 for unlimited lifetime.
  388. # It defaults to 600 secs (10 min) if no value is provided. After that delay,
  389. # the client will get 438 error and will have to re-authenticate itself.
  390. #
  391. #stale-nonce=600
  392. # Uncomment if you want to set the maximum allocation
  393. # time before it has to be refreshed.
  394. # Default is 3600s.
  395. #
  396. #max-allocate-lifetime=3600
  397. # Uncomment to set the lifetime for the channel.
  398. # Default value is 600 secs (10 minutes).
  399. # This value MUST not be changed for production purposes.
  400. #
  401. #channel-lifetime=600
  402. # Uncomment to set the permission lifetime.
  403. # Default to 300 secs (5 minutes).
  404. # In production this value MUST not be changed,
  405. # however it can be useful for test purposes.
  406. #
  407. #permission-lifetime=300
  408. # Certificate file.
  409. # Use an absolute path or path relative to the
  410. # configuration file.
  411. # Use PEM file format.
  412. #
  413. #cert=/usr/local/etc/turn_server_cert.pem
  414. cert=/etc/letsencrypt/live/SERVER_NAME/fullchain.pem
  415. # Private key file.
  416. # Use an absolute path or path relative to the
  417. # configuration file.
  418. # Use PEM file format.
  419. #
  420. #pkey=/usr/local/etc/turn_server_pkey.pem
  421. pkey=/etc/letsencrypt/live/SERVER_NAME/privkey.pem
  422. # Private key file password, if it is in encoded format.
  423. # This option has no default value.
  424. #
  425. #pkey-pwd=...
  426. # Allowed OpenSSL cipher list for TLS/DTLS connections.
  427. # Default value is "DEFAULT".
  428. #
  429. #cipher-list="DEFAULT"
  430. # CA file in OpenSSL format.
  431. # Forces TURN server to verify the client SSL certificates.
  432. # By default this is not set: there is no default value and the client
  433. # certificate is not checked.
  434. #
  435. # Example:
  436. #CA-file=/etc/ssh/id_rsa.cert
  437. # Curve name for EC ciphers, if supported by OpenSSL
  438. # library (TLS and DTLS). The default value is prime256v1,
  439. # if pre-OpenSSL 1.0.2 is used. With OpenSSL 1.0.2+,
  440. # an optimal curve will be automatically calculated, if not defined
  441. # by this option.
  442. #
  443. #ec-curve-name=prime256v1
  444. # Use 566 bits predefined DH TLS key. Default size of the key is 2066.
  445. #
  446. #dh566
  447. # Use 1066 bits predefined DH TLS key. Default size of the key is 2066.
  448. #
  449. #dh1066
  450. # Use custom DH TLS key, stored in PEM format in the file.
  451. # Flags --dh566 and --dh1066 are ignored when the DH key is taken from a file.
  452. #
  453. #dh-file=<DH-PEM-file-name>
  454. # Flag to prevent stdout log messages.
  455. # By default, all log messages go to both stdout and to
  456. # the configured log file. With this option everything will
  457. # go to the configured log only (unless the log file itself is stdout).
  458. #
  459. #no-stdout-log
  460. # Option to set the log file name.
  461. # By default, the turnserver tries to open a log file in
  462. # /var/log, /var/tmp, /tmp and the current directory
  463. # (Whichever file open operation succeeds first will be used).
  464. # With this option you can set the definite log file name.
  465. # The special names are "stdout" and "-" - they will force everything
  466. # to the stdout. Also, the "syslog" name will force everything to
  467. # the system log (syslog).
  468. # In the runtime, the logfile can be reset with the SIGHUP signal
  469. # to the turnserver process.
  470. #
  471. #log-file=/var/tmp/turn.log
  472. log-file=/var/log/coturn/
  473. # Option to redirect all log output into system log (syslog).
  474. #
  475. #syslog
  476. # Set syslog facility for syslog messages
  477. # Default values is ''.
  478. #
  479. #syslog-facility="LOG_LOCAL1"
  480. # This flag means that no log file rollover will be used, and the log file
  481. # name will be constructed as-is, without PID and date appendage.
  482. # This option can be used, for example, together with the logrotate tool.
  483. #
  484. #simple-log
  485. # Enable full ISO-8601 timestamp in all logs.
  486. #new-log-timestamp
  487. # Set timestamp format (in strftime(1) format). Depends on new-log-timestamp to be enabled.
  488. #new-log-timestamp-format "%FT%T%z"
  489. # Disabled by default binding logging in verbose log mode to avoid DoS attacks.
  490. # Enable binding logging and UDP endpoint logs in verbose log mode.
  491. #log-binding
  492. # Option to set the "redirection" mode. The value of this option
  493. # will be the address of the alternate server for UDP & TCP service in the form of
  494. # <ip>[:<port>]. The server will send this value in the attribute
  495. # ALTERNATE-SERVER, with error 300, on ALLOCATE request, to the client.
  496. # Client will receive only values with the same address family
  497. # as the client network endpoint address family.
  498. # See RFC 5389 and RFC 5766 for the description of ALTERNATE-SERVER functionality.
  499. # The client must use the obtained value for subsequent TURN communications.
  500. # If more than one --alternate-server option is provided, then the functionality
  501. # can be more accurately described as "load-balancing" than a mere "redirection".
  502. # If the port number is omitted, then the default port
  503. # number 3478 for the UDP/TCP protocols will be used.
  504. # Colon (:) characters in IPv6 addresses may conflict with the syntax of
  505. # the option. To alleviate this conflict, literal IPv6 addresses are enclosed
  506. # in square brackets in such resource identifiers, for example:
  507. # [2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478 .
  508. # Multiple alternate servers can be set. They will be used in the
  509. # round-robin manner. All servers in the pool are considered of equal weight and
  510. # the load will be distributed equally. For example, if you have 4 alternate servers,
  511. # then each server will receive 25% of ALLOCATE requests. A alternate TURN server
  512. # address can be used more than one time with the alternate-server option, so this
  513. # can emulate "weighting" of the servers.
  514. #
  515. # Examples:
  516. #alternate-server=1.2.3.4:5678
  517. #alternate-server=11.22.33.44:56789
  518. #alternate-server=5.6.7.8
  519. #alternate-server=[2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478
  520. # Option to set alternative server for TLS & DTLS services in form of
  521. # <ip>:<port>. If the port number is omitted, then the default port
  522. # number 5349 for the TLS/DTLS protocols will be used. See the previous
  523. # option for the functionality description.
  524. #
  525. # Examples:
  526. #tls-alternate-server=1.2.3.4:5678
  527. #tls-alternate-server=11.22.33.44:56789
  528. #tls-alternate-server=[2001:db8:85a3:8d3:1319:8a2e:370:7348]:3478
  529. # Option to suppress TURN functionality, only STUN requests will be processed.
  530. # Run as STUN server only, all TURN requests will be ignored.
  531. # By default, this option is NOT set.
  532. #
  533. #stun-only
  534. # Option to hide software version. Enhance security when used in production.
  535. # Revealing the specific software version of the agent through the
  536. # SOFTWARE attribute might allow them to become more vulnerable to
  537. # attacks against software that is known to contain security holes.
  538. # Implementers SHOULD make usage of the SOFTWARE attribute a
  539. # configurable option (https://tools.ietf.org/html/rfc5389#section-16.1.2)
  540. #
  541. #no-software-attribute
  542. # Option to suppress STUN functionality, only TURN requests will be processed.
  543. # Run as TURN server only, all STUN requests will be ignored.
  544. # By default, this option is NOT set.
  545. #
  546. #no-stun
  547. # This is the timestamp/username separator symbol (character) in TURN REST API.
  548. # The default value is ':'.
  549. # rest-api-separator=:
  550. # Flag that can be used to allow peers on the loopback addresses (127.x.x.x and ::1).
  551. # This is an extra security measure.
  552. #
  553. # (To avoid any security issue that allowing loopback access may raise,
  554. # the no-loopback-peers option is replaced by allow-loopback-peers.)
  555. #
  556. # Allow it only for testing in a development environment!
  557. # In production it adds a possible security vulnerability, so for security reasons
  558. # it is not allowed using it together with empty cli-password.
  559. #
  560. #allow-loopback-peers
  561. # Flag that can be used to disallow peers on well-known broadcast addresses (224.0.0.0 and above, and FFXX:*).
  562. # This is an extra security measure.
  563. #
  564. #no-multicast-peers
  565. # Option to set the max time, in seconds, allowed for full allocation establishment.
  566. # Default is 60 seconds.
  567. #
  568. #max-allocate-timeout=60
  569. # Option to allow or ban specific ip addresses or ranges of ip addresses.
  570. # If an ip address is specified as both allowed and denied, then the ip address is
  571. # considered to be allowed. This is useful when you wish to ban a range of ip
  572. # addresses, except for a few specific ips within that range.
  573. #
  574. # This can be used when you do not want users of the turn server to be able to access
  575. # machines reachable by the turn server, but would otherwise be unreachable from the
  576. # internet (e.g. when the turn server is sitting behind a NAT)
  577. #
  578. # Examples:
  579. # denied-peer-ip=83.166.64.0-83.166.95.255
  580. # allowed-peer-ip=83.166.68.45
  581. # File name to store the pid of the process.
  582. # Default is /var/run/turnserver.pid (if superuser account is used) or
  583. # /var/tmp/turnserver.pid .
  584. #
  585. #pidfile="/var/run/turnserver.pid"
  586. # Require authentication of the STUN Binding request.
  587. # By default, the clients are allowed anonymous access to the STUN Binding functionality.
  588. #
  589. #secure-stun
  590. # Mobility with ICE (MICE) specs support.
  591. #
  592. #mobility
  593. # Allocate Address Family according (DEPRECATED and will be removed in favour of allocation-default-address-family)
  594. # If enabled then TURN server allocates address family according the TURN
  595. # Client <=> Server communication address family.
  596. # (By default Coturn works according RFC 6156.)
  597. # !!Warning: Enabling this option breaks RFC6156 section-4.2 (violates use default IPv4)!!
  598. #
  599. #keep-address-family
  600. # TURN server allocates address family according TURN client requested address family.
  601. # If address family not requested explicitly by the client, then it falls back to this default.
  602. # The standard RFC explicitly define that this default must be IPv4,
  603. # so use other option values with care!
  604. # Possible values: "ipv4" or "ipv6" or "keep"
  605. # "keep" sets the allocation default address family according to
  606. # the TURN client allocation request connection address family.
  607. #allocation-default-address-family="ipv4"
  608. #allocation-default-address-family="ipv4"
  609. # User name to run the process. After the initialization, the turnserver process
  610. # will attempt to change the current user ID to that user.
  611. #
  612. #proc-user=<user-name>
  613. # Group name to run the process. After the initialization, the turnserver process
  614. # will attempt to change the current group ID to that group.
  615. #
  616. #proc-group=<group-name>
  617. # Turn OFF the CLI support.
  618. # By default it is always ON.
  619. # See also options cli-ip and cli-port.
  620. #
  621. #no-cli
  622. #Local system IP address to be used for CLI server endpoint. Default value
  623. # is 127.0.0.1.
  624. #
  625. #cli-ip=127.0.0.1
  626. # CLI server port. Default is 5766.
  627. #
  628. #cli-port=5766
  629. # CLI access password. Default is empty (no password).
  630. # For the security reasons, it is recommended that you use the encrypted
  631. # form of the password (see the -P command in the turnadmin utility).
  632. #
  633. # Secure form for password 'qwerty':
  634. #
  635. #cli-password=$5$79a316b350311570$81df9cfb9af7f5e5a76eada31e7097b663a0670f99a3c07ded3f1c8e59c5658a
  636. #
  637. # Or unsecure form for the same password:
  638. #
  639. #cli-password=qwerty
  640. # Enable Web-admin support on https. By default it is Disabled.
  641. # If it is enabled it also enables a http a simple static banner page
  642. # with a small reminder that the admin page is available only on https.
  643. #
  644. #web-admin
  645. # Local system IP address to be used for Web-admin server endpoint. Default value is 127.0.0.1.
  646. #
  647. #web-admin-ip=127.0.0.1
  648. # Web-admin server port. Default is 8080.
  649. #
  650. #web-admin-port=8080
  651. # Web-admin server listen on STUN/TURN worker threads
  652. # By default it is disabled for security resons! (Not recommended in any production environment!)
  653. #
  654. #web-admin-listen-on-workers
  655. #acme-redirect=http://redirectserver/.well-known/acme-challenge/
  656. # Redirect ACME, i.e. HTTP GET requests matching '^/.well-known/acme-challenge/(.*)' to '<URL>$1'.
  657. # Default is '', i.e. no special handling for such requests.
  658. # Server relay. NON-STANDARD AND DANGEROUS OPTION.
  659. # Only for those applications when you want to run
  660. # server applications on the relay endpoints.
  661. # This option eliminates the IP permissions check on
  662. # the packets incoming to the relay endpoints.
  663. #
  664. #server-relay
  665. # Maximum number of output sessions in ps CLI command.
  666. # This value can be changed on-the-fly in CLI. The default value is 256.
  667. #
  668. #cli-max-output-sessions
  669. # Set network engine type for the process (for internal purposes).
  670. #
  671. #ne=[1|2|3]
  672. # Do not allow an TLS/DTLS version of protocol
  673. #
  674. #no-tlsv1
  675. #no-tlsv1_1
  676. #no-tlsv1_2
  677. # Disable RFC5780 (NAT behavior discovery).
  678. #
  679. # Originally, if there are more than one listener address from the same
  680. # address family, then by default the NAT behavior discovery feature enabled.
  681. # This option disables the original behavior, because the NAT behavior
  682. # discovery adds extra attributes to response, and this increase the
  683. # possibility of an amplification attack.
  684. #
  685. # Strongly encouraged to use this option to decrease gain factor in STUN
  686. # binding responses.
  687. #
  688. no-rfc5780
  689. # Disable handling old STUN Binding requests and disable MAPPED-ADDRESS
  690. # attribute in binding response (use only the XOR-MAPPED-ADDRESS).
  691. #
  692. # Strongly encouraged to use this option to decrease gain factor in STUN
  693. # binding responses.
  694. #
  695. no-stun-backward-compatibility
  696. # Only send RESPONSE-ORIGIN attribute in binding response if RFC5780 is enabled.
  697. #
  698. # Strongly encouraged to use this option to decrease gain factor in STUN
  699. # binding responses.
  700. #
  701. response-origin-only-with-rfc5780