Konfigurationsreferenz

Diese Seite beschreibt jedes Feld der Konfigurationsdatei von Drovio Server, settings.conf, im JSON-Format. Siehe Drovio Server konfigurieren für ihren Speicherort je nach Plattform und für die Art und Weise, Änderungen anzuwenden.

Änderungen werden im laufenden Betrieb angewandt, mit zwei Ausnahmen

Die Konfigurationsdatei wird überwacht: eine Änderung wird innerhalb weniger Sekunden wirksam, ohne den Dienst neu zu starten. Zwei Gruppen werden nur beim Start gelesen und erfordern einen Neustart: plugin_management und die Felder, die den HTTP-Listener definieren, nämlich tls, http_port und https_port. Unter Linux werden keystore und keystore_password ohne Neustart erneut angewandt, wenn der Server SIGUSR2 empfängt. Siehe HTTPS aktivieren.

plugin_management

Feld	Typ	Kommentar
plugins	Array	Liste der Plugins, zum Beispiel die Slack-Integration.
plugins[].classpath	String	Pfad der JAR-Datei des Plugins.
plugins[].path	String	Paket, zum Beispiel com.drovio.server.slack.
plugins[].ext	String	Immer java.
plugins[].base_address	String	Hängt vom Plugin ab, zum Beispiel drovio.server.slack.

http

Feld	Typ	Kommentar
url	String	Durch den Hostnamen oder die IP der Maschine zu ersetzen, nötig für Transaktions-E-Mails und Einladungen.
num_instances	Number	Anzahl der HTTP-Listener. Sollte 0 sein, also automatisch, oder den verfügbaren CPU-Kernen der Maschine entsprechen.
session_timeout	Number	Lebensdauer einer Sitzung in ms, wobei die Sitzung bei fehlender Aktivität des Benutzers abläuft.
tls	Boolean	Aktiviert HTTPS. Siehe HTTPS aktivieren.
tls_protocols	Array	Array von Zeichenketten, zum Beispiel ["TLSv1.2", "TLSv1.3"]. Ohne Wert sind TLSv1.2 und TLSv1.3 standardmäßig aktiviert.
tls_cipher_suites	Array	Array von Zeichenketten, zum Beispiel ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", …].
keystore	String	Zertifikat, das bei aktiviertem TLS verwendet wird, als JKS verpackt. Wird unter Linux bei SIGUSR2 neu geladen. Siehe HTTPS aktivieren.
keystore_password	String	Passwort des JKS. Wird unter Linux bei SIGUSR2 neu geladen. Siehe HTTPS aktivieren.
http_port	Number	Auf 80 zu setzen, Standardwert 8090.
https_port	Number	Auf 443 zu setzen, Standardwert 8090. Erfordert, dass TLS aktiviert ist.
admin_ip_whitelist	Array (Strings)	Liste der IPs, die auf /admin zugreifen dürfen, mit optionaler Maske, zum Beispiel "192.168.1.10" oder "172.42.13.0/24".
url_share_your_screen	String	URL der Downloadseite der App, die in mehreren E-Mails angezeigt wird.
url_support	String	URL für den Support.
xsrf_enabled	Boolean	Aktiviert den Schutz gegen Cross-Site Request Forgery, Standardwert true.
deny_xframe	Boolean	Verbietet die Anzeige des Clients in einem Frame, Standardwert true.
drain_delay	Number	Frist in Sekunden, innerhalb derer der Server beim Empfang eines Signals SIGUSR1 alle WebSocket-Verbindungen schließt, Standardwert 180.
drain_period	Number	Zeitabstand in Sekunden, in dem der Server beim Empfang eines Signals SIGUSR1 WebSocket-Verbindungen schließt, Standardwert 10.
prevent_indexing	Boolean	Verhindert die Indexierung der Serverressourcen durch Crawler, etwa den von Google.
jwt_expiration_delay	Number	Ablauffrist in Sekunden des JWT, das der Authentifizierung an der Meeting-API dient.
jwt_secret	String	Geheimnis des JWT, das der Authentifizierung an der Meeting-API dient.
websocket_allowed_origins	String	Regulärer Ausdruck, der die Origins beschreibt, die eine WebSocket-Verbindung öffnen dürfen. Standardmäßig leer, wodurch kein CORS-Handler installiert wird.

