LibreQoS/README.md

36 lines
2.6 KiB
Markdown
Raw Normal View History

2022-09-04 15:35:38 -05:00
<a href="https://libreqos.io/"><img alt="LibreQoS" src="https://raw.githubusercontent.com/rchac/LibreQoS/main/docs/banner2022.png"></a>
2022-09-11 14:30:40 -05:00
LibreQoS is a Quality of Experience and Smart Queue Management system designed for Internet Service Providers (such as Fixed Wireless Internet Service Providers) to optimize the flow of their network traffic and thus reduce bufferbloat, keep the network responsive, and improve the end-user experience.
Because customers see greater performance, ISPs receive fewer support tickets/calls and reduce network traffic from fewer retransmissions.
A sub-$1000 server running LibreQoS can shape traffic for hundreds or thousands of customers at over 10 Gbps.
2022-09-04 15:35:38 -05:00
Learn more at [LibreQoS.io](https://libreqos.io/)
2022-09-07 12:18:52 -05:00
## System Requirements
2022-09-11 14:30:40 -05:00
* VM or physical server. Physical server will have higher throughput (XDP vs generic XDP).
2022-09-09 21:02:01 -05:00
* One management network interface, completely separate from the traffic shaping interfaces. Usually this would be the Ethernet interface built in to the motherboard.
* Dedicated Network Interface Card
* NIC must have two or more interfaces for traffic shaping.
* NIC must have multiple TX/RX transmit queues. [Here's how to check from the command line](https://serverfault.com/questions/772380/how-to-tell-if-nic-has-multiqueue-enabled).
* Known supported cards:
* [NVIDIA ConnectX-4 MCX4121A-XCAT](https://store.mellanox.com/products/nvidia-mcx4121a-xcat-connectx-4-lx-en-adapter-card-10gbe-dual-port-sfp28-pcie3-0-x8-rohs-r6.html)
* [Intel X710](https://www.fs.com/products/75600.html)
* Intel X520
* [Ubuntu Server 22.04](https://ubuntu.com/download/server) or above recommended. All guides assume Ubuntu Server 21.10 or above. Ubuntu Desktop is not recommended as it uses NetworkManager instead of Netplan.
* Kernel version 5.14 or above
* Python 3, PIP, and some modules (listed in respective guides).
* Choose a CPU with solid [single-thread performance](https://www.cpubenchmark.net/singleThread.html) within your budget.
* Recommendations for 10G+ throughput:
* [AMD Ryzen 9 5900X](https://www.bestbuy.com/site/amd-ryzen-9-5900x-4th-gen-12-core-24-threads-unlocked-desktop-processor-without-cooler/6438942.p?skuId=6438942)
* [Intel Core i7-12700KF](https://www.bestbuy.com/site/intel-core-i7-12700kf-desktop-processor-12-8p-4e-cores-up-to-5-0-ghz-unlocked-lga1700-600-series-chipset-125w/6483674.p?skuId=6483674)
2022-09-10 19:37:08 -05:00
2022-09-11 14:30:40 -05:00
## Versions
IPv4 + IPv6:
- [v1.2-alpha](https://github.com/rchac/LibreQoS/tree/main/v1.2)
2022-09-07 12:18:52 -05:00
2022-09-11 14:30:40 -05:00
IPv4 only:
- [v1.1-beta](https://github.com/rchac/LibreQoS/tree/main/v1.1)
- [v1.0-stable](https://github.com/rchac/LibreQoS/tree/main/v1.0)