diff --git a/web/project-website/content/usage/worker-configuration/_index.md b/web/project-website/content/usage/worker-configuration/_index.md index 2c0238e7..c79586e5 100644 --- a/web/project-website/content/usage/worker-configuration/_index.md +++ b/web/project-website/content/usage/worker-configuration/_index.md @@ -4,7 +4,7 @@ weight: 3 --- 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: @@ -13,9 +13,13 @@ manager_url: http://flamenco.local:8080/ task_types: [blender, ffmpeg, file-management, misc] ``` -The 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. +- `manager_url`: The URL of the Manager to connect to. If the setting is blank + (or removed altogether) the Worker will try to auto-detect the Manager on the + 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" >}} [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, 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, -and a *database file* to queue task updates when the Manager is unreachable. +the *worker credentials* (`flamenco-worker-credentials.yaml`), which are used to +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: