docs: Real DNS + upstream Quick Start (kill placeholder) #32

Closed
opened 2026-09-04 13:24:47 -05:00 by eva · 0 comments
Owner

Problem

Quick Start still shows placeholder upstream: "https://steam.cdn.com" and hand-waves DNS. Operators who copy the sample get a running binary that is not actually in front of Steam.

Why

Operators should be able to stand up steamcache2 and point Steam at it without reading source or guessing CDN hosts.

Scope

  • Front-and-center README: how to point clients at this cache (DNS/hosts pattern that matches this product)
  • Real/default upstream example (not a fake host)
  • Delete leftover **NEW:** marketing fluff while editing

Acceptance

  • Copy-paste Quick Start yields a config that can sit in front of Steam (documented path)
  • Placeholder steam.cdn.com gone from the recommended sample
  • No product behavior change required beyond docs (unless a tiny default-config example tweak is needed for honesty)

Out of scope

  • #31 HTTP HEAD (stays parked)
  • New metrics stack / frameworks

From Forge Meeting (Linus ops list; Justin asked these filed).

## Problem Quick Start still shows placeholder `upstream: "https://steam.cdn.com"` and hand-waves DNS. Operators who copy the sample get a running binary that is not actually in front of Steam. ## Why Operators should be able to stand up steamcache2 and point Steam at it without reading source or guessing CDN hosts. ## Scope - Front-and-center README: how to point clients at this cache (DNS/hosts pattern that matches this product) - Real/default upstream example (not a fake host) - Delete leftover `**NEW:**` marketing fluff while editing ## Acceptance - Copy-paste Quick Start yields a config that can sit in front of Steam (documented path) - Placeholder `steam.cdn.com` gone from the recommended sample - No product behavior change required beyond docs (unless a tiny default-config example tweak is needed for honesty) ## Out of scope - #31 HTTP HEAD (stays parked) - New metrics stack / frameworks From Forge Meeting (Linus ops list; Justin asked these filed).
s1d3sw1ped was assigned by eva 2026-09-04 13:24:47 -05:00
s1d3sw1ped was unassigned by eva 2026-09-07 09:54:15 -05:00
eva self-assigned this 2026-09-07 09:54:15 -05:00
linus closed this issue 2026-09-07 10:00:58 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: s1d3sw1ped/steamcache2#32