Variables de entorno
Excubius lee la configuración de su instalación del archivo .env del directorio de instalación, /opt/excubius/.env de manera predeterminada, con modo 0600 y propiedad de la cuenta de servicio. El instalador lo escribe a partir de tus respuestas y genera los secretos una sola vez. Esta referencia enumera las claves que puedes definir, agrupadas como en el archivo.
La mayor parte de la configuración está en la consola, no aquí: la marca y los interruptores de funciones en Configuración › Instancia, los nombres y los certificados en Configuración › Servidor, las fuentes en Configuración › Fuentes, las credenciales de monitoreo en Configuración › Credenciales. Después de cambiar el archivo, reinicia la plataforma como la cuenta de servicio con systemctl --user restart excubius.
Haz una copia de seguridad del archivo .env y, con él, de EXCUBIUS_DATA_KEY. Sin esa clave, los secretos guardados en la base de datos no se pueden descifrar.
Instalación
| Clave | Valor predeterminado | Significado |
|---|---|---|
EXCUBIUS_HOME | /opt/excubius | Directorio de instalación. Lo escribe el instalador |
SERVER_NAME | — | El nombre principal: el host de la URL pública |
REGISTRY | ghcr.io/custorius-labs/excubius | Prefijo del registro y del repositorio de las imágenes |
PROXY_MODE | http | http o https. Solo se aplica hasta que el servicio de certificados toma el control; después decide Configuración › Servidor |
COOKIE_SECURE | vacío | Vacío: las cookies de sesión son Secure siempre que la solicitud llegó por HTTPS. true o false lo fuerzan. Déjalo vacío |
Nombres y TLS
Estas claves inicializan la configuración de TLS solo en el primer inicio, cuando la plataforma todavía no tiene ninguna. A partir de ahí, los nombres y los certificados se administran en Configuración › Servidor, sin reiniciar. El instalador quita del archivo las credenciales de DNS y la clave privada una vez que la plataforma las guardó.
| Clave | Valor predeterminado | Significado |
|---|---|---|
TLS_MODE | vacío | letsencrypt_http, letsencrypt_dns, selfsigned, custom, gateway o http. También se aceptan los nombres del instalador letsencrypt, letsencrypt-dns y later |
TLS_ALIASES | vacío | Otros nombres que los usuarios pueden abrir, separados por espacios |
TLS_CERT_NAMES | vacío | Nombres que se incluyen en el certificado, separados por espacios. Vacío: todos los nombres |
TLS_EMAIL | vacío | Correo electrónico de la cuenta de Let's Encrypt |
TLS_ACME_SERVER | production | staging para ensayar con certificados de prueba en los que los navegadores no confían |
TLS_DNS_PROVIDER | vacío | El id. de dnsapi de acme.sh del proveedor de DNS, como dns_cf o dns_azure |
TLS_DNS_CREDENTIALS | vacío | Pares KEY=VALUE separados por saltos de línea o por ;, o base64:<…> |
TLS_CERT_FILE, TLS_KEY_FILE | vacío | base64:<PEM contents> de tu propia cadena de certificados y tu clave privada |
TLS_ACME_DNSSLEEP | 0 | Segundos de espera para la propagación de DNS en lugar de comprobarla mediante resolutores públicos de DNS sobre HTTPS. Úsalo en redes que no pueden llegar a ellos |
Producto
| Clave | Valor predeterminado | Significado |
|---|---|---|
PRODUCT_NAME | Excubius | Solo como respaldo. El nombre del producto proviene de la marca en Configuración › Instancia |
DEFAULT_LOCALE | en | Idioma predeterminado |
BASE_URL | — | La URL pública, como https://monitoring.example.com. La usan los vínculos de los mensajes |
EXCUBIUS_DEFAULT_PRESET | enterprise | El preset desde el que arranca la instancia: enterprise, databases o core |
EXCUBIUS_FEATURES_ENFORCE_API | false | true: la API también rechaza las funciones desactivadas. Valor predeterminado: solo se ocultan en la interfaz |
Base de datos y secretos
| Clave | Valor predeterminado | Significado |
|---|---|---|
POSTGRES_USER | excubius | Usuario de la base de datos |
POSTGRES_PASSWORD | generado | Solo letras y dígitos, porque se incluye en una URL de conexión |
POSTGRES_DB | excubius | Nombre de la base de datos |
DATABASE_URL | se construye con las tres anteriores | URL de conexión. Los contenedores la reciben construida con las tres claves anteriores |
EXCUBIUS_DATA_KEY | generado | Clave que cifra los secretos guardados en la base de datos: credenciales, secretos de las fuentes, claves de API de DNS. 32 bytes aleatorios, en base64 seguro para URL. Nunca la cambies en una instalación en funcionamiento |
EXCUBIUS_COLLECTOR_TOKEN | generado | Secreto compartido entre el recolector y la API. Vacío: el recolector queda inactivo y los puntos de conexión del recolector se deshabilitan |
Inicio de sesión
| Clave | Valor predeterminado | Significado |
|---|---|---|
JWT_SECRET | generado | Firma los tokens de sesión. 64 caracteres aleatorios |
ACCESS_TOKEN_MINUTES | 15 | Duración de un token de acceso |
REFRESH_TOKEN_DAYS | 14 | Duración de una sesión |
ENTRA_TENANT_ID, ENTRA_CLIENT_ID, ENTRA_CLIENT_SECRET | vacío | Inicio de sesión con Microsoft Entra ID, de un solo inquilino: el id. del directorio, no common ni organizations. Se ofrece cuando las tres están definidas. URI de redirección: <BASE_URL>/api/v1/auth/entra/callback |
GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET | vacío | Inicio de sesión con Google. URI de redirección: <BASE_URL>/api/v1/auth/google/callback |
ALLOWED_SIGNUP_DOMAINS | vacío | Dominios de correo electrónico, separados por comas, cuyas personas obtienen una cuenta como lector en la raíz en su primer inicio de sesión. Solo se aplica hasta que se guarda un modo de registro en la entidad raíz. Vacío: solo por invitación |
Los secretos de cliente nunca se guardan en la base de datos ni se registran.
Núcleo de monitoreo
| Clave | Valor predeterminado | Significado |
|---|---|---|
EXCUBIUS_UNREACHABLE_AFTER | 3 | Errores consecutivos de conexión, de inicio de sesión o de tiempo de espera antes de que un recurso reciba su alerta Sin conexión |
EXCUBIUS_NOTIFY_QUIET_MINUTES | 10 | Minutos mínimos entre dos mensajes de la misma condición. Un aumento de severidad siempre se envía |
EXCUBIUS_COLLECTOR_VIA_PROXY | false | true solo para un recolector fuera del servidor que llega a la API a través de la dirección pública |
Recolector
El contenedor del recolector recibe solo estas claves, nunca el archivo completo.
| Clave | Valor predeterminado | Significado |
|---|---|---|
EXCUBIUS_COLLECTOR_TOKEN | generado | Consulta Base de datos y secretos |
EXCUBIUS_COLLECTOR_TRANSPORTS | todos los transportes presentes | Subconjunto separado por comas que se ofrece, como tsql,http,dns. Valores: tsql, http, dns, winrm, ssh, azure_graph, defender, entra, wazuh |
EXCUBIUS_COLLECTOR_CONCURRENCY | 32 | Comprobaciones que se ejecutan a la vez |
EXCUBIUS_TSQL_THREADS | 16 | Subprocesos para las conexiones a SQL Server |
EXCUBIUS_SQL_APP_NAME | monitoring-collector | Nombre de aplicación de las sesiones de SQL Server del recolector |
EXCUBIUS_ODBC_DRIVER | ODBC Driver 18 for SQL Server | Nombre del controlador ODBC |
AZURE_SUBSCRIPTION_IDS | vacío | Suscripciones separadas por comas para las comprobaciones nativas de Resource Graph (seguridad en la nube, Azure Update Manager) cuando la credencial no define ninguna. Vacío: todas las suscripciones que la identidad puede leer. La fuente Azure Monitor tiene su propia lista |
AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET | vacío | Vacío: la identidad administrada del servidor. AZURE_CLIENT_ID sola indica una identidad administrada asignada por el usuario. Las tres: se usa esa entidad de servicio |
El recolector también tiene parámetros para sus intervalos de sondeo, los tamaños de lote y de búfer y el nombre de host, pero la plataforma instalada no los pasa a su contenedor, así que se aplican sus valores predeterminados: asignaciones cada 30 segundos, trabajos cada 10 segundos, un latido cada 60 segundos, 200 resultados por lote y 10,000 resultados conservados mientras la API no está accesible.
Notificaciones e incidencias
| Clave | Valor predeterminado | Significado |
|---|---|---|
SLACK_BOT_TOKEN | vacío | Token de bot de la aplicación de Slack, con el ámbito chat:write. Vacío: no se envía nada a Slack |
SLACK_DEFAULT_CHANNEL | #alerts | Recibe las advertencias y las alertas críticas cuando ninguna entidad de la ruta tiene un canal |
JIRA_BASE_URL | vacío | https://<site>.atlassian.net |
JIRA_AUTH | token | token (correo electrónico y token de API), oauth (credenciales de cliente de una cuenta de servicio de Atlassian) o bearer |
JIRA_EMAIL, JIRA_API_TOKEN | vacío | Credenciales para token |
JIRA_OAUTH_CLIENT_ID, JIRA_OAUTH_CLIENT_SECRET | vacío | Credenciales para oauth |
JIRA_CLOUD_ID | vacío | Solo oauth: el id. de nube del sitio |
JIRA_OAUTH_TOKEN_URL | https://auth.atlassian.com/oauth/token | URL del token para oauth |
JIRA_DEFAULT_PROJECT | vacío | Clave del proyecto para las incidencias nuevas |
JIRA_ISSUE_TYPE | Task | Nombre del tipo de incidencia en ese proyecto |
JIRA_SYNC_MINUTES | 10 | Cada cuánto se lee el estado de las incidencias abiertas |
WEB_PUSH_VAPID_PUBLIC, WEB_PUSH_VAPID_PRIVATE | vacío | Reservadas para las notificaciones push web, que no están disponibles en esta versión. Déjalas vacías |
Las claves de Jira son valores predeterminados: cada entidad puede reemplazarlos en su propia configuración de Jira. Consulta Crear incidencias de Jira a partir de alertas.
Proceso de actualizaciones y seguridad
| Clave | Valor predeterminado | Significado |
|---|---|---|
EXCUBIUS_SECURITY_WORKER | true | El proceso en segundo plano de la API: feeds de los fabricantes, vencimiento de las aceptaciones de riesgo, comprobaciones que ejecuta la API, instantáneas de la puntuación de seguridad, estado de Jira. Defínelo en false solo en las réplicas adicionales de la API |
EXCUBIUS_FEEDS_ENABLED | true | false: nunca descargar los feeds de los fabricantes, para instalaciones aisladas. Se usan las copias incluidas en la versión |
EXCUBIUS_FEED_TIMEOUT_SECONDS | 60 | Tiempo de espera por solicitud a un feed |
EXCUBIUS_FEED_SQLSERVER_BUILDS_URLS | el sitio de dbatools y, luego, GitHub | URL separadas por espacios de la lista de compilaciones de SQL Server, que se prueban en orden. Pon primero un espejo interno |
EXCUBIUS_FEED_ENDOFLIFE_URL | https://endoflife.date/api | URL base del feed de fin del soporte |
EXCUBIUS_FEED_MSRC_URL | https://api.msrc.microsoft.com/cvrf/v3.0 | URL base de los avisos de seguridad de Microsoft |
EXCUBIUS_FEED_MSRC_MONTHS | 3 | Publicaciones mensuales que se mantienen actualizadas, de 1 a 24 |
HTTPS_PROXY | vacío | Proxy para las solicitudes a los feeds |
Claves que esta versión no lee
El archivo .env.example incluido todavía enumera NEWRELIC_API_KEY, NEWRELIC_ACCOUNT_ID, NEWRELIC_WEBHOOK_SECRET, NINJAONE_CLIENT_ID, NINJAONE_CLIENT_SECRET, NINJAONE_REGION, WAZUH_API_URL, WAZUH_API_USER y WAZUH_API_PASSWORD. Esta versión las ignora. Configura New Relic y NinjaOne en Configuración › Fuentes, y Wazuh con una credencial y los parámetros de la comprobación; consulta Fuentes y Seguridad en la nube.