Skip to main content

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 URLβ€”Yes
CLIENT_BASE_URLFrontend application URLβ€”Yes

Database​

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

Authentication​

VariableDescriptionDefaultRequired
JWT_SECRETJWT signing secretβ€”Yes
JWT_TOKEN_EXPIRATION_TIMEJWT token expiry (sec)86400No
JWT_REFRESH_SECRETRefresh token secretβ€”Yes
JWT_REFRESH_EXPIRATION_TIMERefresh token expiry604800No

Redis​

VariableDescriptionDefaultRequired
REDIS_HOSTRedis hostlocalhostNo
REDIS_PORTRedis port6379No
REDIS_PASSWORDRedis passwordβ€”No
REDIS_TLSEnable TLSfalseNo

File Storage​

VariableDescriptionDefaultRequired
FILE_PROVIDERStorage providerLOCALNo
AWS_ACCESS_KEY_IDS3 access keyβ€”S3 only
AWS_SECRET_ACCESS_KEYS3 secret keyβ€”S3 only
AWS_REGIONS3 regionβ€”S3 only
AWS_S3_BUCKETS3 bucket nameβ€”S3 only
WASABI_ACCESS_KEY_IDWasabi access keyβ€”Wasabi
WASABI_SECRET_ACCESS_KEYWasabi secret keyβ€”Wasabi
WASABI_REGIONWasabi regionβ€”Wasabi
WASABI_SERVICE_URLWasabi service URLβ€”Wasabi
WASABI_S3_BUCKETWasabi bucket nameβ€”Wasabi
CLOUDINARY_API_KEYCloudinary API keyβ€”Cloudinary
CLOUDINARY_API_SECRETCloudinary API secretβ€”Cloudinary
CLOUDINARY_CLOUD_NAMECloudinary cloud nameβ€”Cloudinary

OAuth​

VariableDescriptionDefaultRequired
GOOGLE_CLIENT_IDGoogle OAuth client IDβ€”No
GOOGLE_CLIENT_SECRETGoogle OAuth secretβ€”No
GOOGLE_CALLBACK_URLGoogle OAuth callbackβ€”No
FACEBOOK_CLIENT_IDFacebook OAuth client IDβ€”No
FACEBOOK_CLIENT_SECRETFacebook OAuth secretβ€”No
GITHUB_CLIENT_IDGitHub OAuth client IDβ€”No
GITHUB_CLIENT_SECRETGitHub OAuth secretβ€”No
MICROSOFT_CLIENT_IDMicrosoft OAuth client IDβ€”No
MICROSOFT_CLIENT_SECRETMicrosoft OAuth secretβ€”No

Email​

VariableDescriptionDefaultRequired
MAIL_FROM_ADDRESSDefault from emailβ€”No
MAIL_HOSTSMTP hostβ€”No
MAIL_PORTSMTP port587No
MAIL_USERNAMESMTP usernameβ€”No
MAIL_PASSWORDSMTP passwordβ€”No

Monitoring​

VariableDescriptionDefaultRequired
SENTRY_DSNSentry error tracking DSNβ€”No
SENTRY_TRACES_SAMPLE_RATESentry trace sample rate0.01No

Feature Flags​

VariableDescriptionDefaultRequired
UNLEASH_APP_NAMEUnleash app nameβ€”No
UNLEASH_API_URLUnleash server URLβ€”No
UNLEASH_INSTANCE_IDUnleash instance IDβ€”No
UNLEASH_API_KEYUnleash API keyβ€”No