| On this page |
Overview ¶
Starting in Houdini 22, the new Houdini Installer (formerly Houdini Launcher) is the only supported way to install Houdini.
With the Houdini Installer, installation is now a two-step process:
-
Set up the Houdini Installer application (downloaded from sidefx.com).
-
Open the application or run the
houdini_installercommand to install Houdini and other products.
With the old installer, these steps were combined into a single self-extracting installer. The new approach allows you to install and update multiple Houdini versions without re-downloading the installer each time.
For new scripts, we recommend using the standard install subcommand rather than legacy_install.
See Installer for full documentation of the new installer commands.
Updating Install Scripts ¶
To update scripts that use the old installer, the new installer provides a legacy_install command that accepts most of the same command-line options as the old houdini.install script.
legacy_install subcommand
¶
The legacy_install command translates old installer options into the equivalent new installer commands.
houdini_installer legacy_install [options] [installdir]
Note
The legacy_install command is not available on macOS.
Basic Usage ¶
# Online installation with login credentials houdini_installer legacy_install \ --login-file ~/sidefx_credentials.txt \ --version 22.0.123 \ --accept-EULA 2021-10-13 \ --install-houdini \ --no-install-license \ /opt/hfs22.0 # Offline installation from a tarball houdini_installer legacy_install \ --offline-installer houdini-22.0.123-linux_x86_64_gcc11.3.tar.gz \ --accept-EULA 2021-10-13 \ /opt/hfs22.0
Supported Options ¶
The following options from the old installer are supported:
General Options ¶
--offline-installer ‹path›
Path to the offline installer tarball or ISO file.
--accept-EULA ‹date›
Accept the End User License Agreement. The date should be in the format YYYY-MM-DD (for example, 2021-10-13).
--version ‹version›
The version to install (for example, 22.0.123).
--platform ‹platform›
The platform identifier (for example, linux_x86_64_gcc11.3).
--build-option ‹option›
The build type (for example, production or daily).
--login-file ‹path›
Path to a file containing login credentials.
installdir
(Linux only) The installation directory, specified as a positional argument at the end of the command.
Product Selection ¶
Products can be enabled with --install-<product> or disabled with --no-install-<product>. Short aliases are also supported.
--install-houdini, --houdini
Install Houdini (enabled by default).
--no-install-houdini, --no-houdini
Do not install Houdini.
--install-license, --license
Install the License Server (enabled by default).
--no-install-license, --no-license
Do not install the License Server.
--install-engine-maya, --installEngineMaya
Install the Houdini Engine for Maya.
--no-install-engine-maya, --no-installEngineMaya
Do not install the Houdini Engine for Maya.
--install-engine-unity, --installEngineUnity
Install the Houdini Engine for Unity.
--no-install-engine-unity, --no-installEngineUnity
Do not install the Houdini Engine for Unity.
--install-engine-unreal, --installEngineUnreal
Install the Houdini Engine for Unreal.
--no-install-engine-unreal, --no-installEngineUnreal
Do not install the Houdini Engine for Unreal.
--install-sidefxlabs, --sidefxlabs
Install SideFX Labs.
--sidefxlabs-dir ‹path›
Directory to install SideFX Labs.
HQueue Server Options ¶
--install-hqueue-server
Install HQueue Server.
--no-install-hqueue-server
Do not install HQueue Server.
--hqueue-server-dir ‹path›
Directory to install HQueue Server.
HQueue Client Options ¶
--install-hqueue-client
Install HQueue Client.
--no-install-hqueue-client
Do not install HQueue Client.
--hqueue-client-dir ‹path›
Directory to install HQueue Client.
--hqueue-client-user ‹username›, --hqueue-client-account ‹username›
User account to run HQueue Client.
--hqueue-server-name ‹hostname›
Hostname of the HQueue Server.
--hqueue-server-port ‹port›
Port number of the HQueue Server.
Unsupported Options ¶
The following options from the old installer are not supported by legacy_install:
--make-dir
The new installer does not support automatic directory creation. Ensure the parent directory exists before installation.
--auto-install
Automatic installation is handled differently in the new installer.
--no-root-check
Root privilege checks are handled differently in the new installer.
--no-install-sidefxlabs
Not installing SideFX Labs is the default behavior.
--install-bin-symlink, --no-install-bin-symlink
Creating symlinks in /usr/local/bin for hkey, houdini, hython, and mantra is not supported. You can create these symlinks manually after installation if needed.
--install-hfs-symlink, --no-install-hfs-symlink
The /opt/hfs<version> symlink option is not available via legacy_install. Use the GUI installer or the standard install command with the --symlink-hfs option instead.
--avahi, --no-avahi
Avahi installation is not supported via legacy_install. Use the standard install command with the --avahi option instead.
--license-server-name
Configuring the license server name is not supported.
--upgrade-hqueue-server-if-exists
Automatic HQueue Server upgrade detection is not supported.