From 332ccd6de4db67c804994ec01f1f06a27e2a29ed Mon Sep 17 00:00:00 2001 From: Thatoo Date: Sat, 16 Mar 2024 13:44:47 +0100 Subject: [PATCH 1/7] Update README_fr.md Add coturn configuration FR --- README_fr.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README_fr.md b/README_fr.md index b8bff38..20f2be9 100644 --- a/README_fr.md +++ b/README_fr.md @@ -20,6 +20,19 @@ 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 = ["turn:your.turn.url?transport=udp", "turn:your.turn.url?transport=tcp"] +turn_username = "" +turn_password = "" +``` + ## Documentations et ressources * Site officiel de l’app : @@ -40,4 +53,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 :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** From ee21b19071587c0351d7f5ec6859671391c1a8aa Mon Sep 17 00:00:00 2001 From: Thatoo Date: Sat, 16 Mar 2024 13:51:13 +0100 Subject: [PATCH 2/7] Update README_fr.md Improve coturn configuration --- README_fr.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README_fr.md b/README_fr.md index 20f2be9..da5bf50 100644 --- a/README_fr.md +++ b/README_fr.md @@ -28,9 +28,9 @@ Conduit garde les choses simples, c'est un binaire unique avec une base de donn 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 = ["turn:your.turn.url?transport=udp", "turn:your.turn.url?transport=tcp"] -turn_username = "" -turn_password = "" +turn_uris = ["turn:your.turn.url:5349?transport=udp", "turn:your.turn.url:5349?transport=tcp, turns:your.turn.url:5349?transport=udp", "turns:your.turn.url:5349?transport=tcp"] +turn_username = "" +turn_password = "" ``` ## Documentations et ressources From f18d0c8f1a810e8365c77751cab02555c74239ea Mon Sep 17 00:00:00 2001 From: Thatoo Date: Sat, 16 Mar 2024 13:53:18 +0100 Subject: [PATCH 3/7] Update README.md Add coturn configuration EN --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f4d6bba..0d92828 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,18 @@ 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 = ["turn:your.turn.url:5349?transport=udp", "turn:your.turn.url:5349?transport=tcp, turns:your.turn.url:5349?transport=udp", "turns:your.turn.url:5349?transport=tcp"] +turn_username = "" +turn_password = "" +``` ## Documentation and resources * Official app website: @@ -40,4 +52,4 @@ or sudo yunohost app upgrade conduit -u https://github.com/YunoHost-Apps/conduit_ynh/tree/testing --debug ``` -**More info regarding app packaging:** \ No newline at end of file +**More info regarding app packaging:** From e4281905faea4899acc1f292f563cc09dd3eeddd Mon Sep 17 00:00:00 2001 From: Thatoo Date: Sat, 16 Mar 2024 14:58:08 +0100 Subject: [PATCH 4/7] Update README.md improve coturn config --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d92828..276747a 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,16 @@ Conduit keeps things simple, it's a single binary with an embedded database and 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 = ["turn:your.turn.url:5349?transport=udp", "turn:your.turn.url:5349?transport=tcp, turns:your.turn.url:5349?transport=udp", "turns:your.turn.url:5349?transport=tcp"] +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 alittle bit like : +``` +turn_uris = ["turn:your.turn.url:5349?transport=udp", "turn:your.turn.url:5349?transport=tcp"] +``` + + ## Documentation and resources * Official app website: From 5da7149f92045bf1aa8dd285297f0a0d6d8ad7f8 Mon Sep 17 00:00:00 2001 From: Thatoo Date: Sat, 16 Mar 2024 14:59:43 +0100 Subject: [PATCH 5/7] Update README_fr.md improve config coturn non TLS --- README_fr.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README_fr.md b/README_fr.md index da5bf50..fa65afd 100644 --- a/README_fr.md +++ b/README_fr.md @@ -28,10 +28,15 @@ Conduit garde les choses simples, c'est un binaire unique avec une base de donn 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 = ["turn:your.turn.url:5349?transport=udp", "turn:your.turn.url:5349?transport=tcp, turns:your.turn.url:5349?transport=udp", "turns:your.turn.url:5349?transport=tcp"] +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 From 69377cf823844615ac8ea13273f2b570d4114595 Mon Sep 17 00:00:00 2001 From: Thatoo Date: Sat, 16 Mar 2024 15:00:01 +0100 Subject: [PATCH 6/7] Update README.md typo error --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 276747a..21d2e51 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ turn_uris = ["turns:your.turn.url:5349?transport=udp", "turns:your.turn.url:5349 turn_username = "" turn_password = "" ``` -If your coturn (not Yunohost's one) don't use TLS, you might need to change alittle bit like : +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"] ``` From efe444814b68b70c21ae6f7b699071278f023546 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Thu, 2 May 2024 19:22:59 +0200 Subject: [PATCH 7/7] use admin.md --- README.md | 17 ----------------- README_fr.md | 16 ---------------- doc/Admin.md | 14 ++++++++++++++ doc/DESCRIPTION_fr.md | 2 +- doc/admin_fr.md | 13 +++++++++++++ 5 files changed, 28 insertions(+), 34 deletions(-) create mode 100644 doc/Admin.md create mode 100644 doc/admin_fr.md 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