Skip to content

Environment variables

Vascular supports runtime customization through environment variables. These variables control optional features and integrations without requiring code changes.

Set these environment variables using:

  • docker run -e VAR_NAME=value
  • In your docker-compose.yml or Kubernetes env: block
  • As part of your deployment configuration

Available environment variables

Variable NameDefaultTypeDescription
SERVER_PORT3000StringPort the application listens on.
DATABASE_URL(required)StringPostgreSQL connection string. Must include protocol, user, password, host, port, and db name.
LICENSE_KEY/etc/vascular-inbox/.licenseStringFull path to the license file used to activate the application. Must be mounted at runtime.
CREDS_IN_DBfalseBooleanWhen true, API and app keys are generated on startup and stored in the database. Retrieve them from the database instead of using show-creds.
TENANT_IDRequired when using the backend SDKStringYour Microsoft Entra ID tenant ID. The backend SDK sends Microsoft Entra ID access tokens with requests, and Vascular uses this tenant ID to verify that those tokens come from your organization.
AWS_REGIONeu-west-1StringAWS region where Kinesis Firehose is hosted. Used to stream analytics event records to Firehose.

Vascular Platform developer documentation