Activate licenses

In this article, we will guide 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.

Activate your Katalon Studio Enterprise (KSE) license

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.

  

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.

   

   If you log in with SSO, see Log in to Katalon Studio with SSO.

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

Advanced Settings

You can configure your advanced login settings if:

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

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. Set up your configuration options.

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

   2. Launch browser login site in: If you select Log in from browser, choose where the login page should open:

      • In-app browser: Opens a built-in browser within Katalon Studio. Use this if you want to keep the login flow contained or if your system restricts launching external browsers.

      • System default browser: Opens the login page in your default web browser (e.g., Chrome, Safari). Recommended if you're already signed in to your Katalon or SSO account in your main browser or prefer using browser-based tools like password managers.

   3. Click Save to apply your login settings.

Your advanced login configuration is now saved and ready for use.

note

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.

Activate your Katalon Runtime Engine (KRE) license

Your Katalon Runtime Engine (KRE) license is activated automatically after the owner or administrator of your organization has granted you a KRE license.

To use KRE, you need to authenticate your account with your Katalon API key.

To view your API key, refer to this guide: API Keys.

notes

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

Activate a license while offline

An offline license needs to be activated before it can be used.

requirements

• A machine ID. To view your machine ID, see How Katalon generates a machine ID.
• A KSE_<machine_ID>.lic or KRE_<machine_ID>.lic file.
  • To get this license file, provide your machine ID to your organization's owner or administrator and ask them to grant you an offline license.
  • They can learn how to grant an offline license through this guide: Grant an offline license to users.

Receive your license file from your organization owner or administrator and execute the following steps:

Put your .lic file in its appropriate license folder.

Note that .katalon is a hidden folder. To find the license folder in your computer, search for:

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

Activate KSE offline license

Perform this step only after you have copied your corresponding .lic file to its directory. If you have not yet, read: Activate a license while offline.

Upon opening Katalon Studio for the first time, or while you are logged out, you will automatically be prompted to activate your license by a pop-up window.

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.

Katalon Studio Enterprise offline is ready for use.

Activate KRE offline license

Determine the correct directory for your license file before executing this step. If you have not yet, read: Activate a license while offline.

Activate KRE offline by:

Putting your KRE_<machine_ID>.lic file in the license folder.

Note:

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

Your KRE license is now activated. Every time you start running a test with KRE, KRE automatically verifies that your license file is available and valid.

It should look as the image below.

Activate a license with Private Instance

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

To log in and activate your Katalon Studio Enterprise 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.

   1. If you select Log in from License server, a dialog pops up where you can enter your Private Instance URL and credentials.

      • In the License server address field: Enter the Private Instance URL used for authentication.
      • Enter your email address and password.
      

      Click Log in to continue.

   2. For On-Premises users on version 3.0.0 onwards, you can select Log in from a browser after setting your On-Premises server URL in Advanced Settings. See Advanced Settings.

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

Activate a KRE license with Private Instance

To activate a KRE license with Private Instance, pass the Private Instance URL used for authentication to the -serverUrl parameter.

For example:

./katalonc -noSplash -runMode=console -projectPath="/Users/katalon/Downloads/web-visual-testing-samples-master/Web UI Tests with TestOps Vision.prj" -retry=0 -testSuitePath="Test Suites/TS_RegressionTest_With TestOps Vision" -browserType="Chrome" -executionProfile="default" -apiKey=<your-API-key> --config -proxy.auth.option=NO_PROXY -proxy.system.option=NO_PROXY -proxy.system.applyToDesiredCapabilities=true -serverURL="https://admin-tenant1.katalon-cloudops.com/"

notes

• 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.