Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.46 KB

configuration.md

File metadata and controls

43 lines (30 loc) · 1.46 KB
Raw

Configuration

The Worker agent configuration is loaded when the program starts. The configuration system has three configuration sources which are checked in the following order:

  1. Command-line arguments
  2. Environment variables
  3. Configuration file
  4. Default (if available)

1. Command-line arguments

The agent can be run with command-line arguments. To see the list of available arguments, run:

deadline-worker-agent --help

2. Environment variables

The agent accepts environment variables of the form DEADLINE_WORKER_<SETTING_NAME>.

See worker.toml.example for details about the supported environment variables.

3. Config file

Configuration is stored in the following directories by default:

Platform Default config directory
Linux /etc/amazon/deadline
MacOS /etc/amazon/deadline
Windows C:\ProgramData\Amazon\Deadline\Config

When running install-deadline-worker, an example configuration file worker.toml.example is installed to the configuration directory. If a worker.toml config file does not pre-exist (e.g. from a prior setup), it will create one by copying the installed example file. The install-deadline-worker command then modifies the configuration file based on its program arguments.

Consult worker.toml.example which contains embedded documentation in comments.