From fc6976bae20f439cbaabe2551281826381621d88 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Wed, 26 May 2021 21:11:16 +0200 Subject: [PATCH] Fix --- doc/DISCLAIMER.md | 19 +++++++++++++++++-- doc/DISCLAIMER_fr.md | 21 +++++++++++++++++---- 2 files changed, 34 insertions(+), 6 deletions(-) diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index ab2f084..50c297e 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,8 +1,17 @@ ### Configure your groups -Groups are defined by files in the `/opt/yunohost/galene/groups` directory. Various options are available (see https://github.com/YunoHost-Apps/galene_ynh/wiki/Configuration-file) +*Galène* meeting rooms are called "groups". -## Configure your TURN server +Any group is accessible at `https://domain.tld/group/GroupName`, by typing its name in the home page search field, or by selecting it in the public list (if the group is configured as publicly visible, see below). + +#### Configuring groups and adding new ones + +Groups are defined by *json* files located in *Galène* folder (`/opt/yunohost/galene/groups`). Each group is represented by a `GroupName.json` file. +To create a new group, you need to create a `GroupNameExample.json` file (you can also make subfolder, and the groups will be accessible with `https://domain.tld/group/subfolder/GroupName`). Various options are available (see https://github.com/YunoHost-Apps/galene_ynh/wiki/Configuration-file) + +*NB: spaces are supported in group file names.* + +### Configure your TURN server #### Using Galène Turn server Galène comes with build in TURN server that should work out-of-the-box. @@ -25,3 +34,9 @@ Galène comes with build in TURN server that should work out-of-the-box. ] ``` - set `/etc/systemd/system/galene.service` turn option to `-turn auto` + +To check if the TURN server is up and running, type `/relay-test` in the chat box; if the TURN server is properly configured, you should see a message saying that the relay test has been successful. + +### Server Statistics page + +Some statistics are available under `/opt/yunohost/galene/stats.json`, with a human-readable version at `daomain.ltd/stats.html`. This is only available to the server administrator. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index ce6ec96..0b85282 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -1,10 +1,17 @@ ### Comment créer des groupes -Les groupes sont définis par des fichiers dans le répertoire `/opt/yunohost/galene/groups`. Différentes options sont disponibles (voir https://github.com/YunoHost-Apps/galene_ynh/wiki/Configuration-file) +Les salles de réunion * Galène * sont appelées «groupes». -### Configurez vos groupes +Tout groupe est accessible sur `https://domain.tld/group/GroupName`, en tapant son nom dans le champ de recherche de la page d'accueil, ou en le sélectionnant dans la liste publique (si le groupe est configuré comme visible publiquement, voir ci-dessous ). -## Configurez votre serveur TURN +#### Configurer des groupes et en ajouter de nouveaux + +Les groupes sont définis par des fichiers *json* situés dans le dossier * Galène * (`/opt/yunohost/galene/groups`). Chaque groupe est représenté par un fichier `GroupName.json`. +Pour créer un nouveau groupe, vous devez créer un fichier `GroupNameExample.json` (vous pouvez également créer un sous-dossier, et les groupes seront accessibles avec` https://domain.tld/group/subfolder/GroupName`). Différentes options sont disponibles (voir https://github.com/YunoHost-Apps/galene_ynh/wiki/Configuration-file) + +*NB: les espaces sont pris en charge dans les noms de fichiers de groupe.* + +### Configurez votre serveur TURN #### Utilisation du serveur Galène Turn Galène est livré avec un serveur TURN intégré qui devrait fonctionner immédiatement. @@ -26,4 +33,10 @@ Galène est livré avec un serveur TURN intégré qui devrait fonctionner imméd } ] ``` -- définir l'option de virage `/etc/systemd/system/galene.service` sur `-turn auto` \ No newline at end of file +- définir l'option de virage `/etc/systemd/system/galene.service` sur `-turn auto` + +Pour vérifier si le serveur TURN est opérationnel, tapez `/relay-test` dans la boîte de dialogue ; si le serveur TURN est correctement configuré, vous devriez voir un message indiquant que le test du relais a réussi. + +### Statistiques du serveur + +Certaines statistiques sont disponibles sous `/opt/yunohost/galene/stats.json`, avec une version lisible par l'homme sur `daomain.ltd/stats.html`. Ceci n'est disponible que pour l'administrateur du serveur.