From 5b604077ceff847b3ecd50a68d6eb0b1c0393cd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Chac=C3=B3n?= Date: Fri, 9 Jul 2021 11:55:40 -0600 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f673d6e7..069183cb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,20 @@ ![Banner](docs/Banner.png "Banner") LibreQoS is an application that allows ISPs to apply bandwidth rate limiting to hundreds of clients through cake or fq_codel. Cake and fq_codel are Free and Open Source Active Queue Management algorithms that reduce bufferbloat. When used in the context of an ISP network, these AQMs can be deployed to shape traffic on each customer's connection - reducing latency, enforcing advertised plan bandwidth, and improving network performance. LibreQoS directs each customer's traffic through an individual cake or fq_codel instance, which acts as part of a hierarchy token bucket. Traffic can be shaped by site or by Access Point, in addition to by subscriber. Please test to ensure compatability with your network architecture and design before deploying in production. ## Who is LibreQoS for? -This software is intended for Internet Service Providers. Internet Service Providers with more than 1000 subscribers may benefit more from using commercially supported alternatives with NMS/CRM integrations such as Preseem or Saisei. Individuals wanting to reduce bufferbloat or latency on their home internet connections may want to try a home router supporting fq_codel, such as Ubiquiti's EdgeRouter-X (must enable advanced queue fq_codel). +This software is intended for Internet Service Providers. Internet Service Providers with more than 1000 subscribers may benefit more from using commercially supported alternatives with NMS/CRM integrations such as Preseem or Saisei. +``` +╔══════════╦══════╦═══════════╦══════════╦══════╦═════╦═════════╦══════════════════╦══════════════════╗ +║ ║ IPv4 ║ IPv6 ║ fq_codel ║ cake ║ DPI ║ Metrics ║ Shape By ║ Throughput ║ +╠══════════╬══════╬═══════════╬══════════╬══════╬═════╬═════════╬══════════════════╬══════════════════╣ +║ LibreQoS ║ ✔ ║ v0.8 only ║ ✔ ║ ✔ ║ ║ ║ AP, Client ║ 10G+ (v0.9 only) ║ +╠══════════╬══════╬═══════════╬══════════╬══════╬═════╬═════════╬══════════════════╬══════════════════╣ +║ Preseem ║ ✔ ║ ✔ ║ ✔ ║ ║ ║ ✔ ║ Site, AP, Client ║ 20G+ ║ +╠══════════╬══════╬═══════════╬══════════╬══════╬═════╬═════════╬══════════════════╬══════════════════╣ +║ Seisei ║ ✔ ║ ✔ ║ ? ║ ? ║ ✔ ║ ✔ ║ ? ║ 10G ║ +╚══════════╩══════╩═══════════╩══════════╩══════╩═════╩═════════╩══════════════════╩══════════════════╝ +``` +Individuals wanting to reduce bufferbloat or latency on their home internet connections may want to try a home router supporting fq_codel, such as Ubiquiti's EdgeRouter-X (must enable advanced queue fq_codel). + ## How does fq_codel work? Fq_codel distinguishes interactive flows of traffic (web browsing, audio streaming, VoIP, gaming) from bulk traffic (streaming video services, software updates). Interactive flows are prioritized to optimize their performance, while bulk traffic gets steady throughput and variable latency. The general reduction of connection latency offered by fq_codel is highly beneficial to end-users.