Skip to content

docs(readme): make every claim true and current - #11

Merged
georgiedekker merged 1 commit into
mainfrom
lane/readme-quality
Nov 15, 2026
Merged

georgiedekker merged 1 commit into
mainfrom
lane/readme-quality

Conversation

@nonagenticai-claude

Copy link
Copy Markdown
Contributor

README-only. Corrects the configuration table, tenant fallback description, local-run command and CI description.

Corrections and proof

Claim Old New Proof
DEFAULT_TENANT_ID default n8n-dev (unset) — no default src/config/settings.py has no default_tenant_id field (see the comment where it would be); .venv/lib/python3.14/site-packages/coding_client/auth/_default_tenant.py — os.getenv("DEFAULT_TENANT_ID", "").strip() or None, i.e. None when unset
Tenant fallback unconditional when header absent trusted-CIDR networks only; otherwise 401 coding_client/auth/_default_tenant.py (resolve_default_tenant); src/auth/tenant.py re-exports the SDK middleware
DATABASE_URL default postgresql+psycopg://... "" src/config/settings.py — database_url: str = ""
REDIS_URL default redis://redis:6379/0 "" src/config/settings.py — redis_url: str = ""
CONTAINERS_SERVICE_URL default http://coding-containers:8691 "" src/config/settings.py — containers_service_url: str = ""
OpenTelemetry variable OTEL_EXPORTER_OTLP_ENDPOINT OTEL_ENDPOINT="" (present, unwired) + OTLP_TRACES_ENDPOINT (unset, actual) src/config/settings.py otel_endpoint; .venv/.../coding_client/telemetry.py:156 reads OTLP_TRACES_ENDPOINT
Production requirements "all optional with defaults" four URLs required in production src/config/settings.py _REQUIRED_IN_PRODUCTION = ("database_url", "redis_url", "containers_service_url", "docker_registry_url")
Redis "optional; service operates without it" required in production; validation cache + durable scan queue same _REQUIRED_IN_PRODUCTION; src/app_factory.py:39-112; src/services/scan_queue.py
Table completeness 13 rows all 41 Settings fields (core + scanning/worker tables) src/config/settings.py; checked programmatically that every field appears
Worker semantics — SCAN_MAX_DELIVERIES dead-letters; SCAN_STREAM_MAXLEN caps the stream src/services/scan_worker.py:20,180; src/services/scan_queue.py:131
Local run uv run uvicorn main:app ... ENVIRONMENT=testing PYTHONPATH=src uv run uvicorn main:app ... src/main.py; Dockerfile:234 sets PYTHONPATH=/app/src; import verified locally with that environment
CI/CD image pushed to 192.168.1.114:5000/..., promoted to :latest public reusable workflow, GHCR ghcr.io/nonagenticai/coding-security, no deploy job, weekly rebuild .github/workflows/ci.yml
Path in directory tree routers/security.py routers/security/ src/routers/security/
Licensing / NOTICE — preserved unchanged; NOTICE still referenced README.md ## Licensing + ## License; NOTICE

Verification

  • git diff --stat — README.md only (71 insertions, 25 deletions).
  • Pre-push hook passed: secret scan, ruff check, ruff format --check, ty@0.0.104 check src, full pytest.
  • No remaining occurrences of the stale defaults; the only n8n-dev text now explains that no such fallback exists.

🤖 Generated with Claude Code

- correct DEFAULT_TENANT_ID, DATABASE_URL, REDIS_URL, CONTAINERS_SERVICE_URL
  and the OpenTelemetry defaults against src/config/settings.py
- describe the trusted-CIDR tenant fallback and the production-required URLs
- document every Settings field; Redis is required in production, not optional
- fix the local-run command and replace the stale registry/CI description

Co-Authored-By: Claude Code <noreply@anthropic.com>
Signed-off-by: georgiedekker <georgiedekker@gmail.com>
@georgiedekker
georgiedekker merged commit 5fd8942 into main Nov 15, 2026
7 checks passed
@georgiedekker
georgiedekker deleted the lane/readme-quality branch November 15, 2026 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant