Skip to main content
Version: v0.16

Environment Variables Reference

Complete reference of environment variables for Conduit Core and modules.

Core

VariableRequiredDescriptionDefault
REDIS_HOSTYesRedis host-
REDIS_PORTYesRedis port-
ADMIN_HTTP_PORTNoAdmin REST/GraphQL port3030
ADMIN_SOCKET_PORTNoAdmin WebSocket port3031
GRPC_PORTNogRPC server port55152
MASTER_KEYNoAdmin request authorization-
GRPC_KEYNogRPC signed request protection-
METRICS_PORTNoPrometheus metrics port-

Common Module Variables

All modules support:

VariableRequiredDescriptionDefault
CONDUIT_SERVERYesCore address-
SERVICE_URLNoService address for LB-
GRPC_PORTNoModule gRPC port-
GRPC_KEYNogRPC signed request protection-
METRICS_PORTNoPrometheus metrics port-

Database

VariableRequiredDescriptionDefault
DB_TYPENoDatabase typemongodb
DB_CONN_URINoConnection string-

Router

VariableRequiredDescriptionDefault
CLIENT_HTTP_PORTNoREST/GraphQL port3000
CLIENT_SOCKET_PORTNoWebSocket port3001

Admin Panel (UI)

VariableRequiredDescriptionDefault
CONDUIT_URLYesCore admin URL-
PROMETHEUS_URLNoPrometheus URL for metrics-

Example Configuration

# Core
REDIS_HOST=localhost
REDIS_PORT=6379
MASTER_KEY=your-secure-key
GRPC_KEY=your-grpc-secret

# Database
CONDUIT_SERVER=localhost:55152
DB_TYPE=mongodb
DB_CONN_URI=mongodb://localhost:27017/conduit

# Router
CONDUIT_SERVER=localhost:55152
CLIENT_HTTP_PORT=3000
CLIENT_SOCKET_PORT=3001

# Authentication
CONDUIT_SERVER=localhost:55152

Security Notes

  1. Always set MASTER_KEY in production
  2. Use GRPC_KEY for inter-service security
  3. Don't expose internal ports publicly
  4. Use secrets management for sensitive values