Configure LibreQoS

Configure lqos.conf

Copy the lqosd daemon configuration file to /etc:

cd /opt/libreqos/src
sudo cp lqos.example /etc/lqos.conf

Now edit the file to match your setup with

sudo nano /etc/lqos.conf

Change enp1s0f1 and enp1s0f2 to match your network interfaces. It doesn’t matter which one is which. Notice, it’s paring the interfaces, so when you first enter enps0f1 in the first line, the redirect_to parameter is enp1s0f2 (replacing with your actual interface names).

  • First Line: name = "enp1s0f1", redirect_to = "enp1s0f2"

  • Second Line: name = "enp1s0f2", redirect_to = "enp1s0f1"

Then, if using Bifrost/XDP set use_xdp_bridge = true under that same [bridge] section.

Configure ispConfig.py

Copy ispConfig.example.py to ispConfig.py and edit as needed

cd /opt/libreqos/src/
cp ispConfig.example.py ispConfig.py
nano ispConfig.py

  • Set upstreamBandwidthCapacityDownloadMbps and upstreamBandwidthCapacityUploadMbps to match the bandwidth in Mbps of your network’s upstream / WAN internet connection. The same can be done for generatedPNDownloadMbps and generatedPNUploadMbps.

  • Set interfaceA to the interface facing your core router (or bridged internal network if your network is bridged)

  • Set interfaceB to the interface facing your edge router

  • Set enableActualShellCommands = True to allow the program to actually run the commands.

Network.json

Network.json allows ISP operators to define a Hierarchical Network Topology, or Flat Network Topology.

For networks with no Parent Nodes (no strictly defined Access Points or Sites) edit the network.json to use a Flat Network Topology with nano network.json setting the following file content:

{}

If you plan to use the built-in UISP or Splynx integrations, you do not need to create a network.json file quite yet.

If you plan to use the built-in UISP integration, it will create this automatically on its first run (assuming network.json is not already present). You can then modify the network.json to more accurately reflect your topology.

If you will not be using an integration, you can manually define the network.json following the template file - network.example.json

+-----------------------------------------------------------------------+
| Entire Network                                                        |
+-----------------------+-----------------------+-----------------------+
| Parent Node A         | Parent Node B         | Parent Node C         |
+-----------------------+-------+-------+-------+-----------------------+
| Parent Node D | Sub 3 | Sub 4 | Sub 5 | Sub 6 | Sub 7 | Parent Node F |
+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| Sub 1 | Sub 2 |       |                       |       | Sub 8 | Sub 9 |
+-------+-------+-------+-----------------------+-------+-------+-------+

Manual Setup

You can use

python3 csvToNetworkJSON.py

to convert manualNetwork.csv to a network.json file. manualNetwork.csv can be copied from the template file, manualNetwork.template.csv

Note: The parent node name must match that used for clients in ShapedDevices.csv

ShapedDevices.csv

If you are using an integration, this file will be automatically generated. If you are not using an integration, you can manually edit the file.

Manual Editing

  • Modify the ShapedDevices.csv file using your preferred spreadsheet editor (LibreOffice Calc, Excel, etc), following the template file - ShapedDevices.example.csv

  • Circuit ID is required. Must be a string of some sort (int is fine, gets parsed as string). Must NOT include any number symbols (#). Every circuit needs a unique CircuitID - they cannot be reused. Here, circuit essentially means customer location. If a customer has multiple locations on different parts of your network, use a unique CircuitID for each of those locations.

  • At least one IPv4 address or IPv6 address is required for each entry.

  • The Access Point or Site name should be set in the Parent Node field. Parent Node can be left blank for flat networks.

  • The ShapedDevices.csv file allows you to set minimum guaranteed, and maximum allowed bandwidth per subscriber.

  • The minimum allowed plan rates for Circuits are 2Mbit. Bandwidth min and max should both be above that threshold.

  • Recommendation: set the min bandwidth to something like 25/10 and max to 1.15X advertised plan rate by using bandwidthOverheadFactor = 1.15

    • This way, when an AP hits its ceiling, users have any remaining AP capacity fairly distributed between them.

    • Ensure a reasonable minimum bandwidth minimum for every subscriber, allowing them to utilize up to the maximum provided when AP utilization is below 100%.

Note regarding SLAs: For customers with SLA contracts that guarantee them a minimum bandwidth, set their plan rate as the minimum bandwidth. That way when an AP approaches its ceiling, SLA customers will always get that amount.

image

Once your configuration is complete. You’re ready to run the application and start the Deamons