Referencia de configuración

Esta página describe cada campo del archivo de configuración de Drovio Server, settings.conf, en formato JSON. Consulte Configurar Drovio Server para conocer su ubicación según su plataforma y la forma de aplicar los cambios.

Los cambios se aplican en caliente, con dos excepciones

El archivo de configuración está bajo vigilancia: una modificación surte efecto en unos segundos, sin reiniciar el servicio. Dos familias solo se leen al arrancar y exigen un reinicio: plugin_management, y los campos que definen el escuchador HTTP, es decir tls, http_port y https_port. En Linux, keystore y keystore_password se vuelven a aplicar sin reinicio cuando el servidor recibe SIGUSR2. Consulte Activar HTTPS.

plugin_management

Campo	Tipo	Comentario
plugins	Array	Lista de plugins, por ejemplo la integración con Slack.
plugins[].classpath	String	Ruta del archivo JAR del plugin.
plugins[].path	String	Paquete, por ejemplo com.drovio.server.slack.
plugins[].ext	String	Siempre java.
plugins[].base_address	String	Depende del plugin, por ejemplo drovio.server.slack.

http

Campo	Tipo	Comentario
url	String	Debe sustituirse por el nombre de host o la IP de la máquina, necesario para los correos transaccionales y las invitaciones.
num_instances	Number	Número de escuchadores HTTP. Debe valer 0, en automático, o coincidir con los núcleos disponibles en la máquina.
session_timeout	Number	Duración de vida de una sesión en ms, ya que la sesión expira en ausencia de actividad del usuario.
tls	Boolean	Activa HTTPS. Consulte Activar HTTPS.
tls_protocols	Array	Tabla de cadenas, por ejemplo ["TLSv1.2", "TLSv1.3"]. Sin valor, TLSv1.2 y TLSv1.3 están activados de forma predeterminada.
tls_cipher_suites	Array	Tabla de cadenas, por ejemplo ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", …].
keystore	String	Certificado utilizado cuando TLS está activado, empaquetado en JKS. Se recarga con SIGUSR2 en Linux. Consulte Activar HTTPS.
keystore_password	String	Contraseña del JKS. Se recarga con SIGUSR2 en Linux. Consulte Activar HTTPS.
http_port	Number	Debe fijarse en 80, valor predeterminado 8090.
https_port	Number	Debe fijarse en 443, valor predeterminado 8090. Exige que TLS esté activado.
admin_ip_whitelist	Array (Strings)	Lista de las IP autorizadas a acceder a /admin, con máscara opcional, por ejemplo "192.168.1.10" o "172.42.13.0/24".
url_share_your_screen	String	URL de la página de descarga de la aplicación, que aparece en varios correos.
url_support	String	URL destinada al soporte.
xsrf_enabled	Boolean	Activa la protección contra la falsificación de petición entre sitios, valor predeterminado true.
deny_xframe	Boolean	Impide mostrar el cliente dentro de un marco, valor predeterminado true.
drain_delay	Number	Plazo en segundos en el que el servidor cierra todas las conexiones WebSocket al recibir una señal SIGUSR1, valor predeterminado 180.
drain_period	Number	Periodo en segundos con el que el servidor cierra conexiones WebSocket al recibir una señal SIGUSR1, valor predeterminado 10.
prevent_indexing	Boolean	Impide la indexación de los recursos del servidor por parte de los robots de rastreo, como el de Google.
jwt_expiration_delay	Number	Plazo de expiración en segundos del JWT que sirve para la autenticación en la API de reuniones.
jwt_secret	String	Secreto del JWT que sirve para la autenticación en la API de reuniones.
websocket_allowed_origins	String	Expresión regular que describe los orígenes autorizados a abrir una conexión WebSocket. Vacía de forma predeterminada, lo que no instala ningún gestor CORS.

http → session_store

Campo	Tipo	Comentario
type	String	Tipo de almacén utilizado para las sesiones, default en memoria o redis. Valor predeterminado default.

session_store → on_change

Campo	Tipo	Comentario
transfer_sessions	Boolean	Al cambiar de almacén en ejecución, con true, todas las sesiones existentes se insertan en el nuevo almacén. Valor predeterminado false.
clear_old_store	Boolean	Al cambiar de almacén en ejecución, con true, vacía todas las sesiones del almacén antiguo. Valor predeterminado false.
close_delay	Number	Plazo en ms antes de detener el almacén antiguo una vez implantado el nuevo. Evita interrumpir las consultas en curso hacia el antiguo. Valor predeterminado 5000.

session_store → redis

