ื“ืœื’ ืœืชื•ื›ืŸ ื”ืจืืฉื™

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