Configuration files

On a complete Muster installation, there’re several configuration files that may be manually edited by users or configured automatically by Muster.

The following list shows which files are installed by each module and their purpose:

  • dispatcher.conf: This file holds the behaviours of the dispatcher service.
  • rc.conf: This file holds the behaviours of the renderclient service.
  • cert.pem and key.pem: Those files hold the certificate used for any HTTPS connection through the Muster integrated web server.

You can regenerate certificates on your own or use certificates generated from an authority. We suggest to check the openssl documentation to learn more about self-signed and requests of certificates.

Configuration files hold keys and values after a section declaration surrounded by [] brackets like:

[General]
Mykey = myvalue

An explanation of each configuration file and its structure follows.

SectionKeyDescription
generalengine_startupStarts the selection logic engine on Dispatcher start up (0/1)
enable_webserverEnables the internal web server (0/1)
databaseusernameSpecify the username to use for connecting to the database (valid only for mysql) (string)
passwordSpecify the password to use for connecting to the database (valid only for mysql) (string)
addressSpecify the address of the database (valid only for mysql) (string)
engineSpecify the engine of the database (sqlite / mysql / sqlserver) (string)
db_nameSpecify the name of the database. When using sqlite, it specifies the filename of the database (string)
db_historynameSpecify the name of the history database. When using sqlite, it specifies the filename of the database (string)
db_enablecacheEnables the in-memory data cache (0/1)
behavioursrequeue_on_disconnectionRequeue any active chunk if the processing host disconnects (0/1)
parallel_renderingEnables parallel rendering
requeue_on_timeoutRequeue any active chunk when it takes more than the timeout value to complete (0/1)
requeue_on_timeout_timerSpecify the maximum global chunk timeout (n)
requeue_kill_active_rendersKill any active process when requeuing chunks (0/1)
sumit_paused_jobsSubmit the jobs in paused status (0/1)
max_threadsMaximum number of concurrent threads for actions and assembling (n)
drive_mappingStatically mapped drives (encoded value, configured through Muster Console)
build_status_arrayEnable status array building (0/1)
process_user_pwdPassword for the “impersonate” user
process_usernameName for the “impersonate” user
subst_case_sensitiveSpecifies the case sensitivity of the substitution path engine (0/1)
flag_completed_jobs_as_archivedAutomatically flag as archived completed jobs (0/1)
flag_jobs_as_archivedEnables auto archive (0/1)
flag_jobs_as_archived_countertypeSpecify the type of counter for the time lapse number (integer)
flag_jobs_as_archived_numSpecify an amount of type, related to countertype to elapsed before flagging jobs as archived automatically(integer)
enable_nt_automappingEnables or disables automap on Windows (0/1)
instances_distinguishDefines in which way instances are identified (0 hostname, 1 mac address, 2 host IP address)
make_templates_snapshotsMakes snapshot of edited templates (0/1)
maximum_chunks_requeueDefines the maximum number of times a chunk can be requeued
nt_automapping_disconnection_policySpecify the Windows disconnection policy for mapped drives
prefilter_parent_poolEnables the folders pool prefiltering (0/1)
remove_orphaned_instancesRemove orphaned instances (0/1)
subchunk_calculate_progressCalculates a job progress using the chunk progress too
logsactions_logs_folderSpecify the paths where to store actions log files (string)
clear_actions_logs_exceedsDelete actions logs files when their size exceeds a certain number of MB (0/1)
actions_logs_exceeds_mbSpecify the number of Megabytes for the previous option (integer)
clear_actions_logs_older_thanDelete actions logs files when they are older than a certain number of days (0/1)
actions_logs_daysSpecify the number of days for the previous option (integer)
activity_logs_folderSpecify the paths where to store activity log files (string)
clear_activity_logs_exceedsDelete activity logs files when their size exceeds a certain number of MB (0/1)
activity_logs_exceeds_mbSpecify the number of Megabytes for the previous option (integer)
clear_activity_logs_older_thanDelete activity logs files when they are older than a certain number of days (0/1)
activity_logs_daysSpecify the number of days for the previous option (integer)
activity_logs_folderSpecify the paths where to store the activity log files (string)
activity_logs_severitySpecifies the verbose level of activity logs (1-5)
auto_log_clearClear the log automatically (0/1)
auto_log_clear_limitNumber of entries to reach before clearing the log (n)
send_mail_logSend the log on a mail address (0/1)
send_mail_log_resolutionNumber of entries to reach before sending the log on a mail address (n)
log_system_eventsLog system events (0/1)
log_users_eventsLog user events (0/1)
log_clients_eventsLog client events (0/1)
log_clientserror_eventsLog client error events (0/1)
rc_log_cmdlineLog process spawning command line (0/1)
rc_log_retcodeLog process return code (0/1)
mailersmtp_serverAddress of the smtp server to use for mail notifications (string)
smtp_accountAccount to use to send mail notifications (string)
smtp_authEnable SMTP authentication (0/1)
smtp_auth_loginLogin to use for SMTP authentication (string)
smtp_auth_pwdPassword to use for SMTP authentication (string)
smtp_destinationMail address or distribution list to use for mail notifications (string)
chunk_completationNotify about chunk completation (0/1)
chunk_completation_typeType of notification (Completed / With warnings)
job_completationNotify about jobs completation (0/1)
job_completation_typeType of notification (Completed / With warnings)
networkrenderclient_portNetwork port to listen for incoming renderclient connections (n)
control_portNetwork port to listen for incoming explorer/mrtool connections (n)
notify_portNetwork port to listen/broadcast incoming notificators connections (n)
keep_aliveEnable heartbeat to keep the connections alive (0/1)
keep_alive_resolutionResolution of the heartbeat (n)
stats_broadcastEnable broadcasting of Dispatcher statistics (0/1)
stats_broadcast_resolutionSet the interval to check for broadcasting Dispatcher statistics (default to 60 seconds)
stats_resolutionSet the interval to store Dispatcher statistics (default to 60 seconds)
management_incoming_bufferSet the maximum number of bytes hold by the relative network buffer. Defaults to 125600(125K approx.)
management_outgoing_buffer
notification_outgoing_buffer
rc_incoming_buffer
rc_outgoing_buffer
wol_attempsMaximum number of attempts to wakeup an host (n)
wol_delayTime to wait between each wakeup attempt (n)
wol_warmupSpecify a certain number of seconds to be passed before starting the wakeup checks (integer)
webserverdefault_portDefault port to listen for http connections (n)
default_ssl_portDefault port to listen for https connections (n)
max_bandwidthMaximum bandwidth for each incoming http/https connection (n) 0 = Unlimited
sock_timeoutGlobal timeout value for http/https connections
default_serving_threadsDefault number of spawned http/https serving threads (n)
maximum_serving_threadsMaximum number of spawned http/https serving threads (n)
maximum_pending_connectionsMaximum number of http/https pending connections (n)
webserver_MimetypesList of mimetypes supported by the webserver in the following format:MimeN = extension:type
faults_behavioursexitcode_error_addjob_to_exclusionEnable or disable specific features of the fault behaviours (0/1)
exitcode_error_addtemplate_to_exclusion
exitcode_error_enabled
exitcode_error_pausejob
exitcode_error_pausenode
exitcode_error_requeue_chunk
exitcode_warning_addjob_to_exclusion
exitcode_warning_addtemplate_to_exclusion
exitcode_warning_enabled
exitcode_warning_pausejob
exitcode_warning_pausenode
exitcode_warning_requeue_chunk
log_error_addjob_to_exclusion
log_error_addtemplate_to_exclusion
log_error_enabled
log_error_pausejob
log_error_pausenode
log_error_requeue_chunk
log_warning_addjob_to_exclusion
log_warning_addtemplate_to_exclusion
log_warning_enabled
log_warning_pausejob
log_warning_pausenode
log_warning_requeue_chunk
proc_addjob_to_exclusion
proc_addtemplate_to_exclusion
proc_pausejob
proc_pausenode
proc_requeue_chunk
timeout_addjob_to_exclusion
timeout_addtemplate_to_exclusion
timeout_kill_any_client
timeout_pausejob
timeout_pausenode
actionstimeoutEnable or disable specific features of the actions behaviours (0/1)
chunk_failure_abort_processing
chunk_failure_add_job_to_exclusion
chunk_failure_add_template_to_exclusion
chunk_failure_requeue_chunk
chunk_postaction
chunk_postaction_check_retcode
chunk_postaction_enabled
chunk_postaction_retcode
chunk_postaction_override_timeout
chunk_postaction_timeout
chunk_preaction
chunk_preaction_check_retcode
chunk_preaction_enabled
chunk_preaction_retcode
chunk_preaction_override_timeout
chunk_preaction_timeout
job_failure_lock_job
job_failure_pause_job
job_postaction
job_postaction_check_retcode
job_postaction_enabled
job_postaction_retcode
job_postaction_override_timeout
job_postaction_timeout
job_preaction
job_preaction_check_retcode
job_preaction_enabled
job_preaction_retcode
job_preaction_override_timeout
job_preaction_timeout
licensingcompanyLicensing company name
customerLicensing customer name
keyLicensing key
notificatornotify_configsEnables or disable specific notification events
notify_engine_status
notify_exclusions
notify_jobcompletations
notify_jobstarts
notify_soft_restarts

