Riferimento di configurazione

Questa pagina descrive ogni campo del file di configurazione di Drovio Server, settings.conf, in formato JSON. Consultate Configurare Drovio Server per conoscere la sua posizione a seconda della piattaforma e il modo di applicare le modifiche.

Le modifiche si applicano a caldo, con due eccezioni

Il file di configurazione è sorvegliato: una modifica ha effetto in pochi secondi, senza riavviare il servizio. Due famiglie sono lette solo all'avvio e richiedono un riavvio : plugin_management, e i campi che definiscono l'ascoltatore HTTP, ovvero tls, http_port e https_port. Su Linux, keystore e keystore_password vengono riapplicati senza riavvio quando il server riceve SIGUSR2. Consultate Attivare HTTPS.

plugin_management

Campo	Tipo	Commento
plugins	Array	Elenco dei plugin, per esempio l'integrazione Slack.
plugins[].classpath	String	Percorso del file JAR del plugin.
plugins[].path	String	Pacchetto, per esempio com.drovio.server.slack.
plugins[].ext	String	Sempre java.
plugins[].base_address	String	Dipende dal plugin, per esempio drovio.server.slack.

http

Campo	Tipo	Commento
url	String	Da sostituire con il nome host o l'IP della macchina, necessario per le e-mail transazionali e per gli inviti.
num_instances	Number	Numero di ascoltatori HTTP. Deve valere 0, in automatico, oppure corrispondere ai core disponibili sulla macchina.
session_timeout	Number	Durata di vita di una sessione in ms, la sessione scade in assenza di attività dell'utente.
tls	Boolean	Attiva HTTPS. Consultate Attivare HTTPS.
tls_protocols	Array	Array di stringhe, per esempio ["TLSv1.2", "TLSv1.3"]. Senza valore, TLSv1.2 e TLSv1.3 sono attivi per impostazione predefinita.
tls_cipher_suites	Array	Array di stringhe, per esempio ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", …].
keystore	String	Certificato usato quando TLS è attivo, impacchettato in JKS. Ricaricato su SIGUSR2 sotto Linux. Consultate Attivare HTTPS.
keystore_password	String	Password del JKS. Ricaricata su SIGUSR2 sotto Linux. Consultate Attivare HTTPS.
http_port	Number	Da impostare a 80, valore predefinito 8090.
https_port	Number	Da impostare a 443, valore predefinito 8090. Richiede che TLS sia attivo.
admin_ip_whitelist	Array (Strings)	Elenco degli IP autorizzati ad accedere a /admin, con maschera facoltativa, per esempio "192.168.1.10" o "172.42.13.0/24".
url_share_your_screen	String	URL della pagina di scaricamento dell'applicazione, mostrata in diverse e-mail.
url_support	String	URL destinata al supporto.
xsrf_enabled	Boolean	Attiva la protezione contro la falsificazione di richiesta intersito, valore predefinito true.
deny_xframe	Boolean	Vieta la visualizzazione del client in un frame, valore predefinito true.
drain_delay	Number	Intervallo in secondi entro il quale il server chiude tutte le connessioni WebSocket alla ricezione di un segnale SIGUSR1, valore predefinito 180.
drain_period	Number	Periodo in secondi con cui il server chiude connessioni WebSocket alla ricezione di un segnale SIGUSR1, valore predefinito 10.
prevent_indexing	Boolean	Impedisce l'indicizzazione delle risorse del server da parte dei robot di scansione, come quello di Google.
jwt_expiration_delay	Number	Tempo di scadenza in secondi del JWT usato per l'autenticazione sull'API di riunione.
jwt_secret	String	Segreto del JWT usato per l'autenticazione sull'API di riunione.
websocket_allowed_origins	String	Espressione regolare che descrive le origini autorizzate ad aprire una connessione WebSocket. Vuota per impostazione predefinita, il che non installa alcun gestore CORS.

http → session_store

Campo	Tipo	Commento
type	String	Tipo di archivio usato per le sessioni, default in memoria oppure redis. Valore predefinito default.

session_store → on_change

Campo	Tipo	Commento
transfer_sessions	Boolean	In caso di cambio di archivio durante l'esecuzione, a true, tutte le sessioni esistenti sono inserite nel nuovo archivio. Valore predefinito false.
clear_old_store	Boolean	In caso di cambio di archivio durante l'esecuzione, a true, svuota tutte le sessioni dal vecchio archivio. Valore predefinito false.
close_delay	Number	Ritardo in ms prima dell'arresto del vecchio archivio, una volta che il nuovo è operativo. Evita di interrompere le richieste in corso verso il vecchio. Valore predefinito 5000.

session_store → redis

