docs: public readiness — env reference, clustering guide, README improvements #50

Merged

lerko merged 6 commits from chore/public-readiness into main 2026-06-02 23:53:41 +00:00

Conversation 0 Commits 6 Files Changed 7

+170 -5

lerko commented 2026-06-02 22:26:37 +00:00

Owner

Copy Link

Copy Source

Summary

• .env.example: complete env var reference (21 vars, grouped, self-documenting)
• docs/clustering.md: leader/follower/probe setup guide with security notes
• README: encryption section, clustering summary, upgrading note, 2 new env table rows, releases → GitHub
• CHANGELOG: added missing entries for 2026.05.6 and 2026.06.2
• .gitignore / .dockerignore: added .env and .github/
• Fixed PEER_URL description to include probe nodes

Test plan

• Read README as a first-time user — install paths, env table, links all work
• Verify .env.example covers all code env vars
• Verify docs/clustering.md matches actual cluster behavior
• All internal links resolve

## Summary - `.env.example`: complete env var reference (21 vars, grouped, self-documenting) - `docs/clustering.md`: leader/follower/probe setup guide with security notes - README: encryption section, clustering summary, upgrading note, 2 new env table rows, releases → GitHub - CHANGELOG: added missing entries for 2026.05.6 and 2026.06.2 - `.gitignore` / `.dockerignore`: added `.env` and `.github/` - Fixed PEER_URL description to include probe nodes ## Test plan - Read README as a first-time user — install paths, env table, links all work - Verify .env.example covers all code env vars - Verify docs/clustering.md matches actual cluster behavior - All internal links resolve

lerko added 5 commits 2026-06-02 22:26:37 +00:00

docs: add missing changelog entries for 2026.05.6 and 2026.06.2 ... 056cf9c3f7

Both tags were infrastructure-only (CI/CD pipeline work).
Marked as (infrastructure) to distinguish from user-facing releases.

docs: point release downloads to GitHub mirror ... 21cbaa9ff9

GitHub is the public storefront. Binary releases link to GitHub
where the relay workflow publishes them. Clarify Linux amd64 only
for binary downloads.

docs: add env reference, clustering guide, and README improvements ... 048b245d25

- .env.example: complete env var reference (21 vars, grouped, commented)
- docs/clustering.md: leader/follower/probe setup, aggregation, security
- README: encryption section, clustering summary, upgrading note,
  ALLOW_PRIVATE_TARGETS + ENCRYPTION_KEY in env table, link to .env.example
- .gitignore: add .env to prevent credential leaks

chore: add .env and .github/ to .dockerignore ... 99c0ad8072

Prevent secrets from leaking into Docker build context.
GitHub workflows don't belong in the image.

docs: fix PEER_URL description to include probe nodes d316c5cf1b

lerko added 1 commit 2026-06-02 22:43:17 +00:00

fix(security): bump Go 1.26.3 → 1.26.4 ... 771721abb4

Fixes GO-2026-5039 (net/textproto) and GO-2026-5037 (crypto/x509).

lerko merged commit cc9f04aa2f into main 2026-06-02 23:53:41 +00:00

lerko deleted branch chore/public-readiness 2026-06-02 23:53:41 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

bug

Something isn't working

distribution

Packaging, publishing, branding

feature

New functionality

polish

UX/visual refinement

refactor

Code quality, no behavior change

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

lerko (Tyler Koenig)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lerkolabs/uptop#50