How to Install OAS License Host in Linux

How to Install OAS License Host in Linux

This guide aims to walk you through the installation of the OAS License Host on a Linux host machine.

When running OAS in a virtualized environment, such as Docker or other virtualization platforms, it is not possible to license each OAS instance using the standard licensing method as licensing relies on the hardware thumbprint of the underlying host and will not work correctly in an environment where virtualized hardware is present.

The OAS License Host is a service that handles licensing in these situations. The license host must be installed either locally on the host machine (for example the machine the Docker engine is installed onto) or on a separate host that is on the same network as the containers running OAS. The OAS license is applied on the License Host by using the Configure OAS application's Container License screen.

For this guide on how to install the OAS License Host in Linux you will need:

  • Access to the OAS platform installed either on the same host or on another host on the same network so that you can use the Configure OAS application.
  • A supported Linux based operating system, see: System Requirements.
  • Access to a user account under which the License Host service will run. This guide assumes that the username of this user is oas. If you are using a different username you will have to replace all instances of oas with your own username.

1 - Download License Host

In this section you will download and prepare the OAS License Host service for installation.

  1. Change directory into your user's home directory. For example:

    cd /home/oas

  2. Download the OAS License Host using the following command:

    wget https://filedownloads.openautomationsoftware.com/license-host/oas-linux-license-host.zip

    Your output should look something like this:

    OAS License Host Download Linux

  3. Extract the oas-linux-license-host.zip file to the current directory. This will create a new folder called oas-linux-license-host.

    Extract OAS License Host zip file

    Tips

    To unzip a zip file you might need to install the unzip utilities. In a Debain based Linux system you can do this using the following command:

    sudo apt-get install unzip

  4. Move into the oas-linux-license-host folder.

    cd oas-linux-license-host

  5. Give the OASLicenseHost binary the execute permission.

    chmod +x OASLicenseHost

2 - Create License Host Service

You will now set up a new user service called oas-license-host to run the OAS License Host as a service. You will also enable it to start automatically on reboot.

  1. Create a new folder for systemd user services.

    mkdir -p /home/oas/.config/systemd/user/

  2. Create a new service definition file oas-license-host.service.

    touch /home/oas/.config/systemd/user/oas-license-host.service

  3. Edit the service definition using your favorite text editor.

    nano /home/oas/.config/systemd/user/oas-license-host.service

    Paste the following definition into the oas-license-host.service file.

    [Unit]
Description=Open Automation Software License Host

[Service]
ExecStart=/home/oas/oas-linux-license-host/OASLicenseHost
WorkingDirectory=/home/oas/oas-linux-license-host
SyslogIdentifier=oas-license-host
PrivateTmp=false
KillMode=process

[Install]
WantedBy=default.target

  4. Enable the service so that it starts automatically.

    systemctl --user enable oas-license-host

  5. Start the service.

    systemctl --user start oas-license-host

  6. Check that the service is running.

    systemctl --user status

    OAS License Host service status

3 - Configure License Host License

To configure the OAS License Host license you will need access to the Configure OAS application to view the license configuration screen. You can do this by installing the OAS platform on the same machine as the License Host, or by using another machine with OAS installed that is reachable on the same network as the License Host.

  1. Open the Configure OAS application.

  2. Select Configure > Container License from the top menu.

    Configure container license menu

    Tips

    If you are accessing a License Host on a remote machine, change the Network Node field to the IP address of the License Host server.

  3. If your license is invalid or maintenance has expired you may see a message such as this:

    Container license maintenance expired

    Click OK to continue if you see this message.

  4. On the Container License screen copy the License Code by clicking on the COPY CODE button.

    Container license invalid copy code

Depending on whether you wish to activate a demo license or a production license there are a number of possible scenarios:

A. License Key Generator

The License Key Generator is an online tool for activating demo licenses and managing production licenses where a serial number has been issued to you.

To activate a demo license

  1. Make sure Demo License is selected.
  2. Paste your license code into the License Code field.
  3. Enter your Email address into the Email field.
  4. Click on the I'm not a robot checkbox.
  5. Click on Generate Key to request an activation. You will receive an Email with the License Key.

Tips

You only have a limited number of activations. If you require further activations please contact your sales rep or contact support@oasiot.com.

License key generator demo

To activate a production license

  1. Make sure Purchased License is selected.
  2. Enter your serial number into the Serial Number field.
  3. Paste your license code into the License Code field.
  4. Click on the I'm not a robot checkbox.
  5. Click on Generate Key to request an activation. You will receive an Email with the License Key.

License key generator production

B. Electronic Activation

The electronic activation method can only be used for production licenses. On the Container License screen click on the ELECTRONIC ACTIVATION button. You will be asked for the serial number that you received after purchasing a license.

Enter serial number dialog

Enter the serial number and click on OK. If you have available servers for activation on your license your OAS license will be activated. If you are having any issues, please contact support@oasiot.com with your serial number and license code.

C. Contact Support

If you are looking to activate a demo license, Email the license code that you copied to support@oasiot.com and request a demo license.

If you are looking to activate a production license, Email both the serial number that you received after purchasing a license and the license code that you copied to support@oasiot.com.

In both cases, the support team will review your request and provide you with the relevant License Key.

4 - Review Container License

Once your license has been activated, you can review the license details on the Configure > Container License screen. This screen will give you details about your license status and lists the enabled products and drivers.

The maintenance information section contains:

  • Maintenance expiration date
  • License type
  • Number of tags
  • Networking enabled or disabled
  • Number of containers
  • Serial number

License information

The products and drivers section lists the enabled products and drivers.

License products and driver list

You are now ready to run OAS in your Docker containers. For more details see: