Skip to content

Commit f6e20b0

Browse files
copyleftdevclaude
andcommitted
docs: remove unimplemented rate limit and retention from README
These features are stubs planned for M4. Removed from CLI flags table, TOML example, and resource limits. Marked as planned in project structure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 846ff64 commit f6e20b0

1 file changed

Lines changed: 4 additions & 8 deletions

File tree

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,6 @@ hookbin serve [OPTIONS]
8787
| `--data` | `./hookbin-data` | Data directory for SQLite database |
8888
| `--max-hooks` | `100` | Maximum number of hooks |
8989
| `--max-payload` | `1048576` | Maximum payload size in bytes (1 MB) |
90-
| `--retention` | `86400` | Request retention in seconds (24 hours) |
91-
| `--rate-limit` | `60` | Rate limit per hook (requests/minute) |
9290
| `--max-requests` | `1000` | Max stored requests per hook |
9391
| `--config` || Path to TOML config file |
9492

@@ -100,8 +98,6 @@ port = 8080
10098
data = "/var/lib/hookbin"
10199
max_hooks = 50
102100
max_payload = 2097152
103-
retention = 172800
104-
rate_limit = 120
105101
max_requests = 500
106102
```
107103

@@ -117,11 +113,11 @@ Hookbin follows the [TigerBeetle philosophy](https://tigerbeetle.com/): determin
117113
|----------|---------|--------------|
118114
| Max hooks | 100 | `--max-hooks` |
119115
| Max payload size | 1 MB | `--max-payload` |
120-
| Request retention | 24 hours | `--retention` |
121-
| Rate limit per hook | 60 req/min | `--rate-limit` |
122116
| Max requests per hook | 1,000 | `--max-requests` |
123117
| SQLite WAL mode | Always on ||
124118

119+
**Planned:** rate limiting (per-hook token bucket) and automatic retention cleanup are coming in M4.
120+
125121
Everything is bounded. Nothing grows without limit.
126122

127123
## Build from Source
@@ -166,8 +162,8 @@ src/
166162
models.rs # Hook, Request structs
167163
config.rs # CLI args + TOML config (3-layer merge)
168164
error.rs # AppError with structured suggestions
169-
retention.rs # Background cleanup task
170-
rate_limit.rs # In-process token bucket
165+
retention.rs # Background cleanup task (planned — M4)
166+
rate_limit.rs # In-process token bucket (planned — M4)
171167
handlers/
172168
ingest.rs # POST /h/{hook_id} — capture webhook
173169
hooks.rs # CRUD hooks

0 commit comments

Comments
 (0)