Référence de configuration

Cette page décrit chaque champ du fichier de configuration de Drovio Server, settings.conf, au format JSON. Voir Configurer Drovio Server pour son emplacement selon votre plateforme et pour la façon d'appliquer les modifications.

Les changements s'appliquent à chaud, à deux exceptions près

Le fichier de configuration est surveillé : une modification prend effet en quelques secondes, sans redémarrer le service. Deux familles ne sont lues qu'au démarrage et demandent un redémarrage : plugin_management, et les champs qui définissent l'écouteur HTTP, à savoir tls, http_port et https_port. Sous Linux, keystore et keystore_password sont réappliqués sans redémarrage quand le serveur reçoit SIGUSR2. Voir Activer HTTPS.

plugin_management

Champ	Type	Commentaire
plugins	Array	Liste des plugins, par exemple l'intégration Slack.
plugins[].classpath	String	Chemin du fichier JAR du plugin.
plugins[].path	String	Paquetage, par exemple com.drovio.server.slack.
plugins[].ext	String	Toujours java.
plugins[].base_address	String	Dépend du plugin, par exemple drovio.server.slack.

http

Champ	Type	Commentaire
url	String	À remplacer par le nom d'hôte ou l'IP de la machine, nécessaire aux e-mails transactionnels et aux invitations.
num_instances	Number	Nombre d'écouteurs HTTP. Doit valoir 0, en automatique, ou correspondre aux cœurs disponibles sur la machine.
session_timeout	Number	Durée de vie d'une session en ms, la session expirant en l'absence d'activité de l'utilisateur.
tls	Boolean	Active HTTPS. Voir Activer HTTPS.
tls_protocols	Array	Tableau de chaînes, par exemple ["TLSv1.2", "TLSv1.3"]. Sans valeur, TLSv1.2 et TLSv1.3 sont activés par défaut.
tls_cipher_suites	Array	Tableau de chaînes, par exemple ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", …].
keystore	String	Certificat utilisé quand TLS est activé, empaqueté en JKS. Rechargé sur SIGUSR2 sous Linux. Voir Activer HTTPS.
keystore_password	String	Mot de passe du JKS. Rechargé sur SIGUSR2 sous Linux. Voir Activer HTTPS.
http_port	Number	À fixer à 80, valeur par défaut 8090.
https_port	Number	À fixer à 443, valeur par défaut 8090. Exige que TLS soit activé.
admin_ip_whitelist	Array (Strings)	Liste des IP autorisées à accéder à /admin, avec masque facultatif, par exemple "192.168.1.10" ou "172.42.13.0/24".
url_share_your_screen	String	URL de la page de téléchargement de l'application, affichée dans plusieurs e-mails.
url_support	String	URL destinée au support.
xsrf_enabled	Boolean	Active la protection contre la falsification de requête intersite, valeur par défaut true.
deny_xframe	Boolean	Interdit l'affichage du client dans un cadre, valeur par défaut true.
drain_delay	Number	Délai en secondes dans lequel le serveur ferme toutes les connexions WebSocket à la réception d'un signal SIGUSR1, valeur par défaut 180.
drain_period	Number	Période en secondes à laquelle le serveur ferme des connexions WebSocket à la réception d'un signal SIGUSR1, valeur par défaut 10.
prevent_indexing	Boolean	Empêche l'indexation des ressources du serveur par les robots d'exploration, comme celui de Google.
jwt_expiration_delay	Number	Délai d'expiration en secondes du JWT servant à l'authentification sur l'API de réunion.
jwt_secret	String	Secret du JWT servant à l'authentification sur l'API de réunion.
websocket_allowed_origins	String	Expression régulière décrivant les origines autorisées à ouvrir une connexion WebSocket. Vide par défaut, ce qui n'installe aucun gestionnaire CORS.

http → session_store

Champ	Type	Commentaire
type	String	Type de magasin utilisé pour les sessions, default en mémoire ou redis. Valeur par défaut default.

session_store → on_change

Champ	Type	Commentaire
transfer_sessions	Boolean	Lors d'un changement de magasin en cours d'exécution, à true, toutes les sessions existantes sont insérées dans le nouveau magasin. Valeur par défaut false.
clear_old_store	Boolean	Lors d'un changement de magasin en cours d'exécution, à true, vide toutes les sessions de l'ancien magasin. Valeur par défaut false.
close_delay	Number	Délai en ms avant l'arrêt de l'ancien magasin une fois le nouveau en place. Évite d'interrompre les requêtes en cours vers l'ancien. Valeur par défaut 5000.

session_store → redis

