Pular para o conteúdo principal
Versão: 0.4 · atual

Variáveis de ambiente

ReferênciaRevisado em 11 de outubro de 2026
Aplica-se a:Excubius 0.4Funções: Instalador (administrador do Linux)
PlanosFree · Core · Pro · EnterpriseImplantaçãoAuto-hospedado

O Excubius lê as configurações da instalação do arquivo .env no diretório de instalação, /opt/excubius/.env por padrão, com modo 0600 e pertencente à conta de serviço. O instalador grava esse arquivo a partir das suas respostas e gera os segredos uma única vez. Esta referência lista as chaves que você pode definir, agrupadas como no arquivo.

A maioria das configurações fica no console, não aqui: a identidade visual e as opções de recurso em Settings › Instance, os nomes e certificados em Settings › Server, as fontes em Settings › Sources e as credenciais de monitoramento em Settings › Credentials. Depois de alterar o arquivo, reinicie a plataforma como a conta de serviço com systemctl --user restart excubius.

aviso

Faça backup do arquivo .env e, com ele, da EXCUBIUS_DATA_KEY. Sem essa chave, os segredos armazenados no banco de dados não podem ser descriptografados.

Instalação​

ChavePadrãoSignificado
EXCUBIUS_HOME/opt/excubiusDiretório de instalação. Gravado pelo instalador
SERVER_NAME—O nome principal: o host da URL pública
REGISTRYghcr.io/custorius-labs/excubiusPrefixo do registro e do repositório das imagens
PROXY_MODEhttphttp ou https. Vale somente até o serviço de certificados assumir; depois disso, quem decide é Settings › Server
COOKIE_SECUREvazioVazio: os cookies de sessão são Secure sempre que a solicitação chega por HTTPS. true ou false forçam o valor. Deixe vazio

Nomes e TLS​

Estas chaves inicializam as configurações de TLS somente na primeira inicialização, quando a plataforma ainda não tem nenhuma. A partir daí, os nomes e os certificados são gerenciados em Settings › Server, sem reinicialização. O instalador remove do arquivo as credenciais de DNS e a chave privada assim que a plataforma as armazena.

ChavePadrãoSignificado
TLS_MODEvazioletsencrypt_http, letsencrypt_dns, selfsigned, custom, gateway ou http. Os nomes do instalador letsencrypt, letsencrypt-dns e later também são aceitos
TLS_ALIASESvazioOutros nomes que os usuários podem abrir, separados por espaços
TLS_CERT_NAMESvazioNomes a incluir no certificado, separados por espaços. Vazio: todos os nomes
TLS_EMAILvazioE-mail da conta do Let's Encrypt
TLS_ACME_SERVERproductionstaging para ensaiar com certificados de teste em que os navegadores não confiam
TLS_DNS_PROVIDERvazioO ID dnsapi do acme.sh do provedor de DNS, como dns_cf ou dns_azure
TLS_DNS_CREDENTIALSvazioPares KEY=VALUE separados por quebras de linha ou por ;, ou base64:<…>
TLS_CERT_FILE, TLS_KEY_FILEvaziobase64:<PEM contents> da sua própria cadeia de certificados e da chave privada
TLS_ACME_DNSSLEEP0Segundos de espera pela propagação do DNS, em vez de verificá-la por meio de resolvedores públicos de DNS sobre HTTPS. Use em redes que não conseguem alcançá-los

Produto​

ChavePadrãoSignificado
PRODUCT_NAMEExcubiusSomente valor de reserva. O nome do produto vem da identidade visual em Settings › Instance
DEFAULT_LOCALEenIdioma padrão
BASE_URL—A URL pública, como https://monitoring.example.com. Os links nas mensagens a usam
EXCUBIUS_DEFAULT_PRESETenterpriseA predefinição com que a instância começa: enterprise, databases ou core
EXCUBIUS_FEATURES_ENFORCE_APIfalsetrue: os recursos desativados também são recusados pela API. Padrão: eles ficam ocultos somente na interface

