Setting up the Unity Licensing Server
Follow these procedures for a comprehensive guide to set up your Unity Licensing Server. 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.
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 typing --help after the Unity.Licensing.Server executable:
- Linux:
./Unity.Licensing.Server --help - Windows:
.\Unity.Licensing.Server.exe --help
The licensing server creates and stores configuration files in the home directory of the user that set up the server. Use a dedicated administration account, known as a service account, for setting up and running the licensing server. Do not use a personal user account, because you won't be able to reconfigure the licensing server if that account becomes inaccessible.
For a video tutorial of this setup, refer to the Unity Learn course, Unity Floating License Server Fundamentals.
Overview
Perform these tasks to set up the Unity Licensing Server:
- Download and unzip the server setup file on a dedicated server.
- Run the setup command to store the licensing server configuration parameters in the
licensing-server-config.jsonfile and generate aserver-registration-request.xmlfile to upload to the Unity ID portal page. - Download the license archive from the Unity ID portal and run the import command.
- Test the licensing server.
- (Recommended) Run the create-service command to create a service that starts the licensing server automatically.
- 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.