How to install Katalon TestOps Agent as a service on Ubuntu

Hi everyone,

In this tutorial, I will show you how to install Katalon TestOps Agent as a service on Ubuntu. Running as a service ensures that Katalon TestOps Agent is always running even after the machine is restarted.

If you are not familiar with Katalon TestOps Agent, please go through the following tutorial first. Katalon TestOps Agent will help you:

  • Install and manage multiple versions of Katalon Runtime Engine on your test machines without any manual intervention.
  • Retrieve the latest version of your Katalon Studio projects that are stored on Katalon TestOps or Git to execute, and submit the test results back to Katalon TestOps for review.
  • Keep the number of concurrent executions under a configurable limit. Katalon TestOps will distribute jobs among Agents to balance their workload. This feature is especially helpful if you only have a limited number of licenses and want to queue your executions periodically.

Configure Katalon TestOps Agent

Select Linux as the Operating System, and run the command in the Generate agent config section. A file named agentconfig will be generated inside the Agent directory.

Enable Xvfb mode for Agent

Since Ubuntu service usually does not have access to the display (X11), we will use Xvfb to run browsers and Katalon Studio. Open the agentconfig file and append this line:

xvfbRun=-a -n 0 -s "-screen 0 1024x768x24"

The agentconfig file then looks like

version=v1.5.1
serverUrl=https://analytics.katalon.com
email=<redacted>
apikey=<redacted>
teamId=46804
agentName=My Agent (service)
uuid=<redacted>
xvfbRun=-a -n 0 -s "-screen 0 1024x768x24"

Install Xvfb to Ubuntu

Open a terminal run this command:

sudo apt install -y xvfb

Create Katalon TestOps Agent service

Change directory to the Agent directory, and run this command:

sudo ./service.sh

A service named katalon-agent will be created. You can verify the status with this command:

systemctl status katalon-agent

Make Katalon TestOps Agent autostart with OS

Open a terminal and run this command:

systemctl enable katalon-agent

Now the Katalon Agent service will always be running and waiting to serve your requests!

1 Like