Campo	Tipo	Comentario
connections	Array (Strings)	Lista de las cadenas de conexión a los servidores Redis. Las direcciones siguen redis://[:password@]host[:port][/db-number], por ejemplo "redis://127.0.0.1:7001". rediss también es posible.
master	String	Nombre del maestro, valor predeterminado master.
max_pool_size	Number	Número máximo de conexiones en el pool, valor predeterminado 6.
max_pool_waiting	Number	Número máximo de solicitantes en cola a la espera de una conexión, valor predeterminado 24.
type	String	Tipo de cliente: standalone, sentinel, cluster o replication. Valor predeterminado standalone.
role	String	Rol en alta disponibilidad: master, replica o sentinel. Sin valor predeterminado.
password	String	Contraseña para los modos cluster y sentinel.
pool_cleaner_interval	Number	Periodo de la tarea que cierra las conexiones en estado no válido. -1 significa que la tarea no se ejecuta nunca. Valor predeterminado -1.
pool_recycle_timeout	Number	Plazo en ms tras el cual se recicla una conexión, valor predeterminado 15000.

redis → tls

Se utiliza únicamente cuando las cadenas de conexión emplean el esquema rediss.

Campo	Tipo	Comentario
verify_hostname	Boolean	Comprueba que el certificado corresponde al host contactado.
trust_all	Boolean	Acepta cualquier certificado. Debe dejarse en false fuera de las pruebas.
ca_certificate_path	String	Ruta del certificado de autoridad que sirve para validar el de Redis.

database

Campo	Tipo	Comentario
host	String	Nombre de host de la base de datos.
port	Number	Puerto de la base de datos.
database	String	Nombre de la base de datos.
user	String	Usuario de la base de datos.
password	String	Se genera automáticamente al desplegar un paquete.
ssl_mode	String	Política TLS de la conexión, en el sentido de PostgreSQL: disable, allow, prefer, require, verify-ca o verify-full. Valor predeterminado prefer.

database → pool_options → main

Campo	Tipo	Comentario
max_size	Number	Número de conexiones simultáneas, que debe ajustarse a la capacidad real de su base de datos, valor predeterminado 30, conjuntamente con el tamaño máximo de licensing.
connect_timeout	Number	Plazo de conexión en segundos, que debe adaptarse a la capacidad de su base de datos, valor predeterminado 30.
idle_timeout	Number	Plazo en segundos tras el cual una conexión inactiva puede cerrarse para liberar recursos, valor predeterminado 600.

database → pool_options → licensing

Campo	Tipo	Comentario
max_size	Number	Número de conexiones simultáneas, que debe ajustarse a la capacidad real de su base de datos, valor predeterminado 30, conjuntamente con el tamaño máximo de main.
connect_timeout	Number	Plazo de conexión en segundos, que debe adaptarse a la capacidad de su base de datos, valor predeterminado 30.
idle_timeout	Number	Plazo en segundos tras el cual una conexión inactiva puede cerrarse, valor predeterminado 600.

database → replicas

Ajustes de conexión a las réplicas de lectura. Los campos port, database, user, password y ssl_mode reproducen los de la sección database principal, y los pool_options → main y pool_options → licensing anidados se comportan exactamente como las opciones de pool anteriores, pero se aplican a la instancia réplica.

maintenance

Campo	Tipo	Comentario
enabled	Boolean	No debe modificarse aquí, utilice el panel de administración para activar el modo de mantenimiento.
message	String	Mensaje de mantenimiento. No debe modificarse aquí, utilice el panel de administración.

webrtc

Campo	Tipo	Comentario
turn_servers_secret	String	Si se utilizan servidores TURN, el token secreto compartido.
turn_servers_auth_timeout	Number	Si se utilizan servidores TURN, duración de validez de las credenciales generadas automáticamente.
ice_servers	Array	Lista de los servidores STUN y TURN utilizados. De forma predeterminada, el servidor STUN de Google y ningún servidor TURN.
ice_servers[].url	String	URL STUN o TURN, por ejemplo stun:192.168.1.23:443 o turn:192.168.1.23?transport=tcp.
service_quality	Object	Rango de tasa de bits utilizado para el audio y el vídeo.
service_quality.minimum	Number	Tasa de bits mínima en kbps.
service_quality.maximum	Number	Tasa de bits máxima en kbps.

Consulte Servidor de retransmisión (TURN) para conocer el procedimiento completo.

smtp

Campo	Tipo	Comentario
enabled	Boolean	Activa las notificaciones por correo electrónico.
hostname	String	Por ejemplo 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	Si la autenticación está activa, por lo general una dirección de correo electrónico.
password	String	Contraseña SMTP.
from	String	Formato: Drovio <drovio@example.com>.
admin_email	String	Dirección de correo electrónico del equipo de soporte.
trust_all	Boolean	Pasa por alto los problemas de TLS.
own_hostname	String	Debe rellenarse con su nombre de dominio, por ejemplo example.com.

email_templating

