Documentation contents

AarView · Configure

Configuration reference

Every variable of the standalone edition's .env file: required, optional, public feeds, mail, engines, and the secrets the installer generates.

On this page

All the standalone edition’s configuration lives in .env. The installer creates it from .env.example. This file holds secrets: keep it at mode 0600 and out of any code repository.

After a change:

docker compose up -d

Required

VariableRole
AARVIEW_DOMAINthe name your users type; it must resolve to this server
AARVIEW_OPERATOR_NAMEyour organisation, shown to your users (sign-in page, reports, e-mails)
AARVIEW_ADMIN_EMAILthe identity provider’s administrator, and the contact shown when an account is locked

Optional

VariableDefaultRole
AARVIEW_OPERATOR_TENANToperatorshort identifier of your own organisation (lowercase letters, digits, dashes)
AARVIEW_SUPPORT_EMAILAARVIEW_ADMIN_EMAILsupport address shown to your users
AARVIEW_BIND0.0.0.0address port 443 listens on (0.0.0.0 = every interface)
AARVIEW_LOCKOUT_SECONDS900how long an account stays locked after 5 failed sign-ins
AARVIEW_LICENCE_KEYemptythe licence key; it can also be installed from the Licence page

Public feeds

Outbound HTTPS, carrying no data of yours. Set them to false on a closed network.

VariableDefaultRole
CVE_FEED_ENABLEDtrueCVE feed (NVD and the CISA KEV catalogue)
EUVD_ENABLEDtrueENISA’s EUVD list
NEWS_ALERTS_ENABLEDtruean hourly notification of recent critical CVEs
NEWS_SOURCESthe official CERTsthe feeds the News page reads; empty (NEWS_SOURCES=) = none
NVD_API_KEYemptyoptional NVD API key: it raises the request limit NVD applies

Without NEWS_SOURCES in .env, the News page reads cert-fr, cert-eu-adv, cert-eu-ti, cccs-fr, ancs-tn and africacert.

Mail

VariableDefaultRole
SMTP_HOSTemptyoutgoing mail server (notifications, account links)
SMTP_PORT587port
SMTP_USER, SMTP_PASSWORDemptycredentials

Existing engines

All optional; empty = not configured. The event store, endpoint manager and threat intelligence platform each work with a compatible engine (list on request). Details in Existing engines.

VariablesEngine
EVENTS_URL, EVENTS_USER, EVENTS_PASSWORD, EVENTS_CA_CERTevent store
ENDPOINTS_API_URL, ENDPOINTS_API_USER, ENDPOINTS_API_PASSWORD, ENDPOINTS_API_CA_CERTendpoint manager
INTEL_URL, INTEL_API_KEY, INTEL_CA_CERTthreat intelligence platform
CORTEX_URL, CORTEX_API_KEY, CORTEX_CA_CERTCortex
AI_SERVICE_URL, AI_SERVICE_TOKENAI assistant service

A private authority file goes in certs/ and is referred to as /certs/<file>.

Generated by the installer

Leave them empty: install.sh fills them. Never reuse them between installations.

VariableContent
AARVIEW_INSTANCE_IDinstance id (aarv-…), bound to the licence; never change it on a running install
POSTGRES_PASSWORD, AARVIEW_DB_APP_PASSWORD, AUTHENTIK_DB_PASSWORDdatabase passwords
AUTHENTIK_SECRET_KEY, AUTHENTIK_BOOTSTRAP_PASSWORDidentity provider; the second is akadmin’s initial password
AUTHENTIK_CLIENT_ID, AUTHENTIK_CLIENT_SECRETthe portal’s OpenID Connect client
AARVIEW_AUTHENTIK_TOKENthe token of the portal’s directory account
NEXTAUTH_SECRETthe interface’s sessions
SOURCES_MASTER_KEY, WEBHOOK_MASTER_KEYencryption of source and webhook secrets

Published images

By default the images are built from the source tree. To use published images instead, set AARVIEW_BACKEND_IMAGE and AARVIEW_FRONTEND_IMAGE.