Przejdź do głównej zawartości

Environment Variables Reference

Comprehensive reference of all environment variables used in Ever Gauzy.

Core Application

VariableDescriptionDefaultRequired
NODE_ENVEnvironment modedevelopmentNo
PORTAPI server port3000No
HOSTAPI server host0.0.0.0No
APP_NAMEApplication nameGauzyNo
API_BASE_URLPublic API URLYes
CLIENT_BASE_URLFrontend application URLYes

Database

VariableDescriptionDefaultRequired
DB_TYPEDatabase typesqliteNo
DB_HOSTDatabase hostlocalhostNo
DB_PORTDatabase port5432No
DB_NAMEDatabase namegauzyNo
DB_USERDatabase usernamepostgresNo
DB_PASSDatabase passwordYes*
DB_SSL_MODESSL modefalseNo
DB_POOL_SIZEConnection pool size40No
DB_ORMORM type (typeorm/mikro-orm)typeormNo

Authentication

VariableDescriptionDefaultRequired
JWT_SECRETJWT signing secretYes
JWT_TOKEN_EXPIRATION_TIMEJWT token expiry (sec)86400No
JWT_REFRESH_SECRETRefresh token secretYes
JWT_REFRESH_EXPIRATION_TIMERefresh token expiry604800No

Redis

VariableDescriptionDefaultRequired
REDIS_HOSTRedis hostlocalhostNo
REDIS_PORTRedis port6379No
REDIS_PASSWORDRedis passwordNo
REDIS_TLSEnable TLSfalseNo

File Storage

VariableDescriptionDefaultRequired
FILE_PROVIDERStorage providerLOCALNo
AWS_ACCESS_KEY_IDS3 access keyS3 only
AWS_SECRET_ACCESS_KEYS3 secret keyS3 only
AWS_REGIONS3 regionS3 only
AWS_S3_BUCKETS3 bucket nameS3 only
WASABI_ACCESS_KEY_IDWasabi access keyWasabi
WASABI_SECRET_ACCESS_KEYWasabi secret keyWasabi
WASABI_REGIONWasabi regionWasabi
WASABI_SERVICE_URLWasabi service URLWasabi
WASABI_S3_BUCKETWasabi bucket nameWasabi
CLOUDINARY_API_KEYCloudinary API keyCloudinary
CLOUDINARY_API_SECRETCloudinary API secretCloudinary
CLOUDINARY_CLOUD_NAMECloudinary cloud nameCloudinary

OAuth

VariableDescriptionDefaultRequired
GOOGLE_CLIENT_IDGoogle OAuth client IDNo
GOOGLE_CLIENT_SECRETGoogle OAuth secretNo
GOOGLE_CALLBACK_URLGoogle OAuth callbackNo
FACEBOOK_CLIENT_IDFacebook OAuth client IDNo
FACEBOOK_CLIENT_SECRETFacebook OAuth secretNo
GITHUB_CLIENT_IDGitHub OAuth client IDNo
GITHUB_CLIENT_SECRETGitHub OAuth secretNo
MICROSOFT_CLIENT_IDMicrosoft OAuth client IDNo
MICROSOFT_CLIENT_SECRETMicrosoft OAuth secretNo

Email

VariableDescriptionDefaultRequired
MAIL_FROM_ADDRESSDefault from emailNo
MAIL_HOSTSMTP hostNo
MAIL_PORTSMTP port587No
MAIL_USERNAMESMTP usernameNo
MAIL_PASSWORDSMTP passwordNo

Monitoring

VariableDescriptionDefaultRequired
SENTRY_DSNSentry error tracking DSNNo
SENTRY_TRACES_SAMPLE_RATESentry trace sample rate0.01No

Feature Flags

VariableDescriptionDefaultRequired
UNLEASH_APP_NAMEUnleash app nameNo
UNLEASH_API_URLUnleash server URLNo
UNLEASH_INSTANCE_IDUnleash instance IDNo
UNLEASH_API_KEYUnleash API keyNo