.env.template

# Local configuration for update-attack.py.
#
# Copy this file to .env, then change only the values needed for the local build:
#   cp .env.template .env
#
# Shell environment variables override .env values. Do not commit .env, especially
# when it contains ATTACK_WEBSITE_WORKBENCH_API_KEY. Docker build arguments are
# configured separately; see docs/DOCKER.md.

# Pelican metadata. These variables are passed directly to Pelican and intentionally
# do not use the ATTACK_WEBSITE_ prefix. Defaults: MITRE, ATT&CK, empty site URL,
# America/New_York, and en.
PELICAN_AUTHOR="MITRE"
PELICAN_SITENAME="ATT&CK"
PELICAN_SITEURL=""
PELICAN_TIMEZONE="America/New_York"
PELICAN_DEFAULT_LANG="en"

# Branding, banner, and optional build behavior. Boolean values accept true/false,
# yes/no, on/off, 1/0, and similar Typer forms. Defaults: custom-instance branding,
# banner enabled with the message below, failed tests return a nonzero status,
# and optional extras are not run.
# When ATTACK_WEBSITE_ATTACK_BRAND=true is set without an explicit banner setting,
# the stock custom-instance banner remains hidden; this template explicitly enables it.
ATTACK_WEBSITE_ATTACK_BRAND=false
ATTACK_WEBSITE_BANNER_ENABLED=true
ATTACK_WEBSITE_BANNER_MESSAGE="This is a custom instance of the MITRE ATT&CK Website. The official website can be found at <a href='https://attack.mitre.org'>attack.mitre.org</a>."
ATTACK_WEBSITE_TEST_EXITSTATUS=true
ATTACK_WEBSITE_UPDATE_ATTACK_ALL_EXTRAS=false

# STIX sources and version archives. Each STIX value can be an HTTP(S) URL or a
# local JSON path. These values are the built-in defaults; archived versions use
# attack-version-archives relative to the repository by default.
ATTACK_WEBSITE_STIX_LOCATION_ENTERPRISE="https://raw.githubusercontent.com/mitre/cti/master/enterprise-attack/enterprise-attack.json"
ATTACK_WEBSITE_STIX_LOCATION_MOBILE="https://raw.githubusercontent.com/mitre/cti/master/mobile-attack/mobile-attack.json"
ATTACK_WEBSITE_STIX_LOCATION_ICS="https://raw.githubusercontent.com/mitre/cti/master/ics-attack/ics-attack.json"
ATTACK_WEBSITE_STIX_LOCATION_PRE="https://raw.githubusercontent.com/mitre/cti/master/pre-attack/pre-attack.json"
ATTACK_WEBSITE_ATTACK_VERSION_ARCHIVES="attack-version-archives"

# Optional Workbench credentials for authenticated STIX downloads. Leave both
# values empty by default; the API key is used only when a user is also supplied.
#ATTACK_WEBSITE_WORKBENCH_USER=""
#ATTACK_WEBSITE_WORKBENCH_API_KEY=""

# Optional page integrations. Both values are empty by default. The command-line
# --google-analytics and --google-site-verification options take precedence.
#ATTACK_WEBSITE_GOOGLE_ANALYTICS=""
#ATTACK_WEBSITE_GOOGLE_SITE_VERIFICATION=""

# Optional Osano privacy-compliance script. Disabled by default.
#ATTACK_WEBSITE_INCLUDE_OSANO=false