Fix API docs routing behind managed Caddy HTTPS

This commit is contained in:
Herbert Wolverson committed 2026-09-04 15:17:23 -05:00
1 parent 750560a14d
commit 87f0d595d7
5 files changed
+14 -6

No files matched your search

+1 -1
View File
@@ -21,7 +21,7 @@ API-only access is available through the **Try Insight** link in the WebUI at ha
Use Swagger on your node as the complete reference and test surface for your installed build:
- Direct local API port: `http://<node-ip>:9122/api-docs`
- If optional HTTPS with Caddy is enabled for the WebUI: `https://<hostname-or-node-ip>/api/v1/api-docs`
- If optional HTTPS with Caddy is enabled for the WebUI: `https://<hostname-or-node-ip>/api-docs/`
On systems using managed Caddy HTTPS, leave the API listener on loopback and access it through `/api/v1/`. `LQOS_API_LISTEN` is an advanced override for deployments that intentionally expose the API listener directly; do not set it on managed Caddy systems unless direct API exposure, firewalling, TLS, and operator access controls have been planned together.
+5 -1
View File
@@ -21,7 +21,11 @@ LibreQoS supports two simple choices:
- LibreQoS moves the WebUI listener to `127.0.0.1:9123`.
- Caddy proxies the WebUI and API docs over HTTPS.
- Managed Caddy mode proxies API requests to `127.0.0.1:9122`, so the API stays behind the same HTTPS origin as the WebUI.
- Swagger moves to `/api/v1/api-docs` on the same HTTPS origin as the WebUI.
- Swagger moves to `/api-docs/` on the same HTTPS origin as the WebUI.
The API documentation is public; API requests still require an API key. Existing `/api/v1/api-docs` links redirect to `/api-docs/`.
After upgrading an existing HTTPS installation, reapply your settings in `Configuration -> SSL Setup` to update the Caddy routes. This regenerates `/etc/caddy/Caddyfile`, replacing manual edits, and restarts Caddy, the WebUI, and the API service.
## API Listen Overrides