IntenseWebs/LibreQoS
3
0 Fork 0
mirror of https://github.com/LibreQoE/LibreQoS.git synced 2026-10-25 22:30:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

changes

Browse Source
This commit is contained in:
Robert Chacon committed 2026-04-04 15:46:31 -06:00
1 parent cbd5b56627
commit a41396ea5a
22 files changed
+2105 -196
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/v2.0/integrations-reference.md
+10 -9
View File
@@ -323,7 +323,7 @@ The following UISP options are available in current builds and WebUI (Node Manag
- `insecure_ssl`: disables TLS certificate verification for UISP API calls.
- `airmax_flexible_frame_download_ratio`: when UISP reports aggregate AirMax AP capacity for flexible framing and the live `dlRatio` is absent, LibreQoS uses this fallback download share. `0.8` means 80/20 download/upload.
Current builds scope this flexible-frame handling narrowly to devices where UISP reports `identification.type == "airMax"` and `identification.role == "ap"`. Those AirMax APs prefer aggregate capacity from `theoreticalTotalCapacity` and split it using the live wireless `dlRatio` when UISP provides one.
Current builds scope this flexible-frame handling narrowly to devices where UISP reports `identification.type == "airMax"` and `identification.role == "ap"`. Those AirMax APs use `theoreticalTotalCapacity` only as a flexible-framing hint. The actual shaping rate comes from aggregate `totalCapacity` when UISP provides it, otherwise from the stronger directional capacity, and the split still prefers the live wireless `dlRatio` when UISP provides one.
Recommended use:
1. Keep `insecure_ssl = false` unless you have a known internal PKI/self-signed requirement.
@@ -350,16 +350,17 @@ You have the option to run `uisp_integration` automatically on boot and every X
### UISP Overrides
You can also modify the the following files to more accurately reflect your network:
- integrationUISPbandwidths.csv
You can also use the following override inputs to more accurately reflect your network:
- `Rate Override` for node bandwidth changes stored as operator `AdjustSiteSpeed` entries in `lqos_overrides.json`
- `Topology Override` for UISP `full` parent-selection corrections stored in `lqos_overrides.json`
- integrationUISProutes.csv
- integrationUISPbandwidths.csv as a legacy compatibility input only
Each of the files above have templates available in the `/opt/libreqos/src` folder. If you don't find them there, you can navigate [here](https://github.com/LibreQoE/LibreQoS/tree/develop/src). To utilize the template, copy the file (removing the `.template` part of the filename) and set the appropriate information inside each file.
For example, if you want to change the set bandwidth for a site, you would do:
```
sudo cp /opt/libreqos/src/integrationUISPbandwidths.template.csv /opt/libreqos/src/integrationUISPbandwidths.csv
```
And edit the CSV using LibreOffice or your preferred CSV editor.
Current builds apply `Topology Override` before final `network.json` / `ShapedDevices.csv` emission and give it precedence over legacy UISP route-cost overrides. Current WebUI support is `Pinned Parent` only, forcing one detected immediate upstream parent.
Current UISP builds also auto-migrate a legacy `integrationUISPbandwidths.csv` into operator `AdjustSiteSpeed` overrides on the next integration run when no operator rate overrides exist yet. If operator rate overrides already exist, the CSV is ignored.
Each of the files above have templates available in the `/opt/libreqos/src` folder. If you don't find them there, you can navigate [here](https://github.com/LibreQoE/LibreQoS/tree/develop/src).
#### UISP Route Overrides
docs/v2.0/integrations-uisp.md
+10 -11
View File
@@ -167,7 +167,7 @@ The following UISP options are available in current builds and WebUI (Node Manag
Shared integration defaults also include Ethernet port limiting. When UISP can detect negotiated subscriber-facing Ethernet speed, current builds apply a conservative default multiplier of `0.94` unless the operator overrides it in `Configuration -> Integrations -> Integration Defaults`.
Current builds scope this flexible-frame handling narrowly to devices where UISP reports `identification.type == "airMax"` and `identification.role == "ap"`. Those AirMax APs prefer aggregate capacity from `theoreticalTotalCapacity` and split it using the live wireless `dlRatio` when UISP provides one.
Current builds scope this flexible-frame handling narrowly to devices where UISP reports `identification.type == "airMax"` and `identification.role == "ap"`. Those AirMax APs use `theoreticalTotalCapacity` only as a flexible-framing hint. The actual shaping rate comes from aggregate `totalCapacity` when UISP provides it, otherwise from the stronger directional capacity, and the split still prefers the live wireless `dlRatio` when UISP provides one.
Recommended use:
1. Keep `insecure_ssl = false` unless you have a known internal PKI/self-signed requirement.
@@ -187,20 +187,19 @@ You have the option to run `uisp_integration` automatically on boot and every X
### UISP Overrides
You can also modify the following files to more accurately reflect your network:
- integrationUISPbandwidths.csv
You can also use the following override inputs to more accurately reflect your network:
- Tree-page `Rate Override` edits, stored as operator `AdjustSiteSpeed` entries in `lqos_overrides.json`
- Tree-page `Topology Override` edits for supported UISP `full` nodes, stored in `lqos_overrides.json`
- integrationUISProutes.csv
- integrationUISPbandwidths.csv as a legacy compatibility input only
Tree-page `Operator Override` edits are separate from these legacy UISP files. Current builds write those operator-owned node rate changes to `lqos_overrides.json` and do not rewrite `integrationUISPbandwidths.csv`.
Current UISP builds auto-migrate a legacy `integrationUISPbandwidths.csv` into operator `AdjustSiteSpeed` overrides on the next integration run when no operator rate overrides exist yet. If operator rate overrides already exist, the CSV is ignored and a warning is logged so there is only one active source of truth.
Each of the files above have templates available in the `/opt/libreqos/src` folder. If you don't find them there, you can navigate [here](https://github.com/LibreQoE/LibreQoS/tree/develop/src). To utilize the template, copy the file (removing the `.template` part of the filename) and set the appropriate information inside each file.
For example, if you want to change the set bandwidth for a site, you would do:
```
sudo cp /opt/libreqos/src/integrationUISPbandwidths.template.csv /opt/libreqos/src/integrationUISPbandwidths.csv
```
And edit the CSV using LibreOffice or your preferred CSV editor.
UISP `full` strategy builds also expose tree-page `Topology Override` editing for supported nodes. These overrides are stored in `lqos_overrides.json`, take precedence over legacy UISP route-cost files, and resolve before final `network.json` / `ShapedDevices.csv` emission. Current WebUI support is `Pinned Parent` only.
To avoid conflicting sources of truth, prefer one durable override path per node: either the legacy UISP CSV workflow or the operator override layer.
Each of the files above have templates available in the `/opt/libreqos/src` folder. If you don't find them there, you can navigate [here](https://github.com/LibreQoE/LibreQoS/tree/develop/src).
For new bandwidth changes, prefer the operator override layer over the legacy bandwidth CSV. `integrationUISPbandwidths.csv` remains a compatibility input for one-time migration, not the preferred long-term workflow.
#### UISP Route Overrides
docs/v2.0/node-manager-ui.md
+6 -2
View File
@@ -30,9 +30,13 @@ This page documents key WebUI (Node Manager) views and operational behavior in t
- Attached circuits are shown in a dedicated table for the selected node.
- The attached-circuits IP column keeps rows compact by showing one address inline and collapsing additional addresses as `+X`, with the full list still available on hover.
- Ethernet-limited attached circuits can show inline `10M`, `100M`, or `1G` warning badges beside the `Plan (Mbps)` value; hovering explains the auto-cap and clicking the badge opens the dedicated Ethernet review page.
- Administrators can save or clear `Operator Override` values where node-level overrides are supported. Read-only users and unsupported nodes continue to display current values without edit controls.
- Tree-page operator rate edits write operator-owned overrides to `lqos_overrides.json`; they do not rewrite legacy integration bandwidth CSV files.
- Administrators can save or clear `Rate Override` values where node-level overrides are supported. Read-only users and unsupported nodes continue to display current values without edit controls.
- Tree-page operator rate edits write operator-owned `AdjustSiteSpeed` overrides to `lqos_overrides.json`.
- On UISP `full` builds, legacy `integrationUISPbandwidths.csv` files are auto-migrated into those operator overrides on the next integration run when no operator rate overrides exist yet; otherwise the CSV is ignored.
- Tree-page operator rate edits require an administrator session, a stable node ID, and a non-generated node. Generated/integration-synthetic nodes remain read-only in this editor.
- The tree page keeps `Node Details` as a compact summary card and places the override editors as compact inline rows directly beneath the details table.
- UISP `full` strategy nodes can also expose a `Topology Override` editor on the tree page. Current builds support `Pinned Parent` only, using the node's detected immediate upstream candidates and storing that operator choice in `lqos_overrides.json`.
- The pinned-parent selector defaults to `Default upstream parent` when no override is set. Choosing that default leaves the node on the integration-selected parent.
### Site Map
- Flat operational map of Sites and APs using imported node geodata.