From 1fee086cef4eede8bdc95a21969c0229d981f86d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Wed, 13 Mar 2024 19:16:40 +0100 Subject: [PATCH] Website: add MQTT prefix to table of MQTT topics --- .../usage/manager-configuration/mqtt.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/web/project-website/content/usage/manager-configuration/mqtt.md b/web/project-website/content/usage/manager-configuration/mqtt.md index 03bbfd84..0a8744eb 100644 --- a/web/project-website/content/usage/manager-configuration/mqtt.md +++ b/web/project-website/content/usage/manager-configuration/mqtt.md @@ -47,18 +47,18 @@ mqtt: ## MQTT Topics -The following topics will be used by Flamenco: +The following topics will be used by Flamenco. The `flamenco` prefix for the topics is configurable. -| Description | MQTT topic | JSON event payload | -|----------------------------------|----------------------------------|---------------------------| -| Manager startup/shutdown | `/lifecycle` | `EventLifeCycle` | -| Farm status | `/status` | `EventFarmStatus` | -| Job update | `/jobs` | `EventJobUpdate` | -| Task update | `/jobs/{job UUID}` | `EventTaskUpdate` | -| Worker update | `/workers` | `EventWorkerUpdate` | -| Worker Tag update | `/workertags` | `EventWorkerTagUpdate` | -| Last rendered image | `/last-rendered` | `EventLastRenderedUpdate` | -| Job-specific last rendered image | `/jobs/{job UUID}/last-rendered` | `EventLastRenderedUpdate` | +| Description | MQTT topic | JSON event payload | +|----------------------------------|------------------------------------------|---------------------------| +| Manager startup/shutdown | `flamenco/lifecycle` | `EventLifeCycle` | +| Farm status | `flamenco/status` | `EventFarmStatus` | +| Job update | `flamenco/jobs` | `EventJobUpdate` | +| Task update | `flamenco/jobs/{job UUID}` | `EventTaskUpdate` | +| Worker update | `flamenco/workers` | `EventWorkerUpdate` | +| Worker Tag update | `flamenco/workertags` | `EventWorkerTagUpdate` | +| Last rendered image | `flamenco/last-rendered` | `EventLastRenderedUpdate` | +| Job-specific last rendered image | `flamenco/jobs/{job UUID}/last-rendered` | `EventLastRenderedUpdate` | For the specification of the JSON sent in the MQTT events, use the above table and then look up the type description in the [OpenAPI specification][oapi].