Files
LibreQoS/_build/html/docs/v2.0/quickstart.html
T
2026-02-25 19:40:43 -07:00

772 lines
33 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Quickstart: Choose Your Deployment Path &mdash; LibreQoE documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
<script src="../../_static/jquery.js"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></script>
<script src="https://cdn.jsdelivr.net/npm/d3@7.9.0/dist/d3.min.js"></script>
<script type="module">import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@11.12.1/dist/mermaid.esm.min.mjs";
const initStyles = () => {
const defaultStyle = document.createElement('style');
defaultStyle.textContent = `pre.mermaid {
/* Same as .mermaid-container > pre */
display: block;
width: 100%;
}
pre.mermaid > svg {
/* Same as .mermaid-container > pre > svg */
height: 500px;
width: 100%;
max-width: 100% !important;
}`;
document.head.appendChild(defaultStyle);
const fullscreenStyle = document.createElement('style');
fullscreenStyle.textContent = `.mermaid-container {
display: flex;
flex-direction: row;
width: 100%;
}
.mermaid-container > pre {
display: block;
width: 100%;
}
.mermaid-container > pre > svg {
height: 500px;
width: 100%;
max-width: 100% !important;
}
.mermaid-fullscreen-btn {
width: 28px;
height: 28px;
background: rgba(255, 255, 255, 0.95);
border: 1px solid rgba(0, 0, 0, 0.3);
border-radius: 4px;
cursor: pointer;
display: flex;
align-items: center;
justify-content: center;
transition: all 0.2s;
box-shadow: 0 2px 6px rgba(0, 0, 0, 0.2);
font-size: 14px;
line-height: 1;
padding: 0;
color: #333;
}
.mermaid-fullscreen-btn:hover {
opacity: 100% !important;
background: rgba(255, 255, 255, 1);
box-shadow: 0 3px 10px rgba(0, 0, 0, 0.3);
transform: scale(1.1);
}
.mermaid-fullscreen-btn.dark-theme {
background: rgba(50, 50, 50, 0.95);
border: 1px solid rgba(255, 255, 255, 0.3);
color: #e0e0e0;
}
.mermaid-fullscreen-btn.dark-theme:hover {
background: rgba(60, 60, 60, 1);
box-shadow: 0 3px 10px rgba(255, 255, 255, 0.2);
}
.mermaid-fullscreen-modal {
display: none;
position: fixed !important;
top: 0 !important;
left: 0 !important;
width: 95vw;
height: 100vh;
background: rgba(255, 255, 255, 0.98);
z-index: 9999;
padding: 20px;
overflow: auto;
}
.mermaid-fullscreen-modal.dark-theme {
background: rgba(0, 0, 0, 0.98);
}
.mermaid-fullscreen-modal.active {
display: flex;
align-items: center;
justify-content: center;
}
.mermaid-container-fullscreen {
position: relative;
width: 95vw;
height: 90vh;
max-width: 95vw;
max-height: 90vh;
background: white;
border-radius: 8px;
padding: 20px;
box-shadow: 0 10px 40px rgba(0, 0, 0, 0.3);
overflow: auto;
display: flex;
align-items: center;
justify-content: center;
}
.mermaid-container-fullscreen.dark-theme {
background: #1a1a1a;
box-shadow: 0 10px 40px rgba(0, 0, 0, 0.8);
}
.mermaid-container-fullscreen pre.mermaid {
width: 100%;
height: 100%;
display: flex;
align-items: center;
justify-content: center;
}
.mermaid-container-fullscreen .mermaid svg {
height: 100% !important;
width: 100% !important;
cursor: grab;
}
.mermaid-fullscreen-close {
position: fixed !important;
top: 20px !important;
right: 20px !important;
width: 40px;
height: 40px;
background: rgba(255, 255, 255, 0.95);
border: 1px solid rgba(0, 0, 0, 0.2);
border-radius: 50%;
cursor: pointer;
z-index: 10000;
display: flex;
align-items: center;
justify-content: center;
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.3);
transition: all 0.2s;
font-size: 24px;
line-height: 1;
color: #333;
}
.mermaid-fullscreen-close:hover {
background: white;
box-shadow: 0 6px 16px rgba(0, 0, 0, 0.4);
transform: scale(1.1);
}
.mermaid-fullscreen-close.dark-theme {
background: rgba(50, 50, 50, 0.95);
border: 1px solid rgba(255, 255, 255, 0.2);
color: #e0e0e0;
}
.mermaid-fullscreen-close.dark-theme:hover {
background: rgba(60, 60, 60, 1);
box-shadow: 0 6px 16px rgba(255, 255, 255, 0.2);
}
.mermaid-fullscreen-modal .mermaid-fullscreen-btn {
display: none !important;
}`;
document.head.appendChild(fullscreenStyle);
}
// Detect if page has dark background
const isDarkTheme = () => {
// We use a set of heuristics:
// 1. Check for common dark mode classes or attributes
// 2. Check computed background color brightness
if (document.documentElement.classList.contains('dark') ||
document.documentElement.getAttribute('data-theme') === 'dark' ||
document.body.classList.contains('dark') ||
document.body.getAttribute('data-theme') === 'dark') {
// console.log("Dark theme detected via class/attribute");
return true;
}
if (document.documentElement.classList.contains('light') ||
document.documentElement.getAttribute('data-theme') === 'light' ||
document.body.classList.contains('light') ||
document.body.getAttribute('data-theme') === 'light') {
// console.log("Light theme detected via class/attribute");
return false;
}
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
// console.log("Dark theme detected via prefers-color-scheme");
return true;
}
const bgColor = window.getComputedStyle(document.body).backgroundColor;
const match = bgColor.match(/rgb\((\d+),\s*(\d+),\s*(\d+)/);
if (match) {
const r = parseInt(match[1]);
const g = parseInt(match[2]);
const b = parseInt(match[3]);
const brightness = (r * 299 + g * 587 + b * 114) / 1000;
// console.log("Background color brightness:", brightness);
return brightness < 128;
}
// console.log("No dark or light theme detected, defaulting to light theme");
return false;
};
let darkTheme = isDarkTheme();
let modal = null;
let modalContent = null;
let previousScrollOffset = [window.scrollX, window.scrollY];
const runMermaid = async (rerun) => {
console.log("Running mermaid diagrams, rerun =", rerun);
// clear all existing mermaid charts
let all_mermaids = document.querySelectorAll(".mermaid");
if (rerun) {
all_mermaids.forEach((el) => {
if(!el.hasAttribute("data-original-code")) {
// store original code
// console.log(`Storing original code for first run: `, el.innerHTML);
el.setAttribute('data-original-code', el.innerHTML);
}
if(el.getAttribute("data-processed") === "true") {
// remove and restore original
el.removeAttribute("data-processed");
// console.log(`Restoring original code for re-run: `, el.getAttribute('data-original-code'));
el.innerHTML = el.getAttribute('data-original-code');
} else {
// store original code
// console.log(`Storing original code for re-run: `, el.innerHTML);
el.setAttribute('data-original-code', el.innerHTML);
}
});
await mermaid.run();
}
all_mermaids = document.querySelectorAll(".mermaid");
const mermaids_processed = document.querySelectorAll(".mermaid[data-processed='true']");
if ("False" === "True") {
const mermaids_to_add_zoom = -1 === -1 ? all_mermaids.length : -1;
if(mermaids_to_add_zoom > 0) {
var svgs = d3.selectAll("");
if(all_mermaids.length !== mermaids_processed.length) {
setTimeout(() => runMermaid(false), 200);
return;
} else if(svgs.size() !== mermaids_to_add_zoom) {
setTimeout(() => runMermaid(false), 200);
return;
} else {
svgs.each(function() {
var svg = d3.select(this);
svg.html("<g class='wrapper'>" + svg.html() + "</g>");
var inner = svg.select("g");
var zoom = d3.zoom().on("zoom", function(event) {
inner.attr("transform", event.transform);
});
svg.call(zoom);
});
}
}
} else if(all_mermaids.length !== mermaids_processed.length) {
// Wait for mermaid to process all diagrams
setTimeout(() => runMermaid(false), 200);
return;
}
// Stop here if not adding fullscreen capability
if ("True" !== "True") return;
if (modal !== null ) {
// Destroy existing modal
modal.remove();
modal = null;
modalContent = null;
}
modal = document.createElement('div');
modal.className = 'mermaid-fullscreen-modal' + (darkTheme ? ' dark-theme' : '');
modal.setAttribute('role', 'dialog');
modal.setAttribute('aria-modal', 'true');
modal.setAttribute('aria-label', 'Fullscreen diagram viewer');
modal.innerHTML = `
<button class="mermaid-fullscreen-close${darkTheme ? ' dark-theme' : ''}" aria-label="Close fullscreen">✕</button>
<div class="mermaid-container-fullscreen${darkTheme ? ' dark-theme' : ''}"></div>
`;
document.body.appendChild(modal);
modalContent = modal.querySelector('.mermaid-container-fullscreen');
const closeBtn = modal.querySelector('.mermaid-fullscreen-close');
const closeModal = () => {
modal.classList.remove('active');
modalContent.innerHTML = '';
document.body.style.overflow = ''
window.scrollTo({left: previousScrollOffset[0], top: previousScrollOffset[1], behavior: 'instant'});
};
closeBtn.addEventListener('click', closeModal);
modal.addEventListener('click', (e) => {
if (e.target === modal) closeModal();
});
document.addEventListener('keydown', (e) => {
if (e.key === 'Escape' && modal.classList.contains('active')) {
closeModal();
}
});
document.querySelectorAll('.mermaid').forEach((mermaidDiv) => {
if (mermaidDiv.parentNode.classList.contains('mermaid-container') ||
mermaidDiv.closest('.mermaid-fullscreen-modal')) {
// Already processed, adjust button class if needed
const existingBtn = mermaidDiv.parentNode.querySelector('.mermaid-fullscreen-btn');
if (existingBtn) {
existingBtn.className = 'mermaid-fullscreen-btn' + (darkTheme ? ' dark-theme' : '');
}
return;
}
const container = document.createElement('div');
container.className = 'mermaid-container';
mermaidDiv.parentNode.insertBefore(container, mermaidDiv);
container.appendChild(mermaidDiv);
const fullscreenBtn = document.createElement('button');
fullscreenBtn.className = 'mermaid-fullscreen-btn' + (darkTheme ? ' dark-theme' : '');
fullscreenBtn.setAttribute('aria-label', 'View diagram in fullscreen');
fullscreenBtn.textContent = '⛶';
fullscreenBtn.style.opacity = '50%';
// Calculate dynamic position based on diagram's margin and padding
const diagramStyle = window.getComputedStyle(mermaidDiv);
const marginTop = parseFloat(diagramStyle.marginTop) || 0;
const marginRight = parseFloat(diagramStyle.marginRight) || 0;
const paddingTop = parseFloat(diagramStyle.paddingTop) || 0;
const paddingRight = parseFloat(diagramStyle.paddingRight) || 0;
fullscreenBtn.style.top = `${marginTop + paddingTop + 4}px`;
fullscreenBtn.style.right = `${marginRight + paddingRight + 4}px`;
fullscreenBtn.addEventListener('click', () => {
previousScrollOffset = [window.scroll, window.scrollY];
const clone = mermaidDiv.cloneNode(true);
modalContent.innerHTML = '';
modalContent.appendChild(clone);
const svg = clone.querySelector('svg');
if (svg) {
svg.removeAttribute('width');
svg.removeAttribute('height');
svg.style.width = '100%';
svg.style.height = 'auto';
svg.style.maxWidth = '100%';
svg.style.sdisplay = 'block';
if ("False" === "True") {
setTimeout(() => {
const g = svg.querySelector('g');
if (g) {
var svgD3 = d3.select(svg);
svgD3.html("<g class='wrapper'>" + svgD3.html() + "</g>");
var inner = svgD3.select("g");
var zoom = d3.zoom().on("zoom", function(event) {
inner.attr("transform", event.transform);
});
svgD3.call(zoom);
}
}, 100);
}
}
modal.classList.add('active');
document.body.style.overflow = 'hidden';
});
container.appendChild(fullscreenBtn);
});
};
const load = async () => {
initStyles();
await runMermaid(true);
const reRunIfThemeChanges = async () => {
const newDarkTheme = isDarkTheme();
if (newDarkTheme !== darkTheme) {
darkTheme = newDarkTheme;
console.log("Theme change detected, re-running mermaid with", darkTheme ? "dark" : "default", "theme");
await mermaid.initialize(
{...JSON.parse(
`{"startOnLoad": false}`
),
...{ darkMode: darkTheme, theme: darkTheme ? 'dark' : 'default' },
}
);
await runMermaid(true);
}
};
// Update theme classes when theme changes
const themeObserver = new MutationObserver(reRunIfThemeChanges);
themeObserver.observe(document.documentElement, {
attributes: true,
attributeFilter: ['class', 'style', 'data-theme']
});
themeObserver.observe(document.body, {
attributes: true,
attributeFilter: ['class', 'style', 'data-theme']
});
};
console.log("Initializing mermaid with", darkTheme ? "dark" : "default", "theme");
mermaid.initialize(
{...JSON.parse(
`{"startOnLoad": false}`
),
...{ darkMode: darkTheme, theme: darkTheme ? 'dark' : 'default' },
}
);
window.addEventListener("load", load);</script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Deployment Scenarios" href="design.html" />
<link rel="prev" title="Welcome to the LibreQoS documentation" href="../../index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home">
LibreQoE
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart (Start Here)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#common-install-foundation">Common Install Foundation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#testbed-lab">Testbed / Lab</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#when-to-choose">When to choose</a></li>
<li class="toctree-l3"><a class="reference internal" href="#do-this-now">Do this now</a></li>
<li class="toctree-l3"><a class="reference internal" href="#then-go-here">Then go here</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#supported-integration">Supported Integration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id1">When to choose</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">Do this now</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Then go here</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#custom-script-integration">Custom Script Integration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id4">When to choose</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">Do this now</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">Then go here</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#manual-files-100-subscribers">Manual Files (&lt;100 subscribers)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id7">When to choose</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">Do this now</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">Then go here</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="design.html">Deployment Scenarios</a></li>
<li class="toctree-l1"><a class="reference internal" href="requirements.html">System Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="prereq.html">Prerequisites</a></li>
<li class="toctree-l1"><a class="reference internal" href="ubuntu-server.html">Install Ubuntu Server</a></li>
<li class="toctree-l1"><a class="reference internal" href="bridge.html">Configure Shaping Bridge</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Managing LibreQoS (v1.5 to v2.0):</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configure LibreQoS</a></li>
<li class="toctree-l1"><a class="reference internal" href="operating-modes.html">Operating Modes and Source of Truth</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration-advanced.html">Advanced Configuration Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="integrations.html">CRM/NMS Integrations</a></li>
<li class="toctree-l1"><a class="reference internal" href="components.html">LibreQoS Software Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="node-manager-ui.html">LibreQoS WebUI (Node Manager)</a></li>
<li class="toctree-l1"><a class="reference internal" href="scale-topology.html">Scale Planning and Topology Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="stormguard.html">StormGuard</a></li>
<li class="toctree-l1"><a class="reference internal" href="high-availability.html">High Availability and Failure Domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="update.html">Upgrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Insight</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="insight.html">LibreQoS Insight (Insight)</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">LibreQoS Node API</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="cake.html">CAKE</a></li>
<li class="toctree-l1"><a class="reference internal" href="performance-tuning.html">Performance Tuning</a></li>
<li class="toctree-l1"><a class="reference internal" href="extras.html">Extras</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">LibreQoE</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Quickstart: Choose Your Deployment Path</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/docs/v2.0/quickstart.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="quickstart-choose-your-deployment-path">
<h1>Quickstart: Choose Your Deployment Path<a class="headerlink" href="#quickstart-choose-your-deployment-path" title="Permalink to this heading"></a></h1>
<p>Use this page to choose the correct deployment path quickly, then execute only the steps for that path.</p>
<pre class="mermaid">
flowchart TD
A[Start Here: Quickstart] --&gt; B{Choose Path}
B --&gt; C[Testbed / Lab]
B --&gt; D[Supported Integration]
B --&gt; E[Custom Script Integration]
B --&gt; F[Manual Files &lt;100 subscribers]
C --&gt; G[Configure + Validate in WebUI]
D --&gt; G
E --&gt; G
F --&gt; G
G --&gt; H[Troubleshoot / Optimize / Scale]
</pre><section id="common-install-foundation">
<h2>Common Install Foundation<a class="headerlink" href="#common-install-foundation" title="Permalink to this heading"></a></h2>
<p>Complete this once before any path-specific steps.</p>
<pre class="mermaid">
flowchart LR
A[Review Design + Requirements] --&gt; B[Host Prerequisites + Ubuntu]
B --&gt; C[Configure Bridge]
C --&gt; D[Install LibreQoS .deb]
D --&gt; E[Open WebUI]
</pre><ol class="arabic simple">
<li><p>Review deployment assumptions and capacity:</p>
<ul class="simple">
<li><p><a class="reference internal" href="design.html"><span class="std std-doc">Deployment Scenarios</span></a></p></li>
<li><p><a class="reference internal" href="requirements.html"><span class="std std-doc">System Requirements</span></a></p></li>
</ul>
</li>
<li><p>Prepare host and OS:</p>
<ul class="simple">
<li><p><a class="reference internal" href="prereq.html"><span class="std std-doc">Server Setup - Prerequisites</span></a></p></li>
<li><p><a class="reference internal" href="ubuntu-server.html"><span class="std std-doc">Install Ubuntu Server 24.04</span></a></p></li>
</ul>
</li>
<li><p>Configure bridge mode:</p>
<ul class="simple">
<li><p><a class="reference internal" href="bridge.html"><span class="std std-doc">Configure Shaping Bridge</span></a></p></li>
</ul>
</li>
<li><p>Install LibreQoS (<code class="docutils literal notranslate"><span class="pre">.deb</span></code> recommended):</p></li>
</ol>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~
sudo<span class="w"> </span>apt-get<span class="w"> </span>update
sudo<span class="w"> </span>apt-get<span class="w"> </span>upgrade
wget<span class="w"> </span>https://download.libreqos.com/libreqos_1.5-RC3.202512062019-1_amd64.deb
sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>./libreqos_1.5-RC3.202512062019-1_amd64.deb
</pre></div>
</div>
<ol class="arabic simple" start="5">
<li><p>Open WebUI at <code class="docutils literal notranslate"><span class="pre">http://your_shaper_ip:9123</span></code>.</p></li>
</ol>
</section>
<section id="testbed-lab">
<h2>Testbed / Lab<a class="headerlink" href="#testbed-lab" title="Permalink to this heading"></a></h2>
<section id="when-to-choose">
<h3>When to choose<a class="headerlink" href="#when-to-choose" title="Permalink to this heading"></a></h3>
<p>You want to validate behavior in a controlled environment before inline production.</p>
</section>
<section id="do-this-now">
<h3>Do this now<a class="headerlink" href="#do-this-now" title="Permalink to this heading"></a></h3>
<ol class="arabic simple">
<li><p>Build a lab topology (LibreQoS + traffic generator endpoints + optional OSPF/BGP path simulation).</p></li>
<li><p>Choose a lab track:</p>
<ul class="simple">
<li><p><strong>Lab with manual files</strong>: validate <code class="docutils literal notranslate"><span class="pre">network.json</span></code> + <code class="docutils literal notranslate"><span class="pre">ShapedDevices.csv</span></code> behavior.</p></li>
<li><p><strong>Lab with supported integration</strong>: validate imported subscriber/topology data.</p></li>
</ul>
</li>
<li><p>Generate traffic and validate in WebUI (Dashboard, Tree, Flow, Scheduler Status, Urgent Issues).</p></li>
<li><p>Confirm expected shaping behavior and stability.</p></li>
</ol>
</section>
<section id="then-go-here">
<h3>Then go here<a class="headerlink" href="#then-go-here" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="configuration.html"><span class="std std-doc">Configure LibreQoS</span></a></p></li>
<li><p><a class="reference internal" href="operating-modes.html"><span class="std std-doc">Operating Modes and Source of Truth</span></a></p></li>
<li><p><a class="reference internal" href="integrations.html"><span class="std std-doc">CRM/NMS Integrations</span></a></p></li>
<li><p><a class="reference internal" href="troubleshooting.html"><span class="std std-doc">Troubleshooting</span></a></p></li>
</ul>
</section>
</section>
<section id="supported-integration">
<h2>Supported Integration<a class="headerlink" href="#supported-integration" title="Permalink to this heading"></a></h2>
<section id="id1">
<h3>When to choose<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<p>Your CRM/NMS is supported by built-in LibreQoS integrations.</p>
</section>
<section id="id2">
<h3>Do this now<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<ol class="arabic simple">
<li><p>Configure integration settings in WebUI.</p></li>
<li><p>Run initial sync and validate imported shaping/topology data.</p></li>
<li><p>Place LibreQoS inline for pilot traffic.</p></li>
<li><p>Validate WebUI health signals (Scheduler Status, Urgent Issues, topology/flow views).</p></li>
<li><p>Expand pilot scope after stable operation.</p></li>
</ol>
<p>Note:</p>
<ul class="simple">
<li><p>In integration mode, <code class="docutils literal notranslate"><span class="pre">ShapedDevices.csv</span></code> is typically regenerated by sync jobs.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">network.json</span></code> overwrite behavior depends on integration settings (for example <code class="docutils literal notranslate"><span class="pre">always_overwrite_network_json</span></code>).</p></li>
</ul>
</section>
<section id="id3">
<h3>Then go here<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="integrations.html"><span class="std std-doc">CRM/NMS Integrations</span></a></p></li>
<li><p><a class="reference internal" href="scale-topology.html"><span class="std std-doc">Scale Planning and Topology Design</span></a></p></li>
<li><p><a class="reference internal" href="troubleshooting.html"><span class="std std-doc">Troubleshooting</span></a></p></li>
</ul>
</section>
</section>
<section id="custom-script-integration">
<h2>Custom Script Integration<a class="headerlink" href="#custom-script-integration" title="Permalink to this heading"></a></h2>
<section id="id4">
<h3>When to choose<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<p>Your CRM/NMS is unsupported and you will generate <code class="docutils literal notranslate"><span class="pre">network.json</span></code> + <code class="docutils literal notranslate"><span class="pre">ShapedDevices.csv</span></code> with your own pipeline.</p>
</section>
<section id="id5">
<h3>Do this now<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
<ol class="arabic simple">
<li><p>Implement script/process to generate and refresh shaping files.</p></li>
<li><p>Declare your script outputs as source-of-truth.</p></li>
<li><p>Place LibreQoS inline for pilot traffic.</p></li>
<li><p>Use WebUI for operational checks and quick adjustments.</p></li>
<li><p>Move permanent changes back into your script workflow.</p></li>
</ol>
<p>Note:</p>
<ul class="simple">
<li><p>WebUI edits are useful for quick operations.</p></li>
<li><p>Long-term state should be maintained by your external source-of-truth workflow.</p></li>
</ul>
</section>
<section id="id6">
<h3>Then go here<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="operating-modes.html"><span class="std std-doc">Operating Modes and Source of Truth</span></a></p></li>
<li><p><a class="reference internal" href="configuration-advanced.html"><span class="std std-doc">Advanced Configuration Reference</span></a></p></li>
<li><p><a class="reference internal" href="scale-topology.html"><span class="std std-doc">Scale Planning and Topology Design</span></a></p></li>
<li><p><a class="reference internal" href="troubleshooting.html"><span class="std std-doc">Troubleshooting</span></a></p></li>
</ul>
</section>
</section>
<section id="manual-files-100-subscribers">
<h2>Manual Files (&lt;100 subscribers)<a class="headerlink" href="#manual-files-100-subscribers" title="Permalink to this heading"></a></h2>
<section id="id7">
<h3>When to choose<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
<p>You intentionally maintain <code class="docutils literal notranslate"><span class="pre">network.json</span></code> + <code class="docutils literal notranslate"><span class="pre">ShapedDevices.csv</span></code> directly without CRM/NMS synchronization.</p>
<p>Recommended only for networks under 100 subscribers.</p>
</section>
<section id="id8">
<h3>Do this now<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<ol class="arabic simple">
<li><p>Build and maintain shaping files directly.</p></li>
<li><p>Place LibreQoS inline for pilot traffic.</p></li>
<li><p>Validate shaping and scheduler status in WebUI.</p></li>
<li><p>Maintain strict manual change discipline.</p></li>
<li><p>Plan migration to supported integration or custom scripts if scale/change volume grows.</p></li>
</ol>
</section>
<section id="id9">
<h3>Then go here<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference internal" href="configuration-advanced.html"><span class="std std-doc">Advanced Configuration Reference</span></a></p></li>
<li><p><a class="reference internal" href="operating-modes.html"><span class="std std-doc">Operating Modes and Source of Truth</span></a></p></li>
<li><p><a class="reference internal" href="scale-topology.html"><span class="std std-doc">Scale Planning and Topology Design</span></a></p></li>
<li><p><a class="reference internal" href="troubleshooting.html"><span class="std std-doc">Troubleshooting</span></a></p></li>
</ul>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../../index.html" class="btn btn-neutral float-left" title="Welcome to the LibreQoS documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="design.html" class="btn btn-neutral float-right" title="Deployment Scenarios" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2026, LibreQoE, LLC.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>