Skip to main content

Environment variables

Copy .env.example to .env.local and fill in the values below. Never commit .env.local.

Required

VariableDescriptionExample
AZURE_TENANT_IDYour Azure AD tenant IDxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
AZURE_CLIENT_IDSWA app registration client IDxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
AZURE_CLIENT_SECRETSWA app registration client secretSet in Azure Key Vault in prod
SWA_DEPLOYMENT_TOKENStatic Web Apps deployment tokenFrom Azure Portal → SWA → Manage token

Optional

VariableDescriptionDefault
ALGOLIA_APP_IDAlgolia DocSearch app ID
ALGOLIA_API_KEYAlgolia search-only API key
ALGOLIA_INDEX_NAMEAlgolia index namecharlie-mac-docs

GitHub Actions secrets

These must be added to your repository under Settings → Secrets and variables → Actions:

Secret nameValue
AZURE_STATIC_WEB_APPS_API_TOKENSWA deployment token
AZURE_TENANT_IDAzure AD tenant ID
AAD_CLIENT_IDApp registration client ID
AAD_CLIENT_SECRETApp registration client secret