Champ	Type	Commentaire
connections	Array (Strings)	Liste des chaînes de connexion aux serveurs Redis. Les adresses suivent redis://[:password@]host[:port][/db-number], par exemple "redis://127.0.0.1:7001". rediss est également possible.
master	String	Nom du maître, valeur par défaut master.
max_pool_size	Number	Nombre maximal de connexions dans le pool, valeur par défaut 6.
max_pool_waiting	Number	Nombre maximal de demandeurs en file d'attente d'une connexion, valeur par défaut 24.
type	String	Type de client : standalone, sentinel, cluster ou replication. Valeur par défaut standalone.
role	String	Rôle en haute disponibilité : master, replica ou sentinel. Aucune valeur par défaut.
password	String	Mot de passe pour les modes cluster et sentinel.
pool_cleaner_interval	Number	Période de la tâche qui ferme les connexions en état invalide. -1 signifie que la tâche ne s'exécute jamais. Valeur par défaut -1.
pool_recycle_timeout	Number	Délai en ms au terme duquel une connexion est recyclée, valeur par défaut 15000.

redis → tls

Utilisé uniquement lorsque les chaînes de connexion emploient le schéma rediss.

Champ	Type	Commentaire
verify_hostname	Boolean	Vérifie que le certificat correspond à l'hôte contacté.
trust_all	Boolean	Accepte n'importe quel certificat. À laisser à false en dehors des tests.
ca_certificate_path	String	Chemin du certificat d'autorité servant à valider celui de Redis.

database

Champ	Type	Commentaire
host	String	Nom d'hôte de la base.
port	Number	Port de la base.
database	String	Nom de la base.
user	String	Utilisateur de la base.
password	String	Généré automatiquement lors du déploiement d'un paquet.
ssl_mode	String	Politique TLS de la connexion, au sens de PostgreSQL : disable, allow, prefer, require, verify-ca ou verify-full. Valeur par défaut prefer.

database → pool_options → main

Champ	Type	Commentaire
max_size	Number	Nombre de connexions simultanées, à régler sur la capacité réelle de votre base, valeur par défaut 30, conjointement avec la taille maximale de licensing.
connect_timeout	Number	Délai de connexion en secondes, à adapter à la capacité de votre base, valeur par défaut 30.
idle_timeout	Number	Délai en secondes au terme duquel une connexion inactive peut être fermée pour libérer des ressources, valeur par défaut 600.

database → pool_options → licensing

Champ	Type	Commentaire
max_size	Number	Nombre de connexions simultanées, à régler sur la capacité réelle de votre base, valeur par défaut 30, conjointement avec la taille maximale de main.
connect_timeout	Number	Délai de connexion en secondes, à adapter à la capacité de votre base, valeur par défaut 30.
idle_timeout	Number	Délai en secondes au terme duquel une connexion inactive peut être fermée, valeur par défaut 600.

database → replicas

Réglages de connexion aux réplicas de lecture. Les champs port, database, user, password et ssl_mode reprennent ceux de la section database principale, et les pool_options → main et pool_options → licensing imbriqués se comportent exactement comme les options de pool ci-dessus, mais s'appliquent à l'instance réplica.

maintenance

Champ	Type	Commentaire
enabled	Boolean	À ne pas modifier ici, utilisez le panneau d'administration pour activer le mode maintenance.
message	String	Message de maintenance. À ne pas modifier ici, utilisez le panneau d'administration.

webrtc

Champ	Type	Commentaire
turn_servers_secret	String	Si des serveurs TURN sont utilisés, le jeton secret partagé.
turn_servers_auth_timeout	Number	Si des serveurs TURN sont utilisés, durée de validité des identifiants générés automatiquement.
ice_servers	Array	Liste des serveurs STUN et TURN utilisés. Par défaut, le serveur STUN de Google et aucun serveur TURN.
ice_servers[].url	String	URL STUN ou TURN, par exemple stun:192.168.1.23:443 ou turn:192.168.1.23?transport=tcp.
service_quality	Object	Plage de débit utilisée pour l'audio et la vidéo.
service_quality.minimum	Number	Débit minimal en kbps.
service_quality.maximum	Number	Débit maximal en kbps.

Voir Serveur relais (TURN) pour la marche à suivre complète.

smtp

Champ	Type	Commentaire
enabled	Boolean	Active les notifications par e-mail.
hostname	String	Par exemple smtp.example.com.
port	Number	25, 465, 587…
start_tls	String	disabled, optional or required.
ssl	Boolean	true or false.
login	String	none, disabled or required.
username	String	Si l'authentification est active, en général une adresse e-mail.
password	String	Mot de passe SMTP.
from	String	Format : Drovio <drovio@example.com>.
admin_email	String	Adresse e-mail de l'équipe de support.
trust_all	Boolean	Passe outre les problèmes TLS.
own_hostname	String	À renseigner avec votre nom de domaine, par exemple example.com.

email_templating

