You can configure HQueue by editing the configuration file on the server. The file is located at /opt/hqueue/hqserver.ini.
After modifying the file, you need to restart the HQueue server in order for the changes to take effect. Restarting is platform specific:
On Linux, run:
cd /opt/hqueue
./scripts/hqserverd restart
On Mac OS X, run:
launchctl unload /Library/LaunchDaemons/com.sidefx.hqserver.plist
launchctl load /Library/LaunchDaemons/com.sidefx.hqserver.plis
On Windows, simply restart the HQueueServer service.
Below is a list of the configuration variables that you can modify. Note that you can use %(here)s in any of the variable values to refer to the directory location of the configuration file.
| debug |
Set to true to output debugging information into the server logs (see
10 Logging
). |
| email_to |
The email address that HQueue should send messages to when a system error occurs. Make sure to also set the smtp_server variable. |
| error_email_from |
The email address that HQueue should use when sending messages. Make sure to also set the smtp_server variable. |
| hqserver.activeTimeout |
The number of minutes that should pass before a client machine is considered inactive (i.e. not responding). |
| hqserver.expireJobsDays |
The number of days that should pass before a finished job is permanently deleted from HQueue. |
| hqserver.port |
The port number that the HQueue server listens on. This variable must have the same value as the port variable. |
| hqserver.sharedNetwork.host |
The name of the machine that is hosting the HQueue shared network drive. |
| hqserver.sharedNetwork.mount.linux |
The mount point to the HQueue shared network drive as it should appear on a Linux client or user machine. |
| hqserver.sharedNetwork.mount.macosx |
The mount point to the HQueue shared network drive as it should appear on a Mac OSX client or user machine. |
| hqserver.sharedNetwork.mount.windows |
The mount point to the HQueue shared network drive as it should appear on a Windows client or user machine. |
| hqserver.sharedNetwork.path |
The folder path to the HQueue shared network drive on the host machine. |
| hqserver.upgradePriority |
The priority level to use for the built-in "Upgrade" jobs. |
| job_logs_dir |
The folder where job logs are saved to. |
| port |
The port number that the HQueue server listens on. This variable must have the same value as the hqserver.port variable. |
| smtp_server |
The mail server which delivers messages from HQueue to the address defined in the hqserver.email_to variable. |
| sqlalchemy.default.pool_size |
The maximum number of database connections available in the connection pool. If you see "QueuePool limit of size" errors in the server log, then you need to increase the value of this variable. As a general rule of thumb, set pool size roughly equal to the number of client machines registered on the farm. |
| sqlalchemy.default.max_overflow |
The maximum number of database connections to create in excess of the value defined in sqlalchemy.default.pool_size. This variable only takes effect during peak periods when the number of connections required exceeds the maximum pool size. |
