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
Yunohost-Bot
parent
935cd31593
commit
0f45327284
2 changed files with 92 additions and 32 deletions
58
README.md
58
README.md
|
|
@ -1,7 +1,3 @@
|
|||
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
|
|
@ -9,12 +5,12 @@ It shall NOT be edited by hand.
|
|||
|
||||
# Galene for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/galene)  
|
||||
[](https://install-app.yunohost.org/?app=galene)
|
||||
[](https://dash.yunohost.org/appci/app/galene)  
|
||||
[](https://install-app.yunohost.org/?app=galene)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install galene quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install Galene quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
|
|
@ -25,22 +21,54 @@ Videoconferencing server that is easy to deploy
|
|||
|
||||
**Demo:** https://galene.org:8443/
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
### How to creat groups
|
||||
### Accessing groups
|
||||
|
||||
Groups are defined by files in the `/opt/yunohost/galene/groups` directory. Various options are available (see https://github.com/YunoHost-Apps/galene_ynh/wiki/Configuration-file)
|
||||
*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).
|
||||
|
||||
#### 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.
|
||||
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.*
|
||||
|
||||
### Configuring your TURN server
|
||||
|
||||
#### Using *Galène*'s 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`)
|
||||
|
||||
#### 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:443",
|
||||
"turn:turn.example.org:443?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.
|
||||
|
||||
### 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.
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
|
|
|
|||
66
README_fr.md
66
README_fr.md
|
|
@ -1,12 +1,12 @@
|
|||
# Galene pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/galene)  
|
||||
[](https://install-app.yunohost.org/?app=galene)
|
||||
[](https://dash.yunohost.org/appci/app/galene)  
|
||||
[](https://install-app.yunohost.org/?app=galene)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install galene quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install Galene quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
|
@ -15,32 +15,64 @@ Serveur de visioconférence facile à déployer
|
|||
|
||||
**Version incluse:** 0.3.5~ynh1
|
||||
|
||||
**Démo:** https://galene.org:8443/
|
||||
|
||||
**Démo :** https://galene.org:8443/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
### Comment créer des groupes
|
||||
### Accéder à des groupes
|
||||
|
||||
Les groupes sont définis par des fichiers dans le répertoire `/opt/yunohost/galene/groups`. Différentes options sont disponibles (voir https://github.com/YunoHost-Apps/galene_ynh/wiki/Configuration-file)
|
||||
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).
|
||||
|
||||
#### 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`.
|
||||
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.*
|
||||
|
||||
### 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 `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
|
||||
- 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`
|
||||
|
||||
```
|
||||
[
|
||||
{
|
||||
"urls": [
|
||||
"turn:turn.example.org:443",
|
||||
"turn:turn.example.org:443?transport=tcp"
|
||||
],
|
||||
"username": "galene",
|
||||
"credential": "secret"
|
||||
}
|
||||
]
|
||||
```
|
||||
- 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 relai a réussi.
|
||||
|
||||
### Statistiques 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.
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site official de l'app : https://galene.org/
|
||||
* Documentation officielle utilisateur: https://yunohost.org/en/app_galene
|
||||
* Documentation officielle de l'admin: https://galene.org/
|
||||
* Dépôt de code officiel de l'app: https://github.com/jech/galene
|
||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_galene
|
||||
* Site officiel de l'app : https://galene.org/
|
||||
* Documentation officielle utilisateur : https://yunohost.org/en/app_galene
|
||||
* Documentation officielle de l'admin : https://galene.org/
|
||||
* Dépôt de code officiel de l'app : https://github.com/jech/galene
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_galene
|
||||
* Signaler un bug: https://github.com/YunoHost-Apps/galene_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
|
|
|||
Loading…
Reference in a new issue