From 8af5e6e97960ee2099a9520ccb5fba853366885c Mon Sep 17 00:00:00 2001
From: richvdh There are 3 steps to follow under Installation Instructions.Installation Instructions
+ Installation Instructions
example.com
) rather than a matrix-specific hostname here (in the same way
that your email address is probably user@example.com
rather than
user@email.example.com
) - but doing so may require more advanced setup: see
-Setting up Federation.
(Prebuilt packages are available for some platforms - see Prebuilt packages.)
@@ -388,8 +382,9 @@ for a number of platforms.There is an official synapse image available at https://hub.docker.com/r/matrixdotorg/synapse which can be used with -the docker-compose file available at contrib/docker. Further -information on this including configuration options is available in the README +the docker-compose file available at +contrib/docker. +Further information on this including configuration options is available in the README on hub.docker.com.
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
For information on how to install and use PostgreSQL in Synapse, please see -docs/postgres.md
+docs/postgres.mdSQLite 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.
@@ -506,7 +501,7 @@ but for any practical use, you will need Synapse's APIs to be served over HTTPS.The recommended way to do so is to set up a reverse proxy on port
8448
. You can find documentation on doing so in
-docs/reverse_proxy.md.
Alternatively, you can configure Synapse to expose an HTTPS port. To do
so, you will need to edit homeserver.yaml
, as follows:
For a more detailed guide to configuring your server for federation, see -federate.md.
+federate.md.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. @user:<server_name>
) into clients
@@ -618,7 +613,9 @@ anyone with knowledge of it can register users, including admin accounts,
on your server even if enable_registration
is false
.
For reliable VoIP calls to be routed via this homeserver, you MUST configure -a TURN server. See docs/turn-howto.md for details.
+a TURN server. See +docs/turn-howto.md +for details.Synapse includes support for previewing URLs, which is disabled by default. To
turn it on you must enable the url_preview_enabled: True
config parameter
--
cgit 1.4.1