diff --git a/web/project-website/content/usage/manager-configuration/_index.md b/web/project-website/content/usage/manager-configuration/_index.md index e85ccc65..edae1e55 100644 --- a/web/project-website/content/usage/manager-configuration/_index.md +++ b/web/project-website/content/usage/manager-configuration/_index.md @@ -18,10 +18,12 @@ This is an example `flamenco-manager.yaml` file: ```yaml _meta: version: 3 + manager_name: Flamenco Manager database: flamenco-manager.sqlite listen: :8080 autodiscoverable: true + local_manager_storage_path: ./flamenco-manager-storage shared_storage_path: /path/to/storage shaman: @@ -30,10 +32,12 @@ shaman: period: 24h0m0s maxAge: 744h0m0s extraCheckoutPaths: [] + task_timeout: 10m0s worker_timeout: 1m0s blocklist_threshold: 3 task_fail_after_softfail_count: 3 + variables: blender: values: @@ -47,9 +51,26 @@ variables: values: - platform: all value: -b -y + +mqtt: # See 'MQTT Configuration' below. + client: + broker: "tcp://mqttserver.local:1883" + username: "username" + password: "your-password-here" + topic_prefix: flamenco + ``` The usual way to create a configuration file is simply by starting Flamenco Manager. If there is no config file yet, it will start the setup assistant to create one. If for any reasons the setup assistant is not usable for you, you can use the above example to create `flamenco-manager.yaml` yourself. + +## MQTT Configuration + +The `mqtt` section is completely optional. If you do not know what it's for, just leave it out. + +For more information about the built-in MQTT client, see +[Manager Configuration: MQTT][mqtt]. + +[mqtt]: {{< ref "usage/manager-configuration/mqtt.md" >}} diff --git a/web/project-website/content/usage/manager-configuration/mqtt.md b/web/project-website/content/usage/manager-configuration/mqtt.md new file mode 100644 index 00000000..03bbfd84 --- /dev/null +++ b/web/project-website/content/usage/manager-configuration/mqtt.md @@ -0,0 +1,66 @@ +--- +title: "Manager Configuration: MQTT" +titleTOC: MQTT +--- + +Flamenco Manager can send its internal events to an [MQTT][mqtt] broker. Other +MQTT clients can listen to those events, in order to respond to what happens on +the render farm. + +[mqtt]: https://en.wikipedia.org/wiki/MQTT + +*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: + +```yaml +mqtt: + client: + broker: "tcp://mqttserver.local:1883" + username: "username" + password: "your-password-here" + topic_prefix: flamenco +``` + +