Documentation
TideGuard docs are short on purpose. Start with the guide that matches your job.
Canonical project: github.com/TideGuard/TideGuard · site tideguard.dev. Operator guides here are mirrored at tideguard.dev/docs. If you forked or deployed from a copy, check upstream for newer guides and releases before assuming this checkout is current. AI assistants: see AGENTS.md.
| Guide | Audience |
|---|---|
| Getting started | Operators deploying or running locally for the first time |
| Upgrading | Pull a newer TideGuard into an existing Cloudflare deploy |
| Launch checklist | Pre-production go-live review |
| Custom domain | Point a hostname at TideGuard — full NS setup or partial (Business) CNAME |
| Protecting a domain or origin | Origin proxy, AOP, WAF/bot notes once DNS is on Cloudflare |
| Verifying admission | Redirect URL, click-to-enter hold, how to verify tokens at the origin |
| Architecture | Engineers who need the Workers / Durable Object / KV story |
| Hosted SaaS | Planning: hosted tier, WorkOS/Paddle/Convex patterns, Starter vs Dedicated |
| API | Anyone integrating join, status, tokens, or operator routes |
| Admin | Set up /admin, invite operators, branding, traffic, deep-links |
| Analytics | Live metrics + 24h traffic chart / CSV export; geo-block hits (operator traffic, not GA) |
| IP allowlist | Staff bypass, Pass queue, and Cloudflare zone helpers from admin |
| Waiting-room rules | Crawler/cookie/header bypass, JSON redirects, and full-queue rejection |
| Country block | Temporary event-window geo gate via CF-IPCountry |
| Operator webhooks | HTTPS callbacks for pause, health, depth, schedule, capacity + test ping |
| TOKEN_SECRET rotation | Rotate TOKEN_SECRET / introduce optional ADMIN_SECRET safely |
| Load testing | Contributors validating queue behavior at scale |
Project overview and sales pitch live in the root README. Planned work: ROADMAP.md (not the changelog). Published guides: tideguard.dev/docs. Security expectations live in SECURITY.md. Operator Terms of Service: TERMS.md. MIT license: LICENSE.