Activate Licenses

This document guides you through the activation of your Katalon Studio (KS) and Katalon Test Execution - Local licenses.

note

• If you are behind a proxy server, you need to configure the Authentication proxy settings before activating Katalon licenses. See Configure proxy authentication.

Online License Activation

Requirements

• The owner or admin of your organization have assigned a KS license to your user account before doing this step; or you are a Trial user who can evaluate KS for 30 days.
• You have downloaded and installed Katalon Studio. For detailed instruction, see Install Katalon Studio.
• If you have previously logged in to a Katalon account in Katalon Studio, click on the Profile button and select Log out to prompt the dialog.

Activate your Katalon Studio license

1. Open the application. The Welcome to Katalon Studio dialog automatically pops up.

   

2. Click Log in from Browser. You are directed to the log in page. Log in with your credentials.

Result

Upon successful login, you can switch back to Katalon Studio application. If you are signing in again using saved credentials, Katalon Studio restores the last opened project and files.

Advanced Settings

Look into advanced settings if:

• You are logging in via a License Server.
• You need to Configure a proxy connection.

1. In the Welcome to Katalon Studio dialog, select Advanced settings located below the login options.

2. The Advanced Settings dialog pops up with the following options:

   • License server address: Enter the Private Instance URL used for license authentication.

   • Launch browser login site in:

     • In-app browser: Opens a built-in browser within Katalon Studio.

     • System default browser: Opens the login page in your default web browser. Selected by default.

3. Click Save to apply your login settings.

If you are logged out due to Session Expired, License Expired, or Idle Timeout Exceeded, Katalon Studio lets you re-login quickly. You can:

• Login with another account: you are navigated to the login screen.
• Relogin: re-login using the same account if you selected Remember Me in your initial login.

Activate your Katalon Test Engine - Local license

Your Katalon Test Engine - Local license is activated automatically after the owner or administrator of your org has granted you a Katalon Test Engine - Local license.

To use Katalon Test Engine - Local, you need to authenticate your account with your Katalon API key. See API Keys to learn how to get your API key.

Offline License Activation

Requirements

First, you need to get your machine's ID. See How Katalon generates a machine ID.

Second, a KSE_<machine_ID>.lic or Katalon Test Engine - Local _<machine_ID>.lic file. To get this file:

• Contact your organization's owner or administrator
• Provide your machine ID
• Ask them to grant you an offline license.

For org's owners and admins, see Grant an offline license to users for more details.

Once you get the file, put it in the right folder:

• Windows: C:\\Users\\<user_name>\\.katalon\\license
• Linux: /home/<user_name>/.katalon/license
• macOS: /Users/<user_name>/.katalon/license

Note that .katalon is a hidden folder.

Activate KS offline license

Once you've put the KSE license in the folder:

1. In the login dialog, click Offline license.

2. In the License file section, click Choose file to select your .lic file.

3. Once the license file is loaded, click Activate.

Activate Katalon Test Engine - Local offline license

Once you've put the Katalon Test Engine - Local license in the folder, your Katalon Test Engine - Local license is activated automatically.

Every time you start running a test with **Katalon Test Engine - Local **, it automatically verifies that your license file is available and valid:

To execute multiple sessions in parallel, put multiple license files in the license folder.

Private Instance Activation

Requirements

• You have downloaded and installed **Katalon Studio **.

• A Private Instance URL. To learn more about Private Instance, contact our sales team via business@katalon.com.

Activate a KS license with Private Instance

1. Open the application. The **Welcome to Katalon Studio ** dialog automatically pops up.

   

   Click Log in from License server.

2. Select your login option.

   • Enter Private Instance URL and credentials.

   • Or select Log in from a browser after setting On-Premises server URL in Advanced Settings.

You have successfully logged in using your Private Instance and activated your KSE license.

Activate a Katalon Test Engine - Local license with Private Instance

• Pass the Private Instance URL used for authentication to the -serverUrl parameter.

Example: ./katalonc ... -serverURL="https://admin-tenant1.katalon-cloudops.com/"