On this page |
Server configuration
The HQueue server uses a configuration file in /opt/hqueue/hqserver.ini
on the server machine. You can edit this file and restart the HQueue server to change how HQueue works.
Linux
To restart the server on Linux, run:
cd /opt/hqueue ./scripts/hqserverd restart
Mac
To restart the server on macOS, run:
launchctl unload -F /Library/LaunchDaemons/com.sidefx.hqserver.plist launchctl load -F /Library/LaunchDaemons/com.sidefx.hqserver.plis
Windows
To restart the server on Windows, go to Control Panel ▸ Administrative Tools ▸ Services and restart the HQueueServer
service.
Values
Tip
If you use the string %(here)s
in a value, it will be replaced with the path of the directory containing the hqserver.ini
file. You can use this to specify paths relative to the configuration file location.
Name |
Description |
---|---|
|
The email address that receives messages when a system error or notification occurs. |
|
The email address that sends messages when a system error or notification occurs. |
|
The number of minutes that pass before a client machine is marked as 'not responding'. |
|
The number of days that pass before a finished job is permanently deleted from HQueue. |
|
The port number that the HQueue server listens on. This variable must have the same value as |
|
The machine hosting the shared network drive. (Deprecated: Use the web UI) |
|
The mount point to the shared network drive on a Linux client machine. (Deprecated: Use the web UI) |
|
The mount point to the shared network drive on a macOS client machine. (Deprecated: Use the web UI) |
|
The mount point to the shared network drive on a Windows client machine. (Deprecated: Use the web UI) |
|
The folder path to the shared network drive on the host machine. (Deprecated: Use the web UI) |
|
The priority setting for the built-in “Upgrade” jobs. |
|
The folder where job logs are saved to. |
|
The port number that the HQueue server listens on. This variable must have the same value as |
|
The mail server that delivers messages when a system error or notification occurs. |
|
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 |
|
The maximum number of database connections to create in excess of the value defined in |
Management Scripts
HQueue now has management scripts in case you need a script for your setup needs. The purpose of these scripts is to easily add new objects to the DB without using the web UI. Currently only one management script exists, which is for network folders (manage_network_folders.py), but more will be added in the future.
Here is a list of the management scripts that currently exist:
Name |
Description |
---|---|
|
Deals with adding/modifying/deleting network folders. |
Linux
To use a script on Linux, run in a terminal:
cd <install_dir> ./bin/python ./scripts/<scriptname> <subcommand> (--options)
Mac
To use a script on macOS, run a Terminal app:
cd <install_dir> ./Frameworks/Python.framework/Versions/2.7/bin/python ./scripts/<scriptname> <subcommand> (--options)
Windows
To use a script on Windows, run in a command prompt:
cd <install_dir> .\python27\python.exe .\python27\Scripts\<scriptname> <subcommand> (--options)
The scriptname is the name of the script to execute (e.g. manage_network_folders.py). To see a list of subcommands for each list, run the script with the -h flag. To get subcommand-specific options, run the script and subcommand with the -h flag.
Client configuration
The HQueue client uses a configuration file named hqnode.ini
in the client installation directory. You can edit this file and restart the client to change how the client works.
Linux
To restart the client on Linux, run:
cd <install_dir> ./hqclientd restart
Mac
To restart the client On macOS, run:
launchctl unload -F /Library/LaunchDaemons/com.sidefx.hqclient.plist launchctl load -F /Library/LaunchDaemons/com.sidefx.hqclient.plist
Windows
To restart the client on Windows, go to Control Panel ▸ Administrative Tools ▸ Services and restart the HQueueClient
service.
Values
Name |
Description |
---|---|
|
The mount point to the shared network drive on the client. |
|
The HQueue server the client should connect to. If this is set, the |
|
The port number that the HQueue server listens on. |
|
The name for the client. This is only needed if you are planning to run multiple clients on the same machine. If you wish to run multiple clients on the same machine, ensure each client is launched from separate installation directories and configure each client’s |
|
The number of cpus available to the client for running jobs. |
|
Controls whether the client should automatically upgrade on start up if an upgrade is available. Set this to |