http → session_store

Feld	Typ	Kommentar
type	String	Art des für die Sitzungen verwendeten Speichers, default im Arbeitsspeicher oder redis. Standardwert default.

session_store → on_change

Feld	Typ	Kommentar
transfer_sessions	Boolean	Bei einem Wechsel des Speichers im laufenden Betrieb werden mit true alle bestehenden Sitzungen in den neuen Sitzungsspeicher eingefügt, Standardwert false.
clear_old_store	Boolean	Bei einem Wechsel des Speichers im laufenden Betrieb werden mit true alle Sitzungen aus dem alten Sitzungsspeicher entfernt, Standardwert false.
close_delay	Number	Frist in ms, bevor der alte Sitzungsspeicher gestoppt wird, nachdem der neue eingerichtet ist. Vermeidet, laufende Abfragen an den alten Speicher zu unterbrechen, Standardwert 5000.

session_store → redis

Feld	Typ	Kommentar
connections	Array (Strings)	Liste der Verbindungszeichenketten zu Redis-Servern. Die Adressen folgen redis://[:password@]host[:port][/db-number], zum Beispiel "redis://127.0.0.1:7001". rediss ist ebenfalls möglich.
master	String	Name des Masters, Standardwert master.
max_pool_size	Number	Maximale Anzahl von Verbindungen im Pool, Standardwert 6.
max_pool_waiting	Number	Maximale Anzahl wartender Handler in der Warteschlange für eine Verbindung, Standardwert 24.
type	String	Art des Clients: standalone, sentinel, cluster oder replication, Standardwert standalone.
role	String	Rolle im HA-Modus: master, replica oder sentinel. Standardmäßig ist kein Wert gesetzt.
password	String	Passwort für den Cluster- oder Sentinel-Modus.
pool_cleaner_interval	Number	Zeitabstand der Aufgabe, die Verbindungen in ungültigem Zustand schließt. -1 bedeutet, dass die Aufgabe nie ausgeführt wird, Standardwert -1.
pool_recycle_timeout	Number	Frist in ms, nach der eine Verbindung recycelt wird, Standardwert 15000.

redis → tls

Wird nur verwendet, wenn die Verbindungszeichenketten das Schema rediss benutzen.

Feld	Typ	Kommentar
verify_hostname	Boolean	Prüft, ob das Zertifikat zu dem Host passt, mit dem verbunden wird.
trust_all	Boolean	Akzeptiert jedes Zertifikat. Außerhalb von Tests auf false belassen.
ca_certificate_path	String	Pfad zum CA-Zertifikat, mit dem das Redis-Zertifikat geprüft wird.

database

Feld	Typ	Kommentar
host	String	Hostname der Datenbank.
port	Number	Port der Datenbank.
database	String	Name der Datenbank.
user	String	Benutzer der Datenbank.
password	String	Wird bei der Bereitstellung eines Pakets automatisch erzeugt.
ssl_mode	String	TLS-Richtlinie für die Verbindung, nach der Semantik von PostgreSQL: disable, allow, prefer, require, verify-ca oder verify-full, Standardwert prefer.

database → pool_options → main

Feld	Typ	Kommentar
max_size	Number	Anzahl gleichzeitiger Verbindungen; auf die tatsächliche Kapazität Ihrer Datenbank zu setzen, Standardwert 30, gemeinsam mit der maximalen Größe von licensing.
connect_timeout	Number	Zeitlimit für den Verbindungsaufbau in Sekunden; an die Kapazität Ihrer Datenbank anzupassen, Standardwert 30.
idle_timeout	Number	Frist in Sekunden, nach der eine untätige Verbindung geschlossen werden kann, um Serverressourcen freizugeben, Standardwert 600.

database → pool_options → licensing

Feld	Typ	Kommentar
max_size	Number	Anzahl gleichzeitiger Verbindungen; auf die tatsächliche Kapazität Ihrer Datenbank zu setzen, Standardwert 30, gemeinsam mit der maximalen Größe von main.
connect_timeout	Number	Zeitlimit für den Verbindungsaufbau in Sekunden; an die Kapazität Ihrer Datenbank anzupassen, Standardwert 30.
idle_timeout	Number	Frist in Sekunden, nach der eine untätige Verbindung geschlossen werden kann, Standardwert 600.

database → replicas

Verbindungseinstellungen für die Lesereplikate. Die Felder port, database, user, password und ssl_mode entsprechen denen des Hauptabschnitts database, und die verschachtelten pool_options → main und pool_options → licensing verhalten sich genau wie die obigen Pooloptionen, gelten aber für die Replikatinstanz.

maintenance

Feld	Typ	Kommentar
enabled	Boolean	Sollte hier nicht geändert werden; nutzen Sie die Administrationsoberfläche, um den Wartungsmodus zu aktivieren.
message	String	Wartungsmeldung. Sollte hier nicht geändert werden; nutzen Sie die Administrationsoberfläche.

webrtc

Feld	Typ	Kommentar
turn_servers_secret	String	Wenn TURN-Server verwendet werden, das gemeinsame geheime Token.
turn_servers_auth_timeout	Number	Wenn TURN-Server verwendet werden, Gültigkeitsdauer der automatisch erzeugten Zugangsdaten.
ice_servers	Array	Liste der verwendeten STUN- und TURN-Server. Standardmäßig der STUN-Server von Google und kein TURN-Server.
ice_servers[].url	String	STUN- oder TURN-URL, zum Beispiel stun:192.168.1.23:443 oder turn:192.168.1.23?transport=tcp.
service_quality	Object	Bitratenbereich, der für Audio und Video verwendet wird.
service_quality.minimum	Number	Minimale Bitrate in kbps.
service_quality.maximum	Number	Maximale Bitrate in kbps.

Siehe Relay-Server (TURN) für die vollständige Anleitung.

smtp

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert die E-Mail-Benachrichtigungen.
hostname	String	Zum Beispiel smtp.example.com.
port	Number	25, 465, 587…
start_tls	String	disabled, optional oder required.
ssl	Boolean	true oder false.
login	String	none, disabled oder required.
username	String	Wenn die Anmeldung aktiviert ist, im Grunde eine E-Mail-Adresse.
password	String	SMTP-Passwort.
from	String	Format: Drovio <drovio@example.com>.
admin_email	String	E-Mail-Adresse des Support-Teams.
trust_all	Boolean	Übergeht jedes TLS-Problem.
own_hostname	String	Auf Ihren Domainnamen zu setzen, zum Beispiel example.com.

email_templating

Feld	Typ	Kommentar
transport	String	Transport, über den die aus Vorlagen erzeugten E-Mails zugestellt werden, Standardwert smtp, der den obigen Abschnitt smtp verwendet.

users

Feld	Typ	Kommentar
add_all_contacts	Boolean	Mit true wird ein neu angelegter Benutzer allen bestehenden Benutzern als Kontakt hinzugefügt.

users → remove_inactive

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert die automatische Löschung von Benutzern nach einem Zeitraum der Inaktivität.
inactive_period	Number	Zeitraum der Inaktivität in Sekunden, nach dem der Benutzer automatisch gelöscht wird, Standardwert 7776000, also 90 Tage.

users → license_allocation

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert die automatische Lizenzvergabe, die Benutzern bei der Anmeldung oder beim Anlegen eines Kontos Lizenzen zuweist.
mode	String	Entweder floating, bei der Anmeldung eines Benutzers, oder new_user, beim Anlegen eines Kontos.
max_users	Number	Weist automatisch Lizenzen zu, mit denen Benutzer bis zu max_users weitere Benutzer in ihre Sitzung einladen können; auf 1, 4 oder 999 zu setzen, je nach den erworbenen Lizenzen.

license_allocation → low_count_notification

Feld	Typ	Kommentar
enabled	Boolean	Sendet eine E-Mail an die oben definierte Supportadresse, wenn der Lizenzpool zur Neige geht.
threshold	Number	Prozentsatz freier Lizenzen im Pool, unter dem eine E-Mail gesendet wird.

users → auth → local

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert oder deaktiviert die klassische Authentifizierung mit E-Mail und Passwort.
allow_signup	Boolean	Erlaubt Benutzern, ihre eigenen Konten über die App anzulegen.

