¶ LibreQoS
¶ Overview
LibreQoS is an open-source traffic shaping and QoS platform for ISPs. It applies fair-queueing (CAKE) and per-subscriber rate limits to deliver lower latency and a smoother quality of experience for end users.
The Splynx LibreQoS add-on connects your Splynx instance to a LibreQoS server — typically the cloud-hosted LibreQoS Insight portal. Once installed and configured, it adds shortcuts that open the LibreQoS statistics page for a specific customer or service in one click, without leaving Splynx.
¶ Installation
The add-on can be installed in two ways: through the Splynx Web UI or from the command line on the Splynx server.
To install the add-on from the Web UI, navigate to Config → Integrations → Add-ons, type libreqos in the search field, then click the Install icon in the Actions column next to splynx-libreqos:
Confirm the installation by clicking the Ok, confirm button in the dialog:
To install the add-on via CLI on the Splynx server, run:
apt-get update
apt-get install splynx-libreqos
After installation, the add-on appears in Config → Integrations → Modules list as splynx_libreqos_addon with the Enabled entry-point status:
¶ Configuration
Before configuring the add-on in Splynx, generate an API key in your LibreQoS Insight portal:
- Sign in to insight.libreqos.com.
- Open the Account tab and create a new Splynx API key.
- Copy the generated key — you will paste it into Splynx in the next step.
Then open Config → Integrations → Modules list, click splynx_libreqos_addon, and fill in the LibreQoS configuration block:
- LibreQoS URL - URL of your LibreQoS server. Defaults to
https://insight.libreqos.comfor the cloud-hosted Insight portal. Replace with your own host (for example,https://libreqos.local) if you run LibreQoS on-premise. - LibreQoS API key - API key generated in the Account tab of the LibreQoS Insight portal. Stored encrypted — once saved, the field shows the Warning! This field has a hidden encrypted value notice instead of the key itself.
Click Save.
¶ How the LibreQoS add-on works
After the add-on is installed and configured, Splynx adds two entry points that take an admin from a customer record straight to the matching LibreQoS Insight view:
-
A LibreQoS action on each internet service in the customer's Services tab. Clicking it requests a short-lived statistics URL from LibreQoS for that service's IP and opens the LibreQoS Insight page filtered to that service.
-
A LibreQoS tab on the customer profile. The tab loads the LibreQoS Insight statistics view for the customer directly inside Splynx, so you do not need to switch browser tabs to check traffic shaping, latency, or throughput for that subscriber.
Both shortcuts use the LibreQoS URL and LibreQoS API key from the add-on configuration to authenticate against LibreQoS on each request. If the request fails — for example, because the API key was revoked or the LibreQoS server is unreachable — Splynx shows the Showing statistics failed message in place of the statistics view. In that case, verify that the LibreQoS server is reachable from Splynx and that the API key in the configuration is still valid.