Documentation

Support

Unity License Server

Get Started

Quick start setup

Advanced setup

Administration

Troubleshooting

Unity License Server

Setting up the Unity Licensing Server

Follow these procedures for a comprehensive guide to set up your Unity Licensing Server.
Read time 2 minutesLast updated 3 months ago
If you have a simple setup that requires minimal configuration, you can also use the Quick start setup. If you need to upgrade your server version, refer to Migrating your server to a new version.
Note
For a video tutorial of this setup, refer to the Unity Learn course, Unity Floating License Server Fundamentals.
All Unity Licensing Server operations, including setup, use the following command line interface (CLI) executable, with different command parameters (described later):
  • Linux: 
    ./Unity.Licensing.Server
  • Windows: 
    .\Unity.Licensing.Server.exe
This executable has several command parameters; the corresponding tasks in this guide describe these parameters in detail. You can also view the full syntax of each command by going to the Licensing Server program files directory and typing 
--help
after the 
Unity.Licensing.Server
executable:
  • Linux: 
    ./Unity.Licensing.Server --help
  • Windows: 
    .\Unity.Licensing.Server.exe --help
Important
For version 2.x on Linux, the setup creates a user group called 
unity-licensing-server
and adds the account you use to run the setup. Users who run subsequent administration tasks must belong to this group, even users with administrator or root user accounts.
Important
For version 1.x, use a dedicated administration account, known as a service account, for setting up and running the licensing server. Don't use a personal user account, because you can't reconfigure the licensing server if that account becomes inaccessible.

Overview

Perform these tasks to set up the Unity Licensing Server:
  1. Download and unzip the server setup file on a dedicated server.
  2. Run the setup command to store the licensing server configuration parameters in the 
    licensing-server-config.json
    file and generate a 
    server-registration-request.xml
    file to upload to the Unity ID portal page.
  3. Download the license archive from the Unity ID portal and run the import command.
  4. Test the licensing server.
  5. (Recommended) Run the create-service command to create a service that starts the licensing server automatically.
  6. Back up the server configuration.
If you encounter problems after setting up the licensing server, you can run the generate-report command, which collects and archives data you need for troubleshooting.