Referência de configuração

Esta página descreve cada campo do ficheiro de configuração do Drovio Server, settings.conf, em formato JSON. Ver Configurar o Drovio Server para a sua localização conforme a sua plataforma e para a forma de aplicar as modificações.

As alterações aplicam-se a quente, com duas exceções

O ficheiro de configuração é vigiado: uma modificação produz efeito em poucos segundos, sem reiniciar o serviço. Duas famílias só são lidas no arranque e exigem um reinício: plugin_management, e os campos que definem o escutador HTTP, a saber tls, http_port e https_port. Em Linux, keystore e keystore_password são reaplicados sem reinício quando o servidor recebe SIGUSR2. Ver Ativar HTTPS.

plugin_management

Campo	Tipo	Comentário
plugins	Array	Lista dos plugins, por exemplo a integração Slack.
plugins[].classpath	String	Caminho do ficheiro JAR do plugin.
plugins[].path	String	Pacote, por exemplo com.drovio.server.slack.
plugins[].ext	String	Sempre java.
plugins[].base_address	String	Depende do plugin, por exemplo drovio.server.slack.

http

Campo	Tipo	Comentário
url	String	A substituir pelo nome de anfitrião ou pelo IP da máquina, necessário aos e-mails transacionais e aos convites.
num_instances	Number	Número de escutadores HTTP. Deve valer 0, em automático, ou corresponder aos núcleos disponíveis na máquina.
session_timeout	Number	Tempo de vida de uma sessão em ms, expirando a sessão na ausência de atividade do utilizador.
tls	Boolean	Ativa o HTTPS. Ver Ativar HTTPS.
tls_protocols	Array	Tabela de cadeias, por exemplo ["TLSv1.2", "TLSv1.3"]. Sem valor, TLSv1.2 e TLSv1.3 estão ativados por predefinição.
tls_cipher_suites	Array	Tabela de cadeias, por exemplo ["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", …].
keystore	String	Certificado utilizado quando o TLS está ativado, empacotado em JKS. Recarregado com SIGUSR2 em Linux. Ver Ativar HTTPS.
keystore_password	String	Palavra-passe do JKS. Recarregada com SIGUSR2 em Linux. Ver Ativar HTTPS.
http_port	Number	A fixar em 80, valor predefinido 8090.
https_port	Number	A fixar em 443, valor predefinido 8090. Exige que o TLS esteja ativado.
admin_ip_whitelist	Array (Strings)	Lista dos IP autorizados a aceder a /admin, com máscara facultativa, por exemplo "192.168.1.10" ou "172.42.13.0/24".
url_share_your_screen	String	URL da página de descarregamento da aplicação, apresentado em vários e-mails.
url_support	String	URL destinado ao suporte.
xsrf_enabled	Boolean	Ativa a proteção contra a falsificação de pedido entre sítios, valor predefinido true.
deny_xframe	Boolean	Proíbe a apresentação do cliente num quadro, valor predefinido true.
drain_delay	Number	Prazo em segundos no qual o servidor fecha todas as ligações WebSocket ao receber um sinal SIGUSR1, valor predefinido 180.
drain_period	Number	Período em segundos ao qual o servidor fecha ligações WebSocket ao receber um sinal SIGUSR1, valor predefinido 10.
prevent_indexing	Boolean	Impede a indexação dos recursos do servidor pelos robôs de exploração, como o da Google.
jwt_expiration_delay	Number	Prazo de expiração em segundos do JWT que serve à autenticação na API de reunião.
jwt_secret	String	Segredo do JWT que serve à autenticação na API de reunião.
websocket_allowed_origins	String	Expressão regular que descreve as origens autorizadas a abrir uma ligação WebSocket. Vazio por predefinição, o que não instala qualquer gestor CORS.

http → session_store

Campo	Tipo	Comentário
type	String	Tipo de arquivo utilizado para as sessões, default em memória ou redis. Valor predefinido default.

session_store → on_change

Campo	Tipo	Comentário
transfer_sessions	Boolean	Ao mudar de arquivo com o serviço a correr, se true, todas as sessões existentes são inseridas no novo arquivo de sessões. Valor predefinido false.
clear_old_store	Boolean	Ao mudar de arquivo com o serviço a correr, se true, apaga todas as sessões do antigo arquivo. Valor predefinido false.
close_delay	Number	Prazo em ms antes de parar o antigo arquivo de sessões depois de o novo estar instalado. Evita interromper as consultas pendentes ao antigo arquivo. Valor predefinido 5000.

session_store → redis

