Skip to main content

Set up an On-Premises License Server

Note:
  • Only applicable to users with an On-Premises package.

  • For existing On-Premises users, contact our Sales team at business@katalon.com for data migration.

The Katalon On-Premises License Server allows installation at the client's network location.

The License Server allows you to activate Katalon Studio offline.

To acquire the Katalon On-Premises License Server, contact our Sales team at business@katalon.com.

Features

The following features are available for users of a Katalon Studio On-Premises License Server:

  • Private installation and setup (within your internal network).
  • User and organization management.
  • License management.
  • Katalon Studio subscription.

System requirements

Requirements
Operating SystemMacOS, Windows, Linux (Ubuntu based)
CPUMinimum 4
Memory

Minimum 8 GB

Hard DriveAt least 40 GB available hard disk space.
Warning:
  • The current On-Premises License Server does not support M1 chip (macOS).

Set up Docker

docker resources

Install and setup an On-Premises License Server (for Windows)

Important:
  • You have downloaded PostgreSQL database version 10 onwards.
  • Katalon Studio version 7.2.2 onwards (for Katalon Studio Enterprise).
  • Katalon License Server installer and a license file for activation. To acquire them, contact our Sales team at business@katalon.com.

Install and create a PostgreSQL database

PostgreSQL database is where you manage all data including organizations, teams, and user accounts used in the server.

Follow these steps:

  1. Download PostgreSQL database.
  2. Run the PostgreSQL installation and follow the PostgreSQL setup instructions.

    • Create a password for the database superuser (postgres).

      prosgres password

    • Select the port number the server should listen on.

      prosgres port

  3. After installation, open PgAdmin on your browser.

  4. Sign in with the superuser's password.

    pgadmin page

  5. Create a database named kit.

    kit database

  6. Create a database named k1.

Note:

You can use the default PostgreSQL superuser or create another login role with the superuser's privileges.

Install and set up the Katalon License Server

Note:
  • Contact our Sales team at business@katalon.com for the On-Premises package and license file. We recommend you install the version that is compatible with your operating system.
  1. Run the Katalon License Server installer and follow the setup instructions.

    • Destination directory: the location where the License Server is installed in your machine.

    • TCP ports: the HTTP connector and control ports which the License Server runs on.

      Note:
      • We recommend you use the default ports (unless you're running another application on the same port).
    • Database URL: the JDBC URL for your database.

    • Server URL: the address for the License Server's site (e.g., http://localhost:8080).

      After completing the installation, the server starts on your browser.

  2. Activate the server with the license file you have received.

  3. Create a root user to login.

  4. Sign in using the newly-created account.

You have set up the server successfully.

Install and setup an On-Premises License Server (for MacOS)

Important:
  • You have downloaded PostgreSQL database version 10 onwards.
  • Katalon Studio version 7.2.2 onwards (for Katalon Studio Enterprise).
  • Katalon License Server installer and a license file for activation. To acquire them, contact our Sales team at business@katalon.com.

Follow these steps:

  1. Install the Katalon License Server.
  2. Install PostgreSQL.
  3. Edit the pg_hba.conf file and add the following entry.

    add entry hba conf

  4. Create a database.

    docker run --name postgres -dp 5432:5432 -e POSTGRES_PASSWORD=admin postgres:alpine

  5. Create the database kit in DBeaver.

  6. Create the database k1 in DBeaver.
  7. Edit .env file.

    LICENSE_SERVER_VERSION=latest
    LICENSE_SERVER_PORT=80

    DB_HOST=192.168.250.103
    DB_PORT=5432
    DB_USERNAME=postgres
    DB_PASSWORD=admin
    LICENSE_SERVER_URL=http://192.168.250.103
  8. Use the following commands to run.

    Load imagedocker load -I images.tar.gz
    Start imagedocker-compose up -d.
    Unload imagedocker-compose down
  9. Activate the License Server.

Activate Katalon Studio offline

Important:
  • You have downloaded Katalon Studio.

You need to activate the License Server in the Katalon Studio Activation dialog.

  1. Open the Katalon Studio Activation dialog in Katalon Studio.
  2. Fill in the required information.

    • In the Server URL section, enter the address of your License Server's site that you have configured.
    • In the Email and Password sections, enter the account you have registered with the Katalon On-Premises License Server.
  3. Click Activate to connect with your License Server and retrieve your organizations.
  4. Select an Organization you want to work on, then click OK.

Activate Katalon Runtime Engine

Note:
  • This section explains how to activate Katalon Runtime Engine within a License Server. If you wish to activate a Katalon Runtime Engine license in an offline environment, refer to this documentation: Activate a license while offline.
Important:
  • You have downloaded Katalon Runtime Engine.

To activate your Katalon Runtime Engine license with a License Server, do as follows:

  1. Navigate to where the Katalon Runtime Engine application is located. Right-click on the application and choose Show Package Contents.

    Go to Contents > Eclipse > jre > katalonc.ini.

  2. In the katalonc.ini file, add this parameter: -DtestOps.serverUrl=<license server URL>

    You only need to add this parameter once, then your Katalon Runtime Engine license is activated.