docs: public-facing README + generic configuration docs

Rewrite the README for external users, neutralize example identities in
code comments, generalize the OIDC group note, and simplify the gitleaks
workflow header.
This commit is contained in:
Sulkta 2026-06-28 13:25:25 -07:00
parent b746eacb3e
commit 8a410b0c3c
12 changed files with 118 additions and 58 deletions

View file

@ -1,16 +1,6 @@
# .forgejo/workflows/gitleaks.yml
#
# Sulkta canonical gitleaks workflow. Drop a copy into every public repo at
# `.forgejo/workflows/gitleaks.yml` after the Forgejo act_runner is registered
# (task #295).
#
# Pairs with the pre-receive hook installed on every bare repo — that one is
# the strict enforcement layer (rejects the push); this one provides the
# per-PR red ✗ that branch-protection rules can require before merge.
#
# Layer 1 (this workflow): visible per-PR status, can be a required check.
# Layer 2 (pre-receive hook): strict enforcement at the server.
# Layer 3 (scheduled cron sweep): nightly full-history sweep across all repos.
# Scans the repository for committed secrets with gitleaks on every push and
# pull request. Make it a required status check in branch-protection rules to
# block merges that introduce credentials.
name: gitleaks