Campo	Tipo	Comentário
connections	Array (Strings)	Lista das cadeias de ligação aos servidores redis. Os endereços seguem redis://[:password@]host[:port][/db-number], por exemplo "redis://127.0.0.1:7001". rediss também é possível.
master	String	Nome do mestre, valor predefinido master.
max_pool_size	Number	Número máximo de ligações no pool, valor predefinido 6.
max_pool_waiting	Number	Número máximo de gestores em espera de uma ligação numa fila, valor predefinido 24.
type	String	Tipo de cliente: standalone, sentinel, cluster ou replication. Valor predefinido standalone.
role	String	Papel em modo de alta disponibilidade: master, replica ou sentinel. Sem valor por predefinição.
password	String	Palavra-passe para o modo cluster ou sentinel.
pool_cleaner_interval	Number	Período da tarefa que fecha as ligações num estado inválido. -1 significa que a tarefa nunca é executada. Valor predefinido -1.
pool_recycle_timeout	Number	Tempo limite em ms ao fim do qual uma ligação é reciclada, valor predefinido 15000.

redis → tls

Utilizado unicamente quando as cadeias de ligação empregam o esquema rediss.

Campo	Tipo	Comentário
verify_hostname	Boolean	Verifica que o certificado corresponde ao anfitrião ao qual se liga.
trust_all	Boolean	Aceita qualquer certificado. Deixe em false fora dos testes.
ca_certificate_path	String	Caminho do certificado de autoridade que serve para validar o certificado do Redis.

database

Campo	Tipo	Comentário
host	String	Nome de anfitrião da base de dados.
port	Number	Porta da base de dados.
database	String	Nome da base de dados.
user	String	Utilizador da base de dados.
password	String	Gerada automaticamente ao implantar um pacote.
ssl_mode	String	Política TLS da ligação, segundo a semântica do PostgreSQL: disable, allow, prefer, require, verify-ca ou verify-full. Valor predefinido prefer.

database → pool_options → main

Campo	Tipo	Comentário
max_size	Number	Número de ligações simultâneas, a ajustar à capacidade real da sua base, valor predefinido 30, em conjunto com o tamanho máximo de licensing.
connect_timeout	Number	Tempo limite de ligação em segundos, a adaptar à capacidade da sua base, valor predefinido 30.
idle_timeout	Number	Tempo limite em segundos ao fim do qual uma ligação inativa pode ser fechada para libertar recursos do servidor, valor predefinido 600.

database → pool_options → licensing

Campo	Tipo	Comentário
max_size	Number	Número de ligações simultâneas, a ajustar à capacidade real da sua base, valor predefinido 30, em conjunto com o tamanho máximo de main.
connect_timeout	Number	Tempo limite de ligação em segundos, a adaptar à capacidade da sua base, valor predefinido 30.
idle_timeout	Number	Tempo limite em segundos ao fim do qual uma ligação inativa pode ser fechada, valor predefinido 600.

database → replicas

Definições de ligação às réplicas de leitura. Os campos port, database, user, password e ssl_mode retomam os da secção database principal, e os pool_options → main e pool_options → licensing aninhados comportam-se exatamente como as opções de pool acima, mas aplicam-se à instância réplica.

maintenance

Campo	Tipo	Comentário
enabled	Boolean	Não deve ser alterado aqui; utilize o painel de administração para ativar o modo de manutenção.
message	String	Mensagem de manutenção. Não deve ser alterada aqui; utilize o painel de administração.

webrtc

Campo	Tipo	Comentário
turn_servers_secret	String	Se forem utilizados servidores TURN, o token de segredo partilhado.
turn_servers_auth_timeout	Number	Se forem utilizados servidores TURN, o tempo limite das credenciais geradas automaticamente.
ice_servers	Array	Lista dos servidores STUN e TURN utilizados. Por predefinição, o servidor STUN da Google e nenhum servidor TURN.
ice_servers[].url	String	URL STUN ou TURN, por exemplo stun:192.168.1.23:443 ou turn:192.168.1.23?transport=tcp.
service_quality	Object	Intervalo de débito utilizado para o áudio e o vídeo.
service_quality.minimum	Number	Débito mínimo em kbps.
service_quality.maximum	Number	Débito máximo em kbps.

Ver Servidor de retransmissão (TURN) para o procedimento completo.

smtp

Campo	Tipo	Comentário
enabled	Boolean	Ativa as notificações por e-mail.
hostname	String	Por exemplo smtp.example.com.
port	Number	25, 465, 587…
start_tls	String	disabled, optional ou required.
ssl	Boolean	true ou false.
login	String	none, disabled ou required.
username	String	Se a autenticação estiver ativada, tipicamente um endereço de e-mail.
password	String	Palavra-passe SMTP.
from	String	Formato: Drovio <drovio@example.com>.
admin_email	String	Endereço de e-mail da equipa de suporte.
trust_all	Boolean	Ignora qualquer problema de TLS.
own_hostname	String	A preencher com o seu nome de domínio, por exemplo example.com.

email_templating

