Skip to content

Environment Variables

Stack9-core has a range of features. In order for these features to work, values must be set.

* - Required

Database

*DB_CLIENT - Postgres or Microsoft SQL Server. Valid values: pg, mssql

*DB_HOST- URL of the database

*DB_PORT - Port number of the database

*DB_USER - Database username

*DB_PASSWORD - Database password

Authentication

*AUTH_COOKIE_TIME - Time cookie is valid for in seconds

*AUTH_SECRET_TOKEN - 32 random alphanumeric key

*COOKIE_ENCRYPTION_MAIN_KEY - 32 random alphanumeric key

*COOKIE_ENCRYPTION_MAIN_IV - 12 random alphanumeric key

*COOKIE_ENCRYPTION_SECONDARY_KEY - 32 random alphanumeric key

*COOKIE_ENCRYPTION_SECONDARY_IV - 12 random alphanumeric key

Azure

*AUTH_ADAPTER=azuread

*AUTH_TENANT_ID - Azure AD Tenant ID

*AUTH_CLIENT_ID- Azure AD Application ID

*AUTH_CLIENT_SECRET- Azure AD Application Client Secret

*AUTH_REDIRECT_URL - https://{stack9SiteDomain}/api/auth/callback

File Attachment

Choose between AWS or Azure. Two storages are required for public and private access.

*FILE_ADAPTER - s3 or azure-blob-storage

AWS S3

*AWS_REGION - AWS region. Example: ap-southeast-2

*AWS_S3_BUCKET_PRIVATE - private bucket name. E.g. stack9-core-private

*AWS_S3_BUCKET_PUBLIC - public bucket namestack9-core-public

*AWS_ACCESS_KEY_ID - AWS Access key ID

AWS_SECRET_ACCESS_KEY - AWS Secret access key

Azure Blob Store

*AZURE_BLOB_STORAGE_CONNECTION_STRING_PUBLIC - DefaultEndpointsProtocol=http;AccountName=<account-name>;AccountKey=<account-key>;BlobEndpoint=<blob-endpoint>;

*AZURE_BLOB_STORAGE_CONNECTION_STRING_PRIVATE - DefaultEndpointsProtocol=http;AccountName=<account-name>;AccountKey=<account-key>;BlobEndpoint=<blob-endpoint>;

*AZURE_BLOB_STORAGE_CONTAINER_NAME_PRIVATE - Private storage name. e.g. container-private

*AZURE_BLOB_STORAGE_CONTAINER_NAME_PUBLIC - Public storage name. e.g. container-public

Quicksight

AWS_QUICKSIGHT_USER_IAM_ROLE - AWS IAM role

AWS_QUICKSIGHT_AWS_ACCESS_KEY_ID - AWS access key id

AWS_QUICKSIGHT_AWS_SECRET_ACCESS_KEY - AWS secret access key

AWS_QUICKSIGHT_AWS_SESSION_TOKEN - AWS session token

DASHBOARD_ADAPTOR - Quicksight or None

Send Grid

SEND_GRID_API_KEY - API key

SEND_GRID_SENDER_EMAIL - Send grid sender email

SEND_GRID_SENDER_NAME - Send grid sender name

N8N

N8N_ENDPOINT - URL of n8n

HOOKS_ENABLED -

Sentry

SENTRY_KEY` - Sentry.io key (optional)

Message Queue Service

MESSAGE_QUEUE_SERVICE - aws-sqs or ``None`

MESSAGE_QUEUE_QUEUE_URL - Queue URL

Others

*CLIENT_URL - URL for the client side. Example: https://localhost:3333/

*SITE_DOMAIN - The site domain. Example: localhost:3333