Skip to content

Config File

Note

The config file is only relevant to the legacy submitter. It is not used by any submitters installed through the plugins page of the Companion App. If you are using newer submitters, the only configuration option is API Key authentication. Please visit this page for details.

The Conductor client tools rely upon a configuration file named config.yml.

The default location for the config file varies by platform:

~/Library/Application Support/Conductor/config.yml

~/.conductor/config.yml

C:\Users\<username>\AppData\Roaming\Conductor Technologies\Conductor\config.yml

Settings

The available settings are specified with YAML keys as described below.

environment

Additional environment variable assignments to be included in submissions. For example, you may want to upload and run a pre-render script. You can use this key to add the path to the script.

environment:
  PATH: /path/to/my/scripts

output_dir

By default, files are downloaded to the directory that was specified on submission. Use this key to override that directory and download it to the specified location. 

output_dir: /special/path/to/my/renders

upload_paths

A list of additional paths to be uploaded. Both files and directories are valid. 

upload_paths: 
  - /path/to/my/scripts/prerender.py
  - /assets/not/detected/during/dependency/scan/

local_upload

Specify whether uploads should run on the workstation where jobs are submitted. Set this key to False if you have a dedicated machine to run an uploader daemon. 

local_upload: False

api_key_path

Full path to the location of a file containing your API_KEY. This is optional if you are not running an uploader or downloader daemons. 

api_key_path: /path/to/my/conductor_api_key.json

location

Tag your submissions with a location. This allows you to download only those tagged jobs while running the downloader daemon.

location: london_studio

Sample config.yaml

local__upload: False
output_dir: /dev/wmd/conductor/images
location: wmd_studio
environment:
    MAYA_SCRIPT_PATH: /dev/wmd/conductor/maya/scripts
upload_paths:
    - /dev/wmd/conductor/maya/plugins
    - /dev/wmd/conductor/maya/scripts
api_key_path: /dev/wmd/conductor/conductor_api_key.json
Back to top