Skip to content

Security and Secrets

  • Secrets

    API keys for providers and DB credentials loaded from environment.

  • Validation

    /api/secrets/check verifies which provider keys are configured (never returns values).

  • Least Privilege

    Restrict DB users and network access.

Get started Configuration API

Separate Environments

Use different credentials per environment (dev, staging, prod). Never reuse production secrets locally.

.env Hygiene

.env is for local dev only. In production, use a secret manager and inject env vars securely.

Transport Security

Terminate TLS in front of the API service. Restrict DB ports to private networks.

Secrets Check

import httpx
print(httpx.get("http://127.0.0.1:8012/api/secrets/check", params={"keys": "OPENAI_API_KEY,ANTHROPIC_API_KEY"}).json())

curl -sS "http://127.0.0.1:8012/api/secrets/check?keys=OPENAI_API_KEY,ANTHROPIC_API_KEY" | jq .

async function secrets() {
  console.log(await (await fetch('/api/secrets/check?keys=OPENAI_API_KEY,ANTHROPIC_API_KEY')).json());
}

Credentials withheld from the browser

Two config fields are credential-shaped, and the API never puts their secret halves on the wire (server/config_redaction.py):

Field What is withheld What stays editable
indexing.postgres_url The password inside the DSN Host, port, database, user
tracing.otlp_headers The value of any authorization-type header (Authorization, Proxy-Authorization, Api-Key, or a name containing token/secret/password/apikey) Every other header, e.g. X-Scope-OrgID

The same two values ride in the config snapshot that every eval, reranker, agent-training and synthetic run record pins, and those records are redacted on the way out of their detail routes too — including records written before redaction existed.

The round-trip contract:

  • GET /api/config (and the credential-shaped defaults in /api/config/registry) serve the marker [redacted] in place of each credential.
  • A write (PUT or section PATCH) that returns the marker restores the stored value — "unchanged".
  • Typing a real value rotates it. A marker with nothing stored behind it is refused with a typed 422 rather than persisted as a literal.

If a config field shows [redacted]

That is the withheld-credential marker, not a corrupted value. The Infrastructure → Paths & Stores and RAG → Retrieval → Ops & Tracing forms say so in place; leave the marker to keep the current secret.

The MCP bearer key is different on purpose: MCP_API_KEY is an environment secret and is never read from config, because config is served to the browser. See MCP.

Where this lives

  • Redaction helpers: server/config_redaction.py
  • Config routes: server/api/config.py; run records: server/api/eval.py, server/api/reranker.py, server/api/agent.py, server/synthetic/orchestrator.py
  • Round-trip coverage: tests/api/test_config_redaction.py

Environment Keys (Selected)

Key Purpose
OPENAI_API_KEY, VOYAGE_API_KEY, COHERE_API_KEY, JINA_API_KEY Provider access for embedding/gen/rerank
POSTGRES_* DB connection for pgvector + FTS
MCP_API_KEY Bearer token enforced by the embedded MCP transport when mcp.require_api_key=true — environment only, never a config field
NEO4J_* Neo4j connection
SERVER_PORT API service port
CONFIG_FILE Path to tribrid_config.json 
flowchart LR
    Env["Environment"] --> API
    API --> Check["/api/secrets/check"]
    Check --> Report["Status"]

Audit

Log access to admin endpoints (/api/config, /api/docker/*, /api/reranker/*). Monitor for unusual patterns in logs and metrics.