Conduit
Conduit
Docsllms.txtHostingGitHubIntroduction

Getting Started

OverviewInstall ConduitMCP SetupYour First AppStart with AI

Learn

ArchitectureClient vs Admin APIConfiguration

Modules

OverviewAuthenticationAuthorizationDatabaseEmbeddingsStorageCommunicationsChatRouterFunctions

Guides

Next.js IntegrationReBAC Team ScopingGitOps State Export

Deployment

Deployment OverviewDocker ComposeKubernetes and HelmLocal from SourceContainer Images

Reference

CLI ReferenceClient APIAdmin APIgRPC SDKEnvironment VariablesMCP Tools

Resources

Migration v0.16 → v0.17Legacy DocumentationChangelogFAQGlossaryContributing

Docker Compose

Run Conduit microservices or standalone with Docker Compose.

Microservices mode

From Conduit/docker/:

  1. Copy .env, set GRPC_KEY and DB_CONN_URI
  2. Choose profile: --profile mongodb or --profile postgres
  3. Run: docker compose --profile mongodb up -d

Images: docker.io/conduitplatform/{module}:${IMAGE_TAG}.

Embeddings (opt-in)

Embeddings is a separate module image. Enable the compose profile in addition to mongodb or postgres:

# Production images refuse an empty GRPC_KEY.
export GRPC_KEY='replace-with-a-non-empty-key'
docker compose --profile mongodb --profile embeddings up
  • Image: docker.io/conduitplatform/embeddings:${IMAGE_TAG}. Pin IMAGE_TAG to a published embeddings tag; do not pull embeddings:latest until that tag exists.
  • gRPC: ${EMBEDDINGS_GRPC_PORT:-55165}
  • Metrics: Prometheus scrapes conduit-embeddings:9192

The profile starts the process with module convict enabled still false. Check capabilities, configure the provider catalogue, wait for a queryable vector index, then enable workers with patch_config_embeddings. See Embeddings.

Standalone mode

docker compose -f docker-compose.standalone.yml up -d

Bundles core + default modules in conduit-standalone via PM2. Requires Redis + MongoDB only. Embeddings is not included in standalone v1 — use microservices compose with --profile embeddings after a published tag.

Admin UI

conduit-ui container on port 8080, configured with CONDUIT_URL pointing at Admin API.

CLI alternative

npx @conduitplatform/cli deploy setup

See Install.

Deployment Overview

Choose how to run Conduit — local dev, Docker Compose, Kubernetes, or from source.

Kubernetes and Helm

Deploy Conduit with the official Helm chart — probes, readiness, and production layout.

On this page

Microservices modeEmbeddings (opt-in)Standalone modeAdmin UICLI alternative