Campo	Tipo	Commento
connections	Array (Strings)	Elenco delle stringhe di connessione ai server Redis. Gli indirizzi seguono redis://[:password@]host[:port][/db-number], per esempio "redis://127.0.0.1:7001". È possibile anche rediss.
master	String	Nome del master, valore predefinito master.
max_pool_size	Number	Numero massimo di connessioni nel pool, valore predefinito 6.
max_pool_waiting	Number	Numero massimo di richiedenti in coda per ottenere una connessione, valore predefinito 24.
type	String	Tipo di client: standalone, sentinel, cluster o replication. Valore predefinito standalone.
role	String	Ruolo in alta disponibilità: master, replica o sentinel. Nessun valore predefinito.
password	String	Password per le modalità cluster e sentinel.
pool_cleaner_interval	Number	Periodo dell'attività che chiude le connessioni in stato non valido. -1 significa che l'attività non viene mai eseguita. Valore predefinito -1.
pool_recycle_timeout	Number	Tempo in ms al termine del quale una connessione viene riciclata, valore predefinito 15000.

redis → tls

Usato soltanto quando le stringhe di connessione impiegano lo schema rediss.

Campo	Tipo	Commento
verify_hostname	Boolean	Verifica che il certificato corrisponda all'host contattato.
trust_all	Boolean	Accetta qualsiasi certificato. Da lasciare a false al di fuori dei test.
ca_certificate_path	String	Percorso del certificato dell'autorità che serve a validare quello di Redis.

database

Campo	Tipo	Commento
host	String	Nome host del database.
port	Number	Porta del database.
database	String	Nome del database.
user	String	Utente del database.
password	String	Generata automaticamente durante la distribuzione di un pacchetto.
ssl_mode	String	Politica TLS della connessione, nel senso di PostgreSQL: disable, allow, prefer, require, verify-ca o verify-full. Valore predefinito prefer.

database → pool_options → main

Campo	Tipo	Commento
max_size	Number	Numero di connessioni simultanee, da regolare sulla capacità reale del vostro database, valore predefinito 30, congiuntamente alla dimensione massima di licensing.
connect_timeout	Number	Tempo di connessione in secondi, da adattare alla capacità del vostro database, valore predefinito 30.
idle_timeout	Number	Tempo in secondi al termine del quale una connessione inattiva può essere chiusa per liberare risorse, valore predefinito 600.

database → pool_options → licensing

Campo	Tipo	Commento
max_size	Number	Numero di connessioni simultanee, da regolare sulla capacità reale del vostro database, valore predefinito 30, congiuntamente alla dimensione massima di main.
connect_timeout	Number	Tempo di connessione in secondi, da adattare alla capacità del vostro database, valore predefinito 30.
idle_timeout	Number	Tempo in secondi al termine del quale una connessione inattiva può essere chiusa, valore predefinito 600.

database → replicas

Impostazioni di connessione alle repliche di lettura. I campi port, database, user, password e ssl_mode riprendono quelli della sezione database principale, e i pool_options → main e pool_options → licensing annidati si comportano esattamente come le opzioni di pool qui sopra, ma si applicano all'istanza replica.

maintenance

Campo	Tipo	Commento
enabled	Boolean	Da non modificare qui, usate il pannello di amministrazione per attivare la modalità di manutenzione.
message	String	Messaggio di manutenzione. Da non modificare qui, usate il pannello di amministrazione.

webrtc

Campo	Tipo	Commento
turn_servers_secret	String	Se si usano server TURN, il token segreto condiviso.
turn_servers_auth_timeout	Number	Se si usano server TURN, durata di validità delle credenziali generate automaticamente.
ice_servers	Array	Elenco dei server STUN e TURN usati. Per impostazione predefinita, il server STUN di Google e nessun server TURN.
ice_servers[].url	String	URL STUN o TURN, per esempio stun:192.168.1.23:443 o turn:192.168.1.23?transport=tcp.
service_quality	Object	Intervallo di bitrate usato per l'audio e il video.
service_quality.minimum	Number	Bitrate minimo in kbps.
service_quality.maximum	Number	Bitrate massimo in kbps.

Consultate Server relay (TURN) per la procedura completa.

smtp

Campo	Tipo	Commento
enabled	Boolean	Attiva le notifiche per e-mail.
hostname	String	Per esempio smtp.example.com.
port	Number	25, 465, 587…
start_tls	String	disabled, optional o required.
ssl	Boolean	true o false.
login	String	none, disabled o required.
username	String	Se l'autenticazione è attiva, in genere un indirizzo e-mail.
password	String	Password SMTP.
from	String	Formato: Drovio <drovio@example.com>.
admin_email	String	Indirizzo e-mail del team di supporto.
trust_all	Boolean	Ignora qualsiasi problema TLS.
own_hostname	String	Da valorizzare con il vostro nome di dominio, per esempio example.com.

