ansible-role-docker_jistimeet/README.md

76 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2022-08-28 21:00:48 +02:00
# Role : docker_jitsimeet
Installation de jitsimeet sur un serveur docker_host
2022-08-28 21:00:48 +02:00
## Variables
Fournir les variables suivantes. Par exemple :
```yaml
# Le fqdn pour accéder à jitsimeet
2022-08-28 21:00:48 +02:00
docker_jitsimeet_fqdn: jitsimeet.example.com
# Version de l'image jitsimeet
2022-08-28 21:00:48 +02:00
docker_jitsimeet_version: stable-7648-4
# L'emplacement dans lequel se trouvent les volumes de donnees docker pour le service
2022-08-28 21:00:48 +02:00
docker_jitsimeet_data_dir: /data1
# Le nom de service souhaité : conditionne le nommage des dossiers et le routage par traefik
2022-08-28 21:00:48 +02:00
docker_jitsimeet_service_id: jitsimeet
# Mdp de jicofo ; générer avec `openssl rand -hex 16`
2022-08-28 21:00:48 +02:00
docker_jitsimeet_jicofo_auth_password: "coller_ici_jicofo_auth_password"
# Mdp de jvb ; générer avec `openssl rand -hex 16`
2022-08-28 21:00:48 +02:00
docker_jitsimeet_jvb_auth_password: "coller_ici_jvb_auth_password"
# Adresse du serveur docker sur lequel écoute le service jvb
2022-08-28 21:00:48 +02:00
docker_jitsimeet_jvb_host_address: 10.11.12.13
```
2022-08-28 21:00:48 +02:00
## Notes de réunion
Pour utiliser un serveur etherpad comme support de notes collectives à la réunion, ajouter les variables suivantes :
```yaml
# Active l'utilisation d'un serveur etherpad
docker_jitsimeet_etherpad_enabled: true
# Adresse du serveur sur lequel partager un document par réunion
2022-08-28 21:00:48 +02:00
docker_jitsimeet_etherpad_public_url: https://pad.libretic.fr
```
## Serveur TURN
Pour utiliser un serveur turn, ajouter les variables suivantes :
```yaml
# Active l'utilisation d'un serveur turn
docker_jitsimeet_turnserver_enabled: true
# Adresse du serveur turn à utiliser
docker_jitsimeet_turnserver_fqdn: turn.example.com
# Secret partagé avec le serveur turn
docker_jitsimeet_turnserver_credentials: mdp_du_turnserver
# Port de connexion au serveur turn
docker_jitsimeet_turnserver_port: 1234
# Transport à utiliser (tcp ou udp)
docker_jitsimeet_turnserver_transport: tcp
```
## Métriques
Pour activer l'export de métriques par jvb, fournir les variables suivantes :
```yaml
docker_jitsimeet_exporter_enabled: true
docker_jitsimeet_exporter_port: 9888
```
Jvb peut alors servir les metriques en json sur l'adresse http://jvb:8080/colibri/stats.
Une fois les métriques activées, leur collecte peut se faire par prometheus par scrutation de l'adresse du serveur sur le port indiqué.
Exemple de job prometheus :
```yaml
- job_name: 'jitsi'
static_configs:
- targets:
- adresse_hote_docker:9888
```
Un exemple de tableau de bord grafana utilisable avec les métriques collectées sur prometheus : https://github.com/systemli/prometheus-jitsi-meet-exporter/tree/main/dashboards