Environment Variables Reference
Comprehensive reference of all environment variables used in Ever Gauzy.
Core Applicationโ
| Variable | Description | Default | Required |
|---|
NODE_ENV | Environment mode | development | No |
PORT | API server port | 3000 | No |
HOST | API server host | 0.0.0.0 | No |
APP_NAME | Application name | Gauzy | No |
API_BASE_URL | Public API URL | โ | Yes |
CLIENT_BASE_URL | Frontend application URL | โ | Yes |
Databaseโ
| Variable | Description | Default | Required |
|---|
DB_TYPE | Database type | sqlite | No |
DB_HOST | Database host | localhost | No |
DB_PORT | Database port | 5432 | No |
DB_NAME | Database name | gauzy | No |
DB_USER | Database username | postgres | No |
DB_PASS | Database password | โ | Yes* |
DB_SSL_MODE | SSL mode | false | No |
DB_POOL_SIZE | Connection pool size | 40 | No |
DB_ORM | ORM type (typeorm/mikro-orm) | typeorm | No |
Authenticationโ
| Variable | Description | Default | Required |
|---|
JWT_SECRET | JWT signing secret | โ | Yes |
JWT_TOKEN_EXPIRATION_TIME | JWT token expiry (sec) | 86400 | No |
JWT_REFRESH_SECRET | Refresh token secret | โ | Yes |
JWT_REFRESH_EXPIRATION_TIME | Refresh token expiry | 604800 | No |
| Variable | Description | Default | Required |
|---|
REDIS_HOST | Redis host | localhost | No |
REDIS_PORT | Redis port | 6379 | No |
REDIS_PASSWORD | Redis password | โ | No |
REDIS_TLS | Enable TLS | false | No |
File Storageโ
| Variable | Description | Default | Required |
|---|
FILE_PROVIDER | Storage provider | LOCAL | No |
AWS_ACCESS_KEY_ID | S3 access key | โ | S3 only |
AWS_SECRET_ACCESS_KEY | S3 secret key | โ | S3 only |
AWS_REGION | S3 region | โ | S3 only |
AWS_S3_BUCKET | S3 bucket name | โ | S3 only |
WASABI_ACCESS_KEY_ID | Wasabi access key | โ | Wasabi |
WASABI_SECRET_ACCESS_KEY | Wasabi secret key | โ | Wasabi |
WASABI_REGION | Wasabi region | โ | Wasabi |
WASABI_SERVICE_URL | Wasabi service URL | โ | Wasabi |
WASABI_S3_BUCKET | Wasabi bucket name | โ | Wasabi |
CLOUDINARY_API_KEY | Cloudinary API key | โ | Cloudinary |
CLOUDINARY_API_SECRET | Cloudinary API secret | โ | Cloudinary |
CLOUDINARY_CLOUD_NAME | Cloudinary cloud name | โ | Cloudinary |
| Variable | Description | Default | Required |
|---|
GOOGLE_CLIENT_ID | Google OAuth client ID | โ | No |
GOOGLE_CLIENT_SECRET | Google OAuth secret | โ | No |
GOOGLE_CALLBACK_URL | Google OAuth callback | โ | No |
FACEBOOK_CLIENT_ID | Facebook OAuth client ID | โ | No |
FACEBOOK_CLIENT_SECRET | Facebook OAuth secret | โ | No |
GITHUB_CLIENT_ID | GitHub OAuth client ID | โ | No |
GITHUB_CLIENT_SECRET | GitHub OAuth secret | โ | No |
MICROSOFT_CLIENT_ID | Microsoft OAuth client ID | โ | No |
MICROSOFT_CLIENT_SECRET | Microsoft OAuth secret | โ | No |
| Variable | Description | Default | Required |
|---|
MAIL_FROM_ADDRESS | Default from email | โ | No |
MAIL_HOST | SMTP host | โ | No |
MAIL_PORT | SMTP port | 587 | No |
MAIL_USERNAME | SMTP username | โ | No |
MAIL_PASSWORD | SMTP password | โ | No |
Monitoringโ
| Variable | Description | Default | Required |
|---|
SENTRY_DSN | Sentry error tracking DSN | โ | No |
SENTRY_TRACES_SAMPLE_RATE | Sentry trace sample rate | 0.01 | No |
Feature Flagsโ
| Variable | Description | Default | Required |
|---|
UNLEASH_APP_NAME | Unleash app name | โ | No |
UNLEASH_API_URL | Unleash server URL | โ | No |
UNLEASH_INSTANCE_ID | Unleash instance ID | โ | No |
UNLEASH_API_KEY | Unleash API key | โ | No |
Related Pagesโ