Website: include example flamenco-manager.yaml

Sometimes the setup assistant doesn't work (port already in use, Blender
not installed), so having an example file will make it possible to still
start Flamenco.
This commit is contained in:
Sybren A. Stüvel 2022-09-13 15:29:02 +02:00
parent f33d634161
commit 5d8528d11a

View File

@ -0,0 +1,52 @@
---
title: Manager Configuration
weight: 3
---
Flamenco Manager reads its configuration from `flamenco-manager.yaml`, located
next to the `flamenco-manager` executable. The previous chapters
([Shared Storage][storage] and [Variables][variables]) also described parts of
that configuration file.
## Example Configuration
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:
enabled: true
garbageCollect:
period: 24h0m0s
maxAge: 744h0m0s
extraCheckoutPaths: []
task_timeout: 10m0s
worker_timeout: 1m0s
blocklist_threshold: 3
task_fail_after_softfail_count: 3
variables:
blender:
values:
- platform: linux
value: blender
- platform: windows
value: blender
- platform: darwin
value: blender
blenderArgs:
values:
- platform: all
value: -b -y
```
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.