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
Herbert Wolverson 890c8b05ec Change RTT tracking to reduce erroneous appearance of low-traffic flows.
* Change the "median_rtt" function signature to return an Option
  rather than 0.0 on "no data".
* Change the "median_rtt" function to return None for flows with
  less than 1 mbit of traffic.
* Change the "worst rtt" list to ignore any None entries.
* Change the "funnel" view to only report RTT when there is
  a value.
2023-06-09 19:54:13 +00:00
_readthedocs test 2023-05-19 14:17:54 -06:00
.github Create CODE_OF_CONDUCT.md 2023-03-23 14:13:19 -06:00
docs docs: 📝 update a bunch of formatting and clarifications 2023-05-19 13:58:30 -05:00
old/v1.3 replaceRootNote should be replaceRootNode 2023-03-31 13:07:15 +13:00
sim More test tools 2022-12-11 09:05:09 -08:00
src Change RTT tracking to reduce erroneous appearance of low-traffic flows. 2023-06-09 19:54:13 +00:00
.DS_Store docs: 📝 update a bunch of formatting and clarifications 2023-05-19 13:58:30 -05:00
.gitignore feat: 🎉 base docs structure 2023-05-19 10:43:52 -05:00
.gitmodules Add back v1.3 directory 2023-02-06 18:41:23 -07:00
conf.py docs: 📝 update a bunch of formatting and clarifications 2023-05-19 13:58:30 -05:00
CONTRIBUTING.md 1st Draft of CONTRIBUTING.md 2023-03-27 08:03:12 -07:00
index.rst docs: 📝 update a bunch of formatting and clarifications 2023-05-19 13:58:30 -05:00
LICENSE Initial commit 2020-10-02 09:18:14 -06:00
make.bat Update make.bat 2023-05-19 14:02:54 -06:00
Makefile Update Makefile 2023-05-19 14:02:39 -06:00
README.md Merge branch 'main' into develop 2023-05-26 13:39:49 +00:00
requirements_dev.txt docs: 📝 update a bunch of formatting and clarifications 2023-05-19 13:58:30 -05:00
requirements.txt Update requirements.txt 2023-05-19 13:43:42 -06:00

LibreQoS

LibreQoS is a Quality of Experience (QoE) Smart Queue Management (SQM) system designed for 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.

Servers running LibreQoS can shape traffic for many thousands of customers.

Learn more at LibreQoS.io!

Sponsors

Special thanks to Equinix for providing server resources to support the development of LibreQoS. Learn more about Equinix Metal here.

Support LibreQoS

Please support the continued development of LibreQoS by sponsoring us via GitHub Sponsors or Patreon.

Documentation

Docs

Matrix Chat

Our Matrix chat channel is available at https://matrix.to/#/#libreqos:matrix.org.

LibreQoS

Features

Flexible Hierarchical Shaping / Back-Haul Congestion Mitigation

Starting in version v1.1+, operators can map their network hierarchy in LibreQoS. This enables both simple network hierarchies (Site>AP>Client) as well as much more complex ones (Site>Site>Micro-PoP>AP>Site>AP>Client). This can be used to ensure that a given sites peak bandwidth will not exceed the capacity of its back-haul links (back-haul congestion control). Operators can support more users on the same network equipment with LibreQoS than with competing QoE solutions which only shape by AP and Client.

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. 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 and cpumap-pping. Currently tested in the real world past 11 Gbps (so far) with just 30% CPU use on a 16 core Intel Xeon Gold 6254. It's likely capable of 30Gbps or more.

Graphing

You can graph bandwidth and TCP RTT by client and node (Site, AP, etc), using InfluxDB.

CRM Integrations

Server Recommendations

It is most cost-effective to buy a used server with specifications matching your unique requirements, as laid out in the System Requirements section below. For those who do not have the time to do that, here are some off-the-shelf options to consider:

The AsRock 1U4LW-B6502L2T can be a great lower-cost option as well.

System Requirements

VM or physical server

  • For VMs, NIC passthrough is required for optimal throughput and latency (XDP vs generic XDP). Using Virtio / bridging is much slower than NIC passthrough. Virtio / bridging should not be used for large amounts of traffic.

CPU

  • 2 or more CPU cores
  • A CPU with solid single-thread performance within your budget. Queuing is very CPU-intensive, and requires high single-thread performance.

Single-thread CPU performance will determine the max throughput of a single HTB (cpu core), and in turn, what max speed plan you can offer customers.

Customer Max Plan Passmark Single-Thread
100 Mbps 1000
250 Mbps 1500
500 Mbps 2000
1 Gbps 2500
2 Gbps 3000

Below is a table of approximate aggregate throughput capacity, assuming a a CPU with a single thread performance of 2700 or greater:

Aggregate Throughput CPU Cores
500 Mbps 2
1 Gbps 4
5 Gbps 6
10 Gbps 8
20 Gbps 16
50 Gbps* 32

(* Estimated)

So for example, an ISP delivering 1Gbps service plans with 10Gbps aggregate throughput would choose a CPU with a 2500+ single-thread score and 8 cores, such as the Intel Xeon E-2388G @ 3.20GHz.

Memory

  • Minimum RAM = 2 + (0.002 x Subscriber Count) GB
  • Recommended RAM:
Subscribers RAM
100 4 GB
1,000 8 GB
5,000 16 GB
10,000* 18 GB
50,000* 24 GB

(* Estimated)

Network Interface Requirements

  • 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 for Shaping Interfaces

Get Started