diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 97e0805..2450666 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -19,13 +19,13 @@ If your server name is identical to the domain on which synapse is installed, an If not, you can add the following line in the dns configuration but you normally don't need it as a `.well-known` file is edited during the install to declare your server name and port to the federation. -``` +```text _matrix._tcp. IN SRV 10 0 ``` for example -``` +```text _matrix._tcp.example.com. 3600 IN SRV 10 0 synapse.example.com. ``` @@ -62,7 +62,7 @@ To prevent the situation when the server is behind a NAT, the public IP is writt If you have a dynamic IP address, you also might need to update this config automatically. To do that just edit a file named `/etc/cron.d/coturn_config_rotate` and add the following content (just adapt the `` which could be `synapse` or maybe `synapse__2`). -``` +```text */15 * * * * root bash /opt/yunohost/matrix-/Coturn_config_rotate.sh; ``` @@ -82,13 +82,13 @@ exit 0 Add this line in you sudo config file `/etc/sudoers` -``` +```text openvpn ALL=(ALL) NOPASSWD: /bin/systemctl restart synapse-coturn.service ``` And add this line in your OpenVPN config file -``` +```text ipchange /usr/local/bin/openvpn_up_script.sh ``` @@ -170,7 +170,7 @@ yunohost app setting synapse port_synapse Edit the file `/etc/nginx/conf.d/.d/synapse.conf` and add this text: -``` +```text location /_matrix/ { proxy_pass http://localhost:; proxy_set_header X-Forwarded-For $remote_addr; diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md index bdf769f..d34483f 100644 --- a/doc/POST_INSTALL.md +++ b/doc/POST_INSTALL.md @@ -2,14 +2,16 @@ If your server name is identical to the domain on which synapse is installed, an If not, you may need to put the following line in the dns configuration: +```text _matrix._tcp.__DOMAIN__. 3600 IN SRV 10 0 __PORT_SYNAPSE_TLS__ __DOMAIN__. +``` -For more details, see : https://github.com/element-hq/synapse#setting-up-federation +For more details, see : You also need to open the TCP port __PORT_SYNAPSE_TLS__ 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 . +Your synapse server also implements a turnserver (for VoIP), to have this fully functional please read the 'Turnserver' section in the README available here: . -If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/synapse_ynh +If you're facing an issue or want to improve this app, please open a new issue in this project: -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 +You also need a valid TLS certificate for the domain used by synapse. To do that you can refer to the documentation here :