Skip to main content

Activate Katalon 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 for Authentication.

Activate a KSE license

Log in to your Katalon account in Katalon Studio to use your enterprise license.

  • The Owner or Admin of your Organization must have assigned a license to your account before doing this step.

  1. Open Katalon Studio.
    1. If you are opening Katalon Studio for the first time, the Welcome to Katalon Studio dialog automatically pops up.
      The Katalon Studio activation dialog box.
    2. If you are already logged in to a Katalon account in Katalon Studio, then click on the Profile button and select Log out.
      The profile button and the log out option in Katalon Studio.
      You are logged out of your account. The Welcome to Katalon Studio dialog appears.
  2. Click Log in from Browser. You will be automatically redirected to the Katalon Log in website.
    1. Once you've successfully logged in, you'll be redirected to Katalon Studio.
  3. On the website, log in using your preferred credentials.

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

  4. Once you've successfully logged in, you'll be redirected to Katalon Studio.
You are now using your Katalon Studio Enterprise license.

Activate a KRE license

After the owner or admin of your organization has granted you a KRE license, the license is activated automatically.

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.

Note:

Activate a license while offline

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

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 Welcome to Katalon Studio dialog, click Offline license to prompt the dialog.
    The Katalon Studio activation dialog.
  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.Activating Katalon Runtime Engine offline.

Activate a license with Private Instance

Requirements

  • Katalon Studio version 8.3.5 onwards.

  • A private instance URL. If you want to learn more about Private Instance, contact our sales team via business@katalon.com.

Activate a KSE license with Private Instance

  • A private instance URL. To learn more about Private Instance, contact our sales team via business@katalon.com.
  1. Open Katalon Studio.
    1. If you are opening Katalon Studio for the first time, the Welcome to Katalon Studio dialog automatically pops up.
      The Katalon Studio activation dialog box.
    2. If you are already logged in to a Katalon account in Katalon Studio, then click on the Profile button and select Log out.
      The profile button and the log out option in Katalon Studio.
      You are logged out of your account. The Welcome to Katalon Studio dialog appears.
  2. Click License server and input the following:
    • In the License server address field: the Private Instance URL used for authentication
    • The licensed user account email and password
  3. Click Log in.

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/"
Note: