Important Notice for ReadyAPI Customers |
ReadyAPI has moved to SmartBear License Management and from October 2023, file-based licensing will be retired. As of September 2023, all licenses issued for your subscription term will be ID-based licenses by default. If you are not currently on ID-based licensing, it's time to migrate immediately. File-based licensing will no longer be supported as of October 2023. This means that technical support requests related to file-based licensing will not be accommodated. If you encounter technical issues that you're unable to resolve, it could lead to service interruption. For customers still in the process of migration, we recommend reaching out to your Account Manager to discuss your migration plan. Alternatively, you can log a support request with our Customer Care Team for assistance.
For more details regarding licensing support, please refer to this link.
This topic describes how to configure Protection! Licensing Server 4 that is compatible with ReadyAPI 3.3.0 and earlier. If you use later version, see Configure License Server 5.x.
About
To control floating licenses, ReadyAPI uses Protection! Licensing Server.
This server can be installed on any network machine. It does not require specific hardware to function, unless you have a very large number of licenses to control.
The machine where ReadyAPI is installed should be able to connect to the license server machine by using the IP address for which the license is issued. In most cases, it means that there should not be NATs, load balancers, and other intermediates that remap the IP address of the license server machine.
When you run the license server on a headless machine, use the Licensing Server Management Console to configure it.
Install and configure license server
Floating License Server is needed to control and activate ReadyAPI floating licenses. To configure the license server, perform the following steps:
Note: If you have a working license server and you need to adjust it, skip the beginning of the guide and start with connecting to the server.
1. Get a license file
You need to have a license file at hand when installing and configuring the license server. To get this file, please contact the SmartBear Sales Team. The license key includes encoded information on the IP address of the license server computer and the port number it will use to handle license requests. Please be ready to provide this information to the Sales Team when requesting a license. By default, the server will use port 1099
. If you cannot use this port on the server computer for some reason, choose another available port.
We will then send you a license file, which you will need to install in the Licensing Server Management Console. See below.
Important notes:
-
Licenses are tied to a specific IP address and port of the license server. You cannot activate your license on a different server. To have several license servers, you will need an individual license file for each server.
-
The proxies and firewalls running in your network should allow access to the license server at the specified IP address and port ( by default,
1099
). -
We recommend that you have one license per tool (ReadyAPI Test, ReadyAPI Performance, ReadyAPI Virtualization, VirtServer, and TestEngine) on your license server. If you want to increase the number of seats, use a supplemental license rather than installing one more license. This will help you manage license usage easily. To get a supplemental license, contact your sales representative or write to [email protected].
2. Install Protection! Licensing Server
2.1. Install Java
The Protection! Licensing Server software requires the Java runtime environment:
-
Download the latest Java 8 version. You can do this on the following web site:
http://www.java.com/en/download/manual.jspWe do not support other Java versions (Java 9 and later).
Note: By default, Protection! License Server looks for the installed Java 8 on the computer and uses it if possible. If the server cannot find Java 8, make sure you set the path to the Java 8 installation folder as the value of the JAVA_HOME environment variable. -
Install it on the computer where you will install Protection! License Server.
Install on headless machines
Installation process requires the user to have root permissions.
To check if Java 8 is installed, run the following command:
java -version
If you don't have Java 8, install it by using a preferable package-management utility. For example:
Ubuntu/Debian
sudo apt-get install openjdk-8-jre
CentOS/Red Hat Enterprise Linux
sudo yum install java-1.8.0-openjdk
2.2. Install Protection! Licensing Server
After you install Java on the server computer, you can install Protection! Licensing Server. Follow the steps below.
Note: | The license server installation includes the License Management Console that is needed for managing licenses. |
-
Make sure your computer meets the Licensing Server requirements.
-
Download Protection! Licensing Server:
Windows Linux macOS 32-bit Win Linux macOS 64-bit Win By downloading our software, you agree to our terms of use and privacy policy. -
Run the downloaded installer and follow the installation wizard instructions.
You need to configure the license server settings before using it. See below.
Install on headless machines
Installation process requires the user to have root permissions.
-
Download the license server installation package by using the
wget
application or its analogue:wget "https://dl.eviware.com/Protection/ProtectionLS_4_9_4_linux.sh"
-
Make the downloaded file executable:
chmod +x ./ProtectionLS_4_9_4_linux.sh
-
Run the installation with the root permissions:
sudo ./ProtectionLS_4_9_4_linux.sh
-
Follow the prompts in the terminal to finish the installation.
2.3 Additional configurations
In some cases, you may experience issues when connecting to the license server. It may happen when you, for example, access the server from a different domain. To fix this issue, you need to specify the host name explicitly:
3. Connect to the license server
To configure the license server, connect to it by using the Protection! License Management Console. If you configure a license server for the first time, follow these steps:
-
Open ports on the license server, if needed.
-
Create a connection.
-
Connect to the license server.
3.1. Open ports
By default, the license server uses the following ports:
Port | Description |
---|---|
1099 |
The license server uses this port to handle license requests. You specified this port when requesting the license. The license is bound to this port number. If you want to change this port, you will have to request another license file. |
10991 |
Another port that the license server uses by default for license requests. If needed, you can change the port number in the license server settings. |
9998 and 9999 |
The Protection! License Management Console uses these ports to communicate with the license server. If needed, you can select some other ports in the license server settings. |
Make sure that your firewalls and proxies allow connecting to the license server through these ports. Quite often, these ports are already open.
If you are not sure whether these ports are open, or if you need assistance with configuring your proxies, please ask your system administrators for help. You will need to restart the license server to apply the changes you have made. For information on how to specify other ports, please see Protection! License Server Administrator Guide (pdf).
3.2. Create a connection
-
Start the Protection! Management Console.
You are asked to create a connection:
-
Specify the collection parameters:
-
Enter the server Name and (optionally) Description.
-
Enter the Server Address.
The Management Console can configure license servers working on most other computers, including those headless.
Note: If the Management Console and the license server are on the same machine, leave localhost in this field. -
Enter a Port number (the default is 9999).
-
Enter a Login and a Password.
Note: Default credentials are –
Login: admin
Password: {empty} -
Click OK.
-
You can change the credentials in the Management Console later.
3.3. Connect to the license server
4. Install the license
-
Install the license file.
-
Assign the license to users.
Important: You must assign a license to at least one user or a user group. Otherwise, nobody will be able to use the license.
4.1. Install the license file
-
If you received the license file in a
.zip
archive, extract it from the archive to a directory on your computer. -
In the server Management Console, switch to the Summary view:
-
Click Connect to connect to the server.
You will see summary statistics for the server:
-
In the menu on the left, select License Storage. Then select File > Import Licenses from the main menu:
-
In the subsequent Open File dialog, select the license file you received from SmartBear and click Open:
Note: If you received a .zip
file from SmartBear, then, in the dialog, you need to specify the extracted license file.This will install the license on the server computer.
4.2. Assign the license to users
To provide users with access to the license, you need to assign the installed license to users. The easiest way to do that is to assign the license to the Everyone user group that is available by default. This will make the license available to all the users who connect to your license server.
If you need more control, you can assign the license to an individual user or user group that you create on the license server. You can also assign the license to users from an LDAP server (Lightweight Directory Access Protocol) that is available in your network. See Managing Users and Groups for complete information.
To assign the license to users:
-
Select the license file from the License Entries list, then click Add User on the Allocation tab toolbar on the right:
-
The following dialog will appear:
-
Select the desired group and click OK.
Note: | You can examine the configuration of the assigned user or group by double-clicking it. For example, the Everyone group has the following configuration: |
Now, the selected license will be available to the specified users in the network.
The license server is now installed and configured to control the licenses.
Next steps
Once you activate a floating license on your server, you need to check out (that is, consume) the license on the computers where you will use it. See Check Out Floating Licenses (Legacy).
Restart the license server
If you need to restart the license server, do the following:
Windows
-
Open Control Panel.
-
Select System and Security > Administrative Tools.
-
Open the Services utility.
-
Right-click the ProtectionLS service and select Restart.
Linux and macOS
-
Open a terminal and set the working directory to the bin directory of the license server installation.
-
Run the following command:
./ProtectionLS restart
Uninstall the license server
In case you need to uninstall the license server, for example to move it to the new machine, do the following:
Windows
-
Open Control Panel.
-
Select System and Security > Administrative Tools.
-
Open the Services utility.
-
Right-click the ProtectionLS service and select Stop.
-
Run the uninstall.exe uninstallation script from the license server installation folder.
Linux and macOS
-
Open a terminal and set the working directory to the bin directory of the license server installation.
-
Run the following command:
./ProtectionLS stop
-
Run the uninstall.exe/.sh uninstallation script from the license server installation folder.
More information
For more information on managing your licenses and license user groups, see the Protection! License Server Administrator Guide (pdf).
See Also
Floating License Activation
License Server - System Requirements
Managing Users and Groups
Possible Issues With Floating Licenses