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.
dispatcher.conf
Section | Key | Description |
---|---|---|
general | engine_startup | Starts the selection logic engine on Dispatcher start up (0/1) |
enable_webserver | Enables the internal web server (0/1) | |
database | username | Specify the username to use for connecting to the database (valid only for mysql) (string) |
password | Specify the password to use for connecting to the database (valid only for mysql) (string) | |
address | Specify the address of the database (valid only for mysql) (string) | |
engine | Specify the engine of the database (sqlite / mysql / sqlserver) (string) | |
db_name | Specify the name of the database. When using sqlite, it specifies the filename of the database (string) | |
db_historyname | Specify the name of the history database. When using sqlite, it specifies the filename of the database (string) | |
db_enablecache | Enables the in-memory data cache (0/1) | |
behaviours | requeue_on_disconnection | Requeue any active chunk if the processing host disconnects (0/1) |
parallel_rendering | Enables parallel rendering | |
requeue_on_timeout | Requeue any active chunk when it takes more than the timeout value to complete (0/1) | |
requeue_on_timeout_timer | Specify the maximum global chunk timeout (n) | |
requeue_kill_active_renders | Kill any active process when requeuing chunks (0/1) | |
sumit_paused_jobs | Submit the jobs in paused status (0/1) | |
max_threads | Maximum number of concurrent threads for actions and assembling (n) | |
drive_mapping | Statically mapped drives (encoded value, configured through Muster Console) | |
build_status_array | Enable status array building (0/1) | |
process_user_pwd | Password for the “impersonate” user | |
process_username | Name for the “impersonate” user | |
subst_case_sensitive | Specifies the case sensitivity of the substitution path engine (0/1) | |
flag_completed_jobs_as_archived | Automatically flag as archived completed jobs (0/1) | |
flag_jobs_as_archived | Enables auto archive (0/1) | |
flag_jobs_as_archived_countertype | Specify the type of counter for the time lapse number (integer) | |
flag_jobs_as_archived_num | Specify an amount of type, related to countertype to elapsed before flagging jobs as archived automatically(integer) | |
enable_nt_automapping | Enables or disables automap on Windows (0/1) | |
instances_distinguish | Defines in which way instances are identified (0 hostname, 1 mac address, 2 host IP address) | |
make_templates_snapshots | Makes snapshot of edited templates (0/1) | |
maximum_chunks_requeue | Defines the maximum number of times a chunk can be requeued | |
nt_automapping_disconnection_policy | Specify the Windows disconnection policy for mapped drives | |
prefilter_parent_pool | Enables the folders pool prefiltering (0/1) | |
remove_orphaned_instances | Remove orphaned instances (0/1) | |
subchunk_calculate_progress | Calculates a job progress using the chunk progress too | |
logs | actions_logs_folder | Specify the paths where to store actions log files (string) |
clear_actions_logs_exceeds | Delete actions logs files when their size exceeds a certain number of MB (0/1) | |
actions_logs_exceeds_mb | Specify the number of Megabytes for the previous option (integer) | |
clear_actions_logs_older_than | Delete actions logs files when they are older than a certain number of days (0/1) | |
actions_logs_days | Specify the number of days for the previous option (integer) | |
activity_logs_folder | Specify the paths where to store activity log files (string) | |
clear_activity_logs_exceeds | Delete activity logs files when their size exceeds a certain number of MB (0/1) | |
activity_logs_exceeds_mb | Specify the number of Megabytes for the previous option (integer) | |
clear_activity_logs_older_than | Delete activity logs files when they are older than a certain number of days (0/1) | |
activity_logs_days | Specify the number of days for the previous option (integer) | |
activity_logs_folder | Specify the paths where to store the activity log files (string) | |
activity_logs_severity | Specifies the verbose level of activity logs (1-5) | |
auto_log_clear | Clear the log automatically (0/1) | |
auto_log_clear_limit | Number of entries to reach before clearing the log (n) | |
send_mail_log | Send the log on a mail address (0/1) | |
send_mail_log_resolution | Number of entries to reach before sending the log on a mail address (n) | |
log_system_events | Log system events (0/1) | |
log_users_events | Log user events (0/1) | |
log_clients_events | Log client events (0/1) | |
log_clientserror_events | Log client error events (0/1) | |
rc_log_cmdline | Log process spawning command line (0/1) | |
rc_log_retcode | Log process return code (0/1) | |
mailer | smtp_server | Address of the smtp server to use for mail notifications (string) |
smtp_account | Account to use to send mail notifications (string) | |
smtp_auth | Enable SMTP authentication (0/1) | |
smtp_auth_login | Login to use for SMTP authentication (string) | |
smtp_auth_pwd | Password to use for SMTP authentication (string) | |
smtp_destination | Mail address or distribution list to use for mail notifications (string) | |
chunk_completation | Notify about chunk completation (0/1) | |
chunk_completation_type | Type of notification (Completed / With warnings) | |
job_completation | Notify about jobs completation (0/1) | |
job_completation_type | Type of notification (Completed / With warnings) | |
network | renderclient_port | Network port to listen for incoming renderclient connections (n) |
control_port | Network port to listen for incoming explorer/mrtool connections (n) | |
notify_port | Network port to listen/broadcast incoming notificators connections (n) | |
keep_alive | Enable heartbeat to keep the connections alive (0/1) | |
keep_alive_resolution | Resolution of the heartbeat (n) | |
stats_broadcast | Enable broadcasting of Dispatcher statistics (0/1) | |
stats_broadcast_resolution | Set the interval to check for broadcasting Dispatcher statistics (default to 60 seconds) | |
stats_resolution | Set the interval to store Dispatcher statistics (default to 60 seconds) | |
management_incoming_buffer | Set 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_attemps | Maximum number of attempts to wakeup an host (n) | |
wol_delay | Time to wait between each wakeup attempt (n) | |
wol_warmup | Specify a certain number of seconds to be passed before starting the wakeup checks (integer) | |
webserver | default_port | Default port to listen for http connections (n) |
default_ssl_port | Default port to listen for https connections (n) | |
max_bandwidth | Maximum bandwidth for each incoming http/https connection (n) 0 = Unlimited | |
sock_timeout | Global timeout value for http/https connections | |
default_serving_threads | Default number of spawned http/https serving threads (n) | |
maximum_serving_threads | Maximum number of spawned http/https serving threads (n) | |
maximum_pending_connections | Maximum number of http/https pending connections (n) | |
webserver_Mimetypes | List of mimetypes supported by the webserver in the following format:MimeN = extension:type | |
faults_behaviours | exitcode_error_addjob_to_exclusion | Enable 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 | ||
actions | timeout | Enable 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 | ||
licensing | company | Licensing company name |
customer | Licensing customer name | |
key | Licensing key | |
notificator | notify_configs | Enables or disable specific notification events |
notify_engine_status | ||
notify_exclusions | ||
notify_jobcompletations | ||
notify_jobstarts | ||
notify_soft_restarts |
rc.conf
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
Section | Key | Description |
---|---|---|
general | instances | Number of instances to spawn (n) |
node_priority | Priority of the node | |
behaviours | default_process_priority | Default process priority (1-5) |
drive_mapping | Statically mapped drives (configured through Management console) | |
enable_nt_automapping | Enable automatic drive mapping on Windows (0/1) | |
jobs_start_timeout | Job starting timeout (n) | |
kill_on_lost_connection | Kill processes on lost connection (0/1) | |
start_paused | Start the client in paused status (0/1) | |
suppress_error_check | Suppress log parsing and error check (0/1) | |
time_rules | Time rules (encoded, configure through Management console) | |
time_rules_default | Default client availability (0/1) | |
time_rules_waitproc | Wait for process termination when going out of scope in time rules (0/1) | |
process_username | Username to impersonate for process spawning (string) | |
process_user_pwd | Password for username to impersonate (string) | |
logon_check | Check for user logging locally (0/1) | |
logon_checkremote | Check for user logging remotely (0/1) | |
logon_waitpacket | Wait for packet termination (0/1) | |
rules_makecontrollable | Enable external control from processes (screen saver) (0/1) | |
nt_automapping_disconnection_policy | Specifies the Windows drive mappings disconnection policy | |
priority_process_tree | Applies the priority to the entire process tree(0/1) | |
terminate_process_tree | Terminates the entire process tree on rendering aborts/kills(0/1) | |
process_check | To be available, check that a specific process is running (0/1) | |
process_check_name | Name of the process | |
not_process_check | To be available, check that a specific process is not running (0/1) | |
not_process_check_name | Name of the process | |
network | broadcast_presence | Broadcast presence on the network (0/1) |
connection_resolution | Reconnect every x seconds (n) | |
dispatcher | Dispatcher address (string) | |
dispatcher_port | Dispatcher network port (n) | |
keep_alive | Send heartbeats to keep the connection alive (0/1) | |
keep_alive_resolution | Resolution for heartbeats (n) | |
management_port | Network port for incoming management connections (n) | |
protected_management | Enable secure management (0/1) | |
protected_management_pwd | Set the password for secure management (string) |