Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usertour.io/llms.txt

Use this file to discover all available pages before exploring further.

Usertour uses environment variables to configure various application parameters. Here’s a detailed explanation of the environment variables:
Environment VariableRequiredDescription
Database Configuration
DATABASE_URLYesPostgreSQL database connection URL. Can be configured to use connection poolers like PgBouncer or Prisma Accelerate. This is the main connection URL used by your application. Both DATABASE_URL and DATABASE_DIRECT_URL must be configured.
DATABASE_DIRECT_URLYesDirect PostgreSQL database connection URL. Required when using connection poolers in DATABASE_URL. Used by Prisma CLI commands that need direct database access (like migrations, schema pushes, and introspection). Both DATABASE_URL and DATABASE_DIRECT_URL must be configured.
Server Configuration
NEST_SERVER_PORTNoNestJS server port, default is 3000
NODE_ENVYesNode.js environment
Email Service Configuration
EMAIL_HOSTYesEmail server address
EMAIL_PORTYesEmail server port
EMAIL_USERYesEmail service account
EMAIL_PASSYesEmail service password
Important: Email service configuration is required for user registration and member invitation features. Without proper email configuration, these features will not be available.
Redis Configuration
Redis_HOSTYesRedis server address
Redis_PORTYesRedis server port
Redis_PASSNoRedis server password
Application Configuration
APP_HOMEPAGE_URLYesApplication homepage URL
API_URLNoGraphQL API endpoint, default is /graphql
DOC_URLNoDocumentation URL for error responses, default is https://docs.usertour.com
USERTOUR_TOKENNoUsertour Environment token
AWS S3 Configuration
AWS_S3_REGIONYesAWS S3 region
AWS_S3_ENDPOINTYesAWS S3 endpoint
AWS_S3_ACCESS_KEY_IDYesAWS S3 access key ID
AWS_S3_SECRET_ACCESS_KEYYesAWS S3 secret access key
AWS_S3_BUCKETYesAWS S3 bucket name
AWS_S3_DOMAINYesAWS S3 domain
Analytics Configuration
POSTHOG_KEYNoPostHog API key
POSTHOG_HOSTNoPostHog host URL
OpenTelemetry Configuration
OTLP_TRACES_ENDPOINTNoOpenTelemetry traces endpoint URL for distributed tracing
OTLP_METRICS_ENDPOINTNoOpenTelemetry metrics endpoint URL for metrics collection
Encryption
ENCRYPTION_KEYYes (prod)64-character hex string (32 bytes) used as the AES-256-GCM key for encrypting sensitive data at rest (currently 2FA TOTP secrets). Generate with openssl rand -hex 32. If unset, the server falls back to a known-insecure development key and logs no warning — do not ship that to production. Once users have enrolled in 2FA, do not rotate this key: existing TOTP secrets won’t decrypt with a new value.
Authentication Configuration
JWT_SECRETYesJWT token secret key
JWT_EXPIRATION_TIMEYesJWT token expiration time (e.g. 1h)
JWT_REFRESH_EXPIRATION_TIMEYesJWT refresh token expiration time (e.g. 7d)
Email Authentication
EMAIL_AUTH_ENABLEDNoEnable/disable email authentication
EMAIL_SENDERNoEmail sender name and address
GitHub Authentication
GITHUB_AUTH_ENABLEDNoEnable/disable GitHub authentication
GITHUB_CLIENT_IDNoGitHub OAuth client ID
GITHUB_CLIENT_SECRETNoGitHub OAuth client secret
GITHUB_CALLBACK_URLNoGitHub OAuth callback URL
Google Authentication
GOOGLE_AUTH_ENABLEDNoEnable/disable Google authentication
GOOGLE_CLIENT_IDNoGoogle OAuth client ID
GOOGLE_CLIENT_SECRETNoGoogle OAuth client secret
GOOGLE_CALLBACK_URLNoGoogle OAuth callback URL
Other Configuration
LOGIN_REDIRECT_URLNoURL to redirect after login
USERTOUR_COOKIE_DOMAINNoDomain where cookies are valid and can be accessed
USERTOUR_COOKIE_SECURENoControls whether cookies can only be transmitted over HTTPS.

​
Important Notes

  • For local development, APP_HOMEPAGE_URL can be set to http://[ip]:[port]
  • For production environments, make sure to modify the default security-related configurations (such as JWT secrets)
  • DATABASE_URL includes the database connection parameters with SSL mode preference
  • Both DATABASE_URL and DATABASE_DIRECT_URL must be configured, regardless of whether you’re using connection poolers or not
  • When using connection poolers (like PgBouncer) in production, make sure to:
    • Configure DATABASE_URL to use the connection pooler
    • Set DATABASE_DIRECT_URL to point directly to your PostgreSQL database
    • Ensure both URLs have proper SSL configuration for production use
  • The DATABASE_DIRECT_URL is essential for Prisma CLI operations and should always be configured when using connection poolers
  • Email service configuration is required for user registration and member invitation features. Without proper email configuration, these features will not be available

​
Configuration Example (.env)

Create a .env file in the project root directory. You can refer to the following example: 
# Database Configuration
DATABASE_URL=postgresql://user:password@localhost:5432/dbname
DATABASE_DIRECT_URL=postgresql://user:password@localhost:5432/dbname

# Server Configuration
NEST_SERVER_PORT=3000
NODE_ENV=production

# Email Service Configuration
EMAIL_HOST=smtp.example.com
EMAIL_PORT=587
EMAIL_USER=your_email@example.com
EMAIL_PASS=your_email_password

# Redis Configuration
Redis_HOST=localhost
Redis_PORT=6379
Redis_PASS=

# Application Configuration
APP_HOMEPAGE_URL=http://localhost:8011
API_URL=
DOC_URL=https://docs.usertour.com
USERTOUR_TOKEN=your_token

# AWS S3 Configuration
AWS_S3_REGION=your_region
AWS_S3_ENDPOINT=your_endpoint
AWS_S3_ACCESS_KEY_ID=your_access_key
AWS_S3_SECRET_ACCESS_KEY=your_secret_key
AWS_S3_BUCKET=your_bucket
AWS_S3_DOMAIN=your_domain

# Analytics Configuration
POSTHOG_KEY=your_posthog_key
POSTHOG_HOST=your_posthog_host

# OpenTelemetry Configuration
OTLP_TRACES_ENDPOINT=
OTLP_METRICS_ENDPOINT=

# Encryption (run `openssl rand -hex 32` to generate)
ENCRYPTION_KEY=replace_with_64_hex_chars

# JWT Configuration
JWT_SECRET=your_jwt_secret
JWT_EXPIRATION_TIME=1h
JWT_REFRESH_EXPIRATION_TIME=7d

# Email Authentication
EMAIL_AUTH_ENABLED=true
EMAIL_SENDER=Your App <support@example.com>

# GitHub Authentication
GITHUB_AUTH_ENABLED=true
GITHUB_CLIENT_ID=your_github_client_id
GITHUB_CLIENT_SECRET=your_github_client_secret
GITHUB_CALLBACK_URL=http://localhost:8011/api/auth/github/callback

# Google Authentication
GOOGLE_AUTH_ENABLED=true
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
GOOGLE_CALLBACK_URL=http://localhost:8011/api/auth/google/callback
Note: Do not use these example values directly. Configure them according to your actual environment. Make sure to use secure keys and passwords in production environments.