mirror of
https://github.com/LibreQoE/LibreQoS.git
synced 2026-10-25 14:20:05 -05:00
changes
This commit is contained in:
Robert Chacon committed
1 parent
6648656b31
commit
2cf180d3fe
10 files changed
+145
-103
No files matched your search
+1
-1
@@ -7,12 +7,12 @@ Bienvenido a la documentación de LibreQoS
|
||||
:maxdepth: 1
|
||||
:caption: Primeros Pasos
|
||||
|
||||
Quickstart (Empieza Aquí) <v2.0/quickstart-es>
|
||||
v2.0/design-es
|
||||
v2.0/requirements-es
|
||||
v2.0/prereq-es
|
||||
v2.0/ubuntu-server-es
|
||||
v2.0/bridge-es
|
||||
v2.0/quickstart-es
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
# Configurar LibreQoS
|
||||
|
||||
## Propósito de esta página
|
||||
|
||||
Use esta página para operaciones diarias y configuración por WebUI. Use [Referencia avanzada de configuración](configuration-advanced-es.md) para edición directa de archivos y flujos centrados en CLI.
|
||||
|
||||
## Configuración inicial mediante la herramienta de instalación (desde el .deb)
|
||||
<img width="1605" height="1030" alt="setup_tool" src="https://github.com/user-attachments/assets/5a645da8-c411-4635-9777-a881966981df" />
|
||||
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
# Integraciones CRM/NMS
|
||||
|
||||
## Propósito de esta página
|
||||
|
||||
Use esta página para elegir y configurar integraciones CRM/NMS soportadas. Use las páginas por integración para detalles específicos.
|
||||
|
||||
La mayoría de operadores usan las integraciones incluidas. Si usa scripts propios como fuente de verdad para `network.json` y `ShapedDevices.csv`, comience por [Modos de operación y fuente de verdad](operating-modes-es.md).
|
||||
|
||||
## Elegir ruta de integración
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
# Modos de operación y fuente de verdad
|
||||
|
||||
## Propósito de esta página
|
||||
|
||||
Use esta página para elegir y aplicar su política de fuente de verdad (integraciones incluidas vs fuente personalizada) antes de cambios en producción.
|
||||
|
||||
LibreQoS soporta dos modos de operación principales.
|
||||
|
||||
## Integraciones incluidas (recomendado para la mayoría de operadores)
|
||||
|
||||
@@ -1,27 +1,20 @@
|
||||
# Quickstart: Elija su ruta de despliegue
|
||||
|
||||
LibreQoS soporta múltiples rutas reales de despliegue. Comience eligiendo una ruta y mantenga un único modelo de fuente de verdad para los datos de shaping.
|
||||
Use esta página para elegir rápidamente la ruta correcta y ejecutar solo los pasos de esa ruta.
|
||||
|
||||
## Antes de empezar
|
||||
## Base de instalación común
|
||||
|
||||
- La WebUI es la interfaz operativa principal después de instalar.
|
||||
- Elija un modelo de fuente de verdad para `network.json` y `ShapedDevices.csv`.
|
||||
- Evite ediciones en competencia entre múltiples sistemas para los mismos objetos.
|
||||
Complete esto una vez antes de cualquier paso específico de ruta.
|
||||
|
||||
## Testbed / Lab
|
||||
|
||||
Use esta ruta cuando quiera validar el comportamiento de LibreQoS en un entorno controlado antes de desplegar inline en producción.
|
||||
|
||||
### Flujo de configuración de laboratorio
|
||||
|
||||
1. Arme una topología de laboratorio (caja LibreQoS + endpoints generadores de tráfico + routers opcionales para simular rutas OSPF/BGP).
|
||||
2. Complete plataforma y prerrequisitos de instalación:
|
||||
1. Revise supuestos de despliegue y capacidad:
|
||||
- [Escenarios de Despliegue](design-es.md)
|
||||
- [Requisitos del Sistema](requirements-es.md)
|
||||
2. Prepare host y sistema operativo:
|
||||
- [Configuración del Servidor - Prerrequisitos](prereq-es.md)
|
||||
- [Instalar Ubuntu Server 24.04](ubuntu-server-es.md)
|
||||
3. Configure el modo de puente:
|
||||
- [Configurar Puente de Regulación](bridge-es.md)
|
||||
3. Instale LibreQoS con paquete `.deb` (recomendado):
|
||||
4. Instale LibreQoS (`.deb` recomendado):
|
||||
|
||||
```bash
|
||||
cd ~
|
||||
@@ -31,16 +24,24 @@ wget https://download.libreqos.com/{deb_url_v1_5}
|
||||
sudo apt install ./{deb_url_v1_5}
|
||||
```
|
||||
|
||||
4. Elija una pista de prueba:
|
||||
- **Lab con archivos manuales**: use `network.json` y `ShapedDevices.csv` manuales/de ejemplo.
|
||||
- **Lab con integración soportada**: configure integración y valide datos importados.
|
||||
5. Genere tráfico de prueba y valide en WebUI:
|
||||
- comportamiento de Dashboard/Tree/Flow
|
||||
- estado del scheduler
|
||||
- problemas urgentes
|
||||
6. Cuando el comportamiento sea el esperado, avance a una ruta de piloto inline.
|
||||
5. Abra WebUI en `http://your_shaper_ip:9123`.
|
||||
|
||||
### Después de esta ruta
|
||||
## Testbed / Lab
|
||||
|
||||
### Cuándo elegir
|
||||
|
||||
Quiere validar comportamiento en un entorno controlado antes de producción inline.
|
||||
|
||||
### Haga esto ahora
|
||||
|
||||
1. Arme topología de laboratorio (LibreQoS + endpoints generadores de tráfico + simulación opcional OSPF/BGP).
|
||||
2. Elija una pista de laboratorio:
|
||||
- **Lab con archivos manuales**: validar comportamiento de `network.json` + `ShapedDevices.csv`.
|
||||
- **Lab con integración soportada**: validar datos importados de suscriptores/topología.
|
||||
3. Genere tráfico y valide en WebUI (Dashboard, Tree, Flow, Scheduler Status, Urgent Issues).
|
||||
4. Confirme comportamiento de shaping y estabilidad esperada.
|
||||
|
||||
### Luego vaya aquí
|
||||
|
||||
- [Configurar LibreQoS](configuration-es.md)
|
||||
- [Modos de operación y fuente de verdad](operating-modes-es.md)
|
||||
@@ -49,42 +50,47 @@ sudo apt install ./{deb_url_v1_5}
|
||||
|
||||
## Integración Soportada
|
||||
|
||||
Use esta ruta cuando su CRM/NMS esté soportado por las integraciones incluidas de LibreQoS.
|
||||
### Cuándo elegir
|
||||
|
||||
1. Complete prerrequisitos e instale LibreQoS (mismos enlaces/pasos anteriores).
|
||||
2. Configure la integración en WebUI.
|
||||
3. Valide en WebUI los datos importados de shaping y topología.
|
||||
4. Coloque la caja LibreQoS inline para tráfico piloto.
|
||||
5. Monitoree en WebUI la salud del scheduler, comportamiento de shaping y problemas urgentes.
|
||||
6. Expanda del piloto a un despliegue más amplio tras observar estabilidad.
|
||||
Su CRM/NMS está soportado por integraciones incluidas de LibreQoS.
|
||||
|
||||
### Haga esto ahora
|
||||
|
||||
1. Configure la integración en WebUI.
|
||||
2. Ejecute sincronización inicial y valide datos importados.
|
||||
3. Coloque LibreQoS inline para tráfico piloto.
|
||||
4. Valide señales de salud en WebUI (Scheduler Status, Urgent Issues, vistas de topología/flujo).
|
||||
5. Expanda alcance del piloto tras operación estable.
|
||||
|
||||
Nota:
|
||||
- En modo integración, `ShapedDevices.csv` normalmente se regenera por los jobs de sincronización.
|
||||
- El comportamiento de sobrescritura de `network.json` depende de la configuración (por ejemplo `always_overwrite_network_json`).
|
||||
- La sobrescritura de `network.json` depende de configuración (por ejemplo `always_overwrite_network_json`).
|
||||
|
||||
### Después de esta ruta
|
||||
### Luego vaya aquí
|
||||
|
||||
- [Modos de operación y fuente de verdad](operating-modes-es.md)
|
||||
- [Integraciones CRM/NMS](integrations-es.md)
|
||||
- [Escalado y diseño de topología](scale-topology-es.md)
|
||||
- [Solución de problemas](troubleshooting-es.md)
|
||||
|
||||
## Integración con Script Personalizado
|
||||
|
||||
Use esta ruta cuando su CRM/NMS no esté soportado y usted generará `network.json` y `ShapedDevices.csv` con scripts propios.
|
||||
### Cuándo elegir
|
||||
|
||||
1. Complete prerrequisitos e instale LibreQoS (mismos enlaces/pasos anteriores).
|
||||
2. Implemente script/proceso para generar y refrescar `network.json` y `ShapedDevices.csv`.
|
||||
3. Trate las salidas del script como fuente de verdad para persistencia de largo plazo.
|
||||
4. Coloque la caja LibreQoS inline para tráfico piloto.
|
||||
5. Use WebUI para verificaciones operativas y cambios rápidos.
|
||||
6. Lleve cambios lógicos/de datos permanentes de vuelta a su pipeline de scripts.
|
||||
Su CRM/NMS no está soportado y usted generará `network.json` + `ShapedDevices.csv` con su propio pipeline.
|
||||
|
||||
### Haga esto ahora
|
||||
|
||||
1. Implemente script/proceso para generar y refrescar archivos de shaping.
|
||||
2. Declare salidas del script como fuente de verdad.
|
||||
3. Coloque LibreQoS inline para tráfico piloto.
|
||||
4. Use WebUI para verificaciones operativas y ajustes rápidos.
|
||||
5. Lleve cambios permanentes de vuelta al flujo de scripts.
|
||||
|
||||
Nota:
|
||||
- Las ediciones por WebUI son útiles para cambios operativos rápidos.
|
||||
- Las ediciones por WebUI son útiles para operación rápida.
|
||||
- El estado de largo plazo debe mantenerse en su flujo externo de fuente de verdad.
|
||||
|
||||
### Después de esta ruta
|
||||
### Luego vaya aquí
|
||||
|
||||
- [Modos de operación y fuente de verdad](operating-modes-es.md)
|
||||
- [Referencia avanzada de configuración](configuration-advanced-es.md)
|
||||
@@ -93,18 +99,21 @@ Nota:
|
||||
|
||||
## Archivos Manuales (<100 suscriptores)
|
||||
|
||||
Use esta ruta cuando mantenga intencionalmente `network.json` y `ShapedDevices.csv` de forma directa, sin sincronización CRM/NMS.
|
||||
### Cuándo elegir
|
||||
|
||||
Mantiene intencionalmente `network.json` + `ShapedDevices.csv` sin sincronización CRM/NMS.
|
||||
|
||||
Recomendado solo para redes menores a 100 suscriptores.
|
||||
|
||||
1. Complete prerrequisitos e instale LibreQoS (mismos enlaces/pasos anteriores).
|
||||
2. Construya y mantenga `network.json` y `ShapedDevices.csv` directamente.
|
||||
3. Coloque la caja LibreQoS inline para tráfico piloto.
|
||||
4. Use WebUI para validar shaping, estado del scheduler y comportamiento de topología.
|
||||
5. Mantenga disciplina estricta en actualizaciones manuales (calidad de datos, consistencia y cadencia).
|
||||
6. Si crece el número de suscriptores o el volumen de cambios, planifique migrar a integración soportada o integración con scripts.
|
||||
### Haga esto ahora
|
||||
|
||||
### Después de esta ruta
|
||||
1. Construya y mantenga archivos de shaping directamente.
|
||||
2. Coloque LibreQoS inline para tráfico piloto.
|
||||
3. Valide shaping y estado del scheduler en WebUI.
|
||||
4. Mantenga disciplina estricta de cambios manuales.
|
||||
5. Planifique migración a integración soportada o scripts si crece escala/volumen de cambios.
|
||||
|
||||
### Luego vaya aquí
|
||||
|
||||
- [Referencia avanzada de configuración](configuration-advanced-es.md)
|
||||
- [Modos de operación y fuente de verdad](operating-modes-es.md)
|
||||
@@ -113,5 +122,5 @@ Recomendado solo para redes menores a 100 suscriptores.
|
||||
|
||||
## Instalación para desarrolladores (No recomendada para operadores)
|
||||
|
||||
La instalación basada en Git sigue disponible aquí:
|
||||
La instalación basada en Git está aquí:
|
||||
- [Git Install (Para Desarrolladores)](git-install-es.md)
|
||||
@@ -1,5 +1,9 @@
|
||||
# Configure LibreQoS
|
||||
|
||||
## Page Purpose
|
||||
|
||||
Use this page for daily operations and WebUI configuration. Use [Advanced Configuration Reference](configuration-advanced.md) for direct file editing and CLI-heavy workflows.
|
||||
|
||||
## Initial Configuration Via Setup Tool (From the .deb installer)
|
||||
<img width="1605" height="1030" alt="setup_tool" src="https://github.com/user-attachments/assets/5a645da8-c411-4635-9777-a881966981df" />
|
||||
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
# CRM/NMS Integrations
|
||||
|
||||
## Page Purpose
|
||||
|
||||
Use this page to choose and configure supported CRM/NMS integrations. Use per-integration pages for specific setup details.
|
||||
|
||||
Most operators use built-in integrations. If you use your own scripts as the source of truth for `network.json` and `ShapedDevices.csv`, start with [Operating Modes and Source of Truth](operating-modes.md).
|
||||
|
||||
## Choose Your Integration Path
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
# Operating Modes and Source of Truth
|
||||
|
||||
## Page Purpose
|
||||
|
||||
Use this page to choose and enforce your source-of-truth policy (built-in integrations vs custom source-of-truth) before production changes.
|
||||
|
||||
LibreQoS supports two first-class operating modes.
|
||||
|
||||
## Built-in Integrations (Recommended for Most Operators)
|
||||
|
||||
+59
-50
@@ -1,27 +1,20 @@
|
||||
# Quickstart: Choose Your Deployment Path
|
||||
|
||||
LibreQoS supports multiple real-world deployment paths. Start by selecting one path and keep a single source-of-truth model for shaping data.
|
||||
Use this page to choose the correct deployment path quickly, then execute only the steps for that path.
|
||||
|
||||
## Before You Start
|
||||
## Common Install Foundation
|
||||
|
||||
- WebUI is the primary operational interface after install.
|
||||
- Pick one source-of-truth model for `network.json` and `ShapedDevices.csv`.
|
||||
- Avoid competing edits across multiple systems for the same objects.
|
||||
Complete this once before any path-specific steps.
|
||||
|
||||
## Testbed / Lab
|
||||
|
||||
Use this path when you want to validate LibreQoS behavior in a controlled environment before inline production deployment.
|
||||
|
||||
### Lab setup flow
|
||||
|
||||
1. Build a lab topology (LibreQoS box + traffic generator endpoints + optional routers for OSPF/BGP path simulation).
|
||||
2. Complete platform and install prerequisites:
|
||||
1. Review deployment assumptions and capacity:
|
||||
- [Deployment Scenarios](design.md)
|
||||
- [System Requirements](requirements.md)
|
||||
2. Prepare host and OS:
|
||||
- [Server Setup - Prerequisites](prereq.md)
|
||||
- [Install Ubuntu Server 24.04](ubuntu-server.md)
|
||||
3. Configure bridge mode:
|
||||
- [Configure Shaping Bridge](bridge.md)
|
||||
3. Install LibreQoS using `.deb` package (recommended):
|
||||
4. Install LibreQoS (`.deb` recommended):
|
||||
|
||||
```bash
|
||||
cd ~
|
||||
@@ -31,16 +24,24 @@ wget https://download.libreqos.com/{deb_url_v1_5}
|
||||
sudo apt install ./{deb_url_v1_5}
|
||||
```
|
||||
|
||||
4. Choose one test track:
|
||||
- **Lab with manual files**: use sample/manual `network.json` and `ShapedDevices.csv`.
|
||||
- **Lab with supported integration**: configure integration and validate pulled data.
|
||||
5. Generate test traffic and validate in WebUI:
|
||||
- Dashboard/Tree/Flow behavior
|
||||
- Scheduler status
|
||||
- Urgent issues
|
||||
6. When behavior is as expected, move to an inline pilot path.
|
||||
5. Open WebUI at `http://your_shaper_ip:9123`.
|
||||
|
||||
### After this path
|
||||
## Testbed / Lab
|
||||
|
||||
### When to choose
|
||||
|
||||
You want to validate behavior in a controlled environment before inline production.
|
||||
|
||||
### Do this now
|
||||
|
||||
1. Build a lab topology (LibreQoS + traffic generator endpoints + optional OSPF/BGP path simulation).
|
||||
2. Choose a lab track:
|
||||
- **Lab with manual files**: validate `network.json` + `ShapedDevices.csv` behavior.
|
||||
- **Lab with supported integration**: validate imported subscriber/topology data.
|
||||
3. Generate traffic and validate in WebUI (Dashboard, Tree, Flow, Scheduler Status, Urgent Issues).
|
||||
4. Confirm expected shaping behavior and stability.
|
||||
|
||||
### Then go here
|
||||
|
||||
- [Configure LibreQoS](configuration.md)
|
||||
- [Operating Modes and Source of Truth](operating-modes.md)
|
||||
@@ -49,42 +50,47 @@ sudo apt install ./{deb_url_v1_5}
|
||||
|
||||
## Supported Integration
|
||||
|
||||
Use this path when your CRM/NMS is supported by built-in LibreQoS integrations.
|
||||
### When to choose
|
||||
|
||||
1. Complete install prerequisites and install LibreQoS (same links/steps as above).
|
||||
2. Configure integration in WebUI.
|
||||
3. Validate imported shaping data and topology in WebUI.
|
||||
4. Place the LibreQoS box inline for pilot traffic.
|
||||
5. Monitor scheduler health, shaping behavior, and urgent issues in WebUI.
|
||||
6. Expand from pilot to broader deployment after stable observations.
|
||||
Your CRM/NMS is supported by built-in LibreQoS integrations.
|
||||
|
||||
### Do this now
|
||||
|
||||
1. Configure integration settings in WebUI.
|
||||
2. Run initial sync and validate imported shaping/topology data.
|
||||
3. Place LibreQoS inline for pilot traffic.
|
||||
4. Validate WebUI health signals (Scheduler Status, Urgent Issues, topology/flow views).
|
||||
5. Expand pilot scope after stable operation.
|
||||
|
||||
Note:
|
||||
- In integration mode, `ShapedDevices.csv` is typically regenerated by sync jobs.
|
||||
- `network.json` overwrite behavior depends on integration settings (for example `always_overwrite_network_json`).
|
||||
|
||||
### After this path
|
||||
### Then go here
|
||||
|
||||
- [Operating Modes and Source of Truth](operating-modes.md)
|
||||
- [CRM/NMS Integrations](integrations.md)
|
||||
- [Scale Planning and Topology Design](scale-topology.md)
|
||||
- [Troubleshooting](troubleshooting.md)
|
||||
|
||||
## Custom Script Integration
|
||||
|
||||
Use this path when your CRM/NMS is unsupported and you will generate `network.json` and `ShapedDevices.csv` with your own scripts.
|
||||
### When to choose
|
||||
|
||||
1. Complete install prerequisites and install LibreQoS (same links/steps as above).
|
||||
2. Implement script/process to generate and refresh `network.json` and `ShapedDevices.csv`.
|
||||
3. Treat script outputs as source-of-truth for long-term persistence.
|
||||
4. Place the LibreQoS box inline for pilot traffic.
|
||||
5. Use WebUI for operational checks and quick edits.
|
||||
6. Move permanent logic/data changes back into your script pipeline.
|
||||
Your CRM/NMS is unsupported and you will generate `network.json` + `ShapedDevices.csv` with your own pipeline.
|
||||
|
||||
### Do this now
|
||||
|
||||
1. Implement script/process to generate and refresh shaping files.
|
||||
2. Declare your script outputs as source-of-truth.
|
||||
3. Place LibreQoS inline for pilot traffic.
|
||||
4. Use WebUI for operational checks and quick adjustments.
|
||||
5. Move permanent changes back into your script workflow.
|
||||
|
||||
Note:
|
||||
- WebUI edits are useful for quick operational changes.
|
||||
- WebUI edits are useful for quick operations.
|
||||
- Long-term state should be maintained by your external source-of-truth workflow.
|
||||
|
||||
### After this path
|
||||
### Then go here
|
||||
|
||||
- [Operating Modes and Source of Truth](operating-modes.md)
|
||||
- [Advanced Configuration Reference](configuration-advanced.md)
|
||||
@@ -93,18 +99,21 @@ Note:
|
||||
|
||||
## Manual Files (<100 subscribers)
|
||||
|
||||
Use this path when you intentionally maintain `network.json` and `ShapedDevices.csv` directly without CRM/NMS synchronization.
|
||||
### When to choose
|
||||
|
||||
You intentionally maintain `network.json` + `ShapedDevices.csv` directly without CRM/NMS synchronization.
|
||||
|
||||
Recommended only for networks under 100 subscribers.
|
||||
|
||||
1. Complete install prerequisites and install LibreQoS (same links/steps as above).
|
||||
2. Build and maintain `network.json` and `ShapedDevices.csv` directly.
|
||||
3. Place the LibreQoS box inline for pilot traffic.
|
||||
4. Use WebUI to validate shaping, scheduler status, and topology behavior.
|
||||
5. Keep manual update discipline tight (data quality, consistency, update cadence).
|
||||
6. If subscriber count or change volume grows, plan migration to supported integration or custom script integration.
|
||||
### Do this now
|
||||
|
||||
### After this path
|
||||
1. Build and maintain shaping files directly.
|
||||
2. Place LibreQoS inline for pilot traffic.
|
||||
3. Validate shaping and scheduler status in WebUI.
|
||||
4. Maintain strict manual change discipline.
|
||||
5. Plan migration to supported integration or custom scripts if scale/change volume grows.
|
||||
|
||||
### Then go here
|
||||
|
||||
- [Advanced Configuration Reference](configuration-advanced.md)
|
||||
- [Operating Modes and Source of Truth](operating-modes.md)
|
||||
@@ -113,5 +122,5 @@ Recommended only for networks under 100 subscribers.
|
||||
|
||||
## Developer Install (Not Recommended for Operators)
|
||||
|
||||
Git-based install instructions are still available here:
|
||||
Git-based install instructions are here:
|
||||
- [Git Install (For Developers)](git-install.md)
|
||||
@@ -10,12 +10,12 @@ Welcome to the LibreQoS documentation
|
||||
:maxdepth: 1
|
||||
:caption: Getting Started
|
||||
|
||||
Quickstart (Start Here) <docs/v2.0/quickstart>
|
||||
docs/v2.0/design
|
||||
docs/v2.0/requirements
|
||||
docs/v2.0/prereq
|
||||
docs/v2.0/ubuntu-server
|
||||
docs/v2.0/bridge
|
||||
docs/v2.0/quickstart
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Reference in new issue
Block a user