Activate Licenses

This document guides you through the activation of your Katalon Studio Enterprise (KSE) and Katalon Runtime Engine (KRE) licenses.

note

• To learn more about the details of Katalon licenses, see Types of Licenses.

• If you are behind a proxy server, before activating Katalon licenses, you need to configure the Authentication proxy settings. To learn more about how to configure a proxy, see Configure proxy authentication.

Online License Activation

Requirements

• The owner or admin of your organization have assigned a KSE license to your user account before doing this step; or you are a Trial user who can evaluate KSE for 30 days.

• You have downloaded and installed Katalon Studio Enterprise. 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 Enterprise (KSE) license

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

   

2. Click Log in from Browser. Log in by using your preferred credentials.

   

Upon successful login, you are then redirected to Katalon Studio Enterprise.

Advanced Settings

Look into advanced settings if:

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

Steps to open advanced settings:

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

2. Click Advanced settings link located below the login options.

3. The Advanced Settings dialog pops up with 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.

   • Click Save to apply your login settings.

For On-Premises users on versions before 3.0.0: If you select login via License server, the Log in with License server dialog pops up. The Private Instance URL you have saved in Advanced settings in Step 3 is prepopulated. Enter your email address and password to continue.

Enable Remember Me in Login

Enabling Remember me means you don't have to re-enter your username and password each time you start Katalon Studio or when you’re signed out due to session expiration or inactivity.

Remember me applies only for License Server and Log in from Browser log in options.

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

• Login with another account: it navigates you to the login screen.

• Relogin: re-login using the same account. It's only available if you selected Remember Me in your initial log in.

Activate your Katalon Runtime Engine (KRE) license

Your KRE license is activated automatically after the owner or administrator of your org has granted you a KRE license.

To use KRE, you need to authenticate your account with your Katalon API key. See API Keys to learn how to get your API key.

note

To view details about your current license, see: View License Details.

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 KRE_<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 KSE 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. Click Activate.

Activate KRE offline license

Once you've put the KRE license in the folder, your KRE license is activated automatically.

Every time you start running a test with KRE, KRE 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 Enterprise.

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

Activate a KSE license with Private Instance

1. Open the application. The Welcome to Katalon Studio Enterprise 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 KRE 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/"

Additional Resources

• For a better experience with Katalon Studio, you can also install our plugins. See Using Plugins with Katalon Studio Enterprise License.
• If you have any activation problems, see Troubleshoot Activation Problems.
• For further instructions on working with KRE, refer to Command Syntax.