A fully customizable rate limiter designed to apply rate limiting on individual APIs with specific rules.
Why not? With some free time on hand, RateShield was created to explore the potential of building a versatile rate-limiting solution. What started as a side project is evolving into a powerful tool for developers.
-
Customizable Limiting:
Tailor rate limiting rules to each API endpoint according to your needs. -
Intuitive Dashboard:
A user-friendly interface to monitor and manage all your rate limits effectively. -
Easy Integration:
Plug-and-play middleware that seamlessly integrates into your existing infrastructure.
-
Preventing Abuse:
Control the number of requests your APIs can handle to prevent misuse and malicious activities. -
Cost Management:
Manage third-party API calls efficiently to avoid unexpected overages.
- Token Bucket
- Fixed Window Counter
- Sliding Window
Check out this document.
Before setting up RateShield, ensure you have the following:
- Docker & Docker Compose - Required for running the application and Redis infrastructure
- Redis Stack (included in docker-compose):
- Single Redis instance for storing rate limit rules (port 6379)
- Redis Cluster with 6 nodes (3 masters + 3 replicas) for distributed rate limiting (ports 7000-7005)
- ReJSON module enabled (automatically included with redis/redis-stack image)
- Slack Integration (for error notifications):
- Slack Bot Token
- Slack Channel ID
Quick Start with Docker Compose:
The provided docker-compose.yml includes everything you need - no separate Redis setup required!
cd rate_shield
cp .env.example .env
# Edit .env with your Slack credentials
docker-compose up -dFor detailed setup instructions, see SETUP.md.
Interested in contributing? We'd love your help! Check out our Contribution Guidelines to get started.