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

Website: clarify some things in the worker configuration doc

Browse Source
This commit is contained in:
Sybren A. Stüvel 2022-09-29 10:51:53 +02:00
parent 18a5b7f7d3
commit a3e3d7af16
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
web/project-website/content/usage/worker-configuration/_index.md
View File

@ -4,7 +4,7 @@ weight: 3
--- ---
Flamenco Worker will read its configuration from `flamenco-worker.yaml` in the Flamenco Worker will read its configuration from `flamenco-worker.yaml` in the
*current working directory*. worker's *current working directory*.
This is an example of such a configuration file: This is an example of such a configuration file:
@ -13,9 +13,13 @@ manager_url: http://flamenco.local:8080/
task_types: [blender, ffmpeg, file-management, misc] task_types: [blender, ffmpeg, file-management, misc]
``` ```
The task types are determined by the [job compiler scripts][scripts]. The ones - `manager_url`: The URL of the Manager to connect to. If the setting is blank
listed here are in use by the default scripts. These determine which kind of (or removed altogether) the Worker will try to auto-detect the Manager on the
tasks this Worker will get. See [task types][task-types] for more info. network.
- `task_types`: The types of tasks this Worker is allowed to run. Task types are
determined by the [job compiler scripts][scripts]; the ones listed here are in
use by the default scripts. These determine which kind of tasks this Worker
will get. See [task types][task-types] for more info.
[scripts]: {{< ref "usage/job-types" >}} [scripts]: {{< ref "usage/job-types" >}}
[task-types]: {{< ref "usage/job-types" >}}#task-types [task-types]: {{< ref "usage/job-types" >}}#task-types
@ -24,8 +28,10 @@ tasks this Worker will get. See [task types][task-types] for more info.
Apart from the above configuration file, which can be shared between Workers, Apart from the above configuration file, which can be shared between Workers,
each Worker has a set of files that are specific to that Worker. These contain each Worker has a set of files that are specific to that Worker. These contain
the *worker credentials*, which are used to identify this worker to the Manager, the *worker credentials* (`flamenco-worker-credentials.yaml`), which are used to
and a *database file* to queue task updates when the Manager is unreachable. identify this worker to the Manager, and a *database file*
(`flamenco-worker.sqlite`) to queue task updates when the Manager is
unreachable.
These files are stored in a platform-specific location: These files are stored in a platform-specific location: