2023-05-30 15:06:50 +02:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Configuring a Turn Server - Synapse< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< link rel = "stylesheet" href = "docs/website_files/table-of-contents.css" >
< link rel = "stylesheet" href = "docs/website_files/remove-nav-buttons.css" >
< link rel = "stylesheet" href = "docs/website_files/indent-section-headers.css" >
2023-12-11 15:54:09 +01:00
< link rel = "stylesheet" href = "docs/website_files/version-picker.css" >
2023-05-30 15:06:50 +02:00
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < li class = "part-title" > Introduction< / li > < li class = "chapter-item expanded " > < a href = "welcome_and_overview.html" > Welcome and Overview< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Setup< / li > < li class = "chapter-item expanded " > < a href = "setup/installation.html" > Installation< / a > < / li > < li class = "chapter-item expanded " > < a href = "postgres.html" > Using Postgres< / a > < / li > < li class = "chapter-item expanded " > < a href = "reverse_proxy.html" > Configuring a Reverse Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "setup/forward_proxy.html" > Configuring a Forward/Outbound Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "turn-howto.html" class = "active" > Configuring a Turn Server< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "setup/turn/coturn.html" > coturn TURN server< / a > < / li > < li class = "chapter-item expanded " > < a href = "setup/turn/eturnal.html" > eturnal TURN server< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "delegate.html" > Delegation< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Upgrading< / li > < li class = "chapter-item expanded " > < a href = "upgrade.html" > Upgrading between Synapse Versions< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Usage< / li > < li class = "chapter-item expanded " > < a href = "federate.html" > Federation< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage/configuration/index.html" > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "usage/configuration/config_documentation.html" > Configuration Manual< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage/configuration/homeserver_sample_config.html" > Homeserver Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage/configuration/logging_sample_config.html" > Logging Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "structured_logging.html" > Structured Logging< / a > < / li > < li class = "chapter-item expanded " > < a href = "templates.html" > Templates< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage/configuration/user_authentication/index.html" > User Authentication< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "usage/configuration/user_authentication/single_sign_on/index.html" > Single-Sign On< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "openid.html" > OpenID Connect< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage/configuration/user_authentication/single_sign_on/saml.html" > SAML< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage/configuration/user_authentication/single_sign_on/cas.html" > CAS< / a > < / li > < li class = "chapter-item expanded " > < a href = "sso_mapping_providers.html" > SSO Mapping Providers< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "password_auth_providers.html" > Password Auth Providers< / a > < / li > < li class = "chapter-item expanded " > < a href = "jwt.html" > JSON Web Tokens< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage/configuration/user_authentication/refresh_tokens.html" > Refresh Tokens< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "CAPTCHA_SETUP.html" > Registration Captcha< / a > < / li > < li class = "chapter-item expanded " > < a href = "application_services.html" > Application Services< / a > < / li > < li class = "chapter-item expanded " > < a href = "server_notices.html" > Server Notices< / a > < / li > < li class = "chapter-item expanded " > < a href = "consent_tracking.html" > Consent Tracking< / a > < / li > < li class = "chapter-item expanded " > < a href = "user_directory.html" > User Directory< / a > < / li > < li class = "chapter-item expanded " > < a href = "message_retention_policies.html" > Message Retention Policies< / a > < / li > < li class = "chapter-item expanded " > < a href = "modules/index.html" > Pluggable Modules< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "modules/writing_a_module.html" > Writing a module< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "modules/spam_checker_callbacks.html" > Spam checker callbacks< / a > < / li > < li class
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
2023-12-11 15:54:09 +01:00
< div class = "version-picker" >
< div class = "dropdown" >
< div class = "select" >
< span > < / span >
< i class = "fa fa-chevron-down" > < / i >
< / div >
< input type = "hidden" name = "version" >
< ul class = "dropdown-menu" >
<!-- Versions will be added dynamically in version - picker.js -->
< / ul >
< / div >
< / div >
2023-05-30 15:06:50 +02:00
< / div >
< h1 class = "menu-title" > Synapse< / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< a href = "https://github.com/matrix-org/synapse" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< a href = "https://github.com/matrix-org/synapse/edit/develop/docs/turn-howto.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
<!-- Page table of contents -->
< div class = "sidetoc" >
< nav class = "pagetoc" > < / nav >
< / div >
< h1 id = "overview" > < a class = "header" href = "#overview" > Overview< / a > < / h1 >
< p > This document explains how to enable VoIP relaying on your homeserver with
TURN.< / p >
< p > The synapse Matrix homeserver supports integration with TURN server via the
< a href = "https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00" > TURN server REST API< / a > . This
allows the homeserver to generate credentials that are valid for use on the
TURN server through the use of a secret shared between the homeserver and the
TURN server.< / p >
< p > This documentation provides two TURN server configuration examples:< / p >
< ul >
< li > < a href = "setup/turn/coturn.html" > coturn< / a > < / li >
< li > < a href = "setup/turn/eturnal.html" > eturnal< / a > < / li >
< / ul >
< h2 id = "requirements" > < a class = "header" href = "#requirements" > Requirements< / a > < / h2 >
< p > For TURN relaying to work, the TURN service must be hosted on a server/endpoint with a public IP.< / p >
< p > Hosting TURN behind NAT requires port forwaring and for the NAT gateway to have a public IP.
However, even with appropriate configuration, NAT is known to cause issues and to often not work.< / p >
< p > Afterwards, the homeserver needs some further configuration.< / p >
< h2 id = "synapse-setup" > < a class = "header" href = "#synapse-setup" > Synapse setup< / a > < / h2 >
< p > Your homeserver configuration file needs the following extra keys:< / p >
< ol >
< li > < a href = "usage/configuration/config_documentation.html#turn_uris" > < code > turn_uris< / code > < / a > < / li >
< li > < a href = "usage/configuration/config_documentation.html#turn_shared_secret" > < code > turn_shared_secret< / code > < / a > < / li >
< li > < a href = "usage/configuration/config_documentation.html#turn_user_lifetime" > < code > turn_user_lifetime< / code > < / a > < / li >
< li > < a href = "usage/configuration/config_documentation.html#turn_allow_guests" > < code > turn_allow_guests< / code > < / a > < / li >
< / ol >
< p > As an example, here is the relevant section of the config file for < code > matrix.org< / code > . The
< code > turn_uris< / code > are appropriate for TURN servers listening on the default ports, with no TLS.< / p >
< pre > < code > turn_uris: [ " turn:turn.matrix.org?transport=udp" , " turn:turn.matrix.org?transport=tcp" ]
turn_shared_secret: " n0t4ctuAllymatr1Xd0TorgSshar3d5ecret4obvIousreAsons"
turn_user_lifetime: 86400000
turn_allow_guests: true
< / code > < / pre >
< p > After updating the homeserver configuration, you must restart synapse:< / p >
< ul >
< li > If you use synctl:
< pre > < code class = "language-sh" > # Depending on how Synapse is installed, synctl may already be on
# your PATH. If not, you may need to activate a virtual environment.
synctl restart
< / code > < / pre >
< / li >
< li > If you use systemd:
< pre > < code class = "language-sh" > systemctl restart matrix-synapse.service
< / code > < / pre >
< / li >
< / ul >
< p > ... and then reload any clients (or wait an hour for them to refresh their
settings).< / p >
< h2 id = "troubleshooting" > < a class = "header" href = "#troubleshooting" > Troubleshooting< / a > < / h2 >
< p > The normal symptoms of a misconfigured TURN server are that calls between
devices on different networks ring, but get stuck at " call
connecting" . Unfortunately, troubleshooting this can be tricky.< / p >
< p > Here are a few things to try:< / p >
< ul >
< li >
< p > Check that you have opened your firewall to allow TCP and UDP traffic to the
TURN ports (normally 3478 and 5349).< / p >
< / li >
< li >
< p > Check that you have opened your firewall to allow UDP traffic to the UDP
relay ports (49152-65535 by default).< / p >
< / li >
< li >
< p > Try disabling TLS/DTLS listeners and enable only its (unencrypted)
TCP/UDP listeners. (This will only leave signaling traffic unencrypted;
voice & video WebRTC traffic is always encrypted.)< / p >
< / li >
< li >
< p > Some WebRTC implementations (notably, that of Google Chrome) appear to get
confused by TURN servers which are reachable over IPv6 (this appears to be
an unexpected side-effect of its handling of multiple IP addresses as
defined by
< a href = "https://tools.ietf.org/html/draft-ietf-rtcweb-ip-handling-12" > < code > draft-ietf-rtcweb-ip-handling< / code > < / a > ).< / p >
< p > Try removing any AAAA records for your TURN server, so that it is only
reachable over IPv4.< / p >
< / li >
< li >
< p > If your TURN server is behind NAT:< / p >
< ul >
< li >
< p > double-check that your NAT gateway is correctly forwarding all TURN
ports (normally 3478 & 5349 for TCP & UDP TURN traffic, and 49152-65535 for the UDP
relay) to the NAT-internal address of your TURN server. If advertising
both IPv4 and IPv6 external addresses via the < code > external-ip< / code > option, ensure
that the NAT is forwarding both IPv4 and IPv6 traffic to the IPv4 and IPv6
internal addresses of your TURN server. When in doubt, remove AAAA records
for your TURN server and specify only an IPv4 address as your < code > external-ip< / code > .< / p >
< / li >
< li >
< p > ensure that your TURN server uses the NAT gateway as its default route.< / p >
< / li >
< / ul >
< / li >
< li >
< p > Enable more verbose logging, in < code > coturn< / code > via the < code > verbose< / code > setting:< / p >
< pre > < code > verbose
< / code > < / pre >
< p > or with < code > eturnal< / code > with the shell command < code > eturnalctl loglevel debug< / code > or in the configuration file (the service needs to < a href = "https://eturnal.net/documentation/#Operation" > reload< / a > for it to become effective):< / p >
< pre > < code class = "language-yaml" > ## Logging configuration:
log_level: debug
< / code > < / pre >
< p > ... and then see if there are any clues in its logs.< / p >
< / li >
< li >
< p > If you are using a browser-based client under Chrome, check
< code > chrome://webrtc-internals/< / code > for insights into the internals of the
negotiation. On Firefox, check the " Connection Log" on < code > about:webrtc< / code > .< / p >
< p > (Understanding the output is beyond the scope of this document!)< / p >
< / li >
< li >
< p > You can test your Matrix homeserver TURN setup with < a href = "https://test.voip.librepush.net/" > https://test.voip.librepush.net/< / a > .
Note that this test is not fully reliable yet, so don't be discouraged if
the test fails.
< a href = "https://github.com/matrix-org/voip-tester" > Here< / a > is the github repo of the
source of the tester, where you can file bug reports.< / p >
< / li >
< li >
< p > There is a WebRTC test tool at
< a href = "https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/" > https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/< / a > . To
use it, you will need a username/password for your TURN server. You can
either:< / p >
< ul >
< li >
< p > look for the < code > GET /_matrix/client/r0/voip/turnServer< / code > request made by a
matrix client to your homeserver in your browser's network inspector. In
the response you should see < code > username< / code > and < code > password< / code > . Or:< / p >
< / li >
< li >
< p > Use the following shell commands for < code > coturn< / code > :< / p >
< pre > < code class = "language-sh" > secret=staticAuthSecretHere
u=$((`date +%s` + 3600)):test
p=$(echo -n $u | openssl dgst -hmac $secret -sha1 -binary | base64)
echo -e " username: $u\npassword: $p"
< / code > < / pre >
< p > or for < code > eturnal< / code > < / p >
< pre > < code class = "language-sh" > eturnalctl credentials
< / code > < / pre >
< / li >
< li >
< p > Or (< strong > coturn only< / strong > ): Temporarily configure < code > coturn< / code > to accept a static
username/password. To do this, comment out < code > use-auth-secret< / code > and
< code > static-auth-secret< / code > and add the following:< / p >
< pre > < code > lt-cred-mech
user=username:password
< / code > < / pre >
< p > < strong > Note< / strong > : these settings will not take effect unless < code > use-auth-secret< / code >
and < code > static-auth-secret< / code > are disabled.< / p >
< p > Restart coturn after changing the configuration file.< / p >
< p > Remember to restore the original settings to go back to testing with
Matrix clients!< / p >
< / li >
< / ul >
< p > If the TURN server is working correctly, you should see at least one < code > relay< / code >
entry in the results.< / p >
< / li >
< / ul >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "setup/forward_proxy.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "setup/turn/coturn.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< a rel = "prev" href = "setup/forward_proxy.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "setup/turn/coturn.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< script type = "text/javascript" src = "docs/website_files/table-of-contents.js" > < / script >
2023-12-11 15:54:09 +01:00
< script type = "text/javascript" src = "docs/website_files/version-picker.js" > < / script >
< script type = "text/javascript" src = "docs/website_files/version.js" > < / script >
2023-05-30 15:06:50 +02:00
< / body >
2023-12-11 15:54:09 +01:00
< / html >