Champ	Type	Commentaire
transport	String	Transport utilisé pour acheminer les e-mails à modèle. Valeur par défaut smtp, qui s'appuie sur la section smtp ci-dessus.

users

Champ	Type	Commentaire
add_all_contacts	Boolean	À true, un nouvel utilisateur est ajouté comme contact de tous les utilisateurs existants.

users → remove_inactive

Champ	Type	Commentaire
enabled	Boolean	Active la suppression automatique des utilisateurs après une période d'inactivité.
inactive_period	Number	Durée d'inactivité en secondes au terme de laquelle l'utilisateur est supprimé automatiquement. Valeur par défaut 7776000, soit 90 jours.

users → license_allocation

Champ	Type	Commentaire
enabled	Boolean	Active l'attribution automatique des licences, aux utilisateurs qui se connectent ou qui créent un compte.
mode	String	Soit floating, à la connexion d'un utilisateur, soit new_user, à la création d'un compte.
max_users	Number	Attribue automatiquement des licences permettant d'inviter jusqu'à max_users autres personnes en session. À fixer à 1, 4 ou 999 selon les licences acquises.

license_allocation → low_count_notification

Champ	Type	Commentaire
enabled	Boolean	Envoie un e-mail à l'adresse de support définie plus haut quand le pool de licences approche de l'épuisement.
threshold	Number	Pourcentage de licences libres dans le pool en dessous duquel un e-mail est envoyé.

users → auth → local

Champ	Type	Commentaire
enabled	Boolean	Active ou désactive l'authentification classique, par e-mail et mot de passe.
allow_signup	Boolean	Autorise les utilisateurs à créer eux-mêmes leur compte depuis l'application.

users → auth → ldap

Champ	Type	Commentaire
enabled	Boolean	Active LDAP et Active Directory.
url	String	Nom d'hôte du serveur LDAP ou AD : ldap://ldap.example.com ou ldaps://ldap.example.com, avec port facultatif, par exemple ldap://ldap.example.com:389.
service_account_dn	String	Compte capable de rechercher d'autres comptes, par exemple cn=admin,dc=example,dc=com ou Administrator@domain.com.
service_account_password	String	Mot de passe du compte de service.
base	String	Unité d'organisation où se trouvent les comptes utilisateurs, par exemple ou=users,dc=example,dc=com.
search_filter	String	Le champ qui porte l'adresse e-mail. Sous LDAP, mail ; sous Active Directory, mail ou userPrincipalName. Valeur par défaut (&(objectClass=*)(mail={0})).
ca_certificate_path	String	Chemin du certificat d'autorité servant à valider celui du serveur lors d'une connexion en ldaps.

users → auth → saml

Champ	Type	Commentaire
enabled	Boolean	Active SAML. Ne peut pas l'être si OpenID Connect l'est.
keystore	String	Chemin du JKS, généré automatiquement si le fichier n'existe pas.
keystore_password	String	Mot de passe du magasin JKS.
private_key_password	String	Mot de passe de la clé privée du JKS.
idp_metadata_path	String	Chemin du fichier XML de métadonnées du fournisseur d'identité.
sp_metadata_path	String	Où les métadonnées du fournisseur de service sont exportées à chaque démarrage. Le serveur ne relit jamais ce fichier : les métadonnées sont gardées en mémoire et servies sur /sso/metadata. Laissez vide pour ne pas exporter. Voir SSO.
sp_entity_id	String	Entity ID du fournisseur de service, en général l'URL du serveur. Sans valeur, l'URL de callback complète est utilisée.
passive	Boolean	Lorsque le fournisseur d'identité n'attend aucune saisie de l'utilisateur.
force_auth	Boolean	Force l'authentification auprès du fournisseur d'identité à chaque connexion depuis l'application.
use_name_qualifier	Boolean	Selon la spécification SAML, la requête ne doit pas contenir de NameQualifier si l'entité SP est en nameid-format:entity, mais certains fournisseurs d'identité l'exigent.
wants_assertions_signed	Boolean	Signe les assertions lorsqu'elles doivent être traitées indépendamment de la réponse.
authn_request_signed	Boolean	Signe les requêtes d'authentification.
email_attribute	String	Nom de l'attribut du fournisseur d'identité auquel associer les adresses e-mail.
username_attribute	String	Nom de l'attribut du fournisseur d'identité auquel associer les noms d'utilisateur.
accepted_skew	Number	Tolérance temporelle SAML, au sens de SAML 1.1.
max_auth_lifetime	Number	En secondes, à aligner sur celle de votre fournisseur d'identité, par exemple 8 heures pour ADFS et 14 jours pour Google.

Voir SSO : SAML et OIDC pour le magasin de clés et les URL de callback.

users → auth → oidc

