Skip to content

Commit dbd5ad6

Browse files
authored
docs(orb): correct the anonymization-key description in .env.example (#1280)
The Orb exporter anonymizes with a dedicated, randomly-generated per-instance secret stored in system_flags (since #1257), not a key derived from the App private key. Corrects the .env.example TELEMETRY NOTICE prose to match the shipped code.
1 parent 9f67e6a commit dbd5ad6

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

.env.example

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,9 +188,10 @@ GITTENSORY_REVIEW_DRAFT=false
188188
#
189189
# WHAT IS SENT (per resolved PR, hourly): the gate verdict, the realized outcome (merged/closed), a reversal
190190
# flag, a bucketed reason category, and cycle time. NEVER sent: repo/owner/PR names, commit SHAs, code,
191-
# diffs, comments, or logins. Repo/PR identifiers are HMAC-anonymized with a DEDICATED key derived from YOUR
192-
# OWN App private key (GITHUB_APP_PRIVATE_KEY) — high-entropy and independent of your webhook secret, so even
193-
# gittensory (running the collector) can never de-anonymize them.
191+
# diffs, comments, or logins. Repo/PR identifiers are HMAC-anonymized with a DEDICATED, randomly-generated
192+
# per-instance secret created once and stored in your instance's own database (never your App private key or
193+
# webhook secret) — and the collector never holds it, so even gittensory (running the collector) can never
194+
# de-anonymize them.
194195
# The export carries no shared key; the collector treats it as untrusted, rate-limited, aggregate-only data.
195196
# ORB_AIR_GAP=false # air-gapped/OFFLINE deployments only: compute locally, never send
196197
# ORB_ANONYMIZE=true # HMAC-hash repo/PR before export (default true; false = raw names)

0 commit comments

Comments
 (0)