users → auth → ldap

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert LDAP / AD.
url	String	Hostname des LDAP- oder AD-Servers: ldap://ldap.example.com oder ldaps://ldap.example.com, mit optionalem Port, zum Beispiel ldap://ldap.example.com:389.
service_account_dn	String	Konto, das andere Konten nachschlagen kann, zum Beispiel cn=admin,dc=example,dc=com oder Administrator@domain.com.
service_account_password	String	Passwort des Dienstkontos.
base	String	Organisationseinheit, in der die Benutzerkonten liegen, zum Beispiel ou=users,dc=example,dc=com.
search_filter	String	Welches Feld die E-Mail-Adresse des Benutzers enthält. Unter LDAP mail, unter Active Directory mail oder userPrincipalName, Standardwert (&(objectClass=*)(mail={0})).
ca_certificate_path	String	Pfad zum CA-Zertifikat, mit dem das Serverzertifikat bei einer Verbindung über ldaps geprüft wird.

users → auth → saml

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert SAML, kann nicht aktiviert werden, wenn OpenID Connect aktiviert ist.
keystore	String	Pfad des JKS, wird automatisch erzeugt, wenn die Datei nicht existiert.
keystore_password	String	Passwort des JKS-Speichers.
private_key_password	String	Passwort des privaten Schlüssels im JKS.
idp_metadata_path	String	Pfad der XML-Datei mit den Metadaten des Identity Providers.
sp_metadata_path	String	Wohin die Metadaten des Service Providers bei jedem Start exportiert werden. Der Server liest diese Datei nie zurück: die Metadaten liegen im Arbeitsspeicher und werden unter /sso/metadata ausgeliefert. Leer lassen, um den Export zu überspringen. Siehe SSO.
sp_entity_id	String	Entity ID des Service Providers, in der Regel die URL des Servers; ohne Angabe wird die vollständige Callback-URL verwendet.
passive	Boolean	Wenn der IdP keine Eingabe des Benutzers verlangt.
force_auth	Boolean	Zwingt die Benutzer, sich bei jeder Anmeldung über die App erneut beim IdP zu authentifizieren.
use_name_qualifier	Boolean	Laut SAML-Spezifikation darf die Anfrage keinen NameQualifier enthalten, wenn die SP-Entität im Format nameid-format:entity vorliegt; manche IdPs verlangen ihn dennoch.
wants_assertions_signed	Boolean	Signiert die Assertions, wenn sie getrennt von der Antwort verarbeitet werden müssen.
authn_request_signed	Boolean	Signiert die Authentifizierungsanfragen.
email_attribute	String	Name des IdP-Attributs, auf das die E-Mail-Adressen abgebildet werden.
username_attribute	String	Name des IdP-Attributs, auf das die Benutzernamen abgebildet werden.
accepted_skew	Number	Zulässige Zeitabweichung bei SAML (SAML 1.1).
max_auth_lifetime	Number	In Sekunden; sollte dem Wert Ihres IdP entsprechen, zum Beispiel 8 Stunden bei ADFS, 14 Tage bei Google.

Siehe SSO: SAML und OIDC für den Keystore und die Callback-URLs.

users → auth → oidc

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert OpenID Connect, kann nicht aktiviert werden, wenn SAML aktiviert ist.
client_id	String	OIDC Client ID.
secret	String	OIDC Secret.
discovery_uri	String	OIDC Discovery URI.
email_attribute	String	Name des IdP-Attributs, auf das die E-Mail-Adressen abgebildet werden.
username_attribute	String	Name des IdP-Attributs, auf das die Benutzernamen abgebildet werden.
custom_params	Array	Benutzerdefinierte Parameter.
custom_params[].key	String	Zum Beispiel prompt.
custom_params[].value	String	Zum Beispiel consent.

users → remove_unvalidated

Feld	Typ	Kommentar
enabled	Boolean	Ob nicht bestätigte Konten automatisch gelöscht werden.
time	String	Uhrzeit, zu der diese Aufgabe gestartet wird, zum Beispiel 05:00.
offset	String	UTC-Offset, zum Beispiel +01:00.
remove_delay	Number	Frist in Tagen, nach der nicht bestätigte lokale Konten gelöscht werden. Bei negativem Wert deaktiviert, Standardwert -1.
limit	Number	Maximale Anzahl von Konten, die je Durchlauf gelöscht werden, Standardwert 30.

