mirror of
https://github.com/element-hq/synapse.git
synced 2026-06-06 15:32:04 +00:00
deploy: 251cfc4e09
This commit is contained in:
@@ -182,13 +182,7 @@
|
||||
<nav class="pagetoc"></nav>
|
||||
</div>
|
||||
|
||||
<!--
|
||||
Include the contents of INSTALL.md from the project root without moving it, which may
|
||||
break links around the internet. Additionally, note that SUMMARY.md is unable to
|
||||
directly link to content outside of the docs/ directory. So we use this file as a
|
||||
redirection.
|
||||
-->
|
||||
<h1 id="installation-instructions"><a class="header" href="#installation-instructions">Installation Instructions</a></h1>
|
||||
<h1 id="installation-instructions"><a class="header" href="#installation-instructions">Installation Instructions</a></h1>
|
||||
<p>There are 3 steps to follow under <strong>Installation Instructions</strong>.</p>
|
||||
<ul>
|
||||
<li><a href="#installation-instructions">Installation Instructions</a>
|
||||
@@ -259,7 +253,7 @@ production-ready setup, you will probably want to specify your domain
|
||||
(<code>example.com</code>) rather than a matrix-specific hostname here (in the same way
|
||||
that your email address is probably <code>user@example.com</code> rather than
|
||||
<code>user@email.example.com</code>) - but doing so may require more advanced setup: see
|
||||
<a href="docs/federate.html">Setting up Federation</a>.</p>
|
||||
<a href="../federate.html">Setting up Federation</a>.</p>
|
||||
<h2 id="installing-synapse"><a class="header" href="#installing-synapse">Installing Synapse</a></h2>
|
||||
<h3 id="installing-from-source"><a class="header" href="#installing-from-source">Installing from source</a></h3>
|
||||
<p>(Prebuilt packages are available for some platforms - see <a href="#prebuilt-packages">Prebuilt packages</a>.)</p>
|
||||
@@ -388,8 +382,9 @@ for a number of platforms.</p>
|
||||
<h4 id="docker-images-and-ansible-playbooks"><a class="header" href="#docker-images-and-ansible-playbooks">Docker images and Ansible playbooks</a></h4>
|
||||
<p>There is an official synapse image available at
|
||||
<a href="https://hub.docker.com/r/matrixdotorg/synapse">https://hub.docker.com/r/matrixdotorg/synapse</a> which can be used with
|
||||
the docker-compose file available at <a href="contrib/docker">contrib/docker</a>. Further
|
||||
information on this including configuration options is available in the README
|
||||
the docker-compose file available at
|
||||
<a href="https://github.com/matrix-org/synapse/tree/develop/contrib/docker">contrib/docker</a>.
|
||||
Further information on this including configuration options is available in the README
|
||||
on hub.docker.com.</p>
|
||||
<p>Alternatively, Andreas Peters (previously Silvio Fricke) has contributed a
|
||||
Dockerfile to automate a synapse server in a single Docker image, at
|
||||
@@ -495,7 +490,7 @@ caching model, smarter query optimiser</li>
|
||||
<li>allowing the DB to be run on separate hardware</li>
|
||||
</ul>
|
||||
<p>For information on how to install and use PostgreSQL in Synapse, please see
|
||||
<a href="docs/postgres.html">docs/postgres.md</a></p>
|
||||
<a href="../postgres.html">docs/postgres.md</a></p>
|
||||
<p>SQLite is only acceptable for testing purposes. SQLite should not be used in
|
||||
a production server. Synapse will perform poorly when using
|
||||
SQLite, especially when participating in large rooms.</p>
|
||||
@@ -506,7 +501,7 @@ but for any practical use, you will need Synapse's APIs to be served
|
||||
over HTTPS.</p>
|
||||
<p>The recommended way to do so is to set up a reverse proxy on port
|
||||
<code>8448</code>. You can find documentation on doing so in
|
||||
<a href="docs/reverse_proxy.html">docs/reverse_proxy.md</a>.</p>
|
||||
<a href="../reverse_proxy.html">docs/reverse_proxy.md</a>.</p>
|
||||
<p>Alternatively, you can configure Synapse to expose an HTTPS port. To do
|
||||
so, you will need to edit <code>homeserver.yaml</code>, as follows:</p>
|
||||
<ul>
|
||||
@@ -532,7 +527,7 @@ includes the full certificate chain including any intermediate certificates
|
||||
</li>
|
||||
</ul>
|
||||
<p>For a more detailed guide to configuring your server for federation, see
|
||||
<a href="docs/federate.html">federate.md</a>.</p>
|
||||
<a href="../federate.html">federate.md</a>.</p>
|
||||
<h3 id="client-well-known-uri"><a class="header" href="#client-well-known-uri">Client Well-Known URI</a></h3>
|
||||
<p>Setting up the client Well-Known URI is optional but if you set it up, it will
|
||||
allow users to enter their full username (e.g. <code>@user:<server_name></code>) into clients
|
||||
@@ -618,7 +613,9 @@ anyone with knowledge of it can register users, including admin accounts,
|
||||
on your server even if <code>enable_registration</code> is <code>false</code>.</p>
|
||||
<h3 id="setting-up-a-turn-server"><a class="header" href="#setting-up-a-turn-server">Setting up a TURN server</a></h3>
|
||||
<p>For reliable VoIP calls to be routed via this homeserver, you MUST configure
|
||||
a TURN server. See <a href="docs/turn-howto.html">docs/turn-howto.md</a> for details.</p>
|
||||
a TURN server. See
|
||||
<a href="../turn-howto.html">docs/turn-howto.md</a>
|
||||
for details.</p>
|
||||
<h3 id="url-previews"><a class="header" href="#url-previews">URL previews</a></h3>
|
||||
<p>Synapse includes support for previewing URLs, which is disabled by default. To
|
||||
turn it on you must enable the <code>url_preview_enabled: True</code> config parameter
|
||||
|
||||
Reference in New Issue
Block a user