Environment Variables

This page documents every environment variable used by the eTeamups Platform. A reference file with sensible development defaults is provided at docker.local.env in the repository root. Copy it to .env for local development:

cp docker.local.env .env

Database (MongoDB)

Notes:

• The local Docker Compose stack maps MongoDB container port 27017 to host port 27018. Make sure your MONGODB_URL uses port 27018 for local development.
• In production, use strong credentials and a connection string pointing to your managed MongoDB instance.

Redis

Redis is used by BullMQ for the message queue. The MessageQueue singleton reads REDIS_HOST and REDIS_PORT to configure its connection.

JWT / Authentication Tokens

Notes:

• Always use a strong, unique JWT_SECRET in production. The local default is intentionally weak and clearly marked.
• Token expiry values accept duration strings such as 24h, 7d, 15m, etc.

Application

Service Ports

These variables are referenced in production configurations and Docker setups. The development config files (server.config.dev.ts) hardcode the port values directly, so these variables are primarily used in production and Docker contexts.

Email

Notes:

• The primary email transport uses the Resend API. SMTP variables (EMAIL_HOST, EMAIL_PORT, etc.) are available for alternative configurations but are not required when using Resend.
• For local development, email sending can be skipped or pointed at a service like Mailpit for testing.

CORS

Multiple origins are specified as a comma-separated string. The default allows both the local Nginx gateway (https://localhost:18443) and a typical frontend dev server (http://localhost:3000).

OpenTelemetry / Observability

Notes:

• OpenTelemetry is disabled by default for local development. Set OPEN_TELEMENTRY=true to enable it.
• The platform uses the OpenTelemetry Node.js SDK with auto-instrumentation. Traces and logs are exported via OTLP/HTTP.
• The Winston logger includes an OpenTelemetryTransportV3 that forwards log entries to the configured OTLP logs endpoint.
• Instrumentation is bootstrapped in instrumentation.ts at the project root and in libs/server/src/tracer.ts.

Authorization (Permit.io)

These variables configure Permit.io for fine-grained authorization decisions. They are optional for basic local development but required if you are working on authorization-related features.

Complete Example

Below is a minimal .env file for local development. All values match the defaults in docker.local.env:

# Database
MONGODB_URL=mongodb://admin:password123@localhost:27018/eteamups?authSource=admin
MONGO_INITDB_ROOT_USERNAME=admin
MONGO_INITDB_ROOT_PASSWORD=password123
MONGO_INITDB_DATABASE=eteamups

# Redis
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=

# JWT
JWT_SECRET=your-local-jwt-secret-key-change-this-in-production
JWT_EXPIRY=24h

# Application
NODE_ENV=development
LOG_LEVEL=debug
BASE_URL=https://admin.zeswa.dev
API_BASE_URL=https://localhost:18443

# Service Ports
AUTH_SERVICE_PORT=9000
PROFILE_SERVICE_PORT=9100
ORGANISATION_SERVICE_PORT=9107
MEDIA_SERVICE_PORT=9102

# Email
RESEND_API_KEY=your-resend-api-key
EMAIL_FROM=noreply@mail.eteamups.com

# CORS
CORS_ORIGIN=https://localhost:18443,http://localhost:3000

# OpenTelemetry (disabled by default)
OPEN_TELEMENTRY=false
OTEL_SERVICE_NAME=eteamsup-platform-env

Production Considerations

When deploying to production, ensure the following:

• JWT_SECRET is a cryptographically strong random string, unique per environment.
• MONGO_INITDB_ROOT_PASSWORD and MONGODB_URL use strong, rotated credentials.
• REDIS_PASSWORD is set if your Redis instance requires authentication.
• CORS_ORIGIN is restricted to your actual frontend domain(s).
• NODE_ENV is set to production.
• LOG_LEVEL is set to info or warn to reduce log volume.
• OPEN_TELEMENTRY is set to true with OTEL_EXPORTER_OTLP_ENDPOINT pointing to your observability backend.
• Secrets (JWT_SECRET, RESEND_API_KEY, NEXT_PUBLIC_PERMIT_SDK_KEY, database passwords) are managed through a secrets manager or environment-specific configuration, not committed to version control.