Architeuthis/README.md
2019-05-29 22:49:51 -04:00

52 lines
1.2 KiB
Markdown

# Architeuthis 🦑
[![CodeFactor](https://www.codefactor.io/repository/github/simon987/architeuthis/badge)](https://www.codefactor.io/repository/github/simon987/architeuthis)
![GitHub](https://img.shields.io/github/license/simon987/Architeuthis.svg)
*NOTE: this is very WIP*
HTTP(S) proxy with integrated load-balancing, rate-limiting
and error handling. Built for automated web scraping.
* Strictly obeys configured rate-limiting for each IP & Host
* Seamless exponential backoff retries on timeout or error HTTP codes
* Requires no additional configuration for integration into existing programs
### Typical use case
![user_case](use_case.png)
### Sample configuration
```json
{
"addr": "localhost:5050",
"timeout": "15s",
"wait": "4s",
"multiplier": 2.5,
"retries": 3,
"proxies": [
{
"name": "squid_P0",
"url": "http://user:pass@p0.exemple.com:8080"
},
{
"name": "privoxy_P1",
"url": "http://p1.exemple.com:8080"
}
],
"hosts": {
"*": {
"every": "750ms",
"burst": 5,
"headers": {}
},
"reddit.com": {
"every": "2s",
"burst": 2,
"headers": {"User-Agent": "mybot_v0.1"}
}
}
}
```