Campo	Tipo	Comentário
transport	String	Transporte utilizado para entregar os e-mails com modelo. Valor predefinido smtp, que utiliza a secção smtp acima.

users

Campo	Tipo	Comentário
add_all_contacts	Boolean	Se true, ao criar um utilizador, adiciona-o como contacto a todos os utilizadores existentes.

users → remove_inactive

Campo	Tipo	Comentário
enabled	Boolean	Ativa a remoção automática dos utilizadores após um período de inatividade.
inactive_period	Number	Período de inatividade em segundos ao fim do qual o utilizador é automaticamente removido, valor predefinido 7776000, ou seja 90 dias.

users → license_allocation

Campo	Tipo	Comentário
enabled	Boolean	Ativa a atribuição automática de licenças, que as atribui aos utilizadores quando iniciam sessão ou criam uma conta.
mode	String	Ou floating, quando um utilizador inicia sessão, ou new_user, quando um utilizador cria uma conta.
max_users	Number	Atribui automaticamente licenças que permitem aos utilizadores convidar até max_users outros utilizadores para a sua sessão. A fixar em 1, 4 ou 999, conforme as licenças adquiridas.

license_allocation → low_count_notification

Campo	Tipo	Comentário
enabled	Boolean	Envia um e-mail para o endereço de suporte definido acima quando o pool de licenças se aproxima do esgotamento.
threshold	Number	Percentagem de licenças livres no pool abaixo da qual é enviado um e-mail.

users → auth → local

Campo	Tipo	Comentário
enabled	Boolean	Ativa ou desativa a autenticação clássica, por e-mail e palavra-passe.
allow_signup	Boolean	Autoriza os utilizadores a criar eles próprios a sua conta a partir da aplicação.

users → auth → ldap

Campo	Tipo	Comentário
enabled	Boolean	Ativa o LDAP e o Active Directory.
url	String	Nome de anfitrião do servidor LDAP ou AD: ldap://ldap.example.com ou ldaps://ldap.example.com, com porta facultativa, por exemplo ldap://ldap.example.com:389.
service_account_dn	String	Conta capaz de pesquisar outras contas, por exemplo cn=admin,dc=example,dc=com ou Administrator@domain.com.
service_account_password	String	Palavra-passe da conta de serviço.
base	String	Unidade organizacional onde se encontram as contas de utilizador, por exemplo ou=users,dc=example,dc=com.
search_filter	String	O campo que transporta o endereço de e-mail. Em LDAP, mail; em Active Directory, mail ou userPrincipalName. Valor predefinido (&(objectClass=*)(mail={0})).
ca_certificate_path	String	Caminho do certificado de autoridade que serve para validar o do servidor numa ligação em ldaps.

users → auth → saml

Campo	Tipo	Comentário
enabled	Boolean	Ativa o SAML. Não o pode estar se o OpenID Connect o estiver.
keystore	String	Caminho do JKS, gerado automaticamente se o ficheiro não existir.
keystore_password	String	Palavra-passe do arquivo JKS.
private_key_password	String	Palavra-passe da chave privada do JKS.
idp_metadata_path	String	Caminho do ficheiro XML de metadados do fornecedor de identidade.
sp_metadata_path	String	Onde os metadados do fornecedor de serviço são exportados a cada arranque. O servidor nunca volta a ler este ficheiro: os metadados são guardados em memória e servidos em /sso/metadata. Deixe vazio para não exportar. Ver SSO.
sp_entity_id	String	Entity ID do fornecedor de serviço, em geral o URL do servidor. Sem valor, é utilizado o URL de callback completo.
passive	Boolean	Quando o fornecedor de identidade não espera qualquer introdução do utilizador.
force_auth	Boolean	Força a autenticação junto do fornecedor de identidade a cada início de sessão a partir da aplicação.
use_name_qualifier	Boolean	Segundo a especificação SAML, o pedido não deve conter um NameQualifier se a entidade SP estiver em nameid-format:entity, mas alguns fornecedores de identidade exigem-no.
wants_assertions_signed	Boolean	Assina as asserções quando devem ser tratadas independentemente da resposta.
authn_request_signed	Boolean	Assina os pedidos de autenticação.
email_attribute	String	Nome do atributo do fornecedor de identidade ao qual associar os endereços de e-mail.
username_attribute	String	Nome do atributo do fornecedor de identidade ao qual associar os nomes de utilizador.
accepted_skew	Number	Tolerância temporal SAML, na aceção de SAML 1.1.
max_auth_lifetime	Number	Em segundos, a alinhar pela do seu fornecedor de identidade, por exemplo 8 horas para o ADFS e 14 dias para a Google.

Ver SSO: SAML e OIDC para o arquivo de chaves e os URL de callback.

users → auth → oidc

