Skip to content

Home

Introduction

Development

IDEs

Services

Service manager

API Explorer

Installing your license

After installation and deployment, setting TORO Integrate's license is the next step. TORO Integrate won't work without a license; in fact, as soon as you get it up and running, it will ask you to provide your license key if you have not done it yet.

These are the three different ways to install a license:

License installation for TORO Cloud

The procedures described in this document are not applicable to organizations running on Cloud Edition. License installation is automatic for TORO Cloud subscribers. To learn how to subscribe to TORO Cloud, visit this section instead.

Via Server Admin UI

Only for Server Edition subscribers

The Server Admin user interface is only available on the Server Edition of TORO Integrate (non-headless). If you're using a different edition or the headless version of the Server Edition, prefer the other methods of license installation described in this document.

Access TORO Integrate's Server Admin UI via your browser. By default, you should be taken to the login page but since your license is not present yet, you won't be able to login. Instead, TORO Integrate will inform you that you need to install your license first. You will be provided with two URLs: the first one is for automatically generating and installing a license, and the other one allows you to manually enter a license key (which you will have to generate using the the TORO Marketplace).

License not installed warning

To automatically generate and install your license key:

Installing a license key

  1. Click the first link in the alert displayed earlier.
  2. Login to your account. You may create one if you don't have a TORO Marketplace account yet.
  3. Choose your organization and license type.

    Must be a member of the organization

    Ensure you are a member of the organization you want to select because if you're not, the organization won't appear. To be a member of an organization, you must be invited; this can be done via the TORO Marketplace.

    There will be two options for the license type. Select Free license if you would like to use TORO Integrate on trial. Otherwise, select Use available subscriptions and choose from your account's paid subscriptions.

  4. Once done, click the Generate License button. Doing so will redirect you to the Server Admin login page.

To manually generate and inject your license key:

Installing a license key

  1. Click the second link provided in the alert displayed earlier. A form will appear. Take note of the provided product key.
  2. Follow the steps here in order to generate your license key. The product key would have appeared in the form mentioned earlier.
  3. Copy your license key to the clipboard. You may obtain a copy of your generated license by checking your email (an email is sent when a license is generated).
  4. Go back to the license form and in the text area, paste your license key.
  5. Click Save.

Congratulations! Your license is now installed which means you can now login and use TORO Integrate.

Via CLI tool

To install a license via the CLI tool, we will be using the following commands:

Command Description
export-license Exports the currently installed license to a file.
import-license Imports a license from a provided file.
install-license Installs a license.
license Prints the currently installed license.
product-key Prints the product key.
sync-license Syncs the currently installed license on this machine.

CLI tool and license maintenance

The CLI tool only allows maintaining licenses on local machines. This means you can't use the CLI tool to connect to a remote instance to perform license maintenance. If you want to maintain a license on a remote machine, you must either use the Server Admin interface, or use the CLI tool on the machine itself.

  1. Get a copy of your license key from the Marketplace using the steps described here. You'll be able to obtain a copy of your product key using the product-key command:

    1
    2
    > product-key
    XXXX-XXXX-XXXX-XXXX
    
  2. Start the CLI tool and enter the install-license command, passing the license key generated earlier.

    1
    2
    > install-license --license "<your license key here>"
    License installed.
    

Via TORO Integrate Launcher

Upon clicking the Start button present in the TORO Integrate Launcher for the first time, a dialog will pop up asking, "Do you already have a license?" To trigger the license installation process, click either of the options provided. Select No to let TORO generate and install a license for you; click Yes to do these things by yourself.

Missed the dialog?

If you have closed this dialog, you can open it again by clicking on the TORO Integrate Launcher icon in the Quick access toolbar. Afterwards, select Install License.

To automatically generate and install your license key:

  1. Click the No button in the displayed dialog when asked if you already have a license.
  2. Login to your account. You may create one if you don't have a TORO Marketplace account yet.
  3. Choose your organization and license type.

    Must be a member of the organization

    Ensure you are a member of the organization you want to select because if you're not, the organization won't appear. To be a member of an organization, you must be invited; this can be done via the TORO Marketplace.

    There will be two options for the license type. Select Free license if you would like to use TORO Integrate on trial. Otherwise, select Use available subscriptions and choose from your account's paid subscriptions.

  4. Once done, click the Generate License button. Doing so will redirect you to the Server Admin login page.

To manually generate and inject your license key:

  1. Click the Yes button in the dialog to generate and install the license key by yourself. A form will appear.
  2. Follow the steps here in order to generate your license key. The product key would have appeared in the form mentioned earlier.
  3. Copy your license key to the clipboard. You may obtain a copy of your generated license by checking your email (an email is sent when a license is generated).
  4. Go back to the form and in the text area, paste your license key.
  5. Click Save.

Congratulations! Your license is now installed which means you can now login and use TORO Integrate.