mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
Fix typos
This commit is contained in:
ericgaspar
parent
d964f98eb4
commit
1ebfceecc5
3 changed files with 43 additions and 37 deletions
|
|
@ -14,7 +14,7 @@ routes:
|
|||
- [Liens utiles](#liens-utiles)
|
||||
|
||||
*Synapse* est un serveurs de messagerie instantanée.
|
||||
Chatroom de YunoHost avec matrix : [https://matrix.to/#/#yunohost:matrix.org](https://matrix.to/#/#yunohost:matrix.org)
|
||||
Chatroom de YunoHost avec Matrix : [https://matrix.to/#/#yunohost:matrix.org](https://matrix.to/#/#yunohost:matrix.org)
|
||||
|
||||
### Avertissements / informations importantes
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ Chatroom de YunoHost avec matrix : [https://matrix.to/#/#yunohost:matrix.org](ht
|
|||
|
||||
#### Installation sur les architectures ARM (ou architectures lentes)
|
||||
|
||||
Pour toutes les architectures lentes ou arm, il est recommandé de construire le fichier dh avant l'installation pour avoir une installation plus rapide.
|
||||
Pour toutes les architectures lentes ou ARM, il est recommandé de construire le fichier dh avant l'installation pour avoir une installation plus rapide.
|
||||
Vous pouvez le construire par cette commande : `openssl dhparam -out /etc/ssl/private/dh2048.pem 2048 > /dev/null`
|
||||
Après cela, vous pouvez l'installer sans problème.
|
||||
|
||||
|
|
@ -35,18 +35,21 @@ Si vous voulez un client web, vous pouvez aussi installer Element avec ce paquet
|
|||
|
||||
#### Accès par une fédération
|
||||
|
||||
Si le nom de votre serveur est identique au domaine sur lequel synapse est installé, et que le port par défaut 8448 est utilisé, votre serveur est normalement déjà accessible par la fédération.
|
||||
Si le nom de votre serveur est identique au domaine sur lequel Synapse est installé, et que le port par défaut 8448 est utilisé, votre serveur est normalement déjà accessible par la fédération.
|
||||
|
||||
Si ce n'est pas le cas, vous pouvez ajouter la ligne suivante dans la configuration dns mais vous n'en avez normalement pas besoin car un fichier .well-known est édité pendant l'installation pour déclarer le nom et le port de votre serveur à la fédération.
|
||||
|
||||
```
|
||||
_matrix._tcp.<server_name.tld> <ttl> IN SRV 10 0 <port> <domain-or-subdomain-of-synapse.tld>
|
||||
```
|
||||
|
||||
Par exemple :
|
||||
|
||||
```
|
||||
_matrix._tcp.example.com. 3600 IN SRV 10 0 SYNAPSE_PORT synapse.example.com.
|
||||
```
|
||||
Vous devez remplacer SYNAPSE_PORT par le port réel. Ce port peut être obtenu par la commande : `yunohost app setting SYNAPSE_INSTANCE_NAME synapse_tls_port`
|
||||
|
||||
Vous devez remplacer `SYNAPSE_PORT` par le port réel. Ce port peut être obtenu par la commande : `yunohost app setting SYNAPSE_INSTANCE_NAME synapse_tls_port`
|
||||
|
||||
Pour plus de détails, voir : https://github.com/matrix-org/synapse/blob/master/docs/federate.m
|
||||
|
||||
|
|
@ -56,15 +59,17 @@ Vous avez également besoin d'un certificat TLS valide pour le domaine utilisé
|
|||
|
||||
#### Turnserver
|
||||
|
||||
Pour la Voip et la vidéoconférence, un turnserver est également installé (et configuré). Le turnserver écoute sur deux ports UDP et TCP. Vous pouvez les obtenir avec ces commandes :
|
||||
Pour la VoIP et la vidéoconférence, un turnserver est également installé (et configuré). Le turnserver écoute sur deux ports UDP et TCP. Vous pouvez les obtenir avec ces commandes :
|
||||
|
||||
```
|
||||
yunohost app setting synapse turnserver_tls_port
|
||||
yunohost app setting synapse turnserver_alt_tls_port
|
||||
|
||||
```
|
||||
|
||||
Le turnserver choisira également un port de manière dynamique lorsqu'un nouvel appel est lancé. La plage est comprise entre 49153 et 49193.
|
||||
|
||||
Pour des raisons de sécurité, la plage de ports (49153 - 49193) n'est pas automatiquement ouverte par défaut. Si vous souhaitez utiliser le serveur synapse pour la voix ou la conférence, vous devrez ouvrir cette plage de ports manuellement. Pour ce faire, il suffit d'exécuter cette commande :
|
||||
Pour des raisons de sécurité, la plage de ports (49153-49193) n'est pas automatiquement ouverte par défaut. Si vous souhaitez utiliser le serveur synapse pour la voix ou la conférence, vous devrez ouvrir cette plage de ports manuellement. Pour ce faire, il suffit d'exécuter cette commande :
|
||||
|
||||
```
|
||||
yunohost firewall allow Both 49153:49193
|
||||
|
|
@ -74,7 +79,7 @@ Vous devrez peut-être aussi ouvrir ces ports (si cela n'est pas fait automatiqu
|
|||
|
||||
Pour éviter la situation où le serveur est derrière un NAT, l'IP publique est écrite dans la configuration du turnserver. De cette façon, le turnserver peut envoyer son IP publique réelle au client. Pour plus d'informations, voir [l'exemple de fichier de configuration de coturn](https://github.com/coturn/coturn/blob/master/examples/etc/turnserver.conf#L102-L120). Donc si votre IP change, vous pouvez exécuter le script `/opt/yunohost/__SYNAPSE_INSTANCE_NAME__/Coturn_config_rotate.sh` pour mettre à jour votre configuration.
|
||||
|
||||
Si vous avez une adresse IP dynamique, vous pouvez aussi avoir besoin de mettre à jour cette configuration automatiquement. Pour cela, éditez simplement un fichier nommé `/etc/cron.d/coturn_config_rotate` et ajoutez le contenu suivant (adaptez juste le __SYNAPSE_INSTANCE_NAME__ qui pourrait être `synapse` ou peut-être `synapse__2`).
|
||||
Si vous avez une adresse IP dynamique, vous pouvez aussi avoir besoin de mettre à jour cette configuration automatiquement. Pour cela, éditez simplement un fichier nommé `/etc/cron.d/coturn_config_rotate` et ajoutez le contenu suivant (adaptez juste le `__SYNAPSE_INSTANCE_NAME__` qui pourrait être `synapse` ou peut-être `synapse__2`).
|
||||
|
||||
```
|
||||
*/15 * * * * root bash /opt/yunohost/__SYNAPSE_INSTANCE_NAME__/Coturn_config_rotate.sh;
|
||||
|
|
@ -83,6 +88,7 @@ Si vous avez une adresse IP dynamique, vous pouvez aussi avoir besoin de mettre
|
|||
##### OpenVPN
|
||||
|
||||
Dans le cas où vous avez un serveur OpenVPN, vous pouvez vouloir que `coturn-synapse` redémarre quand le VPN redémarre. Pour ce faire, créez un fichier nommé `/usr/local/bin/openvpn_up_script.sh` avec ce contenu :
|
||||
|
||||
```
|
||||
#!/bin/bash
|
||||
|
||||
|
|
@ -94,26 +100,22 @@ exit 0
|
|||
```
|
||||
|
||||
Ajouter cette ligne dans le fichier de configuration sudo `/etc/sudoers`
|
||||
|
||||
```
|
||||
openvpn ALL=(ALL) NOPASSWD: /bin/systemctl restart coturn-synapse.service
|
||||
```
|
||||
|
||||
Et ajoutez cette ligne dans votre fichier de configuration OpenVPN
|
||||
|
||||
```
|
||||
ipchange /usr/local/bin/openvpn_up_script.sh
|
||||
```
|
||||
|
||||
#### Remarque importante sur la sécurité
|
||||
|
||||
Nous ne recommandons pas d'exécuter Element à partir du même nom de domaine que votre serveur domestique Matrix
|
||||
(synapse). La raison en est le risque de vulnérabilité XSS (cross-site-scripting).
|
||||
qui pourraient se produire si quelqu'un faisait en sorte que Element charge et rende
|
||||
contenu malveillant généré par l'utilisateur à partir d'une API Matrix qui a ensuite un accès de confiance à Element (ou à d'autres applications).
|
||||
à Element (ou à d'autres applications) en raison du partage du même domaine.
|
||||
Nous ne recommandons pas d'exécuter Element à partir du même nom de domaine que votre serveur domestique Matrix (Synapse). La raison en est le risque de vulnérabilité XSS (cross-site-scripting) qui pourraient se produire si quelqu'un faisait en sorte que Element charge et rende contenu malveillant généré par l'utilisateur à partir d'une API Matrix qui a ensuite un accès de confiance à Element (ou à d'autres applications) en raison du partage du même domaine.
|
||||
|
||||
Nous avons mis en place des mesures d'atténuation sommaires pour essayer de nous protéger contre cette situation.
|
||||
situation, mais ce n'est toujours pas une bonne pratique de le faire en premier lieu. Voir
|
||||
https://github.com/vector-im/element-web/issues/1977 pour plus de détails.
|
||||
Nous avons mis en place des mesures d'atténuation sommaires pour essayer de nous protéger contre cette situation, mais ce n'est toujours pas une bonne pratique de le faire en premier lieu. Voir https://github.com/vector-im/element-web/issues/1977 pour plus de détails.
|
||||
|
||||
### Caractéristiques spécifiques à YunoHost
|
||||
|
||||
|
|
@ -128,6 +130,7 @@ Cette application ne fournit pas une bonne interface web. Il est donc recommand
|
|||
#### Support multi-instan
|
||||
|
||||
Pour avoir la possibilité d'avoir plusieurs domaines, vous pouvez utiliser plusieurs instances de synapse. Dans ce cas, toutes les instances fonctionneront sur des ports différents, il est donc très important de mettre un enregistrement SRV dans votre domaine. Vous pouvez obtenir le port que vous devez mettre dans votre enregistrement SRV avec la commande suivante
|
||||
|
||||
```
|
||||
yunohost app setting synapse__<instancenumber> synapse_tls_port
|
||||
```
|
||||
|
|
|
|||
|
|
@ -13,18 +13,18 @@ routes:
|
|||
|
||||
- [Useful links](#useful-links)
|
||||
|
||||
*Synapse* is an instant messaging server matrix network.
|
||||
*Synapse* is an instant messaging server Matrix network.
|
||||
|
||||
Yunohost chatroom with matrix : [https://matrix.to/#/#yunohost:matrix.org](https://matrix.to/#/#yunohost:matrix.org).
|
||||
YunoHost chatroom with Matrix: [https://matrix.to/#/#yunohost:matrix.org](https://matrix.to/#/#yunohost:matrix.org).
|
||||
|
||||
### Disclaimers / important information
|
||||
|
||||
### Configuration
|
||||
|
||||
#### Install for ARM arch (or slow arch)
|
||||
#### Install for ARM architecture (or slow arch)
|
||||
|
||||
For all slow or arm architecture it's recommended to build the dh file before the install to have a quicker install.
|
||||
You could build it by this cmd : `openssl dhparam -out /etc/ssl/private/dh2048.pem 2048 > /dev/null`
|
||||
For all slow or ARM architecture it's recommended to build the dh file before the install to have a quicker install.
|
||||
You could build it by this cmd: `openssl dhparam -out /etc/ssl/private/dh2048.pem 2048 > /dev/null`
|
||||
After that you can install it without problem.
|
||||
|
||||
The package uses a prebuilt python virtual environnement. The binary are taken from this repository: https://github.com/Josue-T/synapse_python_build
|
||||
|
|
@ -38,34 +38,39 @@ If you want a web client you can also install Element with this package: https:/
|
|||
|
||||
If your server name is identical to the domain on which synapse is installed, and the default port 8448 is used, your server is normally already accessible by 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.
|
||||
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.
|
||||
|
||||
```
|
||||
_matrix._tcp.<server_name.tld> <ttl> IN SRV 10 0 <port> <domain-or-subdomain-of-synapse.tld>
|
||||
```
|
||||
|
||||
for example
|
||||
|
||||
```
|
||||
_matrix._tcp.example.com. 3600 IN SRV 10 0 SYNAPSE_PORT synapse.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/blob/master/docs/federate.md
|
||||
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/blob/master/docs/federate.md
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
#### Turnserver
|
||||
|
||||
For Voip and video conferencing a turnserver is also installed (and configured). The turnserver listens on two UDP and TCP ports. You can get them with these commands:
|
||||
For VoIP and video conferencing a turnserver is also installed (and configured). The turnserver listens on two UDP and TCP ports. You can get them with these commands:
|
||||
|
||||
```
|
||||
yunohost app setting synapse turnserver_tls_port
|
||||
yunohost app setting synapse turnserver_alt_tls_port
|
||||
|
||||
```
|
||||
The turnserver will also choose a port dynamically when a new call starts. The range is between 49153 - 49193.
|
||||
|
||||
For some security reason the ports range (49153 - 49193) isn't automatically open by default. If you want to use the synapse server for voip or conferencing you will need to open this port range manually. To do this just run this command:
|
||||
The turnserver will also choose a port dynamically when a new call starts. The range is between 49153-49193.
|
||||
|
||||
For some security reason the ports range (49153-49193) isn't automatically open by default. If you want to use the synapse server for voip or conferencing you will need to open this port range manually. To do this just run this command:
|
||||
|
||||
```
|
||||
yunohost firewall allow Both 49153:49193
|
||||
|
|
@ -75,7 +80,7 @@ You might also need to open these ports (if it is not automatically done) on you
|
|||
|
||||
To prevent the situation when the server is behind a NAT, the public IP is written in the turnserver config. By this the turnserver can send its real public IP to the client. For more information see [the coturn example config file](https://github.com/coturn/coturn/blob/master/examples/etc/turnserver.conf#L102-L120).So if your IP changes, you could run the script `/opt/yunohost/__SYNAPSE_INSTANCE_NAME__/Coturn_config_rotate.sh` to update your config.
|
||||
|
||||
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`).
|
||||
|
||||
```
|
||||
*/15 * * * * root bash /opt/yunohost/__SYNAPSE_INSTANCE_NAME__/Coturn_config_rotate.sh;
|
||||
|
|
@ -84,6 +89,7 @@ If you have a dynamic IP address, you also might need to update this config auto
|
|||
##### OpenVPN
|
||||
|
||||
In case of you have an OpenVPN server you might want than `coturn-synapse` restart when the VPN restart. To do this create a file named `/usr/local/bin/openvpn_up_script.sh` with this content:
|
||||
|
||||
```
|
||||
#!/bin/bash
|
||||
|
||||
|
|
@ -95,26 +101,22 @@ exit 0
|
|||
```
|
||||
|
||||
Add this line in you sudo config file `/etc/sudoers`
|
||||
|
||||
```
|
||||
openvpn ALL=(ALL) NOPASSWD: /bin/systemctl restart coturn-synapse.service
|
||||
```
|
||||
|
||||
And add this line in your OpenVPN config file
|
||||
|
||||
```
|
||||
ipchange /usr/local/bin/openvpn_up_script.sh
|
||||
```
|
||||
|
||||
#### Important Security Note
|
||||
|
||||
We do not recommend running Element from the same domain name as your Matrix
|
||||
homeserver (synapse). The reason is the risk of XSS (cross-site-scripting)
|
||||
vulnerabilities that could occur if someone caused Element to load and render
|
||||
malicious user generated content from a Matrix API which then had trusted
|
||||
access to Element (or other apps) due to sharing the same domain.
|
||||
We do not recommend running Element from the same domain name as your Matrix homeserver (synapse). The reason is the risk of XSS (cross-site-scripting) vulnerabilities that could occur if someone caused Element to load and render malicious user generated content from a Matrix API which then had trusted access to Element (or other apps) due to sharing the same domain.
|
||||
|
||||
We have put some coarse mitigations into place to try to protect against this
|
||||
situation, but it's still not a good practice to do it in the first place. See
|
||||
https://github.com/vector-im/element-web/issues/1977 for more details.
|
||||
We have put some coarse mitigations into place to try to protect against this situation, but it's still not a good practice to do it in the first place. See https://github.com/vector-im/element-web/issues/1977 for more details.
|
||||
|
||||
### YunoHost specific features
|
||||
|
||||
|
|
@ -129,6 +131,7 @@ This app doesn't provide any real good web interface. So it's recommended to use
|
|||
#### Multi instance support
|
||||
|
||||
To give a possibility to have multiple domains you can use multiple instances of synapse. In this case all instances will run on different ports so it's really important to put a SRV record in your domain. You can get the port that you need to put in your SRV record with this following command:
|
||||
|
||||
```
|
||||
yunohost app setting synapse__<instancenumber> synapse_tls_port
|
||||
```
|
||||
|
|
|
|||
|
|
@ -594,7 +594,7 @@ This hook is called several times with different actions keywords (pre and post
|
|||
|
||||
##### Environment variables
|
||||
|
||||
- YNH_DOMAINS: The list of domains managed by Yunohost separated by comma
|
||||
- YNH_DOMAINS: The list of domains managed by YunoHost separated by comma
|
||||
- YNH_MAIN_DOMAINS: The list of main domains separated by comma
|
||||
|
||||
##### Positionnal arguments
|
||||
|
|
|
|||
Loading…
Reference in a new issue