Sommaire de la documentation

AarView · Configurer

Référence de configuration

Toutes les variables du fichier .env de l'édition autonome : obligatoires, facultatives, flux publics, messagerie, moteurs, et secrets générés par l'installateur.

Sur cette page

Toute la configuration de l’édition autonome tient dans .env. L’installateur le crée à partir de .env.example. Ce fichier contient des secrets : gardez-le en mode 0600 et hors de tout dépôt de code.

Après une modification :

docker compose up -d

Obligatoires

VariableRôle
AARVIEW_DOMAINle nom que vos utilisateurs saisissent ; il doit pointer vers ce serveur
AARVIEW_OPERATOR_NAMEvotre organisation, affichée à vos utilisateurs (page de connexion, rapports, e-mails)
AARVIEW_ADMIN_EMAILl’administrateur du fournisseur d’identité, et le contact affiché quand un compte est verrouillé

Facultatives

VariableDéfautRôle
AARVIEW_OPERATOR_TENANToperatoridentifiant court de votre propre organisation (minuscules, chiffres, tirets)
AARVIEW_SUPPORT_EMAILAARVIEW_ADMIN_EMAILadresse de support affichée à vos utilisateurs
AARVIEW_BIND0.0.0.0adresse d’écoute du port 443 (0.0.0.0 = toutes les interfaces)
AARVIEW_LOCKOUT_SECONDS900durée de verrouillage d’un compte après 5 échecs de connexion
AARVIEW_LICENCE_KEYvidela clé de licence ; elle peut aussi s’installer depuis la page Licence

Flux publics

HTTPS sortant, sans aucune donnée vous concernant. Réglez-les à false sur un réseau fermé.

VariableDéfautRôle
CVE_FEED_ENABLEDtrueflux CVE (NVD et catalogue CISA KEV)
EUVD_ENABLEDtrueliste EUVD de l’ENISA
NEWS_ALERTS_ENABLEDtruenotification, chaque heure, des CVE critiques récentes
NEWS_SOURCESles CERT officielsles flux lus par la page Actualités ; vide (NEWS_SOURCES=) = aucun
NVD_API_KEYvideclé d’API NVD, facultative : elle relève la limite de requêtes imposée par NVD

Sans NEWS_SOURCES dans .env, la page Actualités lit cert-fr, cert-eu-adv, cert-eu-ti, cccs-fr, ancs-tn et africacert.

Messagerie

VariableDéfautRôle
SMTP_HOSTvideserveur d’envoi (notifications, liens de compte)
SMTP_PORT587port
SMTP_USER, SMTP_PASSWORDvideidentifiants

Moteurs existants

Tous facultatifs ; vide = non configuré. Le stockage d’évènements, le gestionnaire d’agents et la plateforme de renseignement fonctionnent chacun avec un moteur compatible (liste sur demande). Détail dans Moteurs existants.

VariablesMoteur
EVENTS_URL, EVENTS_USER, EVENTS_PASSWORD, EVENTS_CA_CERTstockage d’évènements
ENDPOINTS_API_URL, ENDPOINTS_API_USER, ENDPOINTS_API_PASSWORD, ENDPOINTS_API_CA_CERTgestionnaire d’agents
INTEL_URL, INTEL_API_KEY, INTEL_CA_CERTplateforme de renseignement
CORTEX_URL, CORTEX_API_KEY, CORTEX_CA_CERTCortex
AI_SERVICE_URL, AI_SERVICE_TOKENservice d’assistant IA

Un fichier d’autorité privée se dépose dans certs/ et se désigne par /certs/<fichier>.

Générées par l’installateur

Laissez-les vides : install.sh les remplit. Ne les réutilisez jamais d’une installation à l’autre.

VariableContenu
AARVIEW_INSTANCE_IDidentifiant d’instance (aarv-…), lié à la licence ; ne le changez jamais sur une installation en service
POSTGRES_PASSWORD, AARVIEW_DB_APP_PASSWORD, AUTHENTIK_DB_PASSWORDmots de passe de la base
AUTHENTIK_SECRET_KEY, AUTHENTIK_BOOTSTRAP_PASSWORDfournisseur d’identité ; le second est le mot de passe initial d’akadmin
AUTHENTIK_CLIENT_ID, AUTHENTIK_CLIENT_SECRETle client OpenID Connect du portail
AARVIEW_AUTHENTIK_TOKENle jeton du compte d’annuaire du portail
NEXTAUTH_SECRETles sessions de l’interface
SOURCES_MASTER_KEY, WEBHOOK_MASTER_KEYle chiffrement des secrets de sources et de webhooks

Images publiées

Par défaut, les images sont construites depuis les sources. Pour utiliser des images publiées, renseignez AARVIEW_BACKEND_IMAGE et AARVIEW_FRONTEND_IMAGE.