anonfunc/upload-baker
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added more details to readme

Browse Source
This commit is contained in:
Giovanni Harting
2022-07-05 20:25:43 +02:00
parent 9be30184db
commit 60a25ad2ea
1 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,3 +1,23 @@
# upload-baker
Auto-adjusts cake (or similar qdisc with bandwidth option) for your upload based on latency.
Auto-adjusts cake (or similar qdisc with bandwidth option) for your upload based on latency.
## How it works
`upload-baker` monitors your latency to a configurable host periodically.
As soon as the latency goes above the configured value (e.g. 50ms), it throttles the upload bandwidth.
### Examples
Some examples below, recorded with telegraf & rendered with grafana.
#### Throttling
![](https://git.harting.dev/anonfunc/upload-baker/raw/branch/master/doc/image_down.png)
#### Recovery
![](https://git.harting.dev/anonfunc/upload-baker/raw/branch/master/doc/image_ramp-up.png)
## Limitations
The mechanism used is not perfect, meaning increased latency
can have more possibly causes than varying upload bandwidth from your isp
(which is the main goal this project tries to solve).