Merge pull request #26 from Thatoo/patch-1

Add coturn config information

README.md

@@ -20,6 +20,7 @@ Conduit is a lightweight open-source server implementation of the Matrix Specifi
 Conduit keeps things simple, it's a single binary with an embedded database and can be much faster than other server implementations in some cases.
 
 **Shipped version:** 0.6.0~ynh6
+
 ## Documentation and resources
 
 - Official app website: <https://conduit.rs/>

README_fr.md

@@ -19,7 +19,9 @@ Il NE doit PAS être modifié à la main.
 Conduit est une implémentation de serveur open source légère de la spécification Matrix avec un accent sur une configuration facile et des exigences système faibles. Cela signifie que vous pouvez créer votre propre configuration Conduit en quelques minutes seulement.
 Conduit garde les choses simples, c'est un binaire unique avec une base de données intégrée et peut être beaucoup plus rapide que d'autres implémentations de serveur dans certains cas.
 
-**Version incluse :** 0.6.0~ynh6
+**Version incluse :** 0.6.0~ynh6
+
+
 ## Documentations et ressources
 
 - Site officiel de l’app : <https://conduit.rs/>
@@ -40,4 +42,4 @@ ou
 sudo yunohost app upgrade conduit -u https://github.com/YunoHost-Apps/conduit_ynh/tree/testing --debug
 ```
 
-**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
+**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>

doc/Admin.md

@@ -0,0 +1,14 @@
+###  Coturn configuration
+
+To be able to take advantage of audio and video call functionalities, a coturn server is often required. It is possible to [install a coturn server in YunoHost (https://github.com/YunoHost-Apps/coturn-ynh/blob/master/README-en.md).
+It is then necessary to fill in the information provided by the coturn server in the file 'conduit.toml' such as:
+
+```
+turn_uris = ["turns:your.turn.url:5349?transport=udp", "turns:your.turn.url:5349?transport=tcp"]
+turn_username = "<YOUR_USERNAME>"
+turn_password = "<YOUR_PASSWORD>"
+```
+If your coturn (not Yunohost's one) don't use TLS, you might need to change a little bit like :
+```
+turn_uris = ["turn:your.turn.url:5349?transport=udp", "turn:your.turn.url:5349?transport=tcp"]
+``

doc/DESCRIPTION_fr.md

@@ -1,2 +1,2 @@
 Conduit est une implémentation de serveur open source légère de la spécification Matrix avec un accent sur une configuration facile et des exigences système faibles. Cela signifie que vous pouvez créer votre propre configuration Conduit en quelques minutes seulement.
-Conduit garde les choses simples, c'est un binaire unique avec une base de données intégrée et peut être beaucoup plus rapide que d'autres implémentations de serveur dans certains cas.
+Conduit garde les choses simples, c'est un binaire unique avec une base de données intégrée et peut être beaucoup plus rapide que d'autres implémentations de serveur dans certains cas.

doc/admin_fr.md

@@ -0,0 +1,13 @@
+### Configuration d'un coturn
+
+Afin de pouvoir profiter des fonctionnalités d'appels audio et video, un serveur coturn est souvent requis. Il est possible d'[installer un serveur coturn dans YunoHost](https://github.com/YunoHost-Apps/coturn_ynh/blob/master/README_fr.md).
+Il est ensuite nécessaire de renseigner les informations fournies par le serveur coturn dans le fichier `conduit.toml` tel que :
+```
+turn_uris = ["turns:your.turn.url:5349?transport=udp", "turns:your.turn.url:5349?transport=tcp"]
+turn_username = "<YOUR_USERNAME>"
+turn_password = "<YOUR_PASSWORD>"
+```
+Si votre serveur coturn (autre que celui de Yunohost) n'utilise pas une connection TLS, vous devrez ajuster ainsi :
+```
+turn_uris = ["turn:your.turn.url:5349?transport=udp", "turn:your.turn.url:5349?transport=tcp"]
+```