Campo	Tipo	Comentario
transport	String	Transporte utilizado para entregar los correos con plantilla. Valor predeterminado smtp, que se apoya en la sección smtp anterior.

users

Campo	Tipo	Comentario
add_all_contacts	Boolean	Con true, un nuevo usuario se añade como contacto de todos los usuarios existentes.

users → remove_inactive

Campo	Tipo	Comentario
enabled	Boolean	Activa la eliminación automática de los usuarios tras un periodo de inactividad.
inactive_period	Number	Duración de inactividad en segundos tras la cual el usuario se elimina automáticamente. Valor predeterminado 7776000, es decir 90 días.

users → license_allocation

Campo	Tipo	Comentario
enabled	Boolean	Activa la asignación automática de las licencias, a los usuarios que se conectan o que crean una cuenta.
mode	String	Bien floating, al conectarse un usuario, bien new_user, al crearse una cuenta.
max_users	Number	Asigna automáticamente licencias que permiten invitar hasta max_users personas más en sesión. Debe fijarse en 1, 4 o 999 según las licencias adquiridas.

license_allocation → low_count_notification

Campo	Tipo	Comentario
enabled	Boolean	Envía un correo a la dirección de soporte definida más arriba cuando el pool de licencias se acerca al agotamiento.
threshold	Number	Porcentaje de licencias libres en el pool por debajo del cual se envía un correo.

users → auth → local

Campo	Tipo	Comentario
enabled	Boolean	Activa o desactiva la autenticación clásica, por correo electrónico y contraseña.
allow_signup	Boolean	Autoriza a los usuarios a crear ellos mismos su cuenta desde la aplicación.

users → auth → ldap

Campo	Tipo	Comentario
enabled	Boolean	Activa LDAP y Active Directory.
url	String	Nombre de host del servidor LDAP o AD: ldap://ldap.example.com o ldaps://ldap.example.com, con puerto opcional, por ejemplo ldap://ldap.example.com:389.
service_account_dn	String	Cuenta capaz de buscar otras cuentas, por ejemplo cn=admin,dc=example,dc=com o Administrator@domain.com.
service_account_password	String	Contraseña de la cuenta de servicio.
base	String	Unidad organizativa donde se encuentran las cuentas de usuario, por ejemplo ou=users,dc=example,dc=com.
search_filter	String	El campo que contiene la dirección de correo electrónico. En LDAP, mail; en Active Directory, mail o userPrincipalName. Valor predeterminado (&(objectClass=*)(mail={0})).
ca_certificate_path	String	Ruta del certificado de autoridad que sirve para validar el del servidor en una conexión mediante ldaps.

users → auth → saml

Campo	Tipo	Comentario
enabled	Boolean	Activa SAML. No puede estarlo si OpenID Connect lo está.
keystore	String	Ruta del JKS, generado automáticamente si el archivo no existe.
keystore_password	String	Contraseña del almacén JKS.
private_key_password	String	Contraseña de la clave privada del JKS.
idp_metadata_path	String	Ruta del archivo XML de metadatos del proveedor de identidad.
sp_metadata_path	String	Dónde se exportan los metadatos del proveedor de servicio en cada arranque. El servidor nunca vuelve a leer este archivo: los metadatos se guardan en memoria y se sirven en /sso/metadata. Déjelo vacío para no exportar. Consulte SSO.
sp_entity_id	String	Entity ID del proveedor de servicio, por lo general la URL del servidor. Sin valor, se utiliza la URL de callback completa.
passive	Boolean	Cuando el proveedor de identidad no espera ninguna entrada del usuario.
force_auth	Boolean	Fuerza la autenticación ante el proveedor de identidad en cada conexión desde la aplicación.
use_name_qualifier	Boolean	Según la especificación SAML, la petición no debe contener un NameQualifier si la entidad SP está en nameid-format:entity, pero algunos proveedores de identidad lo exigen.
wants_assertions_signed	Boolean	Firma las aserciones cuando deben tratarse con independencia de la respuesta.
authn_request_signed	Boolean	Firma las peticiones de autenticación.
email_attribute	String	Nombre del atributo del proveedor de identidad al que asociar las direcciones de correo electrónico.
username_attribute	String	Nombre del atributo del proveedor de identidad al que asociar los nombres de usuario.
accepted_skew	Number	Tolerancia temporal SAML, en el sentido de SAML 1.1.
max_auth_lifetime	Number	En segundos, debe alinearse con la de su proveedor de identidad, por ejemplo 8 horas para ADFS y 14 días para Google.

Consulte SSO: SAML y OIDC para el almacén de claves y las URL de callback.

users → auth → oidc

