https://github.com/inkeep/agents-optional-local-dev
A repo for helping you set up optional services when developing locally with the Inkeep agent framework
https://github.com/inkeep/agents-optional-local-dev
Last synced: 5 months ago
JSON representation
A repo for helping you set up optional services when developing locally with the Inkeep agent framework
- Host: GitHub
- URL: https://github.com/inkeep/agents-optional-local-dev
- Owner: inkeep
- Created: 2025-09-13T02:55:35.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-23T16:24:09.000Z (8 months ago)
- Last Synced: 2025-12-03T08:27:59.607Z (6 months ago)
- Size: 704 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/NangoHQ/nango)
Inkeep Agents uses Nango to store credentials.
- **Nango Server**: `localhost:3050`
- **Nango Connect UI**: `localhost:3051`
### 2. [SigNoz](https://github.com/SigNoz/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](https://github.com/open-telemetry/opentelemetry-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](https://github.com/jaegertracing/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
```bash
cp .env.example .env && \
encryption_key=$(openssl rand -base64 32) && \
sed -i '' "s||$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
### Updating
```
docker-compose stop
docker-compose rm -f
docker-compose pull
docker-compose up -d
```