users → auth

Feld	Typ	Kommentar
sso_auth_token_lifetime	Number	Lebensdauer jedes erzeugten SSO-Auth-Tokens, standardmäßig 10 Minuten.

users → email_code

Einmalcodes, die per E-Mail versendet werden und dazu dienen, eine Adresse zu bestätigen oder ein Konto wiederherzustellen.

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert die E-Mail-Codes, Standardwert true.
ttl	Number	Lebensdauer eines Codes in Sekunden, Standardwert 900, also 15 Minuten.
max_per_day	Number	Maximale Anzahl von Codes, die pro Tag an eine E-Mail-Adresse gesendet werden, über alle Zwecke hinweg. 0 oder weniger deaktiviert das Kontingent, Standardwert 10.
alert_threshold_per_hour	Number	Anzahl der pro Stunde gesendeten Codes, oberhalb derer der Administrator alarmiert wird. 0 oder weniger deaktiviert den Alarm, Standardwert 500.

logging

Feld	Typ	Kommentar
severity	String	Ausführlichkeit der Protokollierung: off, error, warning, info, debug oder trace, Standardwert info.
loggers.<key>	String	<key> kann eine beliebige Klasse oder ein beliebiges Paket sein. Überschreibt die Ausführlichkeit der Protokollierung für die angegebene Klasse oder das angegebene Paket, mit denselben Werten wie severity.

reporting

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert die automatische Erzeugung von Nutzungsberichten.
frequency	String	Häufigkeit der Nutzungsberichte: daily, weekly oder monthly.
hour	Number	Stunde, zu der der Nutzungsbericht erzeugt wird, bei allen Häufigkeiten verwendet.
day_of_week	Number	Wochentag für weekly-Berichte; 1 = Sonntag, 2 = Montag, und so weiter.
day_of_month	Number	Tag des Monats für monthly-Berichte (1-31); der Wert 31 löst einen Bericht am letzten Tag jedes Monats aus.
options	Array (Strings)	Einzubeziehende Ereignistypen: user_login, session_lifetime oder swap_request.
anonymous	Boolean	Maskiert alle identifizierenden Daten.
recipients	Array (Strings)	Liste der E-Mail-Adressen, an die die Berichte gesendet werden.
archive_name_pattern	String	Muster für den Dateinamen des Datenarchivs des Berichts, zum Beispiel erzeugt My_archive den Namen My_archive [2019-08-01 14.00.00 to 2019-08-02 14.00.00].

remote_desktop

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert die Remote-Desktop-Funktion.

app_update

Feld	Typ	Kommentar
base_url	String	Den Standardwert nicht ändern. Der Cloud vorbehaltenes Feld.

anonymize

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert die tägliche Aufgabe zur Anonymisierung der Daten.
when	String	Wann die Aufgabe läuft: now, nach dem Start des Servers, oder eine Uhrzeit im 24-Stunden-Format HH:mm, zum Beispiel 17:30.
offset	String	Zeitversatz, der zur Planung der Aufgabe verwendet wird, zum Beispiel +02:00. Standardmäßig der Versatz des Servers.
limit	Number	Maximale Anzahl von Benutzern, die je Durchlauf anonymisiert werden, Standardwert 30.

monitoring

Feld	Typ	Kommentar
enabled	Boolean	Bindet die Monitoring-Routen unter /api/monitoring ein, Standardwert false.

meeting

Feld	Typ	Kommentar
url	String	URL, die zur Verwaltung der Meetings geöffnet wird.
enabled	Boolean	Aktiviert die Meeting-Schaltfläche.

calls

Feld	Typ	Kommentar
expiration_delay	Number	Frist in Sekunden, nach der ein getrennter Anrufteilnehmer als ausgeschieden gilt, Standardwert 60.

calls → clean_task

Feld	Typ	Kommentar
enabled	Boolean	Aktiviert die Aufgabe, die alte Anrufdaten entfernt, Standardwert true.
frequency	Number	Häufigkeit in Sekunden der Aufgabe, die alte Anrufdaten entfernt, standardmäßig 1 Tag.