Activate licenses
In this article, we will guide you through the activation of your Katalon Studio Enterprise (KSE) and Katalon Runtime Engine (KRE) licenses.
- 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 a KSE license
The Owner or Admin of your Organization have assigned a KSE license to your user account before doing this step; or you're 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.
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.
- 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.
- A machine ID. To view your machine ID, see How Katalon generates a machine ID.
- A
KSE_<machine_ID>.lic
orKRE_<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.
.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.
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.
KRE_<machine_ID>.lic
file in the license folder. To execute multiple sessions in parallel, put multiple license files in the license folder.
It should look as the image below.
Activate a license with Private Instance
Activate a KSE license with Private Instance
- 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 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/"
- 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.