In addition to the rc.conf common keys, the file also contains keys and values specific to each template configurable field. The section name is equal to the template unique ID (i.e. [1] for template ID 1), while the key depends on the name of the configurable field.

Example:

[1]
MYKEY = MYVALUE

This sets the value MYKEY of template ID 1 to MYVALUE

SectionKeyDescription
generalinstancesNumber of instances to spawn (n)
node_priorityPriority of the node
behavioursdefault_process_priorityDefault process priority (1-5)
drive_mappingStatically mapped drives (configured through Management console)
enable_nt_automappingEnable automatic drive mapping on Windows (0/1)
jobs_start_timeoutJob starting timeout (n)
kill_on_lost_connectionKill processes on lost connection (0/1)
start_pausedStart the client in paused status (0/1)
suppress_error_checkSuppress log parsing and error check (0/1)
time_rulesTime rules (encoded, configure through Management console)
time_rules_defaultDefault client availability (0/1)
time_rules_waitprocWait for process termination when going out of scope in time rules (0/1)
process_usernameUsername to impersonate for process spawning (string)
process_user_pwdPassword for username to impersonate (string)
logon_checkCheck for user logging locally (0/1)
logon_checkremoteCheck for user logging remotely (0/1)
logon_waitpacketWait for packet termination (0/1)
rules_makecontrollableEnable external control from processes (screen saver) (0/1)
nt_automapping_disconnection_policySpecifies the Windows drive mappings disconnection policy
priority_process_treeApplies the priority to the entire process tree(0/1)
terminate_process_treeTerminates the entire process tree on rendering aborts/kills(0/1)
process_checkTo be available, check that a specific process is running (0/1)
process_check_nameName of the process
not_process_checkTo be available, check that a specific process is not running (0/1)
not_process_check_nameName of the process
networkbroadcast_presenceBroadcast presence on the network (0/1)
connection_resolutionReconnect every x seconds (n)
dispatcherDispatcher address (string)
dispatcher_portDispatcher network port (n)
keep_aliveSend heartbeats to keep the connection alive (0/1)
keep_alive_resolutionResolution for heartbeats (n)
management_portNetwork port for incoming management connections (n)
protected_managementEnable secure management (0/1)
protected_management_pwdSet the password for secure management (string)