Documentation

Documentation.

Everything you need to integrate Brume into your stack.

New here? Start with the quickstart.

Install the SDK, create a client, send your first message. Under 5 minutes.

Quickstart SDK Reference

Guides

Get up and running with Brume Limit

Getting StartedCreate a project, mint an API key, and make your first rate-limit check.Rate LimitingBrume Limit: define rules, evaluate with limit/check, and read X-RateLimit-* headers.AuthenticationAPI key authentication: scopes, hashing, and rotation.Error HandlingError codes, PLAN_LIMIT semantics, and fail-open behavior.WebhooksOutbound webhook delivery for gateway events.

Operations

Deploy, monitor, and scale the gateway

ArchitectureHow the gateway, Redis, Postgres, and the rule cache fit together.DeploymentReverse proxy, TLS, health checks, and zero-downtime systemd upgrades.SecurityKey hashing, payload limits, TLS enforcement, and the privacy architecture.BenchmarksWorkload, hardware, and latency methodology for Brume measurements.

Runbooks

Operational runbooks for incident response and recovery

Runbook: Deploy RollbackZero-downtime deploy procedure and the rollback path if it goes wrong.Runbook: Redis FailoverHow to handle a Redis failover or outage in the rate-limit path.

Migration

Move from Unkey or Upstash to Brume Limit.

Migrate from UnkeySide-by-side code swap from Unkey rate limiting to Brume Limit.Migrate from UpstashReplace @upstash/ratelimit and its Redis with one HTTP call.