A Quality of Experience and Smart Queue Management system for ISPs. Leverage CAKE to improve network responsiveness, enforce bandwidth plans, and reduce bufferbloat.
Go to file
2022-09-12 22:40:39 -06:00
docs Add files via upload 2022-09-12 22:37:14 -06:00
v0.7 Delete new.txt 2021-07-01 23:53:20 -06:00
v0.8 Update README.md 2022-09-11 13:27:02 -06:00
v0.9 Update README.md 2022-09-11 13:26:34 -06:00
v1.0 Update README.md 2022-09-11 13:25:34 -06:00
v1.1 typo correction 2022-09-12 01:38:23 -06:00
v1.2 add +x permission for LibreQoS.py 2022-09-12 20:19:57 +02:00
.gitmodules add xdp-cpumap-tc to v1.2 2022-09-05 07:57:08 -06:00
LICENSE Initial commit 2020-10-02 09:18:14 -06:00
README.md Update README.md 2022-09-12 22:40:39 -06:00

LibreQoS

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.

Learn more at LibreQoS.io

LibreQoS

Major Features

Flexible Hierarchical Shaping

Network hierarchy can be mapped to a json file in v1.1+. This allows for both simple network heirarchies (Site>AP>Client) as well as much more complex ones (Site>Site>Micro-PoP>AP>Site>AP>Client). This allows operators to ensure a given sites peak bandwidth will not exceed the capacity of its back-haul links (back-haul congestion control). This can allow operators to support more users on the same network equipment with LibreQoS than with competing QoE solutions which only shape by AP and Client. Shaping just by AP and client could allow for high aggregate peaks to occur on back-hauls links, which can trigger packet loss and disrupt network connectivity. LibreQoS flexible shaping provides a solution to this.

CAKE

CAKE is the product of nearly a decade of development efforts to improve on fq_codel. With the diffserv_4 parameter enabled CAKE groups traffic in to Bulk, Best Effort, Video, and Voice. This means that without having to fine-tune traffic priorities as you would with DPI products CAKE automatically ensures your clients OS update downloads will not disrupt their zoom calls. It allows for multiple video conferences to operate on the same connection which might otherwise “fight” for upload bandwidth causing call disruptions. It holds the connection together like glue. With work-from-home, remote learning, and tele-medicine becoming increasingly common minimizing video call disruptions can save jobs, keep students engaged, and help ensure equitable access to medical care.

XDP

Fast, multi-CPU queueing leveraging xdp-cpumap-tc. Tested up to 11 Gbps of real world traffic with just 30% CPU use on an Intel Xeon Gold 6254. Likely capable of 30Gbps or more.

Graphing

Graph bandwidth by client and node (Site, AP, etc), with great visalizations made possible by InfluxDB

System Requirements

  • VM or physical server. Physical server will have higher throughput (XDP vs generic XDP).
  • 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.
  • Ubuntu Server 22.04 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 within your budget.

Versions

IPv4 + IPv6:

IPv4 only: