IntenseWebs/LibreQoS
3
0
Fork 0
mirror of https://github.com/LibreQoE/LibreQoS.git synced 2025-02-25 18:55:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Robert Chacón 2021-02-27 09:17:43 -07:00 committed by GitHub
parent cfc29b71f0
commit d29588f6b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -44,7 +44,8 @@ sudo python3 -m pip install ipaddress schedule prettytable
### VM Performance ### VM Performance
#### Memory use #### Memory use
On ProxMox VMs you can enable <a href="https://www.reddit.com/r/Proxmox/comments/asakcb/problem_with_ram_cache/">ballooning memory</a> to allow freed up memory to be reclaimed by the hypervisor. On ProxMox VMs you can enable <a href="https://www.reddit.com/r/Proxmox/comments/asakcb/problem_with_ram_cache/">ballooning memory</a> to allow freed up memory to be reclaimed by the hypervisor.
#### Enable Offloading in Guest VM ## How to run LibreQoS
### Enable Offloading in Guest VM
Performance can greatly benefit from enabling certrain hardware offloading inside the guest VM. If you're using a system that uses Netplan (e.g. Ubuntu) to configure the network then you can use a Netplan post-up script to configure offloading. You create a script in the following directory with a name prefixed by a number to indicate load order e.g. /usr/lib/networkd-dispatcher/routable.d/10-enable-offloading - which is executable and owned by root. e.g. Performance can greatly benefit from enabling certrain hardware offloading inside the guest VM. If you're using a system that uses Netplan (e.g. Ubuntu) to configure the network then you can use a Netplan post-up script to configure offloading. You create a script in the following directory with a name prefixed by a number to indicate load order e.g. /usr/lib/networkd-dispatcher/routable.d/10-enable-offloading - which is executable and owned by root. e.g.
``` ```
#!/bin/sh #!/bin/sh
@ -78,7 +79,9 @@ to allow the program to actually run the commands.
### Configure for your clients ### Configure for your clients
* Modify the Shaper.csv file using your preferred spreadsheet editor (LibreOffice Calc, Excel, etc), following the template. * Modify the Shaper.csv file using your preferred spreadsheet editor (LibreOffice Calc, Excel, etc), following the template.
* Either an IPv4 or IPv6 address is required for each entry, and Hostname is recommended. * Either an IPv4 or IPv6 address is required for each entry, and Hostname is recommended.
## Run LibreQoS ## One-Time Runs
One-time runs show the response from the terminal for each filter rule applied, and can be very helpful for debugging and to make sure it is correctly configured.
Cd to your preferred directory and download the latest release Cd to your preferred directory and download the latest release
``` ```
git clone https://github.com/rchac/LibreQoS.git git clone https://github.com/rchac/LibreQoS.git
@ -88,7 +91,7 @@ git clone https://github.com/rchac/LibreQoS.git
``` ```
sudo python3 ./LibreQoS.py sudo python3 ./LibreQoS.py
``` ```
## Running as a service ### Running as a service
You can use the scheduled.py file to set the time of day you want the shapers to be refreshed at after the initial run. You can use the scheduled.py file to set the time of day you want the shapers to be refreshed at after the initial run.
On linux distributions that use systemd, such as Ubuntu, add the following to /etc/systemd/system/LibreQoS.service, replacing "/home/$USER/LibreQoSDirectory" with wherever you downloaded LibreQoS to: On linux distributions that use systemd, such as Ubuntu, add the following to /etc/systemd/system/LibreQoS.service, replacing "/home/$USER/LibreQoSDirectory" with wherever you downloaded LibreQoS to:
``` ```
@ -116,17 +119,18 @@ You can restart the service to refresh any changes you've made to the Shaper.csv
``` ```
sudo systemctl restart LibreQoS.service sudo systemctl restart LibreQoS.service
``` ```
## Statistics ### Statistics
``` ```
python3 ./stats.py python3 ./stats.py
``` ```
![Stats](docs/stats.png?raw=true "Stats") ![Stats](docs/stats.png?raw=true "Stats")
## Memory use ## Performance tips
### Memory use
Generally memory use should be under 2GB. If for any reason memory exceeds that, please make sure memory ballooning is enabled on VM host, and try Generally memory use should be under 2GB. If for any reason memory exceeds that, please make sure memory ballooning is enabled on VM host, and try
``` ```
sudo sh -c 'echo 1 >/proc/sys/vm/drop_caches' sudo sh -c 'echo 1 >/proc/sys/vm/drop_caches'
``` ```
## Server CPU Recommendations ### Server CPU Recommendations
* Choose a CPU with solid single-thread performance within your budget * Choose a CPU with solid single-thread performance within your budget
* Generally speaking any new CPU above $200 can probably handle shaping over 2Gbps * Generally speaking any new CPU above $200 can probably handle shaping over 2Gbps
https://www.cpubenchmark.net/high_end_cpus.html https://www.cpubenchmark.net/high_end_cpus.html