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

Configuration

Module config via Admin API, config bus, environment variables, and readiness tuning.

Conduit stores module configuration in core. Changes propagate over the config bus (Redis pub/sub). Modules implement onConfig lifecycle hooks.

Reading config

  • Admin panel UI
  • Admin API GET /config and GET /config/{module}
  • MCP: get_config, get_config_{module}

Updating config

  • Admin panel
  • MCP: patch_config_{module} with a config body
  • Admin API PATCH /config/{module}

Never patch production config from application runtime code.

Readiness configuration

Core's deep readiness probe (GET /ready) evaluates bootstrap state, gRPC health, Redis, and module registration. Tune behavior with READY_* environment variables on the core process:

VariableDefaultPurpose
READY_REQUIRED_MODULES(empty)Comma-separated module names that must be registered and serving before /ready returns 200
READY_CHECK_REDIStruePING Redis as part of readiness
READY_STRICTfalseWhen true, optional modules that are not serving fail readiness (not just warn)
READY_PROBE_MODULES_ACTIVEfalseWhen true, actively gRPC-health-check each module instead of trusting registry serving flag
READY_TOTAL_TIMEOUT_MS3000Overall budget for the readiness evaluation
READY_REDIS_TIMEOUT_MS500Timeout for Redis PING
READY_MODULE_TIMEOUT_MS1000Per-module health probe timeout

Helm sets READY_REQUIRED_MODULES automatically on the core deployment. Override in core.env when running custom topologies.

Environment variables

Every module process requires:

VariablePurpose
CONDUIT_SERVERCore gRPC address (host:port) — required
SERVICE_URLThis module's reachable address for discovery
GRPC_PORTgRPC bind port (default 5000)
GRPC_KEYShared secret for inter-module gRPC

See Environment variables reference for the full list.

Client vs Admin API

Which API to use in apps, MCP, and server-side code — and what never to mix.

Overview

Conduit Platform modules overview.

On this page

Reading configUpdating configReadiness configurationEnvironment variables