email_templating

Campo	Tipo	Commento
transport	String	Trasporto usato per recapitare le e-mail a modello. Valore predefinito smtp, che si appoggia alla sezione smtp qui sopra.

users

Campo	Tipo	Commento
add_all_contacts	Boolean	A true, un nuovo utente viene aggiunto come contatto di tutti gli utenti esistenti.

users → remove_inactive

Campo	Tipo	Commento
enabled	Boolean	Attiva l'eliminazione automatica degli utenti dopo un periodo di inattività.
inactive_period	Number	Periodo di inattività in secondi al termine del quale l'utente viene eliminato automaticamente. Valore predefinito 7776000, ovvero 90 giorni.

users → license_allocation

Campo	Tipo	Commento
enabled	Boolean	Attiva l'assegnazione automatica delle licenze, agli utenti che si connettono o che creano un account.
mode	String	O floating, alla connessione di un utente, oppure new_user, alla creazione di un account.
max_users	Number	Assegna automaticamente licenze che permettono di invitare fino a max_users altre persone in sessione. Da fissare a 1, 4 o 999 secondo le licenze acquisite.

license_allocation → low_count_notification

Campo	Tipo	Commento
enabled	Boolean	Invia un'e-mail all'indirizzo di supporto definito più sopra quando il pool di licenze si avvicina all'esaurimento.
threshold	Number	Percentuale di licenze libere nel pool sotto la quale viene inviata un'e-mail.

users → auth → local

Campo	Tipo	Commento
enabled	Boolean	Attiva o disattiva l'autenticazione classica, per e-mail e password.
allow_signup	Boolean	Autorizza gli utenti a creare da soli il proprio account dall'applicazione.

users → auth → ldap

Campo	Tipo	Commento
enabled	Boolean	Attiva LDAP e Active Directory.
url	String	Nome host del server LDAP o AD: ldap://ldap.example.com o ldaps://ldap.example.com, con porta facoltativa, per esempio ldap://ldap.example.com:389.
service_account_dn	String	Account in grado di cercare altri account, per esempio cn=admin,dc=example,dc=com o Administrator@domain.com.
service_account_password	String	Password dell'account di servizio.
base	String	Unità organizzativa in cui si trovano gli account utente, per esempio ou=users,dc=example,dc=com.
search_filter	String	Il campo che porta l'indirizzo e-mail. Sotto LDAP, mail; sotto Active Directory, mail o userPrincipalName. Valore predefinito (&(objectClass=*)(mail={0})).
ca_certificate_path	String	Percorso del certificato dell'autorità che serve a validare quello del server durante una connessione in ldaps.

users → auth → saml

Campo	Tipo	Commento
enabled	Boolean	Attiva SAML. Non può esserlo se OpenID Connect lo è.
keystore	String	Percorso del JKS, generato automaticamente se il file non esiste.
keystore_password	String	Password dell'archivio JKS.
private_key_password	String	Password della chiave privata del JKS.
idp_metadata_path	String	Percorso del file XML dei metadati del fornitore di identità.
sp_metadata_path	String	Dove i metadati del fornitore di servizio sono esportati a ogni avvio. Il server non rilegge mai questo file: i metadati sono tenuti in memoria e serviti su /sso/metadata. Lasciate vuoto per non esportare. Consultate SSO.
sp_entity_id	String	Entity ID del fornitore di servizio, in genere l'URL del server. Senza valore, viene usata l'URL di callback completa.
passive	Boolean	Quando il fornitore di identità non attende alcun inserimento da parte dell'utente.
force_auth	Boolean	Forza l'autenticazione presso il fornitore di identità a ogni connessione dall'applicazione.
use_name_qualifier	Boolean	Secondo la specifica SAML, la richiesta non deve contenere un NameQualifier se l'entità SP è in nameid-format:entity, ma alcuni fornitori di identità lo esigono.
wants_assertions_signed	Boolean	Firma le asserzioni quando devono essere trattate indipendentemente dalla risposta.
authn_request_signed	Boolean	Firma le richieste di autenticazione.
email_attribute	String	Nome dell'attributo del fornitore di identità a cui associare gli indirizzi e-mail.
username_attribute	String	Nome dell'attributo del fornitore di identità a cui associare i nomi utente.
accepted_skew	Number	Tolleranza temporale SAML, nel senso di SAML 1.1.
max_auth_lifetime	Number	In secondi, da allineare a quella del vostro fornitore di identità, per esempio 8 ore per ADFS e 14 giorni per Google.

Consultate SSO: SAML e OIDC per l'archivio di chiavi e le URL di callback.

users → auth → oidc

