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

Auto-update README

This commit is contained in:
Yunohost-Bot 2021-06-02 07:04:54 +00:00 committed by Yunohost-Bot
parent 2a24c5e9b4
commit c475f65551
2 changed files with 22 additions and 26 deletions

View file

@ -29,13 +29,11 @@ Videoconferencing server that is easy to deploy
### Accessing 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).
#### Creating and configuring groups #### Creating and configuring groups
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. 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 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). 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.*
@ -54,8 +52,8 @@ Galène comes with a built-in TURN server that should work out-of-the-box.
[ [
{ {
"urls": [ "urls": [
"turn:turn.example.org:443", "turn:turn.example.org:5349",
"turn:turn.example.org:443?transport=tcp" "turn:turn.example.org:5349?transport=tcp"
], ],
"username": "galene", "username": "galene",
"credential": "secret" "credential": "secret"
@ -75,7 +73,7 @@ Some statistics are available under `/opt/yunohost/galene/stats.json`, with a hu
* Official app website: https://galene.org/ * Official app website: https://galene.org/
* Official user documentation: https://yunohost.org/en/app_galene * Official user documentation: https://yunohost.org/en/app_galene
* Official admin documentation: https://galene.org/ * Official admin documentation: https://galene.org/
* Upstream app code repository: https://github.com/jech/galene * Upstream app code repository: https://github.com/jech/galene
* YunoHost documentation for this app: https://yunohost.org/app_galene * YunoHost documentation for this app: https://yunohost.org/app_galene
* Report a bug: https://github.com/YunoHost-Apps/galene_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/galene_ynh/issues

View file

@ -6,16 +6,16 @@
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Galene quickly and simply on a YunoHost server. > *Ce package vous permet d'installer Galene rapidement et simplement sur un serveur YunoHost.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
Serveur de visioconférence facile à déployer Serveur de visioconférence facile à déployer
**Version incluse:** 0.3.5~ynh1 **Version incluse :** 0.3.5~ynh1
**Démo :** https://galene.org:8443/ **Démo :** https://galene.org:8443/
## Captures d'écran ## Captures d'écran
@ -25,16 +25,14 @@ Serveur de visioconférence facile à déployer
### Accéder à 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).
#### Ajouter et configurer des groupes #### 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.*
### Configurer votre serveur TURN ### Configurer votre serveur TURN
@ -50,8 +48,8 @@ Galène est livré avec un serveur TURN intégré qui devrait fonctionner imméd
[ [
{ {
"urls": [ "urls": [
"turn:turn.example.org:443", "turn:turn.example.org:5349",
"turn:turn.example.org:443?transport=tcp" "turn:turn.example.org:5349?transport=tcp"
], ],
"username": "galene", "username": "galene",
"credential": "secret" "credential": "secret"
@ -68,12 +66,12 @@ Certaines statistiques sont disponibles sous `/opt/yunohost/galene/stats.json`,
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://galene.org/ * Site officiel de l'app : https://galene.org/
* Documentation officielle utilisateur : https://yunohost.org/en/app_galene * Documentation officielle utilisateur : https://yunohost.org/en/app_galene
* Documentation officielle de l'admin : https://galene.org/ * Documentation officielle de l'admin : https://galene.org/
* Dépôt de code officiel de l'app : https://github.com/jech/galene * Dépôt de code officiel de l'app : https://github.com/jech/galene
* Documentation YunoHost pour cette app : https://yunohost.org/app_galene * Documentation YunoHost pour cette app : https://yunohost.org/app_galene
* Signaler un bug: https://github.com/YunoHost-Apps/galene_ynh/issues * Signaler un bug : https://github.com/YunoHost-Apps/galene_ynh/issues
## Informations pour les développeurs ## Informations pour les développeurs
@ -82,8 +80,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/galene_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/galene_ynh/tree/testing --debug
or ou
sudo yunohost app upgrade galene -u https://github.com/YunoHost-Apps/galene_ynh/tree/testing --debug sudo yunohost app upgrade galene -u https://github.com/YunoHost-Apps/galene_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