diff --git a/README.md b/README.md index 9f577e1..4f5e4f1 100644 --- a/README.md +++ b/README.md @@ -38,59 +38,6 @@ Galène is a videoconference server (an “SFU”) that is easy to deploy and th ![Screenshot of Galène](./doc/screenshots/screenshot.png) -## Disclaimers / important information - -### Accessing 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). -During install a group is created with YunoHost LDAP authentication, accessible at `https://domain.tld/group/YunoHost_Users`. - -#### Creating and configuring groups - -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 and restart Galène service (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.* - -When Galène is removed, the data directory (`/home/yunohost.app/galene/`) is preserved. If you want to remove it along with Galène, use the `--purge` option: `sudo yunohost app remove galene --purge`. - -### Configuring your 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/UDP port `1194` (or whatever is configured with the `-turn` option in `/etc/systemd/system/galene.service`) - -#### Using your own TURN server -- Install [coturn_ynh](https://github.com/YunoHost-Apps/coturn_ynh). -- Add `/opt/yunohost/galene/data/ice-servers.json` with these lines and change `turn.example.org` and `secret` - -``` - [ - { - "urls": [ - "turn:turn.example.org:5349", - "turn:turn.example.org:5349?transport=tcp" - ], - "username": "galene", - "credential": "secret" - } - ] -``` -- 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. - -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 - -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 (the admin/password is set in the `config.json` file: `/opt/yunohost/galene/data/config.json`). - -### How do I record my lecture? - -Make sure allow-recording is set in your group configuration. Log-in as an operator, then say `/record` before you start your lecture. Don't forget to say `/unrecord` at the end. You will find your recordings under `https://server.example.com/recordings/groupname/`. The video recordings are stored in `/home/yunohost.app/galene/recordings` folder. - - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index d291126..911444d 100644 --- a/README_fr.md +++ b/README_fr.md @@ -36,58 +36,6 @@ Galène est un serveur de visioconférence (un « SFU ») facile à déployer et ![Capture d’écran de Galène](./doc/screenshots/screenshot.png) -## Avertissements / informations importantes - -### Accéder à des 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). -Pendant l'installation, un groupe est créé avec l'authentification LDAP de YunoHost, accessible à `https://domain.tld/group/YunoHost_Users`. - -#### Ajouter et configurer des groupes - -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` et redémarrer le service Galène (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.* - -Lorsque Galène est supprimé, le répertoire de données (`/home/yunohost.app/galene/`) est conservé. Si vous souhaitez le supprimer avec Galène, utilisez l'option `--purge` : `sudo yunohost app remove galene --purge`. - -### Configurer votre serveur TURN - -#### Utilisation du serveur TURN de *Galène* -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/UDP `1194` (ou tout ce qui est configuré avec l'option `-turn` dans `/etc/systemd/system/galene.service`) - -#### Utilisation de votre propre serveur TURN -- Installez [coturn_ynh](https://github.com/YunoHost-Apps/coturn_ynh). -- Ajoutez `/var/www/galene/data/ice-servers.json` avec ces lignes et changez `turn.example.org` et `secret` - -``` - [ - { - "urls": [ - "turn:turn.example.org:5349", - "turn:turn.example.org:5349?transport=tcp" - ], - "username": "galene", - "credential": "secret" - } - ] -``` -- 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 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 - -Les statistiques sont disponibles sous `/opt/yunohost/galene/stats.json`, avec une version lisible sur `domain.ltd/stats.html`. Cette page n'est disponible que pour l'administrateur du serveur (le mot de passe et l'administrateur sont définis dans le fichier `config.json` : `/opt/yunohost/galene/data/config.json`). - -### 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` 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 * Site officiel de l’app :