Conduit
Conduit
Docsllms.txtHostingGitHubIntroduction

Getting Started

OverviewInstall ConduitMCP SetupYour First AppStart with AI

Learn

ArchitectureClient vs Admin APIConfiguration

Modules

OverviewAuthenticationAuthorizationDatabaseStorageCommunicationsChatRouterFunctions

Guides

Next.js IntegrationReBAC Team ScopingGitOps State Export

Deployment

Deployment OverviewDocker ComposeKubernetes and HelmLocal from SourceContainer Images

Reference

CLI ReferenceClient APIAdmin APIEnvironment VariablesMCP Tools

Resources

Migration v0.16 → v0.17Legacy DocumentationChangelogFAQGlossaryContributing

Environment Variables

Core and module environment variable reference — ports, gRPC, and readiness tuning.

Every module process

VariableRequiredPurpose
CONDUIT_SERVERYesCore gRPC address (host:port)
SERVICE_URLYesThis module's reachable address
GRPC_PORTNogRPC bind port (default 5000)
GRPC_KEYProductionShared inter-module secret

Core / ports

VariableDefaultPurpose
ADMIN_HTTP_PORT3030Admin API, /ready, /live, MCP (/mcp)
CLIENT_HTTP_PORT3000Client API (router)
CLIENT_SOCKET_PORT3001Client WebSockets
REDIS_HOST / REDIS_PORT—Config bus

Core readiness (READY_*)

Set on the core process. Controls GET /ready deep health evaluation:

VariableDefaultPurpose
READY_REQUIRED_MODULES(empty)Comma-separated modules that must register before ready (Helm sets database or database,router)
READY_CHECK_REDIStrueInclude Redis PING in readiness
READY_STRICTfalseFail readiness when optional modules are not serving
READY_PROBE_MODULES_ACTIVEfalseActively gRPC-health-check each module
READY_TOTAL_TIMEOUT_MS3000Overall readiness evaluation budget
READY_REDIS_TIMEOUT_MS500Redis PING timeout
READY_MODULE_TIMEOUT_MS1000Per-module health probe timeout

Example for a minimal compose stack:

READY_REQUIRED_MODULES=database,router
READY_CHECK_REDIS=true

Database module

VariablePurpose
DB_CONN_URIMongoDB or PostgreSQL connection string

See Kubernetes and Helm for probe and READY_REQUIRED_MODULES defaults in the official chart, and deployment guides for compose-specific overrides.

Admin API

REST, GraphQL, and WebSocket admin surface on core — auth, scope, health, and MCP relationship.

MCP Tools

How Admin API routes map to MCP tool names — modules, exclusions, and bulk operations.

On this page

Every module processCore / portsCore readiness (READY_*)Database module