Campo	Tipo	Commento
enabled	Boolean	Attiva OpenID Connect. Non può esserlo se SAML lo è.
client_id	String	Client ID OIDC.
secret	String	Secret OIDC.
discovery_uri	String	URI di discovery OIDC.
email_attribute	String	Nome dell'attributo del fornitore di identità a cui associare gli indirizzi e-mail.
username_attribute	String	Nome dell'attributo del fornitore di identità a cui associare i nomi utente.
custom_params	Array	Parametri personalizzati.
custom_params[].key	String	Per esempio prompt.
custom_params[].value	String	Per esempio consent.

users → remove_unvalidated

Campo	Tipo	Commento
enabled	Boolean	Elimina automaticamente gli account non validati.
time	String	Ora di lancio dell'attività, per esempio 05:00.
offset	String	Scarto rispetto a UTC, per esempio +01:00.
remove_delay	Number	Tempo in giorni al termine del quale gli account locali non validati vengono eliminati. Disattivato se negativo, valore predefinito -1.
limit	Number	Numero massimo di account eliminati a ogni esecuzione, valore predefinito 30.

users → auth

Campo	Tipo	Commento
sso_auth_token_lifetime	Number	Durata di vita di qualsiasi token di autenticazione SSO generato, valore predefinito 10 minuti.

users → email_code

Codici monouso inviati per e-mail, che servono a confermare un indirizzo o a recuperare un account.

Campo	Tipo	Commento
enabled	Boolean	Attiva i codici per e-mail, valore predefinito true.
ttl	Number	Durata di vita di un codice in secondi, valore predefinito 900, ovvero 15 minuti.
max_per_day	Number	Numero massimo di codici inviati a uno stesso indirizzo al giorno, tutti gli usi compresi. 0 o meno disattiva la quota, valore predefinito 10.
alert_threshold_per_hour	Number	Numero di codici inviati all'ora oltre il quale l'amministratore viene avvisato. 0 o meno disattiva l'avviso, valore predefinito 500.

logging

Campo	Tipo	Commento
severity	String	Livello di dettaglio dei log: off, error, warning, info, debug o trace. Valore predefinito info.
loggers.<key>	String	<key> indica una classe o un pacchetto. Sostituisce il livello di dettaglio per quella classe o quel pacchetto, con gli stessi valori di severity.

reporting

Campo	Tipo	Commento
enabled	Boolean	Attiva la generazione automatica di rapporti d'uso.
frequency	String	Frequenza dei rapporti d'uso: daily, weekly o monthly.
hour	Number	Ora di generazione del rapporto, usata qualunque sia la frequenza.
day_of_week	Number	Giorno della settimana per i rapporti weekly: 1 per domenica, 2 per lunedì, e così via.
day_of_month	Number	Giorno del mese per i rapporti monthly, da 1 a 31. Il valore 31 attiva un rapporto l'ultimo giorno di ogni mese.
options	Array (Strings)	Tipi di eventi da includere: user_login, session_lifetime o swap_request.
anonymous	Boolean	Maschera ogni dato personale identificativo.
recipients	Array (Strings)	Elenco degli indirizzi e-mail destinatari dei rapporti.
archive_name_pattern	String	Modello di nome file dell'archivio dei dati del rapporto. My_archive produce per esempio My_archive [2019-08-01 14.00.00 to 2019-08-02 14.00.00].

remote_desktop

Campo	Tipo	Commento
enabled	Boolean	Attiva la funzionalità di desktop remoto.

app_update

Campo	Tipo	Commento
base_url	String	Non modificate il valore predefinito. Campo riservato al Cloud.

anonymize

Campo	Tipo	Commento
enabled	Boolean	Attiva l'attività quotidiana di anonimizzazione dei dati.
when	String	Momento di esecuzione dell'attività: now, dopo l'avvio del server, oppure un'ora nel formato 24 h HH:mm, per esempio 17:30.
offset	String	Scarto orario usato per pianificare l'attività, per esempio +02:00. Per impostazione predefinita, quello del server.
limit	Number	Numero massimo di utenti anonimizzati in una esecuzione, valore predefinito 30.

monitoring

Campo	Tipo	Commento
enabled	Boolean	Monta le rotte di supervisione sotto /api/monitoring, valore predefinito false.

meeting

Campo	Tipo	Commento
url	String	URL da aprire per gestire le riunioni.
enabled	Boolean	Attiva il pulsante di riunione.

calls

Campo	Tipo	Commento
expiration_delay	Number	Tempo in secondi al termine del quale un partecipante disconnesso è considerato come uscito dalla chiamata, valore predefinito 60.

calls → clean_task

Campo	Tipo	Commento
enabled	Boolean	Attiva l'attività che elimina i vecchi dati di chiamata, valore predefinito true.
frequency	Number	Frequenza in secondi dell'attività che elimina i vecchi dati di chiamata, valore predefinito un giorno.