Banco de dados e segredos​

ChavePadrãoSignificado
POSTGRES_USERexcubiusUsuário do banco de dados
POSTGRES_PASSWORDgeradoSomente letras e dígitos, porque é incorporada a uma URL de conexão
POSTGRES_DBexcubiusNome do banco de dados
DATABASE_URLmontada a partir das três acimaURL de conexão. Os contêineres a recebem montada a partir das três chaves acima
EXCUBIUS_DATA_KEYgeradoChave que criptografa os segredos armazenados no banco de dados: credenciais, segredos das fontes, chaves de API de DNS. 32 bytes aleatórios, em base64 seguro para URL. Nunca a altere em uma instalação em execução
EXCUBIUS_COLLECTOR_TOKENgeradoSegredo compartilhado entre o coletor e a API. Vazio: o coletor fica ocioso e os endpoints do coletor são desabilitados

Entrada​

ChavePadrãoSignificado
JWT_SECRETgeradoAssina os tokens de sessão. 64 caracteres aleatórios
ACCESS_TOKEN_MINUTES15Tempo de vida de um token de acesso
REFRESH_TOKEN_DAYS14Tempo de vida de uma sessão
ENTRA_TENANT_ID, ENTRA_CLIENT_ID, ENTRA_CLIENT_SECRETvazioEntrada com o Microsoft Entra ID, locatário único: o ID do diretório, não common nem organizations. Oferecida quando as três estão definidas. URI de redirecionamento: <BASE_URL>/api/v1/auth/entra/callback
GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRETvazioEntrada com o Google. URI de redirecionamento: <BASE_URL>/api/v1/auth/google/callback
ALLOWED_SIGNUP_DOMAINSvazioDomínios de e-mail, separados por vírgulas, cujas pessoas recebem uma conta com a função Visualizador na raiz na primeira entrada. Vale somente até que um modo de registro seja salvo na entidade raiz. Vazio: somente por convite

Os segredos de cliente nunca são armazenados no banco de dados nem registrados em log.

Núcleo de monitoramento​

ChavePadrãoSignificado
EXCUBIUS_UNREACHABLE_AFTER3Falhas consecutivas de conexão, de entrada ou de tempo limite antes de um recurso receber o alerta Cannot reach
EXCUBIUS_NOTIFY_QUIET_MINUTES10Mínimo de minutos entre duas mensagens para a mesma condição. Um aumento de severidade é sempre enviado
EXCUBIUS_COLLECTOR_VIA_PROXYfalsetrue somente para um coletor fora do servidor que alcança a API pelo endereço público

Coletor​

O contêiner do coletor recebe somente estas chaves, nunca o arquivo inteiro.

ChavePadrãoSignificado
EXCUBIUS_COLLECTOR_TOKENgeradoConsulte Banco de dados e segredos
EXCUBIUS_COLLECTOR_TRANSPORTStodos os transportes presentesSubconjunto a oferecer, separado por vírgulas, como tsql,http,dns. Valores: tsql, http, dns, winrm, ssh, azure_graph, defender, entra, wazuh
EXCUBIUS_COLLECTOR_CONCURRENCY32Verificações executadas ao mesmo tempo
EXCUBIUS_TSQL_THREADS16Threads para conexões com o SQL Server
EXCUBIUS_SQL_APP_NAMEmonitoring-collectorNome do aplicativo das sessões do coletor no SQL Server
EXCUBIUS_ODBC_DRIVERODBC Driver 18 for SQL ServerNome do driver ODBC
AZURE_SUBSCRIPTION_IDSvazioAssinaturas, separadas por vírgulas, para as verificações nativas do Resource Graph (segurança de nuvem, Azure Update Manager) quando a credencial não define nenhuma. Vazio: todas as assinaturas que a identidade consegue ler. A fonte Azure Monitor tem sua própria lista
AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRETvazioVazio: a identidade gerenciada do servidor. AZURE_CLIENT_ID sozinha indica uma identidade gerenciada atribuída pelo usuário. As três: essa entidade de serviço é usada no lugar

O coletor também tem configurações para seus intervalos de sondagem, tamanhos de lote e de buffer e nome de host, mas a plataforma instalada não as passa para o contêiner, então os valores padrão se aplicam: atribuições a cada 30 segundos, trabalhos a cada 10 segundos, uma pulsação a cada 60 segundos, 200 resultados por lote e 10.000 resultados mantidos enquanto a API está inacessível.

Notificações e tickets​

ChavePadrãoSignificado
SLACK_BOT_TOKENvazioToken de bot do aplicativo do Slack, com o escopo chat:write. Vazio: nada é enviado ao Slack
SLACK_DEFAULT_CHANNEL#alertsRecebe os avisos e os críticos quando nenhuma entidade no caminho tem um canal
JIRA_BASE_URLvaziohttps://<site>.atlassian.net
JIRA_AUTHtokentoken (e-mail e token de API), oauth (credenciais de cliente de uma conta de serviço da Atlassian) ou bearer
JIRA_EMAIL, JIRA_API_TOKENvazioCredenciais para token
JIRA_OAUTH_CLIENT_ID, JIRA_OAUTH_CLIENT_SECRETvazioCredenciais para oauth
JIRA_CLOUD_IDvazioSomente oauth: o ID de nuvem do site
JIRA_OAUTH_TOKEN_URLhttps://auth.atlassian.com/oauth/tokenURL do token para oauth
JIRA_DEFAULT_PROJECTvazioChave do projeto para novos itens
JIRA_ISSUE_TYPETaskNome do tipo de item nesse projeto
JIRA_SYNC_MINUTES10Com que frequência o status dos itens abertos é lido
WEB_PUSH_VAPID_PUBLIC, WEB_PUSH_VAPID_PRIVATEvazioReservadas para notificações por push na web, não disponíveis nesta versão. Deixe-as vazias

As chaves do Jira são valores padrão: cada entidade pode substituí-las nas suas próprias configurações do Jira. Consulte Criar itens do Jira a partir de alertas.

Worker de atualizações e segurança​

ChavePadrãoSignificado
EXCUBIUS_SECURITY_WORKERtrueO worker em segundo plano da API: feeds dos fornecedores, vencimento da aceitação de riscos, verificações executadas pela API, instantâneos da pontuação de segurança, status do Jira. Defina false somente em réplicas extras da API
EXCUBIUS_FEEDS_ENABLEDtruefalse: nunca buscar os feeds dos fornecedores, para instalações isoladas da rede (air-gapped). As cópias incluídas na versão são usadas
EXCUBIUS_FEED_TIMEOUT_SECONDS60Tempo limite por solicitação de feed
EXCUBIUS_FEED_SQLSERVER_BUILDS_URLSo site do dbatools e, depois, o GitHubURLs da lista de builds do SQL Server, separadas por espaços, tentadas em ordem. Coloque um espelho interno em primeiro lugar
EXCUBIUS_FEED_ENDOFLIFE_URLhttps://endoflife.date/apiURL base do feed de fim do suporte
EXCUBIUS_FEED_MSRC_URLhttps://api.msrc.microsoft.com/cvrf/v3.0URL base dos avisos de segurança da Microsoft
EXCUBIUS_FEED_MSRC_MONTHS3Lançamentos mensais mantidos atualizados, de 1 a 24
HTTPS_PROXYvazioProxy para as solicitações de feed

Chaves que esta versão não lê​

O .env.example incluído ainda lista NEWRELIC_API_KEY, NEWRELIC_ACCOUNT_ID, NEWRELIC_WEBHOOK_SECRET, NINJAONE_CLIENT_ID, NINJAONE_CLIENT_SECRET, NINJAONE_REGION, WAZUH_API_URL, WAZUH_API_USER e WAZUH_API_PASSWORD. Esta versão as ignora. Configure o New Relic e o NinjaOne em Settings › Sources, e o Wazuh com uma credencial e os parâmetros da verificação; consulte Fontes e Segurança de nuvem.