From 4bdd59384d1cbd36613dad6e9771f4342faf8ce6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Josu=C3=A9=20Tille?= Date: Fri, 8 Feb 2019 15:27:41 +0100 Subject: [PATCH] Update doc for federation --- README.md | 6 +++++- scripts/install | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 627d99c..9e2bf4e 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,9 @@ If you want a web client you can also install riot with this package: https://gi ### Access by federation -To be accessible by the federation you need to put the following line in the dns configuration: +If your server name is identical to the domain on wich synapse is installed, and the default port 8448 is used, your server is normally already accessible by the federation. + +If not, you may need to put the following line in the dns configuration: ``` _matrix._tcp. IN SRV 10 0 @@ -47,6 +49,8 @@ _matrix._tcp.example.com. 3600 IN SRV 10 0 SYNAPSE_PORT example.com. ``` You need to replace SYNAPSE_PORT by the real port. This port can be obtained by the command: `yunohost app setting SYNAPSE_INSTANCE_NAME synapse_tls_port` +For more details, see : https://github.com/matrix-org/synapse#setting-up-federation + If it is not automatically done, you need to open this in your ISP box. You also need a valid TLS certificate for the domain used by synapse. To do that you can refer to the documentation here : https://yunohost.org/#/certificate_en diff --git a/scripts/install b/scripts/install index 7c38e44..7c265d1 100644 --- a/scripts/install +++ b/scripts/install @@ -363,10 +363,14 @@ ynh_add_fail2ban_config -t # WARNING : theses command are used in INSTALL, RESTORE # For any update do it in all files -message="To federate this app you need to add this line in your DNS configuration: +message="If your server name is identical to the domain on wich synapse is installed, and the default port 8448 is used, your server is normally already accessible by the federation. + +If not, you may need to put the following line in the dns configuration: _matrix._tcp.$domain. 3600 IN SRV 10 0 $synapse_tls_port $domain. +For more details, see : https://github.com/matrix-org/synapse#setting-up-federation + You also need to open the TCP port $synapse_tls_port on your ISP box if it's not automatically done. Your synapse server also implements a turnserver (for VoIP), to have this fully functional please read the 'Turnserver' section in the README available here: https://github.com/YunoHost-Apps/synapse_ynh .