Skip to main content
Feedback

Unattended runtime installation

You can use command-line code run an unattended (or silent) installation.

Open a command prompt in Windows or Linux and use commands to install your basic runtime, runtime cluster, or runtime cloud. Using the command line is useful to automate the installation process.

The system where you are installing a runtime must meet the applicable system requirements. For more information, refer to Basic runtime system requirements, Runtime cluster system requirements, and Runtime cloud system requirements.

note

This method of installation uses the unattended mode option (-q) of the install4j installer.

The command-line code includes the following variables. Required options are listed first, followed by optional ones.

  • username - (Required in conjunction with password; alternative to installToken) Specifies the Platform user name.

  • password - (Required in conjunction with username; alternative to installToken) Specifies the password associated with the Platform user.

  • installToken - (Alternative to username and password) Specifies a unique installer token.

    A token is valid only for the account for which it was generated. Tokens expire after a set amount of time ranging from 30 minutes to 24 hours.

  • accountId - (Required with username and password; invalid with installToken) Specifies your Platform account identifier.

  • cloudId - (For runtime cloud installation, required with username and password; invalid with installToken) Specifies the cloud identifier.

  • dir - (Optional) The directory in which to install the runtime. If not specified, this variable defaults to the home directory of the user installing the container. For example, home/<user>/Boomi_AtomSphere/<containerType>/<containerType_nameOfHost>

  • environmentId - (Optional) Specifies the environment to which a newly installed container is attached. If you do not select an environment during installation, the new container appears in the list of Unattached Runtimes on the Runtime Management page.

  • jdkPath - (For runtime cloud installation) Specifies the file path location for the Java Development Kit (JDK).

  • atomName - (Optional ) Specifies the runtime name. The name is typically generated automatically and incorporated into the host name.

  • localPath - (Optional for runtime cluster and runtime cloud installations) Specifies the local file path (instead of the network file system). The localPath must be consistent among all runtime cluster and runtime cloud nodes.

  • localTempPath - (Optional for runtime cluster and runtime cloud installations) The localTempPath specifies the local temporary file path used by Java for temporary storage. This directory must be consistent among all runtime cluster and runtime cloud nodes.

    Boomi recommends that you do not set the localTempPath for Cloud runtime clusters that run on Linux. Configuring a custom temporary directory on Linux interferes with the Cloud runtime cluster's operation.

  • sys.symlinksDir - (Optional) Specifies the directory that contains symbolic links to the launcher executables (Linux only).

  • proxyHost - (Optional) Specifies the proxy host name.

  • proxyPassword - (Optional) Specifies the proxy user’s password.

  • proxyPort - (Optional) Specifies the proxy’s port number.

  • proxyUser - (Optional) Specifies the proxy’s user name.

For a complete list of the command-line options for the install4j installer, see Command-Line Options For Generated Installers.

Command-line code samples

The following example shows a sample Linux command for installing a runtime. The -console option displays status messages on the console from which you start the installer.

note

For Windows, the examples can be modified by changing .sh to .exe.

./atom_install64.sh -q -console -Vusername=user@mycompany.com -Vpassword=boomi 
-VatomName=myAtom -VaccountId=myAccount  -dir /home/<username>/<atom_installation_directory>

The following example shows a sample Linux command that uses an installer token to install a runtime.

./atom_install64.sh -q -console -VinstallToken=<token> -VatomName=myAtom 
-dir /home/<username>/<atom_installation_directory>

The following example shows a sample Linux command for installing a runtime cluster.

./molecule_install64.sh -q -console -Vusername=user@mycompany.com -Vpassword=boomi 
-VatomName=myMolecule -VaccountId=myAccount -VlocalPath=/<your_selected_directory>/local 
-VlocalTempPath=/<your_selected_directory>/temp -dir /home/<username>/<molecule_installation_directory>

The following example shows a sample Linux command for installing a runtime cloud.

./cloud_install64.sh -q -console -Vusername=user@mycompany.com -Vpassword=boomi 
-VatomName=myCloud -VaccountId=myAccount 
-VcloudId=b1038bf0-33bd-4731-9b59-ada292e48e9c
-VenvironmentId=38c54779-799e-4bfa-99e6-22257722f475 
-VjdkPath=/usr/local/java/jdk -VlocalPath=/<your_selected_directory> 
-dir /home/<username>/<cloud_installation_directory>

The following example shows a sample Linux command for installing a runtime with proxy settings. You can use proxy settings in a similar way for runtime cluster and runtime cloud installation.

./atom_install64.sh -q -console -Vusername=user@mycompany.com -Vpassword=boomi 
-VatomName=myAtom -VaccountId=myAccount  -VenvironmentId=<environment_id>
-dir /home/<username>/<atom_installation_directory> 
-VproxyHost=<proxy_host_name> -VproxyUser=<proxy_user_name>
-VproxyPassword=<proxy_password> -VproxyPort=<proxy_port_number>
On this Page