Skip to main content

Environment Variable Explanation

System parameters can be controlled through environment variables. Copy env.tmpl to .env and modify the parameters in it.

Some parameter explanations are as follows:

Environment VariableDescription
API_BASE_URLAPI service address (needs modification)
WEB_PORTPort of website
INSTALLATION_MODEInstallation mode (standalone: standard mode; with-doris: Doris integrated mode; with-starrocks: Starrocks integrated mode)
DB_NAMEDatabase name
DB_USERDatabase username
DB_PASSDatabase password
DB_PORTDatabase port
DB_HOSTDatabase address
REDIS_PASSWORDCache service password
WEBAPP_PORTWEB UI service port
NODE_ENVOperating environment: development or production
LOGGER_LEVELLog level
DEFAULT_LATITUDEDefault latitude
DEFAULT_LONGITUDEDefault longitude
DEFAULT_CURRENCYDefault currency
DEMODemo system

To customize the SMTP mail server configuration, you need to configure the following environment variables:

Environment variableDescription
MAIL_FROM_ADDRESSSender's email address
MAIL_HOSTMail service host
MAIL_PORTMail service port number
MAIL_USERNAMEMail account
MAIL_PASSWORDMail password

File Storage​

Custom File Storage Providers

Environment VariableDescription
FILE_PROVIDERFile storage provider (LOCAL | S3 | OSS)
ALIYUN_ACCESS_KEY_IDAlibaba Cloud Access Key ID
ALIYUN_ACCESS_KEY_SECRETAlibaba Cloud Access Key Secret
ALIYUN_REGIONAlibaba Cloud Region
ALIYUN_OSS_ENDPOINTAlibaba Cloud OSS Endpoint
ALIYUN_OSS_BUCKETAlibaba Cloud OSS Bucket
AWS_ACCESS_KEY_IDAmazon Cloud Access Key ID
AWS_SECRET_ACCESS_KEYAmazon Cloud Secret Access Key
AWS_REGIONAmazon Cloud Region
AWS_S3_BUCKETAmazon Cloud S3 Bucket