flamenco/web/project-website/content/usage/manager-configuration/mqtt.md

title	titleTOC
Manager Configuration: MQTT	MQTT

Flamenco Manager can send its internal events to an MQTT broker. Other MQTT clients can listen to those events, in order to respond to what happens on the render farm.

MQTT support was introduced in Flamenco 3.5.

Configuration

To enable MQTT functionality, place a section like this in your flamenco-manager.yaml file and restart Flamenco Manager:

mqtt:
  client:
    broker: "tcp://mqttserver.local:1883"
    username: "username"
    password: "your-password-here"
    topic_prefix: flamenco

broker

The URL of the MQTT Broker. Supports tcp:// and ws:// URLs.

username & password

The credentials used to connect to the MQTT Broker. For anonymous access, just remove those two keys.

topic_prefix

Topic prefix for the MQTT events sent to the broker. Defaults to flamenco. For example, job updates are sent to the flamenco/jobs topic.

MQTT Topics

The following topics will be used by Flamenco:

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

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.