{"id":41235918,"url":"https://github.com/inkeep/agents-optional-local-dev","last_synced_at":"2026-01-23T01:03:31.575Z","repository":{"id":315308035,"uuid":"1055909624","full_name":"inkeep/agents-optional-local-dev","owner":"inkeep","description":"A repo for helping you set up optional services when developing locally with the Inkeep agent framework","archived":false,"fork":false,"pushed_at":"2025-10-23T16:24:09.000Z","size":721,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-03T08:27:59.607Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inkeep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-13T02:55:35.000Z","updated_at":"2025-10-23T16:24:12.000Z","dependencies_parsed_at":"2025-09-17T22:22:16.092Z","dependency_job_id":"46dbacbf-a498-42a2-9c79-2b65c55f0766","html_url":"https://github.com/inkeep/agents-optional-local-dev","commit_stats":null,"previous_names":["inkeep/agents-optional-local-dev"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/inkeep/agents-optional-local-dev","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fagents-optional-local-dev","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fagents-optional-local-dev/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fagents-optional-local-dev/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fagents-optional-local-dev/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inkeep","download_url":"https://codeload.github.com/inkeep/agents-optional-local-dev/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkeep%2Fagents-optional-local-dev/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28676490,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T01:00:35.747Z","status":"ssl_error","status_checked_at":"2026-01-23T01:00:19.529Z","response_time":144,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-23T01:03:31.480Z","updated_at":"2026-01-23T01:03:31.545Z","avatar_url":"https://github.com/inkeep.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Inkeep Agents Docker Compose for Optional Local Dev\n\n\u003e [!WARNING]\n\u003e These Docker Compose configurations are **for local development and testing only**.  \n\u003e They are **not suitable for production use** and should not be deployed in live environments.\n\n## Services Overview\n\nThis setup provides 4 main service profiles for local development with the Inkeep Agents Framework:\n\n### 1. [Nango](https://github.com/NangoHQ/nango)\nInkeep Agents uses Nango to store credentials.\n- **Nango Server**: `localhost:3050`\n- **Nango Connect UI**: `localhost:3051`\n\n### 2. [SigNoz](https://github.com/SigNoz/signoz)\nSigNoz is the underlying service to view Spans and Traces in the Inkeep Manage UI.\n- **SigNoz UI**: `localhost:3080`\n- **OTLP gRPC**: `localhost:4317`\n- **OTLP HTTP**: `localhost:4318`\n\n### 3. [OTEL Collector](https://github.com/open-telemetry/opentelemetry-collector)\nA 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.\n- **OTLP gRPC**: `localhost:14317`\n- **OTLP HTTP**: `localhost:14318`\n\n### 4. [Jaeger](https://github.com/jaegertracing/jaeger)\nAn optional misc tool to view traces from the Inkeep Agents Framework.\n- **Jaeger UI**: `localhost:16686`\n- **OTLP gRPC**: `localhost:24317`\n- **OTLP HTTP**: `localhost:24318`\n\n## Steps\n\n### 1. Clone this repository\n\n### 2. Configure environment variables\n\n```bash\ncp .env.example .env \u0026\u0026 \\\n  encryption_key=$(openssl rand -base64 32) \u0026\u0026 \\\n  sed -i '' \"s|\u003cREPLACE_WITH_BASE64_256BIT_ENCRYPTION_KEY\u003e|$encryption_key|\" .env \u0026\u0026 \\\n  echo \"Docker environment file created with auto-generated encryption key\"\n```\n\n### 3. Start\nStart the full stack from deploy/docker (includes Nango, Signoz, OTEL Collector, and Jaeger)\n```\ndocker compose up -d\n```\n\n### 4. Retreive `NANGO_SECRET_KEY`\n\n- Open Nango at `http://localhost:3050`\n- Navigate to Environment Settings and copy the Secret Key\n\n### 5. Create `SIGNOZ_API_KEY`\n\n- Open SigNoz at `http://localhost:3080`\n- Create an account on first login if needed\n- Navigate to Settings → Account Settings → API Keys → New Key\n- Create a new API key with at least the Viewer role\n\n### Updating\n\n```\ndocker-compose stop\ndocker-compose rm -f\ndocker-compose pull\ndocker-compose up -d\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkeep%2Fagents-optional-local-dev","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finkeep%2Fagents-optional-local-dev","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkeep%2Fagents-optional-local-dev/lists"}