Get Started

Estimated reading time: 1 minute

Install Java. The recommended version is Java 8.

Download and extract the latest release of the Katalium Server at https://github.com/katalon-studio/katalium-server/releases. The kata-server.jar can be run in Standalone, Grid Hub, or Grid Node mode.

Standalone mode

To start the server in standalone mode, execute standalone.sh file (in macOS and Linux) or standalone.bat file (in Windows).

cd katalium-server
standalone.bat
cd katalium-server
chmod u+x ./standalone.sh

Activate the server for the first time.

KATALON_EMAIL: Enter your Katalon account. You can sign up for a free account at https://www.katalon.com.

KATALON_API_KEY: Enter the API Key. You can generate new API keys at https://analytics.katalon.com. Go to Profile > Create API Key > Input key name > Click Create.

Grid mode

Grid Hub

To start the server as a Grid Hub, execute hub.sh file (in macOS and Linux) or hub.bat file (in Windows).

cd katalium-server
hub.bat
cd katalium-server
chmod u+x ./hub.sh

See Standalone mode for activation steps.

Grid Node

To start the server as a Grid Node, execute node.sh file (in macOS and Linux) or node.bat file (in Windows). Before executing the scripts, please set the Hub URL in nodeConfigForWindow.json (for Windows) or nodeConfig.json (for macOS and Linux) so that Grid Nodes can register themselves with the above Grid Hub, e.g. http://hub_ip:4444.

cd katalium-server
node.bat
cd katalium-server
chmod u+x ./node.sh

See Standalone mode for activation steps.

User Contributed Notes