IntenseWebs/LibreQoS
3
0
Fork 0
mirror of https://github.com/LibreQoE/LibreQoS.git synced 2024-11-22 08:16:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

chore: 📝 rebuild docs

Browse Source
This commit is contained in:
bile0026 2023-05-19 12:42:07 -05:00
parent 03bb72f04e
commit 20c58309a8
No known key found for this signature in database
8 changed files with 55 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
_build/doctrees/README.doctree
View File

Binary file not shown.

BIN
_build/doctrees/environment.pickle
View File

Binary file not shown.

43
_build/html/README.html
View File

@ -17,8 +17,8 @@
<script src="_static/js/theme.js"></script> <script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="LibreQoE Quickstart Guide" href="docs/Quickstart/quickstart.html" /> <link rel="next" title="Network Design Assumptions" href="docs/Quickstart/networkdesignassumptions.html" />
<link rel="prev" title="Welcome to the LibreQoE documentation!" href="index.html" /> <link rel="prev" title="Welcome to the LibreQoS documentation!" href="index.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -44,6 +44,7 @@
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Sponsors</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Sponsors</a></li>
<li class="toctree-l1"><a class="reference internal" href="#support-libreqos">Support LibreQoS</a></li> <li class="toctree-l1"><a class="reference internal" href="#support-libreqos">Support LibreQoS</a></li>
<li class="toctree-l1"><a class="reference internal" href="#documentation">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="#matrix-chat">Matrix Chat</a></li> <li class="toctree-l1"><a class="reference internal" href="#matrix-chat">Matrix Chat</a></li>
<li class="toctree-l1"><a class="reference internal" href="#features">Features</a><ul> <li class="toctree-l1"><a class="reference internal" href="#features">Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#flexible-hierarchical-shaping-back-haul-congestion-mitigation">Flexible Hierarchical Shaping / Back-Haul Congestion Mitigation</a></li> <li class="toctree-l2"><a class="reference internal" href="#flexible-hierarchical-shaping-back-haul-congestion-mitigation">Flexible Hierarchical Shaping / Back-Haul Congestion Mitigation</a></li>
@ -54,10 +55,36 @@
</ul> </ul>
</li> </li>
</ul> </ul>
<p class="caption" role="heading"><span class="caption-text">Read me first!</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/Quickstart/networkdesignassumptions.html">Network Design Assumptions</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Change Notes:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/ChangeNotes/v1.4.html">LibreQoS v1.3.1 to v1.4 Change Summary</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Quickstart:</span></p> <p class="caption" role="heading"><span class="caption-text">Quickstart:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="docs/Quickstart/quickstart.html">LibreQoE Quickstart Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="docs/SystemRequirements/Compute.html">System Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Quickstart/readthisfirst.html">Network Design Assumptions</a></li> <li class="toctree-l1"><a class="reference internal" href="docs/SystemRequirements/Networking.html">Network Interface Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Quickstart/quickstart-prereq.html">Server Setup - Pre-requisites</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Quickstart/quickstart-libreqos-1.4.html">Install LibreQoS 1.4</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Quickstart/share.html">Share your before and after</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Updates:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/Updates/update.html">Updating 1.4 To Latest Version</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Technical Documentation:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/TechnicalDocs/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/TechnicalDocs/integrations.html">Integrations</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/TechnicalDocs/extras.html">Extras</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/TechnicalDocs/performance-tuning.html">Performance Tuning</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Legacy:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/Legacy/v1.3.1.html">LibreQoS v1.3.1</a></li>
</ul> </ul>
</div> </div>
@ -97,6 +124,10 @@ Learn more about <a class="reference external" href="https://deploy.equinix.com/
<h1>Support LibreQoS<a class="headerlink" href="#support-libreqos" title="Permalink to this heading"></a></h1> <h1>Support LibreQoS<a class="headerlink" href="#support-libreqos" title="Permalink to this heading"></a></h1>
<p>Please support the continued development of LibreQoS by sponsoring us via <a class="reference external" href="https://github.com/sponsors/LibreQoE">GitHub Sponsors</a> or <a class="reference external" href="https://patreon.com/libreqos">Patreon</a>.</p> <p>Please support the continued development of LibreQoS by sponsoring us via <a class="reference external" href="https://github.com/sponsors/LibreQoE">GitHub Sponsors</a> or <a class="reference external" href="https://patreon.com/libreqos">Patreon</a>.</p>
</section> </section>
<section id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading"></a></h1>
<p><a class="reference external" href="https://libreqos.readthedocs.io">Docs</a></p>
</section>
<section id="matrix-chat"> <section id="matrix-chat">
<h1>Matrix Chat<a class="headerlink" href="#matrix-chat" title="Permalink to this heading"></a></h1> <h1>Matrix Chat<a class="headerlink" href="#matrix-chat" title="Permalink to this heading"></a></h1>
<p>Our Matrix chat channel is available at <a class="reference external" href="https://matrix.to/#/#libreqos:matrix.org">https://matrix.to/#/#libreqos:matrix.org</a>.</p> <p>Our Matrix chat channel is available at <a class="reference external" href="https://matrix.to/#/#libreqos:matrix.org">https://matrix.to/#/#libreqos:matrix.org</a>.</p>
@ -134,8 +165,8 @@ Learn more about <a class="reference external" href="https://deploy.equinix.com/
</div> </div>
</div> </div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to the LibreQoE documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="index.html" class="btn btn-neutral float-left" title="Welcome to the LibreQoS documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="docs/Quickstart/quickstart.html" class="btn btn-neutral float-right" title="LibreQoE Quickstart Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="docs/Quickstart/networkdesignassumptions.html" class="btn btn-neutral float-right" title="Network Design Assumptions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div> </div>
<hr/> <hr/>

