Inkeep Agents Docker Compose for Optional Local Dev

Warning

These Docker Compose configurations are for local development and testing only.
They are not suitable for production use and should not be deployed in live environments.

Services Overview

This setup provides 4 main service profiles for local development with the Inkeep Agents Framework:

1. Nango

Inkeep Agents uses Nango to store credentials.

• Nango Server: localhost:3050
• Nango Connect UI: localhost:3051

2. SigNoz

SigNoz is the underlying service to view Spans and Traces in the Inkeep Manage UI.

• SigNoz UI: localhost:3080
• OTLP gRPC: localhost:4317
• OTLP HTTP: localhost:4318

3. OTEL Collector

A standalone OpenTelemetry Collector, to manage outgoing can be sent to multiple destinations. The Inkeep Agents Run API will first send traces to the OTEL Collector, which then forwards traces to Signoz and Jaeger.

• OTLP gRPC: localhost:14317
• OTLP HTTP: localhost:14318

4. Jaeger

An optional misc tool to view traces from the Inkeep Agents Framework.

• Jaeger UI: localhost:16686
• OTLP gRPC: localhost:24317
• OTLP HTTP: localhost:24318

Steps

1. Clone this repository

2. Configure environment variables

cp .env.example .env && \
  encryption_key=$(openssl rand -base64 32) && \
  sed -i '' "s|<REPLACE_WITH_BASE64_256BIT_ENCRYPTION_KEY>|$encryption_key|" .env && \
  echo "Docker environment file created with auto-generated encryption key"

3. Start

Start the full stack from deploy/docker (includes Nango, Signoz, OTEL Collector, and Jaeger)

docker compose up -d

4. Retreive NANGO_SECRET_KEY

• Open Nango at http://localhost:3050
• Navigate to Environment Settings and copy the Secret Key

5. Create SIGNOZ_API_KEY

• Open SigNoz at http://localhost:3080
• Create an account on first login if needed
• Navigate to Settings → Account Settings → API Keys → New Key
• Create a new API key with at least the Viewer role