IBEX Harness
DocsBenchmarksBlogChangelogRoadmap
GitHub
IBEX Harness

Documentation

IntroductionQuickstart (5 minutes)ConceptsFAQ
Getting Started›FAQ
Getting Started

FAQ

Answers to common setup, security, and capability-boundary questions for the shipped auth + proxy stack.

Quick answers for the questions we hear most during local setup and security review.

Never commit real PATs or provider API keys. Use .env.example as a template and keep secrets in your local .env files only.

Setup

What do I need installed?

Go 1.25+, Docker Desktop (or Docker Engine + Compose), make, and pnpm 9.x for the docs site. See TOOLCHAIN.md in the engineering docs.

Which ports does local dev use?

ServicePort
Proxy HTTP8080
Auth gRPC9091
Postgres5432
Redis6379

Boot the stack:

bash
git clone https://github.com/Rick1330/ibex-harness.git
cd ibex-harness
make compose-dev-up
make db-migrate

Security

Does the proxy fail open on rate limits?

Yes — if Redis is unreachable, requests proceed without rate limiting. This is intentional for availability; see the security integration tests in services/proxy.

Does agent verification fail closed?

Yes. A missing or cross-org X-IBEX-Agent-ID returns 403 before the request reaches provider logic.

Capability boundary

Why do I sometimes see 501 PROVIDER_NOT_CONFIGURED?

That code means the model id is not registered in the active provider registry (typo, or missing from defaults / IBEX_LLM_EXTRA_MODELS). In non-production environments, default IBEX_LLM_MODE=mock returns HTTP 200 for registered models. Mock mode is rejected when IBEX_ENV=production — use IBEX_LLM_MODE=live with OPENAI_API_KEY for live forwarding. See Provider adapters and Chat completions.

Where is the dashboard?

The operator dashboard is Phase 3+. Today the shipped surface is API-only: proxy + auth + this docs site. See current state.

Still stuck?

Open a GitHub issue with your request_id from the error envelope.

Was this page helpful?

Edit on GitHub

Last updated on

PreviousConceptsNextArchitecture

On this page

  • Setup
  • What do I need installed?
  • Which ports does local dev use?
  • Security
  • Does the proxy fail open on rate limits?
  • Does agent verification fail closed?
  • Capability boundary
  • Why do I sometimes see 501 PROVIDER_NOT_CONFIGURED?
  • Where is the dashboard?
  • Still stuck?
0%