Skip to main content
The application is configured through environment variables defined in a .env file. Copy .env.example to .env and update values for your environment.

Database

PostgreSQL (Primary)

VariableDescriptionDefault
TYPEORM_HOSTDatabase hostdb
TYPEORM_PORTDatabase port5432
TYPEORM_USERNAMEDatabase usershoptokenadmin
TYPEORM_PASSWORDDatabase passwordshoptoken123
TYPEORM_DATABASEDatabase nameshoptoken
TYPEORM_MIGRATIONSMigration file pathdb/postgres/migrations/*.ts
TYPEORM_MIGRATIONS_DIRMigration output directorydb/postgres/migrations

ClickHouse (Analytics)

VariableDescriptionDefault
CLICKHOUSE_HOSTClickHouse hostclickhouse
CLICKHOUSE_DATABASEDatabase nameltvai
CLICKHOUSE_USERNAMEClickHouse userltvaiadmin
CLICKHOUSE_PASSWORDClickHouse passwordltvai123
CLICKHOUSE_PORTHTTP port8123

Redis

VariableDescriptionDefault
REDIS_HOSTRedis hostredis
REDIS_PORTRedis port6379
REDIS_PASSWORDRedis passwordredispassword
REDIS_USE_TLSEnable TLSfalse

Authentication

JWT Secrets

VariableDescription
RETAILER_JWT_PRIVATE_KEYSecret for retailer (merchant) tokens
ADMIN_JWT_PRIVATE_KEYSecret for admin panel tokens
BRIDGE_JWT_PRIVATE_KEYSecret for cross-service bridge tokens
PORTAL_JWT_PRIVATE_KEYSecret for merchant portal SSO tokens

Ecommerce Integrations

Shopify

VariableDescription
SHOPIFY_API_KEYShopify app API key
SHOPIFY_API_SECRET_KEYShopify app secret

BigCommerce

VariableDescription
BIGCOMMERCE_CLIENT_IDBigCommerce app client ID
BIGCOMMERCE_CLIENT_SECRETBigCommerce app secret

Email & Communication

VariableDescription
SENDGRID_API_KEYSendGrid API key for email delivery
SENDGRID_SUBUSER_EMAIL_PREFIXSendGrid subuser prefix

AWS Services

SQS Queues

VariableDescription
SQS_QUEUE_EMAIL_ANALYTICSEmail analytics processing
SQS_QUEUE_WEBHOOK_EVENTSWebhook event processing
SQS_QUEUE_SCHEDULESEmail scheduling
SQS_QUEUE_OUTGOING_WEBHOOKSOutgoing webhook delivery
SQS_QUEUE_SEGMENTATION_REQUESTSSegmentation processing
SQS_QUEUE_CATALOG_UPDATESProduct catalog sync (FIFO)
SQS_QUEUE_EXTERNAL_PROFILE_PUSH_SYNCExternal profile sync
SQS_QUEUE_OUTREACH_INBOUND_EMAILSInbound email processing
SQS_QUEUE_INBOX_INBOUND_EMAILSInbox email processing

Other AWS

VariableDescription
AWS_BATCH_JOB_QUEUE_NAMEAWS Batch job queue
AWS_BATCH_JOB_DEFINITION_NAME_SEGMENT_SYNCSegment sync job definition

Application

VariableDescriptionDefault
ENVEnvironment namedevelopment
LOCALRunning locally flagtrue
LOG_LEVELLogging leveldebug
LOG_PRETTYPretty print logstrue
USE_NEST_LOGGERUse NestJS built-in loggerfalse
SELF_URLBackend self-referencing URL-
RETAILER_UI_URLRetailer dashboard URL-
WEB_JS_URLFrontend widget JS URL-
PORTAL_URLMerchant portal URL-

Slack Webhooks

VariableDescription
APP_INSTALLS_SLACK_WEBHOOK_URLNew app install notifications
SEQUENCE_UPDATES_SLACK_WEBHOOK_URLSequence update notifications
WAITLIST_JOINED_SLACK_WEBHOOK_URLWaitlist join notifications