Campo	Tipo	Comentario
enabled	Boolean	Activa OpenID Connect. No puede estarlo si SAML lo está.
client_id	String	Client ID de OIDC.
secret	String	Secreto de OIDC.
discovery_uri	String	URI de descubrimiento de OIDC.
email_attribute	String	Nombre del atributo del proveedor de identidad al que asociar las direcciones de correo electrónico.
username_attribute	String	Nombre del atributo del proveedor de identidad al que asociar los nombres de usuario.
custom_params	Array	Parámetros personalizados.
custom_params[].key	String	Por ejemplo prompt.
custom_params[].value	String	Por ejemplo consent.

users → remove_unvalidated

Campo	Tipo	Comentario
enabled	Boolean	Elimina automáticamente las cuentas no validadas.
time	String	Hora de lanzamiento de la tarea, por ejemplo 05:00.
offset	String	Desfase respecto a UTC, por ejemplo +01:00.
remove_delay	Number	Plazo en días tras el cual se eliminan las cuentas locales no validadas. Desactivado si es negativo, valor predeterminado -1.
limit	Number	Número máximo de cuentas eliminadas en cada ejecución, valor predeterminado 30.

users → auth

Campo	Tipo	Comentario
sso_auth_token_lifetime	Number	Duración de vida de todo token de autenticación SSO generado, valor predeterminado 10 minutos.

users → email_code

Códigos de un solo uso enviados por correo electrónico, que sirven para confirmar una dirección o para recuperar una cuenta.

Campo	Tipo	Comentario
enabled	Boolean	Activa los códigos por correo electrónico, valor predeterminado true.
ttl	Number	Duración de vida de un código en segundos, valor predeterminado 900, es decir 15 minutos.
max_per_day	Number	Número máximo de códigos enviados a una misma dirección por día, todos los usos incluidos. 0 o menos desactiva la cuota, valor predeterminado 10.
alert_threshold_per_hour	Number	Número de códigos enviados por hora por encima del cual se alerta al administrador. 0 o menos desactiva la alerta, valor predeterminado 500.

logging

Campo	Tipo	Comentario
severity	String	Nivel de detalle de los registros: off, error, warning, info, debug o trace. Valor predeterminado info.
loggers.<key>	String	<key> designa una clase o un paquete. Sustituye el nivel de detalle para esa clase o ese paquete, con los mismos valores que severity.

reporting

Campo	Tipo	Comentario
enabled	Boolean	Activa la generación automática de informes de uso.
frequency	String	Frecuencia de los informes de uso: daily, weekly o monthly.
hour	Number	Hora de generación del informe, utilizada sea cual sea la frecuencia.
day_of_week	Number	Día de la semana para los informes weekly: 1 para domingo, 2 para lunes, y así sucesivamente.
day_of_month	Number	Día del mes para los informes monthly, del 1 al 31. El valor 31 desencadena un informe el último día de cada mes.
options	Array (Strings)	Tipos de eventos que incluir: user_login, session_lifetime o swap_request.
anonymous	Boolean	Enmascara cualquier dato personal identificable.
recipients	Array (Strings)	Lista de las direcciones de correo electrónico destinatarias de los informes.
archive_name_pattern	String	Plantilla de nombre de archivo del archivo comprimido de datos del informe. My_archive produce por ejemplo My_archive [2019-08-01 14.00.00 to 2019-08-02 14.00.00].

remote_desktop

Campo	Tipo	Comentario
enabled	Boolean	Activa la funcionalidad de escritorio remoto.

app_update

Campo	Tipo	Comentario
base_url	String	No modifique el valor predeterminado. Campo reservado al Cloud.

anonymize

Campo	Tipo	Comentario
enabled	Boolean	Activa la tarea diaria de anonimización de los datos.
when	String	Momento de ejecución de la tarea: now, tras el arranque del servidor, o una hora en formato de 24 h HH:mm, por ejemplo 17:30.
offset	String	Desfase horario utilizado para planificar la tarea, por ejemplo +02:00. De forma predeterminada, el del servidor.
limit	Number	Número máximo de usuarios anonimizados en una ejecución, valor predeterminado 30.

monitoring

Campo	Tipo	Comentario
enabled	Boolean	Monta las rutas de supervisión bajo /api/monitoring, valor predeterminado false.

meeting

Campo	Tipo	Comentario
url	String	URL que abrir para gestionar las reuniones.
enabled	Boolean	Activa el botón de reunión.

calls

Campo	Tipo	Comentario
expiration_delay	Number	Plazo en segundos tras el cual se considera que un participante desconectado ha abandonado la llamada, valor predeterminado 60.

calls → clean_task

Campo	Tipo	Comentario
enabled	Boolean	Activa la tarea que elimina los datos de llamada antiguos, valor predeterminado true.
frequency	Number	Frecuencia en segundos de la tarea que elimina los datos de llamada antiguos, valor predeterminado un día.