From b9eda3a382f2f48496e568aac23e284d60f44c49 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Mon, 6 Sep 2021 09:02:45 +0200 Subject: [PATCH] fix --- conf/passwd | 1 - doc/DESCRIPTION.md | 14 +++++++------- doc/DESCRIPTION_fr.md | 9 +++++++++ doc/DISCLAIMER.md | 10 ++++++---- doc/DISCLAIMER_fr.md | 14 ++++++++------ scripts/backup | 3 --- scripts/change_url | 4 +--- scripts/install | 8 ++++---- scripts/upgrade | 5 ----- 9 files changed, 35 insertions(+), 33 deletions(-) delete mode 100644 conf/passwd diff --git a/conf/passwd b/conf/passwd deleted file mode 100644 index e1d71a5..0000000 --- a/conf/passwd +++ /dev/null @@ -1 +0,0 @@ -__ADMIN__:__PASSWORD__ diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index c250c69..8951640 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,10 +1,10 @@ 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. \ No newline at end of file +- 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 diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index 9586a92..cb17ea2 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -1 +1,10 @@ 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é diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 56fe09e..be313fa 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -4,14 +4,14 @@ #### 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`) @@ -35,9 +35,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? diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index b43abaa..2fc4b08 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -4,7 +4,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.* @@ -17,7 +17,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` ``` [ @@ -31,14 +31,16 @@ 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`. diff --git a/scripts/backup b/scripts/backup index e9c81e1..5d6324e 100755 --- a/scripts/backup +++ b/scripts/backup @@ -13,9 +13,6 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { - ynh_clean_check_starting -} # Exit if an error occurs during the execution of the script ynh_abort_if_errors diff --git a/scripts/change_url b/scripts/change_url index 344d4bd..d650a59 100755 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,8 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -ynh_abort_if_errors - #================================================= # RETRIEVE ARGUMENTS #================================================= @@ -110,7 +108,7 @@ fi #================================================= ynh_script_progression --message="Starting a systemd service..." --weight=3 -ynh_systemd_action --service_name=$app --action=start --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name=$app --action=start --log_path="systemd" #================================================= # RELOAD NGINX diff --git a/scripts/install b/scripts/install index 268260f..e2ab403 100755 --- a/scripts/install +++ b/scripts/install @@ -36,7 +36,7 @@ app=$YNH_APP_INSTANCE_NAME #================================================= ynh_script_progression --message="Validating installation parameters..." --weight=1 -final_path=/opt/yunohost/$app +final_path=/var/www/$app test ! -e "$final_path" || ynh_die --message="This path already contains a folder" # Register (book) web path @@ -104,8 +104,8 @@ chown -R $app:www-data "$final_path" # Create data folder mkdir -p "$final_path/data" echo '$admin:$password' > "$final_path/data/passwd" -#chmod 400 "$final_path/data/passwd" -#chown $app: "$final_path/data/passwd" +chmod 400 "$final_path/data/passwd" +chown $app: "$final_path/data/passwd" #================================================= # NGINX CONFIGURATION @@ -143,7 +143,7 @@ ynh_add_systemd_config # MODIFY A CONFIG FILE #================================================= -#ynh_add_config --template="../conf/passwd" --destination="$final_path/data/passwd" +# Create a group name config ynh_add_config --template="../conf/groupname.json" --destination="$datadir/groups/$group_name.json" #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 611e232..2035586 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -92,7 +92,6 @@ then # tmpdir="$(mktemp -d)" # # Backup the config file in the temp dir - # cp -ar "$final_path/groups" "$tmpdir/groups" # cp -ar "$final_path/data/passwd" "$tmpdir/passwd" # # Remove the app directory securely @@ -100,11 +99,7 @@ then ynh_setup_source --dest_dir="$final_path" --source_id="$architecture" --keep="$final_path/data/passwd" - # # Create data and groups folder - # mkdir -p "$final_path/data" "$final_path/groups" - # # Copy the admin saved settings from tmp directory to final path - # cp -ar "$tmpdir/groups" "$final_path/groups" # cp -ar "$tmpdir/passwd" "$final_path/data/passwd" # # Remove the tmp directory securely