Campo	Tipo	Comentário
enabled	Boolean	Ativa o OpenID Connect. Não o pode estar se o SAML o estiver.
client_id	String	Client ID OIDC.
secret	String	Segredo OIDC.
discovery_uri	String	URI de descoberta OIDC.
email_attribute	String	Nome do atributo do fornecedor de identidade ao qual associar os endereços de e-mail.
username_attribute	String	Nome do atributo do fornecedor de identidade ao qual associar os nomes de utilizador.
custom_params	Array	Parâmetros personalizados.
custom_params[].key	String	Por exemplo prompt.
custom_params[].value	String	Por exemplo consent.

users → remove_unvalidated

Campo	Tipo	Comentário
enabled	Boolean	Se as contas não validadas devem ser removidas automaticamente.
time	String	Hora a que lançar esta tarefa, por exemplo 05:00.
offset	String	Desvio em relação ao UTC, por exemplo +01:00.
remove_delay	Number	Prazo em dias ao fim do qual as contas locais não validadas são removidas. Desativado quando negativo, valor predefinido -1.
limit	Number	Número máximo de contas a eliminar em cada execução, valor predefinido 30.

users → auth

Campo	Tipo	Comentário
sso_auth_token_lifetime	Number	Tempo de vida de qualquer token de autenticação SSO gerado, valor predefinido 10 minutos.

users → email_code

Códigos de utilização única enviados por e-mail, que servem para confirmar um endereço ou para recuperar uma conta.

Campo	Tipo	Comentário
enabled	Boolean	Ativa os códigos por e-mail, valor predefinido true.
ttl	Number	Tempo de vida de um código em segundos, valor predefinido 900, ou seja 15 minutos.
max_per_day	Number	Número máximo de códigos enviados para um endereço de e-mail por dia, todas as finalidades juntas. 0 ou menos desativa a quota. Valor predefinido 10.
alert_threshold_per_hour	Number	Número de códigos enviados por hora acima do qual o administrador é alertado. 0 ou menos desativa o alerta. Valor predefinido 500.

logging

Campo	Tipo	Comentário
severity	String	Verbosidade dos registos: off, error, warning, info, debug ou trace. Valor predefinido info.
loggers.<key>	String	<key> pode ser qualquer classe ou pacote. Substitui a verbosidade dos registos para a classe ou o pacote indicado, com os mesmos valores que severity.

reporting

Campo	Tipo	Comentário
enabled	Boolean	Ativa a geração automática de relatórios de utilização.
frequency	String	Frequência dos relatórios de utilização: daily, weekly ou monthly.
hour	Number	Hora de geração do relatório de utilização, utilizada com todas as frequências.
day_of_week	Number	Dia da semana para os relatórios weekly; 1 = domingo, 2 = segunda-feira, e assim por diante.
day_of_month	Number	Dia do mês para os relatórios monthly, de 1 a 31; o valor 31 desencadeia um relatório no último dia de cada mês.
options	Array (Strings)	Tipos de eventos a incluir: user_login, session_lifetime ou swap_request.
anonymous	Boolean	Oculta qualquer dado identificativo.
recipients	Array (Strings)	Lista dos endereços de e-mail para onde os relatórios são enviados.
archive_name_pattern	String	Padrão de nome de ficheiro do arquivo de dados do relatório; por exemplo My_archive gera My_archive [2019-08-01 14.00.00 to 2019-08-02 14.00.00].

remote_desktop

Campo	Tipo	Comentário
enabled	Boolean	Ativa a funcionalidade de ambiente de trabalho remoto.

app_update

Campo	Tipo	Comentário
base_url	String	Não altere o valor predefinido. Campo dedicado ao Cloud.

anonymize

Campo	Tipo	Comentário
enabled	Boolean	Ativa a tarefa diária de anonimização dos dados.
when	String	Quando a tarefa corre: now, após o arranque do servidor, ou uma hora no formato HH:mm de 24 horas, por exemplo 17:30.
offset	String	Desvio horário utilizado para agendar a tarefa, por exemplo +02:00. Por predefinição, o desvio do servidor.
limit	Number	Número máximo de utilizadores a anonimizar durante uma execução, valor predefinido 30.

monitoring

Campo	Tipo	Comentário
enabled	Boolean	Monta as rotas de monitorização em /api/monitoring, valor predefinido false.

meeting

Campo	Tipo	Comentário
url	String	URL a abrir para gerir as reuniões.
enabled	Boolean	Ativa o botão de reunião.

calls

Campo	Tipo	Comentário
expiration_delay	Number	Prazo em segundos ao fim do qual um participante desligado de uma chamada é considerado como tendo saído, valor predefinido 60.

calls → clean_task

Campo	Tipo	Comentário
enabled	Boolean	Ativa a tarefa que remove os dados antigos das chamadas, valor predefinido true.
frequency	Number	Frequência em segundos da tarefa que remove os dados antigos das chamadas, valor predefinido 1 dia.