Client Configuration

Overview

Clients are configured using the deadline.ini file. Some settings are stored in a system deadline.ini file, and some are stored in a per-user deadline.ini file. Most of these settings are set during the Client Installation, but they can be changed afterwards by editing the deadline.ini file directly. Some of these settings can also be updated using Auto Configuration.

This guide will cover the various settings, and how they can be configured.

DEADLINE_PATH Environment Variable

The DEADLINE_PATH Environment variable is an environment variable on Windows and Linux which contains the path to Deadline’s bin directory. On OS X, it is instead a file located at /Users/Shared/Thinkbox which contains the path to Deadline’s resources directory.

DEADLINE_PATH is used by the integrated submisison scripts that are shipped with Deadline to determine where the Deadline Client is installed to, and what the Repository path is. While it is possible to modify this value on the system manually, you can instead use one of the Submitter installers to Change the DEADLINE_PATH Value.

Local Slave Instance Files

Deadline supports the ability to run Multiple Slaves On One Machine. The local slave instances are represented by .ini files which are stored in the “slaves” folder in the following locations. Note that the # in the path will change based on the Deadline version number.

  • Windows: %PROGRAMDATA%\Thinkbox\Deadline#\slaves\
  • Linux: /var/lib/Thinkbox/Deadline#/slaves/
  • OS X: /Users/Shared/Thinkbox/Deadline#/slaves/

To remove local slave instances, simply delete their corresponding .ini file. Note that this does not remove the slave entries from the repository that the slaves connected to.

Configuration File Format

The deadline.ini file has an ini file format, so there will be a [Deadline] section followed by a number of key=value pairs that represent each setting. For example:

[Deadline]
LicenseServer=@my-server
NetworkRoot=\\\\repository\\path
LauncherListeningPort=17060
AutoConfigurationPort=17061

System Configuration File

The system deadline.ini file can be found in the following locations. Note that the # in the path will change based on the Deadline version number.

  • Windows: %PROGRAMDATA%\Thinkbox\Deadline#\deadline.ini
  • Linux: /var/lib/Thinkbox/Deadline#/deadline.ini
  • OS X: /Users/Shared/Thinkbox/Deadline#/deadline.ini

The following settings can be configured in the system deadline.ini file. Note that other settings can show up in this file, but they are used internally by Deadline and are not documented here.

NetworkRoot

The NetworkRoot setting tells the Client which Repository to connect to.

NetworkRoot=\\\\repository\\path

There can also be additional NetworkRoot# settings that store previous Repository paths. These paths will be pre-populated in the drop down list when changing Repositories.

NetworkRoot0=\\\\repository\\path
NetworkRoot1=\\\\another\\repository
NetworkRoot2=\\\\test\\repository

This setting can be changed using the Change Repository option in the Launcher or the Monitor, and it can also be configured using Auto Configuration.

LicenseServer

The LicenseServer setting tells the Client where it can get a license from.

LicenseServer=@my-server

This setting can be changed using the Change License Server option in the Launcher or the Slave, and it can also be configured using Auto Configuration.

LauncherListeningPort

The LauncherListeningPort setting is the port that the Launcher listens on for Remote Control. It must be the same on all Clients.

LauncherListeningPort=17060

This setting can only be changed manually.

LauncherServiceStartupDelay

The LauncherServiceStartupDelay setting is the number of seconds that the Launcher waits during startup when running as a service or daemon. This delay helps ensure that the machine has set its host name before the Launcher starts up any other Deadline applications.

LauncherServiceStartupDelay=60

This setting can only be changed manually.

SlaveStartupPort

The SlaveStartupPort setting is the port that the Slaves on this machine use when starting up to ensure that only one Slave starts up at a time.

LauncherListeningPort=17063

This setting can only be changed manually.

AutoConfigurationPort

The AutoConfigurationPort setting is the port that the Clients use when Auto Configuring themselves. It must be the same on all Clients.

AutoConfigurationPort=17061

This setting can only be changed manually

SlaveDataRoot

The SlaveDataRoot setting tells the Slave where to copy its job files temporarily during rendering. The default location is the “slave” folder in the same folder as the per-user deadline.ini file. If left blank, the default location will be used as well.

SlaveDataRoot=C:\LocalSlaveData

This setting can be configured using Auto Configuration.

MultipleSlavesEnabled

The MultipleSlavesEnabled setting indicates if multiple slaves are allowed to run on this machine or not. The default is True.

MultipleSlavesEnabled=True

This setting can only be changed manually.

RestartStalledSlave

The RestartStalledSlave setting indicates if the Launcher should try to restart the Slave on the machine if it becomes stalled. The default is True.

RestartStalledSlave=True

This setting can be changed from the Launcher menu, and it can also be configured using Auto Configuration.

LaunchPulseAtStartup

The LaunchPulseAtStartup setting controls if the Launcher should automatically launch Pulse after the launcher starts up. The default is False.

LaunchPulseAtStartup=True

This setting can only be changed manually.

KeepPulseRunning

The KeepPulseRunning setting controls if the Launcher should automatically relaunch Pulse if it is shut down or crashes. The default is False.

KeepPulseRunning=True

This setting can only be changed manually.

LaunchBalancerAtStartup

The LaunchBalancerAtStartup setting controls if the Launcher should automatically launch the Balancer after the launcher starts up. The default is False.

LaunchBalancerAtStartup=True

This setting can only be changed manually.

KeepBalancerRunning

The KeepBalancerRunning setting controls if the Launcher should automatically relaunch Balancer if it is shut down or crashes. The default is False.

KeepBalancerRunning=True

This setting can only be changed manually.

LaunchWebServiceAtStartup

The LaunchWebServiceAtStartup setting controls if the Launcher should automatically launch the Web Service after the launcher starts up. The default is False.

LaunchWebServiceAtStartup=True

This setting can only be changed manually.

KeepWebServiceRunning

The KeepWebServiceRunning setting controls if the Launcher should automatically relaunch Web Service if it is shut down or crashes. The default is False.

KeepWebServiceRunning=True

This setting can only be changed manually.

AutoUpdateOverride

The AutoUpdateOverride setting can be used to override the Automatic Upgrades setting in the Repository Configuration. If left blank, then it will not override the Repository Options, which is also the default behavior if this setting isn’t specified.

AutoUpdateOverride=False

This setting can be configured using Auto Configuration.

Per-User Configuration File

The per-user deadline.ini file can be found in the following locations. Note that the # in the path will change based on the Deadline version number.

  • Windows: %LOCALAPPDATA%\Thinkbox\Deadline#\deadline.ini
  • Linux: ~/Thinkbox/Deadline#/deadline.ini
  • OS X: ~/Library/Application Support/Thinkbox/Deadline#/deadline.ini

The following settings can be configured in the per-user deadline.ini file.

User

The User setting is used by the Client to know which user you are when launching the Monitor or when submitting jobs.

User=Ryan

This setting can be changed using the Change User option in the Launcher or the Monitor. To prevent users from changing who they are, see the User Management documentation.

LaunchSlaveAtStartup

The LaunchSlaveAtStartup setting controls if the Launcher should automatically launch the Slave after the launcher starts up. The default is True.

LaunchSlaveAtStartup=False

This setting can be changed from the Launcher menu, and it can also be configured using Auto Configuration.