Champ	Type	Commentaire
enabled	Boolean	Active OpenID Connect. Ne peut pas l'être si SAML l'est.
client_id	String	Client ID OIDC.
secret	String	Secret OIDC.
discovery_uri	String	URI de découverte OIDC.
email_attribute	String	Nom de l'attribut du fournisseur d'identité auquel associer les adresses e-mail.
username_attribute	String	Nom de l'attribut du fournisseur d'identité auquel associer les noms d'utilisateur.
custom_params	Array	Paramètres personnalisés.
custom_params[].key	String	Par exemple prompt.
custom_params[].value	String	Par exemple consent.

users → remove_unvalidated

Champ	Type	Commentaire
enabled	Boolean	Supprime automatiquement les comptes non validés.
time	String	Heure de lancement de la tâche, par exemple 05:00.
offset	String	Décalage par rapport à UTC, par exemple +01:00.
remove_delay	Number	Délai en jours au terme duquel les comptes locaux non validés sont supprimés. Désactivé si négatif, valeur par défaut -1.
limit	Number	Nombre maximal de comptes supprimés à chaque exécution, valeur par défaut 30.

users → auth

Champ	Type	Commentaire
sso_auth_token_lifetime	Number	Durée de vie de tout jeton d'authentification SSO généré, valeur par défaut 10 minutes.

users → email_code

Codes à usage unique envoyés par e-mail, servant à confirmer une adresse ou à récupérer un compte.

Champ	Type	Commentaire
enabled	Boolean	Active les codes par e-mail, valeur par défaut true.
ttl	Number	Durée de vie d'un code en secondes, valeur par défaut 900, soit 15 minutes.
max_per_day	Number	Nombre maximal de codes envoyés à une même adresse par jour, tous usages confondus. 0 ou moins désactive le quota, valeur par défaut 10.
alert_threshold_per_hour	Number	Nombre de codes envoyés par heure au-delà duquel l'administrateur est alerté. 0 ou moins désactive l'alerte, valeur par défaut 500.

logging

Champ	Type	Commentaire
severity	String	Niveau de détail des journaux : off, error, warning, info, debug ou trace. Valeur par défaut info.
loggers.<key>	String	<key> désigne une classe ou un paquetage. Remplace le niveau de détail pour cette classe ou ce paquetage, avec les mêmes valeurs que severity.

reporting

Champ	Type	Commentaire
enabled	Boolean	Active la génération automatique de rapports d'usage.
frequency	String	Fréquence des rapports d'usage : daily, weekly ou monthly.
hour	Number	Heure de génération du rapport, utilisée quelle que soit la fréquence.
day_of_week	Number	Jour de la semaine pour les rapports weekly : 1 pour dimanche, 2 pour lundi, et ainsi de suite.
day_of_month	Number	Jour du mois pour les rapports monthly, de 1 à 31. La valeur 31 déclenche un rapport le dernier jour de chaque mois.
options	Array (Strings)	Types d'événements à inclure : user_login, session_lifetime ou swap_request.
anonymous	Boolean	Masque toute donnée personnelle identifiante.
recipients	Array (Strings)	Liste des adresses e-mail destinataires des rapports.
archive_name_pattern	String	Modèle de nom de fichier de l'archive de données du rapport. My_archive produit par exemple My_archive [2019-08-01 14.00.00 to 2019-08-02 14.00.00].

remote_desktop

Champ	Type	Commentaire
enabled	Boolean	Active la fonctionnalité de bureau à distance.

app_update

Champ	Type	Commentaire
base_url	String	Ne modifiez pas la valeur par défaut. Champ réservé au Cloud.

anonymize

Champ	Type	Commentaire
enabled	Boolean	Active la tâche quotidienne d'anonymisation des données.
when	String	Moment d'exécution de la tâche : now, après le démarrage du serveur, ou une heure au format 24 h HH:mm, par exemple 17:30.
offset	String	Décalage horaire utilisé pour planifier la tâche, par exemple +02:00. Par défaut, celui du serveur.
limit	Number	Nombre maximal d'utilisateurs anonymisés en une exécution, valeur par défaut 30.

monitoring

Champ	Type	Commentaire
enabled	Boolean	Monte les routes de supervision sous /api/monitoring, valeur par défaut false.

meeting

Champ	Type	Commentaire
url	String	URL à ouvrir pour gérer les réunions.
enabled	Boolean	Active le bouton de réunion.

calls

Champ	Type	Commentaire
expiration_delay	Number	Délai en secondes au terme duquel un participant déconnecté est considéré comme ayant quitté l'appel, valeur par défaut 60.

calls → clean_task

Champ	Type	Commentaire
enabled	Boolean	Active la tâche qui supprime les anciennes données d'appel, valeur par défaut true.
frequency	Number	Fréquence en secondes de la tâche qui supprime les anciennes données d'appel, valeur par défaut un jour.