From 1faa7ce25dcc054c41f183a0d0842ed5295162f3 Mon Sep 17 00:00:00 2001 From: Felix Matouschek Date: Thu, 16 Apr 2026 20:42:32 +0200 Subject: [PATCH] docs: Update AGENTS.md and README.md for rate limiting changes Add pkg/ratelimit/ to project structure, include make functest in pre-submit checklist, remove stale enabled fields and add idleSeconds to YAML config example. Co-Authored-By: Claude Sonnet 4.6 Signed-off-by: Felix Matouschek --- AGENTS.md | 5 +++-- README.md | 3 +-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 2a4d62c..42a37d3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -15,8 +15,8 @@ HTTP request, ACMEDNS, DirectAdmin Legacy, plain HTTP). - `make lint` - Lint with golangci-lint - `make vendor` - Tidy and vendor dependencies -Always run `make lint` and `make test` before submitting changes. -Run `make vendor` after modifying dependencies. +Always run `make lint`, `make test`, and `make functest` before submitting +changes. Run `make vendor` after modifying dependencies. ## Code Style @@ -45,6 +45,7 @@ Run `make vendor` after modifying dependencies. - `pkg/middleware/clean/` - Record cleanup (cloud/ backend) - `pkg/hetzner/` - Hetzner Cloud API client helpers - `pkg/data/` - Shared data types +- `pkg/ratelimit/` - Per-client-IP rate limiting (token bucket) - `pkg/sanitize/` - Input sanitization ## Git diff --git a/README.md b/README.md index aa97789..79fd502 100644 --- a/README.md +++ b/README.md @@ -84,11 +84,10 @@ listenAddr: :8081 trustedProxies: - 127.0.0.1 rateLimit: - enabled: true rps: 5 burst: 10 + idleSeconds: 600 lockout: - enabled: true maxAttempts: 10 durationSeconds: 3600 windowSeconds: 900