2020-10-02 10:44:48 -05:00
|
|
|
# LibreQoS
|
2020-10-02 11:06:54 -05:00
|
|
|
A simple way to shape hundreds of clients and reduce bufferbloat using cake or fq_codel. This is alpha software, please do not deploy in production.
|
2020-10-02 10:55:22 -05:00
|
|
|
|
2020-10-02 11:29:16 -05:00
|
|
|
## Lab Requirements
|
2020-10-02 11:33:45 -05:00
|
|
|
* Edge and Core routers with MTU 1500 on links between them
|
2020-10-02 11:29:16 -05:00
|
|
|
* OSPF primary link (low cost) through the server running LibreQoS
|
|
|
|
|
* OSPF backup link recommended
|
|
|
|
|
|
|
|
|
|
## Server Requirements
|
|
|
|
|
* VM or physical server
|
2020-10-02 11:35:03 -05:00
|
|
|
* One management network interface
|
|
|
|
|
* Two dedicated network interface cards, preferably SFP+ capable
|
2020-10-02 11:29:16 -05:00
|
|
|
* 8GB RAM or more recommended
|
2020-10-02 10:55:22 -05:00
|
|
|
* Python 3
|
2020-10-02 10:44:48 -05:00
|
|
|
* Recent Linux kernel
|
|
|
|
|
* tc (available via package iproute2)
|
|
|
|
|
* Cake
|
|
|
|
|
|
|
|
|
|
git clone https://github.com/dtaht/sch_cake.git
|
|
|
|
|
|
|
|
|
|
cd sch_cake
|
|
|
|
|
make; sudo make install
|
|
|
|
|
|
|
|
|
|
## Features
|
2020-10-02 10:55:22 -05:00
|
|
|
* Cake (Common Applications Kept Enhanced)
|
2020-10-02 10:47:56 -05:00
|
|
|
* fq_codel
|
2020-10-02 10:55:22 -05:00
|
|
|
* HTB (Hierarchy Token Bucket)
|
|
|
|
|
* tc filters divided into groups with hashing filters to significantly increase efficiency
|
2020-10-02 10:44:48 -05:00
|
|
|
|
2020-10-02 10:59:58 -05:00
|
|
|
## How to use
|
2020-10-02 11:33:45 -05:00
|
|
|
* Add linux interface bridge br0 to the two dedicated interfaces
|
2020-10-02 10:59:58 -05:00
|
|
|
* Modify setting parameters in LibreQoS.py to suit your environment
|
|
|
|
|
* Run:
|
|
|
|
|
sudo python3 ./LibreQoS.py
|
|
|
|
|
|
|
|
|
|
## Special Thanks
|
2020-10-02 11:00:35 -05:00
|
|
|
Thank you to the hundreds of contributors to the cake and fq_codel projects.
|
2020-10-02 10:59:58 -05:00
|
|
|
|
2020-10-02 11:33:45 -05:00
|
|
|
## References
|
|
|
|
|
* https://tldp.org/HOWTO/Adv-Routing-HOWTO/lartc.adv-filter.hashing.html
|
|
|
|
|
* http://linux-ip.net/gl/tc-filters/tc-filters.html
|
|
|
|
|
|
2020-10-02 10:44:48 -05:00
|
|
|
## License
|
2020-10-02 11:01:17 -05:00
|
|
|
Copyright (C) 2020 Robert Chacón
|
2020-10-02 10:44:48 -05:00
|
|
|
|
|
|
|
|
LibreQoS is free software: you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
|
the Free Software Foundation, either version 2 of the License, or
|
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
2020-10-02 10:48:37 -05:00
|
|
|
LibreQoS is distributed in the hope that it will be useful,
|
2020-10-02 10:44:48 -05:00
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
|
along with LibreQoS. If not, see <http://www.gnu.org/licenses/>.
|
