From 868c7d5a4c9febdd9d0ca93a41c29c610bbc3de6 Mon Sep 17 00:00:00 2001 From: Vivian Leung Date: Thu, 21 Aug 2025 12:54:06 +0200 Subject: [PATCH] Add missing Manager Config definitions (#104424) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add documentation for `database_check_period` and `clientID` to [Manager Configuration Definitions][1]. [1]: https://flamenco.blender.org/usage/manager-configuration/#definitions Reviewed-on: https://projects.blender.org/studio/flamenco/pulls/104424 Reviewed-by: Sybren A. Stüvel --- .../usage/manager-configuration/_index.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/web/project-website/content/usage/manager-configuration/_index.md b/web/project-website/content/usage/manager-configuration/_index.md index 922ac0b2..0b6a29c0 100644 --- a/web/project-website/content/usage/manager-configuration/_index.md +++ b/web/project-website/content/usage/manager-configuration/_index.md @@ -97,6 +97,22 @@ The file path for the SQLite database. --- +`database_check_period` [duration format](#durations) + +How frequently the database is checked for internal consistency. + +This check always happens at startup of Flamenco Manager. By setting this to a +non-zero duration, the check is also performed while Flamenco Manager is +running. + +It is not typically necessary to set this; it was implemented to help find a +bug, which has been fixed in Flamenco 3.6 ([#104305][bug-104305]). The setting +may be removed in the future. + +[bug-104305]: https://projects.blender.org/studio/flamenco/issues/104305 + +--- + `listen` string The IP and port (e.g., `:8080`, `192.168.0.1:8080`, or `[::]:8080`) Flamenco Manager will listen on. @@ -282,6 +298,12 @@ The configuration for the broker and client. --- +`clientID` string + +An identifier that each MQTT client uses to identify itself. + +--- + `broker` string The URL for the MQTT server.