Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xuqingfeng/caddy-rate-limit
A rate limit plugin for caddy
https://github.com/xuqingfeng/caddy-rate-limit
caddy rate-limit
Last synced: 16 days ago
JSON representation
A rate limit plugin for caddy
- Host: GitHub
- URL: https://github.com/xuqingfeng/caddy-rate-limit
- Owner: xuqingfeng
- License: mit
- Created: 2016-07-05T14:08:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-04-12T04:28:13.000Z (over 3 years ago)
- Last Synced: 2024-08-01T00:43:12.454Z (3 months ago)
- Topics: caddy, rate-limit
- Language: Go
- Homepage: https://caddyserver.com/docs/http.ratelimit
- Size: 3.58 MB
- Stars: 67
- Watchers: 8
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## caddy-rate-limit
>a `rate limit` plugin for [caddy](https://caddyserver.com/)
**Only support Caddy v1, try on https://github.com/mholt/caddy-ratelimit if you are using v2**
[](https://travis-ci.org/xuqingfeng/caddy-rate-limit)
[](https://pkg.go.dev/github.com/xuqingfeng/caddy-rate-limit?tab=doc)
### Syntax
**Excessive requests will be terminated with an error 429 (Too Many Requests)! And `X-RateLimit-RetryAfter` header will be returned.**
For single resource:
```
ratelimit methods path rate burst unit
```
- `methods` are the request methods it will match (comma separately)
- `path` is the file or directory to apply `rate limit`
- `rate` is the limited request in every time unit (r/s, r/m, r/h, r/d, r/w) (e.g. 1)
- `burst` is the maximum burst size client can exceed; burst >= rate (e.g. 2)
- `unit` is the time interval (currently support: `second`, `minute`, `hour`, `day`, `week`)
For multiple resources:
```
ratelimit methods rate burst unit {
whitelist CIDR,CIDR
limit_by_header xxx
status xxx,xxx
resources
}
```
- `whitelist` is the keyword for whitelist your trusted ips (comma separately). [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) is the IP range you don't want to perform `rate limit`. `whitelist` is a general rule, it won't target for specific resource.
- `limit_by_header` is the keyword for matching the [request header](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields). Like `whitelist`, it's also a general rule.
**Note:** normally you shouldn't apply this rule unless the default `limit by ip` is not what you want and you want to `limit by request header`(e.g. `Authorization`).
- `status` is the keyword for matching the [response status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) (comma separately).
If this rule is triggered, all subsequent requests from that client will be blocked regardless of which status code is returned or which resource is requested.
**Note:** this won't block resources not defined in `ratelimit`'s config.
- `resources` is a list of files/directories to apply `rate limit`, one per line
**Note:** If you don't want to apply `rate limit` on some special resources, add `^` in front of the path.
### Examples
Limit clients to 2 requests per second (bursts of 3) to any methods and any resources under /r:
```
ratelimit * /r 2 3 second
```
Don't perform `rate limit` if requests come from **1.2.3.4** or **192.168.1.0/30(192.168.1.0 ~ 192.168.1.3)**, for the listed paths, limit clients to 2 requests per minute (bursts of 2) if the request method is **GET** or **POST** and always ignore `/dist/app.js`:
```
ratelimit get,post 2 2 minute {
whitelist 1.2.3.4/32,192.168.1.0/30
status *
/foo.html
/api
^/dist/app.js
}
```
### Download
`curl https://getcaddy.com | bash -s personal http.ratelimit`
### Docker
```bash
docker run -d -p 2016:2016 -v `pwd`/Caddyfile:/Caddyfile -v `pwd`/test_site:/test_site --name ratelimit xuqingfeng/caddy-rate-limit
```
---
**Inspired by**
[http://nginx.org/en/docs/http/ngx_http_limit_req_module.html](http://nginx.org/en/docs/http/ngx_http_limit_req_module.html)
[https://github.com/didip/tollbooth](https://github.com/didip/tollbooth)