16
_build/html/_sources/README.md.txt
View File

@ -7,6 +7,7 @@ Servers running LibreQoS can shape traffic for many thousands of customers.
Learn more at [LibreQoS.io](https://libreqos.io/)! Learn more at [LibreQoS.io](https://libreqos.io/)!
## Sponsors ## Sponsors
Special thanks to Equinix for providing server resources to support the development of LibreQoS. Special thanks to Equinix for providing server resources to support the development of LibreQoS.
Learn more about [Equinix Metal here](https://deploy.equinix.com/metal/). Learn more about [Equinix Metal here](https://deploy.equinix.com/metal/).
@ -14,28 +15,37 @@ Learn more about [Equinix Metal here](https://deploy.equinix.com/metal/).
Please support the continued development of LibreQoS by sponsoring us via [GitHub Sponsors](https://github.com/sponsors/LibreQoE) or [Patreon](https://patreon.com/libreqos). Please support the continued development of LibreQoS by sponsoring us via [GitHub Sponsors](https://github.com/sponsors/LibreQoE) or [Patreon](https://patreon.com/libreqos).
## Documentation
[Docs](https://libreqos.readthedocs.io)
## Matrix Chat ## Matrix Chat
Our Matrix chat channel is available at [https://matrix.to/#/#libreqos:matrix.org](https://matrix.to/#/#libreqos:matrix.org). Our Matrix chat channel is available at [https://matrix.to/#/#libreqos:matrix.org](https://matrix.to/#/#libreqos:matrix.org).
<img alt="LibreQoS" src="https://user-images.githubusercontent.com/22501920/223866474-603e1112-e2e6-4c67-93e4-44c17b1b7c43.png"></a> <img alt="LibreQoS" src="https://user-images.githubusercontent.com/22501920/223866474-603e1112-e2e6-4c67-93e4-44c17b1b7c43.png"></a>
## Features ## Features
### Flexible Hierarchical Shaping / Back-Haul Congestion Mitigation ### Flexible Hierarchical Shaping / Back-Haul Congestion Mitigation
<img src="https://raw.githubusercontent.com/LibreQoE/LibreQoS/main/docs/nestedHTB2.png" width="350"></img> <img src="https://raw.githubusercontent.com/LibreQoE/LibreQoS/main/docs/nestedHTB2.png" width="350"></img>
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 site’s 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. 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 site’s 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
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. 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 ### 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. 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 ### Graphing
You can graph bandwidth and TCP RTT by client and node (Site, AP, etc), using InfluxDB. You can graph bandwidth and TCP RTT by client and node (Site, AP, etc), using InfluxDB.
### CRM Integrations ### CRM Integrations
* UISP
* Splynx - UISP
- Splynx

1
_build/html/genindex.html
View File

@ -41,6 +41,7 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Sponsors</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html">Sponsors</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#support-libreqos">Support LibreQoS</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#support-libreqos">Support LibreQoS</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#documentation">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#matrix-chat">Matrix Chat</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#matrix-chat">Matrix Chat</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#features">Features</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#features">Features</a></li>
</ul> </ul>

2
_build/html/index.html
View File

@ -43,6 +43,7 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Sponsors</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html">Sponsors</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#support-libreqos">Support LibreQoS</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#support-libreqos">Support LibreQoS</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#documentation">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#matrix-chat">Matrix Chat</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#matrix-chat">Matrix Chat</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#features">Features</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#features">Features</a></li>
</ul> </ul>
@ -109,6 +110,7 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Sponsors</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html">Sponsors</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#support-libreqos">Support LibreQoS</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#support-libreqos">Support LibreQoS</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#documentation">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#matrix-chat">Matrix Chat</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#matrix-chat">Matrix Chat</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#features">Features</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#features">Features</a></li>
</ul> </ul>

1
_build/html/search.html
View File

@ -44,6 +44,7 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Sponsors</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html">Sponsors</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#support-libreqos">Support LibreQoS</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#support-libreqos">Support LibreQoS</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#documentation">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#matrix-chat">Matrix Chat</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#matrix-chat">Matrix Chat</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#features">Features</a></li> <li class="toctree-l1"><a class="reference internal" href="README.html#features">Features</a></li>
</ul> </ul>

2
_build/html/searchindex.js
View File

File diff suppressed because one or more lines are too long