Licensing Server Dashboard

The Licensing Server Dashboard is a graphical user interface, hosted on the Unity Licensing Server.

This dashboard is available starting with version 2.0 of the Unity Licensing Server.

This dashboard provides administrators with important information, like the status of the server, and real-time and historical data about Unity license usage. The dashboard allows administrators to view important metrics, such as:

  • The number of active licenses.
  • The number of available licenses.
  • The number of licenses released to clients over a specific period of time.

The dashboard provides usage graphs and a detailed breakdown of license usage by individual users. Together, this information helps you make informed decisions about your current and future licensing needs. To manage licenses, continue to use the Unity ID portal.

Dashboard modes

The dashboard has two modes:

  • Standard user mode: Users who don't have administrator access can view the Overview page only. Furthermore, the data on that page is only a subset of the information presented on the administrators' version of the Overview page.
  • Administrator mode: This mode presents the full set of licensing data. To access this mode, log in with the username admin and the password that was created when the server was set up.
    Note: If you're upgrading to version 2.0 (or later) from an earlier version of the server that used an adminIpAllowlist, users in that list will automatically log in to the administrator mode (without prompt for credentials).

Administrator mode features

The administrator mode has the following views and features:

  • An at-a-glance view showing the server status, overview of subscriptions, current license availability, and license activity for all toolsets from the past seven days.
  • A full view of your licenses, including counts, validity dates, if borrowing is allowed, and more.
  • A detailed real-time view of the licenses currently in use.
  • An interactive view of historical license usage (to a maximum of 18 months), which you can filter, sort, and search.
  • Options to download log files, export search results to csv files, and export data to JSON files, and more.

Note: Pages that display license usage reflect the data at the time you loaded those pages. You can actively reload your browser to get the latest data.

Requirements

Unity bundles the dashboard with version 2.0 (or later) of the Licensing Server. After you set up the server, which includes defining the admin password, you can load the dashboard without any additional steps or setup.

Load the dashboard

The dashboard runs in a browser. You can load the dashboard any time the Unity Licensing Server is running.

To load the dashboard:

  1. Open a browser.

  2. In the address bar, enter the IP address and port for your licensing server. The value is in the format http://IP-address:port or https://IP-address:port, depending on the protocol (http or https) selected during setup.

    You can find the Licensing Server Dashboard address in the licensing-server-config.json file, whose location is listed in Server paths. The address is stored in the URL key in the Kestrel JSON object.

    Example:

    http://10.255.255.192:80

Change the admin password

Follow these steps to change the password for the admin account you use to access the dashboard:

  1. Stop the server.
  2. Rerun the setup, accepting the default values (which were stored during your previous setup) until you get to the credentials step.
  3. Set a new password for admin.
  4. Complete the setup.
  5. Restart the server.

Additional resources