diff --git a/README.md b/README.md index fa48100..a4e3ecf 100644 --- a/README.md +++ b/README.md @@ -20,23 +20,6 @@ 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 -## Disclaimers / important information - -## Configuration - -### Configuration d'un coturn -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 = "" -turn_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"] -``` - ## Documentation and resources diff --git a/README_fr.md b/README_fr.md index 2ab6606..eb87b40 100644 --- a/README_fr.md +++ b/README_fr.md @@ -20,22 +20,6 @@ Conduit est une implémentation de serveur open source légère de la spécifica 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 -## Avertissements / informations importantes - -## Configuration - -### 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 = "" -turn_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"] -``` ## Documentations et ressources diff --git a/doc/Admin.md b/doc/Admin.md new file mode 100644 index 0000000..b462c34 --- /dev/null +++ b/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 = "" +turn_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"] +`` \ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index 8dae02e..fa0f956 100644 --- a/doc/DESCRIPTION_fr.md +++ b/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. \ No newline at end of file +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. diff --git a/doc/admin_fr.md b/doc/admin_fr.md new file mode 100644 index 0000000..e4ab54e --- /dev/null +++ b/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 = "" +turn_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"] +``` \ No newline at end of file