Skip to main content
Skip table of contents

Linux

Follow these steps to install and configure the Universal Orchestrator on a Linux server.

Step 1 - Copy the Universal Orchestrator to the Server

Start by copying the Universal Orchestrator to the Linux server you wish to run the Universal Orchestrator on. Use a command such as the following to SCP the file to the host.

BASH
scp ~/Downloads/KeyfactorUniversalOrchestrator-11.2.0.zip username@<IP_ADDRESS>:/home/username/KeyfactorUniversalOrchestrator-11.2.0.zip

If you are using public key-based authentication to your server, it would resemble the following command.

BASH
scp -i ~/.ssh/public_key.pem ~/Downloads/KeyfactorUniversalOrchestrator-11.2.0.zip username@<IP_ADDRESS>:/home/username/KeyfactorUniversalOrchestrator-11.2.0.zip

Step 2 - Transfer the Installation Script

Use the same command to SCP the SetupOrchestrator_{deploymentName}.sh script to the server. Alternatively, use vi, vim, or nano to create a new file and paste the contents into the file. Add execute permissions to the file once it is created.

CODE
chmod +x SetupOrchestrator_{deploymentName}.sh

Step 3 - Verify File Placement

Ensure that the SetupOrchestrator_{deploymentName}.sh and the UniversalOrchestrator .zip file are in the same directory.

Step 4 - Run the Installation Script

Run the SetupOrchestrator_{deploymentName}.sh script.

CODE
./SetupOrchestrator_{deploymentName}.sh

The first thing the script will do is check for and install any dependencies that it needs to run. For additional information on the UO installation requirements, refer to Preparing for the Universal Orchestrator.

Step 5 - Connect to Command SaaS

Next, it will try to connect to the Command SaaS deployment. If the connection fails, it is likely because it is required to allow any addresses into the Command SaaS deployment via the Self-Service Source IP feature of the Command SaaS Portal. If this happens, run the command to get your outbound IP address and add the following command to the Portal.

CODE
curl ifconfig.me
image-20240315-000342.png

Step 6 - Install Dependencies and Provide Client Secret

The script will then detect your OS version and install .NET Core and any other required dependencies. Once done, the script will ask you for your Client Secret to access your Command SaaS deployment. Copy and paste the Client Secret into the terminal, and then press Enter.

image-20240315-024228.png

Step 7 - Approve the Universal Orchestrator in the Command Portal

You should then see a message telling you to go to the Command Portal to approve the Universal Orchestrator.

image-20240315-024319.png
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.