Setting up the Unity Licensing Server (quick start)

Follow this quick start guide for simple setups that require minimal configuration.

Read time 3 minutes

Last updated 2 days ago

You can also read this guide as an overview. If you have a complex setup, or if you require comprehensive instructions, refer to Server setup (advanced).

Before you start

Important

You might not be able to restore all configuration files if they become damaged. Once your server is running correctly, it's important to back up any configuration files so that you can restore the server if it becomes unusable. For instructions on how to back up your configuration files, refer to Backing up and restoring.

1: Download the server setup

After the organization owner receives a welcome email and claims the license, go to id.unity.com. Sign into your existing account (or create a Unity ID), then select Organizations from the left panel. Select your organization (or create a new one). Select Subscriptions & Services in the left panel and select the new subscription that uses floating licensing. Select Configure License Server > Manage seats to add seats to the subscription. Return to the License servers page, select Download new server, select the operating system for your dedicated server, and download the

Unity.Licensing.Server.*.zip

file.

2: Extract the server files

Extract the contents of the

Unity.Licensing.Server.*.zip

archive to a directory on your dedicated server. This directory will be the program files directory for your licensing server.

Platform	Suggested server path
Windows	`C:\UnityLicensingServer`
Linux	`/opt/UnityLicensingServer`

3: Configure the server

To configure the licensing server, navigate to the directory where you extracted the server files in the previous step. Run the command that matches your operating system and follow the prompts to complete the configuration:

Windows: Open the Windows PowerShell with elevated privileges (Run as administrator) and run
```
.\Unity.Licensing.Server.exe setup
```
Linux: Open the Linux Terminal and run
```
sudo -H ./Unity.Licensing.Server setup
```

The setup process includes steps to configure:

The server name
HTTPS/SSL (optional)
Network interface and port
Administrator access

The server configuration generates two files in the current working directory:

services-config.json

and

server-registration-request.xml

4: Register the server

The

server-registration-request.xml

file contains machine binding information. Register this server in the Unity ID portal under Organizations > (Organization Name) > Subscriptions & Services > (Floating Subscription) > Configure License Server. Follow the instructions in the portal to assign seats and download the license archive.

5: Import the license archive

Download the license archive as a

.zip

file from the Unity ID portal page. Close any Linux Terminal or Windows PowerShell windows, then open a new window. This ensures that changes to your user or group permission that the

setup

command made are applied in the new terminal session. Go to the directory where you extracted the server files. Without unzipping the license archive, run the following command from the console or terminal to import the files:

Platform	Import command
Windows	`.\Unity.Licensing.Server.exe import [license archive path]`
Linux	`./Unity.Licensing.Server import [license archive path]`

This step completes the configuration of the licensing server. Continue to the next steps to run and test the server.

6: Test the licensing server

To launch the server, go to the directory where you extracted the server files and run the following command:

Platform	Server launch command
Windows	`.\Unity.Licensing.Server.exe`
Linux	`./Unity.Licensing.Server`

Example output:


Server Version: 1.6.0.19b28b6Successfully started the licensing server: http://10.211.55.4:8080/v1/admin/statusPress Ctrl+C to shut down...

To test if the server is running, access the administrator API by copying the URL from the previous output to the address bar in the web browser of your choice. After accessing an endpoint,

"serverStatus": "Healthy"

indicates a successful configuration. Your licensing server is ready to use.

7: Create a service to run the licensing server

To make the licensing server run as a service and automatically launch at startup, go to the directory where you extracted the server files. Run the command that matches your operating system and follow the on-screen instructions:

Windows: Open the Windows PowerShell with elevated privileges (Run as administrator) and run
```
.\Unity.Licensing.Server.exe create-service
```

Linux: Open the Linux Terminal and run

sudo -H ./Unity.Licensing.Server create-service

This command creates and starts the service.

Note

On Windows, make sure the user who runs service has the "Log on as a service" right assigned. For more information, refer to Setting up a service for the licensing server.

8: Configure the client computers

The

services-config.json

file configures the Unity Editor to communicate with the floating licensing server. (This file was automatically generated in Step 3.) Copy

services-config.json

to the following path on all client computers:

Platform	Services Configuration Path
Windows	`%PROGRAMDATA%\Unity\config\`
macOS	`/Library/Application Support/Unity/config/`
Linux	`/usr/share/unity3d/config/`

To view a sample

services-config.json

file, refer to Copying the configuration file. With this file, the Unity Editor acquires a new license when launched and returns the license when closed.

Documentation

Development

User Acquisition

Monetization

Industry

Documentation

Development

User Acquisition

Monetization

Industry

Unity License Server

Get Started

Quick start setup

Advanced setup

Administration

Troubleshooting

Unity License Server

Setting up the Unity Licensing Server (quick start)

Before you start

1: Download the server setup

2: Extract the server files

Platform

Suggested server path

3: Configure the server

4: Register the server

5: Import the license archive

Platform

Import command

6: Test the licensing server

Platform

Server launch command

7: Create a service to run the licensing server

8: Configure the client computers

Platform

Services Configuration Path