Install Ranorex Subscription License Manager

This guide explains how to install the Ranorex Subscription License Manager in a self-hosted environment. Follow the prerequisites and installation steps below to ensure a successful setup.

IMPORTANT

Planned downtime during Subscription License Manager upgrades (starting with v1.0.1). When upgrading Subscription License Manager to v1.0.1, the upgrade restarts essential services. During this restart, there may be a temporary interruption in license availability.

What to expect: During the upgrade, Ranorex Studio and Ranorex Runtime instances that rely on Subscription License Manager may not be able to acquire licenses. The upgrade can take up to 5 minutes for Subscription License Manager to come fully back online.

Recommended action: Before starting the upgrade, notify all Ranorex Studio users and any test environments using Runtime licenses. Avoid using Ranorex Studio or running automated tests in CI/CD pipelines during the upgrade window.
Schedule the upgrade during a maintenance window or outside active testing hours to minimize disruption.

Prerequisites

Before installing the Subscription License Manager, confirm that your system meets the following requirements. These include software and hardware requirements, as well as the default network ports used during installation.

For the service user, you can either use an existing account or create one during installation:

• A pre-created user can be either a domain user or a local user. Leave the Domain field empty for a local user.
• A user created during installation must be a local user. Leave the Domain field empty.

The account running the installer must have permission to create local users, and domain policies must not prevent this.

Software Requirements

• Windows administrator rights.
• WSL version must be 2.5.9.0 or later.
• The service user account specified for Ranorex Subscription License Manager must have Log on as a service permission.
• The IP Helper service must be enabled and running; otherwise, licenses cannot be shared between machines on the same network.
• If you install the Subscription License Manager in a virtual machine, the VM must support nested virtualization and have it enabled (required for WSL 2 / Hyper-V). Nested virtualization is supported in Hyper-V VMs (when enabled) and in supported Azure VM sizes.
  See Enable nested virtualization for the Subscription License Manager.

Note: If your WSL version is lower (check with wsl --version), run wsl --update to update it.

Hardware Requirements

• 4 CPUs
• 16 GB RAM
• 10 GB disk space

Network Ports

The following ports are used during the Subscription License Manager installation. In most cases, the default values work without changes. You can adjust them only if your IT team requires specific configurations.

Important: Port 443 should be open in the firewall for inbound connections (they are open automatically in the Windows firewall during the installation)

Note: If custom ports were configured for NGINX during the initial setup, make sure to specify that port again when installing the license.

Installation Steps

1. Double-click the LicenseManagerInstaller to start the installer.
   
2. In the Ranorex Subscription License Manager Setup window, review the Welcome page and click Next.
   
3. Read the End User License Agreement. Select I accept the terms in the License Agreement and click Next.
   
4. Accept the default installation location, or click Change… to specify a new path. Click Next.
   
5. Provide the credentials for a service user (localhost) who will manage the portal.
   • Domain (optional)
   • Username
   • Password
     
6. Configure the port settings and click Verify to ensure availability. Once verification completes, click Next.

   Important: We recommend using the default ports provided by Ranorex. If you need changes, consult your IT department.

   
   
7. Click Install to begin the installation process.
   

You’re all set with the License Manager. Proceed to Activate the Self-Hosted Subscription License.