blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add missing Manager Config definitions (#104424)

Browse Source 
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 <sybren@blender.org>
This commit is contained in:
Vivian Leung 2025-08-21 12:54:06 +02:00 committed by Sybren A. Stüvel
parent 80d921fb2a
commit 868c7d5a4c
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
web/project-website/content/usage/manager-configuration/_index.md
View File

@ -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 `listen` string
The IP and port (e.g., `:8080`, `192.168.0.1:8080`, or `[::]:8080`) Flamenco Manager will listen on. 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 `broker` string
The URL for the MQTT server. The URL for the MQTT server.