Getting Started
This documentation guides you through every aspect of the distributed rate limiter—from architectural concepts to production deployment. Whether you're integrating it into an existing service, tuning performance, or deploying at scale, you'll find detailed explanations, code examples, and troubleshooting guidance.
Documentation Overview
Core Concepts
Learn why rate limiting must be distributed, how the system resolves configuration, and the architecture behind consistent enforcement.
Quick Integration
Get up and running in 5 minutes with Spring Boot. Includes filter setup, configuration basics, and your first request flow.
Algorithms
Understand the 4 rate-limiting algorithms: Token Bucket, Leaky Bucket, Fixed Counter, and Sliding Window. Learn when to use each.
Deployment & Ops
Docker Compose, Kubernetes, Helm, infrastructure sizing, and operational runbooks for production systems.
Security & Performance
IP spoofing protection, trusted proxy configuration, memory usage, Redis operations per request, and scaling triggers.
Advanced Topics
Integration recipes, monitoring with Prometheus and Grafana, testing strategies, and comprehensive troubleshooting.
Pro Tip: Use the search bar (Ctrl+K) to quickly find specific topics, algorithms, or configuration details.
Start with "Architecture and Concepts" if you're new, or jump to "Integrate in 5 Minutes" if you want to get hands-on immediately.
Each document includes headings and sub-sections for easy navigation within specific topics.