YunoHost-Apps/galene_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/galene_ynh.git synced 2024-09-03 18:36:31 +02:00
Code Issues Activity Actions

Fix

Browse source
This commit is contained in:
ericgaspar 2021-05-29 15:21:20 +02:00
parent 901e91fe4d
commit 935cd31593
2 changed files with 28 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
doc/DISCLAIMER.md
View file

@ -1,25 +1,25 @@
### Configure your groups ### Accessing groups
*Galène* meeting rooms are called "groups". *Galène* meeting rooms are called "groups".
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). 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 #### Creating and configuring groups
Groups are defined by *json* files located in *Galène* folder (`/opt/yunohost/galene/groups`). Each group is represented by a `GroupName.json` file. Groups are defined by *json* files located in the *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) To create a new group, you need to create a `GroupNameExample.json` file (you can also make subfolder groups, 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.* *NB: spaces are supported in group file names.*
### Configure your TURN server ### Configuring your TURN server
#### Using Galène Turn server #### Using *Galène*'s TURN server
Galène comes with build in TURN server that should work out-of-the-box. Galène comes with a built-in TURN server that should work out-of-the-box.
- If your server is behind NAT, allow incoming traffic to TCP port `8443` (or whatever is configured with the `-http` option in `/etc/systemd/system/galene.service`) and port `1194` (or whatever is configured with the `-turn` option in `/etc/systemd/system/galene.service`) - If your server is behind NAT, allow incoming traffic to TCP port `8443` (or whatever is configured with the `-http` option in `/etc/systemd/system/galene.service`) and TCP/UDP port `1194` (or whatever is configured with the `-turn` option in `/etc/systemd/system/galene.service`)
#### Using you own TURN server #### Using your own TURN server
- Install [coturn_ynh](https://github.com/YunoHost-Apps/coturn_ynh). - Install [coturn_ynh](https://github.com/YunoHost-Apps/coturn_ynh).
- Add `/opt/yunohost/galene/data/ice-servers.json` with this lines and change `turn.example.org` and `secret` - Add `/opt/yunohost/galene/data/ice-servers.json` with these lines and change `turn.example.org` and `secret`
``` ```
[ [
@ -33,10 +33,10 @@ 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`. (or `-turn ""` to disable the built in TURN server) - set `/etc/systemd/system/galene.service` `-turn` option to `-turn auto`. (or `-turn ""` to disable the built-in TURN server)
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. 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 ### 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. Some statistics are available under `/opt/yunohost/galene/stats.json`, with a human-readable version at `domain.ltd/stats.html`. This is only available to the server administrator.

30
doc/DISCLAIMER_fr.md
View file

@ -1,42 +1,42 @@
### Comment créer des groupes ### Accéder à des groupes
Les salles de réunion * Galène * sont appelées «groupes». Les salles de réunion *Galène* sont appelées «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 ). 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).
#### Configurer des groupes et en ajouter de nouveaux #### Ajouter et configurer des groupes
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`. 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) 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.* *NB: les espaces sont pris en charge dans les noms de fichiers de groupe.*
### Configurez votre serveur TURN ### Configurer votre serveur TURN
#### Utilisation du serveur Galène Turn #### Utilisation du serveur TURN de *Galène*
Galène est livré avec un serveur TURN intégré qui devrait fonctionner immédiatement. Galène est livré avec un serveur TURN intégré qui devrait fonctionner immédiatement.
- Si votre serveur est derrière NAT, autorisez le trafic entrant vers le port TCP `8443` (ou tout ce qui est configuré avec l'option `-http` dans `/etc/systemd/system/galene.service`) et le port `1194` (ou tout ce qui est configuré avec l'option `-turn` dans `/etc/systemd/system/galene.service`) - Si votre serveur est derrière NAT, autorisez le trafic entrant vers le port TCP `8443` (ou tout ce qui est configuré avec l'option `-http` dans `/etc/systemd/system/galene.service`) et le port TCP/UDP `1194` (ou tout ce qui est configuré avec l'option `-turn` dans `/etc/systemd/system/galene.service`)
#### Utilisation de votre propre serveur TURN #### Utilisation de votre propre serveur TURN
- Installez [coturn_ynh] (https://github.com/YunoHost-Apps/coturn_ynh). - Installez [coturn_ynh](https://github.com/YunoHost-Apps/coturn_ynh).
- Ajoutez `/opt/yunohost/galene/data/ice-servers.json` avec ces lignes et changez `turn.example.org` et `secret` - Ajoutez `/opt/yunohost/galene/data/ice-servers.json` avec ces lignes et changez `turn.example.org` et `secret`
``` ```
[ [
{ {
"urls": [ "urls": [
"turn: turn.example.org: 443", "turn:turn.example.org:443",
"turn: turn.example.org: 443? transport = tcp" "turn:turn.example.org:443?transport=tcp"
], ],
"username": "galene", "username": "galene",
"credential": "secret" "credential": "secret"
} }
] ]
``` ```
- définir l'option de virage `/etc/systemd/system/galene.service` sur `-turn auto` (ou `-turn ""` pour désactiver le serveur TURN intégré) - définir l'option de virage de `/etc/systemd/system/galene.service` sur `-turn auto` (ou `-turn ""` pour désactiver le serveur TURN intégré)
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. 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 relai a réussi.
### Statistiques du serveur ### 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. Certaines statistiques sont disponibles sous `/opt/yunohost/galene/stats.json`, avec une version lisible par l'homme sur `domain.ltd/stats.html`. Ceci n'est disponible que pour l'administrateur du serveur.