summary refs log tree commit diff
path: root/v1.45.0/reverse_proxy.html
diff options
context:
space:
mode:
Diffstat (limited to 'v1.45.0/reverse_proxy.html')
-rw-r--r--v1.45.0/reverse_proxy.html481
1 files changed, 0 insertions, 481 deletions
diff --git a/v1.45.0/reverse_proxy.html b/v1.45.0/reverse_proxy.html
deleted file mode 100644

index 60c7894cf3..0000000000 --- a/v1.45.0/reverse_proxy.html +++ /dev/null
@@ -1,481 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="sidebar-visible no-js light"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>Configuring a Reverse Proxy - 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"> - - - - </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" class="active">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">Configuring a Turn Server</a></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 "><a href="MSC1711_certificates_FAQ.html">Upgrading from pre-Synapse 1.0</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/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 "><div>Single-Sign On</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><div>SAML</div></li><li class="chapter-item expanded "><div>CAS</div></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></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="development/url_previews.html">URL Previews</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="chapter-item expanded "><a href="modules/third_party_rules_callbacks.html">Third-party rules callbacks</a></li><li class="chapter-item expanded "><a href="modules/presence_router_callbacks.html">Presence router callbacks</a></li><li class="chapter-item expanded "><a href="modules/account_validity_callbacks.html">Account validity callbacks</a></li><li class="chapter-item expanded "><a href="modules/porting_legacy_module.html">Porting a legacy module to the new interface</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="workers.html">Workers</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="synctl_workers.html">Using synctl with Workers</a></li><li class="chapter-item expanded "><a href="systemd-with-workers/index.html">Systemd</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="usage/administration/index.html">Administration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/administration/admin_api/index.html">Admin API</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="admin_api/account_validity.html">Account Validity</a></li><li class="chapter-item expanded "><a href="admin_api/delete_group.html">Delete Group</a></li><li class="chapter-item expanded "><a href="admin_api/event_reports.html">Event Reports</a></li><li class="chapter-item expanded "><a href="admin_api/media_admin_api.html">Media</a></li><li class="chapter-item expanded "><a href="admin_api/purge_history_api.html">Purge History</a></li><li class="chapter-item expanded "><a href="admin_api/register_api.html">Register Users</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/registration_tokens.html">Registration Tokens</a></li><li class="chapter-item expanded "><a href="admin_api/room_membership.html">Manipulate Room Membership</a></li><li class="chapter-item expanded "><a href="admin_api/rooms.html">Rooms</a></li><li class="chapter-item expanded "><a href="admin_api/server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="admin_api/statistics.html">Statistics</a></li><li class="chapter-item expanded "><a href="admin_api/user_admin_api.html">Users</a></li><li class="chapter-item expanded "><a href="admin_api/version_api.html">Server Version</a></li></ol></li><li class="chapter-item expanded "><a href="manhole.html">Manhole</a></li><li class="chapter-item expanded "><a href="metrics-howto.html">Monitoring</a></li><li class="chapter-item expanded "><a href="usage/administration/request_log.html">Request log format</a></li><li class="chapter-item expanded "><div>Scripts</div></li></ol></li><li class="chapter-item expanded "><li class="part-title">Development</li><li class="chapter-item expanded "><a href="development/contributing_guide.html">Contributing Guide</a></li><li class="chapter-item expanded "><a href="code_style.html">Code Style</a></li><li class="chapter-item expanded "><a href="development/git.html">Git Usage</a></li><li class="chapter-item expanded "><div>Testing</div></li><li class="chapter-item expanded "><a href="opentracing.html">OpenTracing</a></li><li class="chapter-item expanded "><a href="development/database_schema.html">Database Schemas</a></li><li class="chapter-item expanded "><a href="development/experimental_features.html">Experimental features</a></li><li class="chapter-item expanded "><div>Synapse Architecture</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="log_contexts.html">Log Contexts</a></li><li class="chapter-item expanded "><a href="replication.html">Replication</a></li><li class="chapter-item expanded "><a href="tcp_replication.html">TCP Replication</a></li></ol></li><li class="chapter-item expanded "><a href="development/internal_documentation/index.html">Internal Documentation</a></li><li><ol class="section"><li class="chapter-item expanded "><div>Single Sign-On</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="development/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="development/cas.html">CAS</a></li></ol></li><li class="chapter-item expanded "><a href="development/room-dag-concepts.html">Room DAG concepts</a></li><li class="chapter-item expanded "><div>State Resolution</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="auth_chain_difference_algorithm.html">The Auth Chain Difference Algorithm</a></li></ol></li><li class="chapter-item expanded "><a href="media_repository.html">Media Repository</a></li><li class="chapter-item expanded "><a href="room_and_user_statistics.html">Room and User Statistics</a></li></ol></li><li class="chapter-item expanded "><div>Scripts</div></li><li class="chapter-item expanded affix "><li class="part-title">Other</li><li class="chapter-item expanded "><a href="deprecation_policy.html">Dependency Deprecation Policy</a></li></ol> - </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> - - </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/reverse_proxy.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="using-a-reverse-proxy-with-synapse"><a class="header" href="#using-a-reverse-proxy-with-synapse">Using a reverse proxy with Synapse</a></h1> -<p>It is recommended to put a reverse proxy such as -<a href="https://nginx.org/en/docs/http/ngx_http_proxy_module.html">nginx</a>, -<a href="https://httpd.apache.org/docs/current/mod/mod_proxy_http.html">Apache</a>, -<a href="https://caddyserver.com/docs/quick-starts/reverse-proxy">Caddy</a>, -<a href="https://www.haproxy.org/">HAProxy</a> or -<a href="https://man.openbsd.org/relayd.8">relayd</a> in front of Synapse. One advantage -of doing so is that it means that you can expose the default https port -(443) to Matrix clients without needing to run Synapse with root -privileges.</p> -<p>You should configure your reverse proxy to forward requests to <code>/_matrix</code> or -<code>/_synapse/client</code> to Synapse, and have it set the <code>X-Forwarded-For</code> and -<code>X-Forwarded-Proto</code> request headers.</p> -<p>You should remember that Matrix clients and other Matrix servers do not -necessarily need to connect to your server via the same server name or -port. Indeed, clients will use port 443 by default, whereas servers default to -port 8448. Where these are different, we refer to the 'client port' and the -'federation port'. See <a href="https://matrix.org/docs/spec/server_server/latest#resolving-server-names">the Matrix -specification</a> -for more details of the algorithm used for federation connections, and -<a href="delegate.html">Delegation</a> for instructions on setting up delegation.</p> -<p><strong>NOTE</strong>: Your reverse proxy must not <code>canonicalise</code> or <code>normalise</code> -the requested URI in any way (for example, by decoding <code>%xx</code> escapes). -Beware that Apache <em>will</em> canonicalise URIs unless you specify -<code>nocanon</code>.</p> -<p>Let's assume that we expect clients to connect to our server at -<code>https://matrix.example.com</code>, and other servers to connect at -<code>https://example.com:8448</code>. The following sections detail the configuration of -the reverse proxy and the homeserver.</p> -<h2 id="homeserver-configuration"><a class="header" href="#homeserver-configuration">Homeserver Configuration</a></h2> -<p>The HTTP configuration will need to be updated for Synapse to correctly record -client IP addresses and generate redirect URLs while behind a reverse proxy. </p> -<p>In <code>homeserver.yaml</code> set <code>x_forwarded: true</code> in the port 8008 section and -consider setting <code>bind_addresses: ['127.0.0.1']</code> so that the server only -listens to traffic on localhost. (Do not change <code>bind_addresses</code> to <code>127.0.0.1</code> -when using a containerized Synapse, as that will prevent it from responding -to proxied traffic.)</p> -<h2 id="reverse-proxy-configuration-examples"><a class="header" href="#reverse-proxy-configuration-examples">Reverse-proxy configuration examples</a></h2> -<p><strong>NOTE</strong>: You only need one of these.</p> -<h3 id="nginx"><a class="header" href="#nginx">nginx</a></h3> -<pre><code>server { - listen 443 ssl http2; - listen [::]:443 ssl http2; - - # For the federation port - listen 8448 ssl http2 default_server; - listen [::]:8448 ssl http2 default_server; - - server_name matrix.example.com; - - location ~* ^(\/_matrix|\/_synapse\/client) { - # note: do not add a path (even a single /) after the port in `proxy_pass`, - # otherwise nginx will canonicalise the URI and cause signature verification - # errors. - proxy_pass http://localhost:8008; - proxy_set_header X-Forwarded-For $remote_addr; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $host; - - # Nginx by default only allows file uploads up to 1M in size - # Increase client_max_body_size to match max_upload_size defined in homeserver.yaml - client_max_body_size 50M; - } -} -</code></pre> -<h3 id="caddy-v1"><a class="header" href="#caddy-v1">Caddy v1</a></h3> -<pre><code>matrix.example.com { - proxy /_matrix http://localhost:8008 { - transparent - } - - proxy /_synapse/client http://localhost:8008 { - transparent - } -} - -example.com:8448 { - proxy / http://localhost:8008 { - transparent - } -} -</code></pre> -<h3 id="caddy-v2"><a class="header" href="#caddy-v2">Caddy v2</a></h3> -<pre><code>matrix.example.com { - reverse_proxy /_matrix/* http://localhost:8008 - reverse_proxy /_synapse/client/* http://localhost:8008 -} - -example.com:8448 { - reverse_proxy http://localhost:8008 -} -</code></pre> -<p><a href="delegate.html">Delegation</a> example:</p> -<pre><code>(matrix-well-known-header) { - # Headers - header Access-Control-Allow-Origin &quot;*&quot; - header Access-Control-Allow-Methods &quot;GET, POST, PUT, DELETE, OPTIONS&quot; - header Access-Control-Allow-Headers &quot;Origin, X-Requested-With, Content-Type, Accept, Authorization&quot; - header Content-Type &quot;application/json&quot; -} - -example.com { - handle /.well-known/matrix/server { - import matrix-well-known-header - respond `{&quot;m.server&quot;:&quot;matrix.example.com:443&quot;}` - } - - handle /.well-known/matrix/client { - import matrix-well-known-header - respond `{&quot;m.homeserver&quot;:{&quot;base_url&quot;:&quot;https://matrix.example.com&quot;},&quot;m.identity_server&quot;:{&quot;base_url&quot;:&quot;https://identity.example.com&quot;}}` - } -} - -matrix.example.com { - reverse_proxy /_matrix/* http://localhost:8008 - reverse_proxy /_synapse/client/* http://localhost:8008 -} -</code></pre> -<h3 id="apache"><a class="header" href="#apache">Apache</a></h3> -<pre><code>&lt;VirtualHost *:443&gt; - SSLEngine on - ServerName matrix.example.com - - RequestHeader set &quot;X-Forwarded-Proto&quot; expr=%{REQUEST_SCHEME} - AllowEncodedSlashes NoDecode - ProxyPreserveHost on - ProxyPass /_matrix http://127.0.0.1:8008/_matrix nocanon - ProxyPassReverse /_matrix http://127.0.0.1:8008/_matrix - ProxyPass /_synapse/client http://127.0.0.1:8008/_synapse/client nocanon - ProxyPassReverse /_synapse/client http://127.0.0.1:8008/_synapse/client -&lt;/VirtualHost&gt; - -&lt;VirtualHost *:8448&gt; - SSLEngine on - ServerName example.com - - RequestHeader set &quot;X-Forwarded-Proto&quot; expr=%{REQUEST_SCHEME} - AllowEncodedSlashes NoDecode - ProxyPass /_matrix http://127.0.0.1:8008/_matrix nocanon - ProxyPassReverse /_matrix http://127.0.0.1:8008/_matrix -&lt;/VirtualHost&gt; -</code></pre> -<p><strong>NOTE</strong>: ensure the <code>nocanon</code> options are included.</p> -<p><strong>NOTE 2</strong>: It appears that Synapse is currently incompatible with the ModSecurity module for Apache (<code>mod_security2</code>). If you need it enabled for other services on your web server, you can disable it for Synapse's two VirtualHosts by including the following lines before each of the two <code>&lt;/VirtualHost&gt;</code> above:</p> -<pre><code>&lt;IfModule security2_module&gt; - SecRuleEngine off -&lt;/IfModule&gt; -</code></pre> -<p><strong>NOTE 3</strong>: Missing <code>ProxyPreserveHost on</code> can lead to a redirect loop.</p> -<h3 id="haproxy"><a class="header" href="#haproxy">HAProxy</a></h3> -<pre><code>frontend https - bind :::443 v4v6 ssl crt /etc/ssl/haproxy/ strict-sni alpn h2,http/1.1 - http-request set-header X-Forwarded-Proto https if { ssl_fc } - http-request set-header X-Forwarded-Proto http if !{ ssl_fc } - http-request set-header X-Forwarded-For %[src] - - # Matrix client traffic - acl matrix-host hdr(host) -i matrix.example.com - acl matrix-path path_beg /_matrix - acl matrix-path path_beg /_synapse/client - - use_backend matrix if matrix-host matrix-path - -frontend matrix-federation - bind :::8448 v4v6 ssl crt /etc/ssl/haproxy/synapse.pem alpn h2,http/1.1 - http-request set-header X-Forwarded-Proto https if { ssl_fc } - http-request set-header X-Forwarded-Proto http if !{ ssl_fc } - http-request set-header X-Forwarded-For %[src] - - default_backend matrix - -backend matrix - server matrix 127.0.0.1:8008 -</code></pre> -<h3 id="relayd"><a class="header" href="#relayd">Relayd</a></h3> -<pre><code>table &lt;webserver&gt; { 127.0.0.1 } -table &lt;matrixserver&gt; { 127.0.0.1 } - -http protocol &quot;https&quot; { - tls { no tlsv1.0, ciphers &quot;HIGH&quot; } - tls keypair &quot;example.com&quot; - match header set &quot;X-Forwarded-For&quot; value &quot;$REMOTE_ADDR&quot; - match header set &quot;X-Forwarded-Proto&quot; value &quot;https&quot; - - # set CORS header for .well-known/matrix/server, .well-known/matrix/client - # httpd does not support setting headers, so do it here - match request path &quot;/.well-known/matrix/*&quot; tag &quot;matrix-cors&quot; - match response tagged &quot;matrix-cors&quot; header set &quot;Access-Control-Allow-Origin&quot; value &quot;*&quot; - - pass quick path &quot;/_matrix/*&quot; forward to &lt;matrixserver&gt; - pass quick path &quot;/_synapse/client/*&quot; forward to &lt;matrixserver&gt; - - # pass on non-matrix traffic to webserver - pass forward to &lt;webserver&gt; -} - -relay &quot;https_traffic&quot; { - listen on egress port 443 tls - protocol &quot;https&quot; - forward to &lt;matrixserver&gt; port 8008 check tcp - forward to &lt;webserver&gt; port 8080 check tcp -} - -http protocol &quot;matrix&quot; { - tls { no tlsv1.0, ciphers &quot;HIGH&quot; } - tls keypair &quot;example.com&quot; - block - pass quick path &quot;/_matrix/*&quot; forward to &lt;matrixserver&gt; - pass quick path &quot;/_synapse/client/*&quot; forward to &lt;matrixserver&gt; -} - -relay &quot;matrix_federation&quot; { - listen on egress port 8448 tls - protocol &quot;matrix&quot; - forward to &lt;matrixserver&gt; port 8008 check tcp -} -</code></pre> -<h2 id="health-check-endpoint"><a class="header" href="#health-check-endpoint">Health check endpoint</a></h2> -<p>Synapse exposes a health check endpoint for use by reverse proxies. -Each configured HTTP listener has a <code>/health</code> endpoint which always returns -200 OK (and doesn't get logged).</p> -<h2 id="synapse-administration-endpoints"><a class="header" href="#synapse-administration-endpoints">Synapse administration endpoints</a></h2> -<p>Endpoints for administering your Synapse instance are placed under -<code>/_synapse/admin</code>. These require authentication through an access token of an -admin user. However as access to these endpoints grants the caller a lot of power, -we do not recommend exposing them to the public internet without good reason.</p> - - </main> - - <nav class="nav-wrapper" aria-label="Page navigation"> - <!-- Mobile navigation buttons --> - - <a rel="prev" href="postgres.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/forward_proxy.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="postgres.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/forward_proxy.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> - - - - - </body> -</html> \ No newline at end of file