YunoHost-Apps/synapse_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/synapse_ynh.git synced 2024-09-03 20:26:38 +02:00
Code Issues Activity Actions

markdown fixes

Browse source
This commit is contained in:
OniriCorpe 2024-03-13 21:36:07 +01:00
parent 06b27aee6e
commit 0f3dc49815
2 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/ADMIN.md
View file

@ -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. 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.<server_name.tld> <ttl> IN SRV 10 0 <port> <domain-or-subdomain-of-synapse.tld> _matrix._tcp.<server_name.tld> <ttl> IN SRV 10 0 <port> <domain-or-subdomain-of-synapse.tld>
``` ```
for example for example
``` ```text
_matrix._tcp.example.com. 3600 IN SRV 10 0 <synapse_port> synapse.example.com. _matrix._tcp.example.com. 3600 IN SRV 10 0 <synapse_port> 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 `<synapse_instance_name>` which could be `synapse` or maybe `synapse__2`). 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 `<synapse_instance_name>` which could be `synapse` or maybe `synapse__2`).
``` ```text
*/15 * * * * root bash /opt/yunohost/matrix-<synapse_instance_name>/Coturn_config_rotate.sh; */15 * * * * root bash /opt/yunohost/matrix-<synapse_instance_name>/Coturn_config_rotate.sh;
``` ```
@ -82,13 +82,13 @@ exit 0
Add this line in you sudo config file `/etc/sudoers` Add this line in you sudo config file `/etc/sudoers`
``` ```text
openvpn ALL=(ALL) NOPASSWD: /bin/systemctl restart synapse-coturn.service openvpn ALL=(ALL) NOPASSWD: /bin/systemctl restart synapse-coturn.service
``` ```
And add this line in your OpenVPN config file And add this line in your OpenVPN config file
``` ```text
ipchange /usr/local/bin/openvpn_up_script.sh 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/<previous-domain.tld>.d/synapse.conf` and add this text: Edit the file `/etc/nginx/conf.d/<previous-domain.tld>.d/synapse.conf` and add this text:
``` ```text
location /_matrix/ { location /_matrix/ {
proxy_pass http://localhost:<server_port_retrived_before>; proxy_pass http://localhost:<server_port_retrived_before>;
proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-For $remote_addr;

10
doc/POST_INSTALL.md
View file

@ -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: 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__. _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 : <https://github.com/element-hq/synapse#setting-up-federation>
You also need to open the TCP port __PORT_SYNAPSE_TLS__ on your ISP box if it's not automatically done. 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: <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: 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: <https://github.com/YunoHost-Apps/synapse_ynh>
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 : <https://yunohost.org/#/certificate_en>