Update README.md

This commit is contained in:
Robert Chacón
2022-10-19 20:31:57 -06:00
committed by GitHub
parent 22bc9d03ce
commit 66b7abc3ab

View File

@@ -28,6 +28,10 @@ Fast, multi-CPU queueing leveraging xdp-cpumap-tc. Tested up to 11 Gbps of real
### Graphing
Graph bandwidth by client and node (Site, AP, etc), with great visalizations made possible by InfluxDB
### CRM Integrations
* UISP (v1.2+)
* Splynx (v1.3+)
## 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.
@@ -35,20 +39,20 @@ Graph bandwidth by client and node (Site, AP, etc), with great visalizations mad
* 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)
* [NVIDIA Mellanox MCX512A-ACAT](https://www.fs.com/products/119649.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
* [Ubuntu Server 22.04](https://ubuntu.com/download/server) or above. All guides assume Ubuntu Server. Ubuntu Desktop is not recommended as it uses NetworkManager instead of Netplan. Kernel version 5.15 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:
* Recommendations for 10G+ throughput on a budget:
* [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)
## Versions
IPv4 + IPv6:
- [v1.2](https://github.com/rchac/LibreQoS/tree/main/v1.2)
- [v1.3-alpha](https://github.com/rchac/LibreQoS/tree/main/v1.3)
IPv4 only:
- [v1.1](https://github.com/rchac/LibreQoS/tree/main/v1.1)