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:
parent
b9eda3a382
commit
9b377b8a7b
2 changed files with 31 additions and 17 deletions
25
README.md
25
README.md
|
@ -17,14 +17,15 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
|||
|
||||
Galène is a videoconference server (an “SFU”) that is easy to deploy and that requires moderate server resources. It was originally designed for lectures and conferences (where a single speaker streams audio and video to hundreds or thousands of users), but later evolved to be useful for student practicals (where users are divided into many small groups), and meetings (where a dozen users interact with each other).
|
||||
|
||||
### Client features
|
||||
### Client features:
|
||||
|
||||
- multiparty audio and video
|
||||
- text chat
|
||||
- reasonably good support for mobile (Android and iPhone/iPad)
|
||||
- screen and window sharing, including sharing multiple windows simultaneously (not on mobile)
|
||||
- streaming video and audio from disk
|
||||
- activity detection
|
||||
|
||||
- multiparty audio and video;
|
||||
- text chat;
|
||||
- reasonably good support for mobile (Android and iPhone/iPad);
|
||||
- screen and window sharing, including sharing multiple windows simultaneously (not on mobile);
|
||||
- streaming video and audio from disk;
|
||||
- activity detection.
|
||||
|
||||
**Shipped version:** 0.4.0~ynh1
|
||||
|
||||
|
@ -42,14 +43,14 @@ Galène is a videoconference server (an “SFU”) that is easy to deploy and th
|
|||
|
||||
#### Creating and configuring groups
|
||||
|
||||
Groups are defined by JSON files located in the *Galène* folder (`/home/yunohost.app/galene/groups`). Each group is represented by a `GroupName.json` file.
|
||||
Groups are defined by JSON files located in the folder `/home/yunohost.app/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 configuration 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.*
|
||||
|
||||
### Configuring your TURN server
|
||||
|
||||
#### Using *Galène*'s TURN server
|
||||
#### Using *Galène*'s internal TURN server
|
||||
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 TCP/UDP port `1194` (or whatever is configured with the `-turn` option in `/etc/systemd/system/galene.service`)
|
||||
|
||||
|
@ -73,9 +74,11 @@ Galène comes with a built-in TURN server that should work out-of-the-box.
|
|||
|
||||
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.
|
||||
|
||||
You can also install Galène with an external TURN server with this branch: https://github.com/YunoHost-Apps/galene_ynh/tree/galene+turn
|
||||
|
||||
### Server Statistics page
|
||||
|
||||
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.
|
||||
Statistics are available under `/var/www/galene/stats.json`, with a human-readable version at `domain.ltd/stats.html`. This is only available to the server administrator.
|
||||
|
||||
### How do I record my lecture?
|
||||
|
||||
|
|
23
README_fr.md
23
README_fr.md
|
@ -13,6 +13,15 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
|||
|
||||
Galène est un serveur de visioconférence (un « SFU ») facile à déployer et qui nécessite des ressources serveur modérées. Il a été conçu à l'origine pour les cours et les conférences (où un seul orateur diffuse de l'audio et de la vidéo à des centaines ou des milliers d'utilisateurs), mais a évolué par la suite pour être utile pour les travaux pratiques des étudiants (où les utilisateurs sont divisés en plusieurs petits groupes) et les réunions (où un douzaine d'utilisateurs interagissent entre eux).
|
||||
|
||||
### Fonctionnalités client :
|
||||
|
||||
- audio et vidéo multipartites
|
||||
- chat textuel
|
||||
- assez bonne prise en charge pour mobile (Android et iPhone/iPad)
|
||||
- partage d'écran et de fenêtre, y compris le partage de plusieurs fenêtres simultanément (pas sur mobile)
|
||||
- streaming vidéo et audio à partir du disque
|
||||
- détection d'activité
|
||||
|
||||
|
||||
**Version incluse :** 0.4.0~ynh1
|
||||
|
||||
|
@ -30,7 +39,7 @@ Les salles de réunion *Galène* sont appelées « groupes ». Tout groupe est a
|
|||
|
||||
#### Ajouter et configurer des groupes
|
||||
|
||||
Les groupes sont définis par des fichiers JSON situés dans le dossier *Galène* (`/home/yunohost.app/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 `/home/yunohost.app/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 de configurations 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.*
|
||||
|
@ -43,7 +52,7 @@ Galène est livré avec un serveur TURN intégré qui devrait fonctionner imméd
|
|||
|
||||
#### Utilisation de votre propre serveur TURN
|
||||
- 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 `/var/www/galene/data/ice-servers.json` avec ces lignes et changez `turn.example.org` et `secret`
|
||||
|
||||
```
|
||||
[
|
||||
|
@ -57,17 +66,19 @@ Galène est livré avec un serveur TURN intégré qui devrait fonctionner imméd
|
|||
}
|
||||
]
|
||||
```
|
||||
- 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é).
|
||||
- Dans `/etc/systemd/system/galene.service` changer l'option `-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 relai a réussi.
|
||||
Pour vérifier si le serveur TURN est opérationnel, tapez `/relay-test` dans la boîte de dialogue du chat de *Galène* ; si le serveur TURN est correctement configuré, vous devriez voir un message indiquant que le test du relai a réussi.
|
||||
|
||||
Vous pouvez également installer *Galène* avec un serveur TURN externe avec cette branch : https://github.com/YunoHost-Apps/galene_ynh/tree/galene+turn
|
||||
|
||||
### Statistiques du serveur
|
||||
|
||||
Certaines statistiques sont disponibles sous `/opt/yunohost/galene/stats.json`, avec une version lisible sur `domain.ltd/stats.html`. Ceci n'est disponible que pour l'administrateur du serveur.
|
||||
Les statistiques sont disponibles sous `/var/www/galene/stats.json`, avec une version lisible sur `domain.ltd/stats.html`. Cette page n'est disponible que pour l'administrateur du serveur.
|
||||
|
||||
### Comment enregistrer ma conférence ?
|
||||
|
||||
Assurez-vous que l'autorisation d'enregistrement est définie dans la configuration de votre groupe. Connectez-vous en tant qu'opérateur, puis dites `/record` avant de commencer votre cours. N'oubliez pas de dire `/unrecord` à la fin. Vous trouverez vos enregistrements sous `https://server.example.com/recordings/groupname/`. Les enregistrements vidéo sont stockés dans le dossier `/home/yunohost.app/galene/recordings`.
|
||||
Assurez-vous que l'autorisation d'enregistrement est définie dans la configuration de votre groupe. Connectez-vous en tant qu'opérateur, puis dites `/record` dans la fenêtre de chat avant de commencer la visio. N'oubliez pas de dire `/unrecord` à la fin. Vous trouverez vos enregistrements sous `https://server.example.com/recordings/groupname/`. Les enregistrements vidéo sont stockés dans le dossier `/home/yunohost.app/galene/recordings`.
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue