Variables d'environnement
Excubius lit ses paramètres d'installation dans le fichier .env du répertoire d'installation, /opt/excubius/.env par défaut, en mode 0600 et appartenant au compte de service. Le programme d'installation l'écrit à partir de vos réponses et génère les secrets une seule fois. Cette référence répertorie les clés que vous pouvez définir, regroupées comme dans le fichier.
La plupart des paramètres se trouvent dans la console, pas ici : la personnalisation de la marque et les commutateurs de fonctionnalité dans Settings › Instance, les noms et les certificats dans Settings › Server, les sources dans Settings › Sources, les informations d'identification de supervision dans Settings › Credentials. Après avoir modifié le fichier, redémarrez la plateforme avec le compte de service à l'aide de systemctl --user restart excubius.
Sauvegardez le fichier .env, et avec lui EXCUBIUS_DATA_KEY. Sans cette clé, les secrets stockés dans la base de données ne peuvent pas être déchiffrés.
Installation
| Clé | Valeur par défaut | Signification |
|---|---|---|
EXCUBIUS_HOME | /opt/excubius | Répertoire d'installation. Écrit par le programme d'installation |
SERVER_NAME | — | Le nom principal : l'hôte de l'URL publique |
REGISTRY | ghcr.io/custorius-labs/excubius | Préfixe du registre et du dépôt des images |
PROXY_MODE | http | http ou https. S'applique uniquement jusqu'à ce que le service de certificats prenne le relais ; ensuite, c'est Settings › Server qui décide |
COOKIE_SECURE | vide | Vide : les cookies de session sont Secure chaque fois que la requête est arrivée en HTTPS. true ou false forcent la valeur. Laissez-la vide |
Noms et TLS
Ces clés initialisent les paramètres TLS au premier démarrage uniquement, lorsque la plateforme n'en a pas encore. Ensuite, les noms et les certificats se gèrent dans Settings › Server, sans redémarrage. Le programme d'installation retire du fichier les informations d'identification DNS et la clé privée une fois que la plateforme les a stockées.
| Clé | Valeur par défaut | Signification |
|---|---|---|
TLS_MODE | vide | letsencrypt_http, letsencrypt_dns, selfsigned, custom, gateway ou http. Les noms du programme d'installation letsencrypt, letsencrypt-dns et later sont également acceptés |
TLS_ALIASES | vide | Autres noms que les utilisateurs peuvent ouvrir, séparés par des espaces |
TLS_CERT_NAMES | vide | Noms à inclure dans le certificat, séparés par des espaces. Vide : tous les noms |
TLS_EMAIL | vide | Adresse e-mail du compte Let's Encrypt |
TLS_ACME_SERVER | production | staging pour faire une répétition avec des certificats de test auxquels les navigateurs ne font pas confiance |
TLS_DNS_PROVIDER | vide | L'ID dnsapi d'acme.sh du fournisseur DNS, comme dns_cf ou dns_azure |
TLS_DNS_CREDENTIALS | vide | Paires KEY=VALUE séparées par des retours à la ligne ou par ;, ou base64:<…> |
TLS_CERT_FILE, TLS_KEY_FILE | vide | base64:<PEM contents> de votre propre chaîne de certificats et de votre clé privée |
TLS_ACME_DNSSLEEP | 0 | Secondes d'attente de la propagation DNS au lieu de la vérifier via des résolveurs publics DNS-over-HTTPS. Utilisez-la sur les réseaux qui ne peuvent pas les joindre |
Produit
| Clé | Valeur par défaut | Signification |
|---|---|---|
PRODUCT_NAME | Excubius | Valeur de repli uniquement. Le nom du produit provient de la personnalisation de la marque dans Settings › Instance |
DEFAULT_LOCALE | en | Langue par défaut |
BASE_URL | — | L'URL publique, comme https://monitoring.example.com. Les liens des messages l'utilisent |
EXCUBIUS_DEFAULT_PRESET | enterprise | Le préréglage à partir duquel l'instance démarre : enterprise, databases ou core |
EXCUBIUS_FEATURES_ENFORCE_API | false | true : l'API refuse aussi les fonctionnalités désactivées. Par défaut, elles sont seulement masquées dans l'interface |
Base de données et secrets
| Clé | Valeur par défaut | Signification |
|---|---|---|
POSTGRES_USER | excubius | Utilisateur de la base de données |
POSTGRES_PASSWORD | générée | Lettres et chiffres uniquement, car elle est intégrée dans une URL de connexion |
POSTGRES_DB | excubius | Nom de la base de données |
DATABASE_URL | construite à partir des trois clés ci-dessus | URL de connexion. Les conteneurs la reçoivent construite à partir des trois clés ci-dessus |
EXCUBIUS_DATA_KEY | générée | Clé qui chiffre les secrets stockés dans la base de données : informations d'identification, secrets des sources, clés d'API DNS. 32 octets aléatoires, en base64 compatible URL. Ne la modifiez jamais sur une installation en service |
EXCUBIUS_COLLECTOR_TOKEN | généré | Secret partagé entre le collecteur et l'API. Vide : le collecteur reste inactif et les points de terminaison du collecteur sont désactivés |
Connexion
| Clé | Valeur par défaut | Signification |
|---|---|---|
JWT_SECRET | généré | Signe les jetons de session. 64 caractères aléatoires |
ACCESS_TOKEN_MINUTES | 15 | Durée de vie d'un jeton d'accès |
REFRESH_TOKEN_DAYS | 14 | Durée de vie d'une session |
ENTRA_TENANT_ID, ENTRA_CLIENT_ID, ENTRA_CLIENT_SECRET | vide | Connexion Microsoft Entra ID, locataire unique : l'ID de l'annuaire, pas common ni organizations. Proposée dès que les trois clés sont définies. URI de redirection : <BASE_URL>/api/v1/auth/entra/callback |
GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET | vide | Connexion Google. URI de redirection : <BASE_URL>/api/v1/auth/google/callback |
ALLOWED_SIGNUP_DOMAINS | vide | Domaines de messagerie, séparés par des virgules, dont les utilisateurs reçoivent un compte avec le rôle de lecteur sur la racine à leur première connexion. S'applique uniquement jusqu'à ce qu'un mode d'inscription soit enregistré sur l'entité racine. Vide : sur invitation uniquement |
Les secrets clients ne sont jamais stockés dans la base de données ni journalisés.
Cœur de la supervision
| Clé | Valeur par défaut | Signification |
|---|---|---|
EXCUBIUS_UNREACHABLE_AFTER | 3 | Échecs consécutifs de connexion réseau, d'authentification ou de délai d'expiration avant qu'une ressource reçoive son alerte Cannot reach |
EXCUBIUS_NOTIFY_QUIET_MINUTES | 10 | Nombre minimal de minutes entre deux messages pour la même condition. Une gravité en hausse est toujours envoyée |
EXCUBIUS_COLLECTOR_VIA_PROXY | false | true uniquement pour un collecteur situé hors du serveur qui joint l'API par l'adresse publique |
Collecteur
Le conteneur du collecteur reçoit uniquement ces clés, jamais le fichier entier.
| Clé | Valeur par défaut | Signification |
|---|---|---|
EXCUBIUS_COLLECTOR_TOKEN | généré | Consultez Base de données et secrets |
EXCUBIUS_COLLECTOR_TRANSPORTS | tous les transports présents | Sous-ensemble à proposer, séparé par des virgules, comme tsql,http,dns. Valeurs : tsql, http, dns, winrm, ssh, azure_graph, defender, entra, wazuh |
EXCUBIUS_COLLECTOR_CONCURRENCY | 32 | Vérifications exécutées simultanément |
EXCUBIUS_TSQL_THREADS | 16 | Threads pour les connexions SQL Server |
EXCUBIUS_SQL_APP_NAME | monitoring-collector | Nom d'application des sessions SQL Server du collecteur |
EXCUBIUS_ODBC_DRIVER | ODBC Driver 18 for SQL Server | Nom du pilote ODBC |
AZURE_SUBSCRIPTION_IDS | vide | Abonnements, séparés par des virgules, pour les vérifications Resource Graph natives (sécurité du cloud, Azure Update Manager) lorsque les informations d'identification n'en définissent aucun. Vide : tous les abonnements que l'identité peut lire. La source Azure Monitor a sa propre liste |
AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET | vide | Vide : l'identité managée du serveur. AZURE_CLIENT_ID seul désigne une identité managée affectée par l'utilisateur. Les trois : ce principal de service est utilisé à la place |
Le collecteur dispose aussi de paramètres pour ses intervalles d'interrogation, la taille de ses lots et de sa mémoire tampon et son nom d'hôte, mais la plateforme installée ne les transmet pas à son conteneur ; leurs valeurs par défaut s'appliquent donc : affectations toutes les 30 secondes, travaux toutes les 10 secondes, une pulsation toutes les 60 secondes, 200 résultats par lot, 10 000 résultats conservés tant que l'API est inaccessible.
Notifications et tickets
| Clé | Valeur par défaut | Signification |
|---|---|---|
SLACK_BOT_TOKEN | vide | Jeton de bot de l'application Slack, avec l'étendue chat:write. Vide : rien n'est envoyé à Slack |
SLACK_DEFAULT_CHANNEL | #alerts | Reçoit les avertissements et les alertes critiques lorsqu'aucune entité du chemin n'a de canal |
JIRA_BASE_URL | vide | https://<site>.atlassian.net |
JIRA_AUTH | token | token (adresse e-mail et jeton d'API), oauth (informations d'identification client d'un compte de service Atlassian) ou bearer |
JIRA_EMAIL, JIRA_API_TOKEN | vide | Informations d'identification pour token |
JIRA_OAUTH_CLIENT_ID, JIRA_OAUTH_CLIENT_SECRET | vide | Informations d'identification pour oauth |
JIRA_CLOUD_ID | vide | oauth uniquement : l'ID cloud du site |
JIRA_OAUTH_TOKEN_URL | https://auth.atlassian.com/oauth/token | URL de jeton pour oauth |
JIRA_DEFAULT_PROJECT | vide | Clé du projet pour les nouveaux tickets |
JIRA_ISSUE_TYPE | Task | Nom du type de ticket dans ce projet |
JIRA_SYNC_MINUTES | 10 | Fréquence de lecture de l'état des tickets ouverts |
WEB_PUSH_VAPID_PUBLIC, WEB_PUSH_VAPID_PRIVATE | vide | Réservées aux notifications web push, non disponibles dans cette version. Laissez-les vides |
Les clés Jira sont des valeurs par défaut : chaque entité peut les remplacer dans ses propres paramètres Jira. Consultez Créer des tickets Jira à partir des alertes.
Processus des mises à jour et de la sécurité
| Clé | Valeur par défaut | Signification |
|---|---|---|
EXCUBIUS_SECURITY_WORKER | true | Le processus d'arrière-plan de l'API : flux des éditeurs, expiration des acceptations de risque, vérifications exécutées par l'API, instantanés du score de sécurité, état Jira. Définissez false uniquement sur les réplicas supplémentaires de l'API |
EXCUBIUS_FEEDS_ENABLED | true | false : ne jamais récupérer les flux des éditeurs, pour les installations isolées (air-gapped). Les copies fournies avec la version sont utilisées |
EXCUBIUS_FEED_TIMEOUT_SECONDS | 60 | Délai d'expiration par requête de flux |
EXCUBIUS_FEED_SQLSERVER_BUILDS_URLS | le site dbatools, puis GitHub | URL de la liste des builds SQL Server, séparées par des espaces et essayées dans l'ordre. Placez un miroir interne en premier |
EXCUBIUS_FEED_ENDOFLIFE_URL | https://endoflife.date/api | URL de base du flux de fin de support |
EXCUBIUS_FEED_MSRC_URL | https://api.msrc.microsoft.com/cvrf/v3.0 | URL de base des avis de sécurité Microsoft |
EXCUBIUS_FEED_MSRC_MONTHS | 3 | Publications mensuelles tenues à jour, de 1 à 24 |
HTTPS_PROXY | vide | Proxy pour les requêtes de flux |
Clés que cette version ne lit pas
Le fichier .env.example fourni répertorie encore NEWRELIC_API_KEY, NEWRELIC_ACCOUNT_ID, NEWRELIC_WEBHOOK_SECRET, NINJAONE_CLIENT_ID, NINJAONE_CLIENT_SECRET, NINJAONE_REGION, WAZUH_API_URL, WAZUH_API_USER et WAZUH_API_PASSWORD. Cette version les ignore. Configurez New Relic et NinjaOne dans Settings › Sources, et Wazuh avec des informations d'identification et les paramètres de la vérification ; consultez Sources et Sécurité du cloud.