Relationships
#4727 Document trusted telemetry endpoint and authentication semantics
Opened by stack72 · 11/13/2026
Documentation surface
The canonical user documentation is the Swamp Club manual in the swamp-club site. This change belongs there, not in the CLI repository README.
Problem
The manual documents telemetryEndpoint resolution and separately documents that signed-in telemetry sends the active API key for attribution. It does not state their combined trust contract: authenticated telemetry sends that key to the resolved telemetry endpoint.
This is intentional for operator-controlled and in-prem telemetry collectors, but the trusted deployment boundary needs to be explicit.
Requested documentation
Update these existing manual pages:
content/manual/reference/repository-configuration.md, undertelemetryEndpoint: identify it as trusted deployment configuration for an operator-controlled collector.content/manual/reference/usage-telemetry-events.md, underEndpoint: state that the resolved endpoint is also the destination for the authentication header when telemetry is attributed.content/manual/explanation/usage-telemetry.md, underAttribution: connect API-key attribution to the resolved endpoint and link to the endpoint reference.
Acceptance criteria
- Document endpoint precedence:
SWAMP_TELEMETRY_ENDPOINT, repository marker, localhost auto-detection, then the hosted default. - State that custom telemetry endpoints must be controlled by the trusted deployment operator.
- State that signed-in telemetry forwards the active API key using the
x-api-keyrequest header to the resolved endpoint for attribution. - Provide guidance for organization-managed and in-prem telemetry collectors.
- Clarify that repository telemetry configuration is trusted deployment configuration, not a security boundary intended for arbitrary public repository content.
Non-goal
This issue does not add origin restrictions. Any future credential-to-origin binding must support managed in-prem deployments without breaking authenticated telemetry.
Open
No activity in this phase yet.
Sign in to post a ripple.