There are three ways to license RealityServer.
Which you need will depend on your environment and requirements. If you have multiple valid license types RLM will be used first and if this fails RealityServer will attempt to obtain a Cloud license. See below for installation instructions for each license type.
Node-locked licenses are by far the simplest. These licenses are tied to a specific host machine. They are not suitable for use with virtual machines or cloud environments since the details we use to identify the host may change over time. Node-locked licenses are provided as an activation code in the form xxxx-xxxx-xxxx-xxxx. These may be permanent or time limited (for example of you have an evaluation or annual subscription). To activate a node-locked license simply run RealityServer with the --activate command line option.
realityserver --activate xxxx-xxxx-xxxx-xxxxThis will contact the activation servers over the Internet and install your license. In the process a file license.lic will be created in the RealityServer root directory containing your license (please ensure write permissions are available for that directory) and the following message will be emitted.
RLM license activated and written to file: C:\migenius\realityserver\license.licOf course the actual file location will depend on where you have extracted your RealityServer installation to. If you decide you want to move your license to another machine you can do this yourself by first revoking the activation for the license.
realityserver --revokeWhich will emit a message like this.
License revoked.You can then activate the license again on a different machine (or of course the same machine again), without the need to contact migenius. If your machine fails in some way and you are unable to revoke your existing license please contact us for a new activation code.
Activation requires an Internet connection during the activation process. If you need to activate your node-locked license without an Internet connection please contact us to obtain the required tools.
If you run multiple versions of RealityServer often and don’t want to have to copy the license file around you can move it to the following folder under Windows (you may need to create the folder).
%ProgramData%\migenius\RealityServer\licenseUnder Linux it will be the following location (again you may need to create this.
/var/opt/migenius/RealityServer/licenseIf you would like to keep your license local to your user rather than being system wide you can move it to your user directory instead. Under Windows that is here.
%APPDATA%\migenius\RealityServer\licenseUnder Linux here.
$HOME/.migenius/RealityServer/licenseFloating licenses are more complex as they require the installation of a license server. The license server is installed on one machine and the machines running RealityServer then contact this license server to obtain their licenses. Floating licenses are suitable for use in virtual machines and cloud environments (so long as you expose your license server to the cloud). Floating licenses are also provided as an activation code, however instead of directly activating with RealityServer you will need to activate them within your license server. Please refer to the following article for instructions on how to install the migenius License Server software.
Floating License Server Installation
Once you have installed the floating license server and activated your licenses within the server you can tell RealityServer to use the server by creating your own license.lic file and placing it in the RealityServer directory. The file should contain the following line.
HOST hostname any 5053Where hostname should be replaced with the hostname or IP address of your license server. The default licensing port is 5053, if you change this on your license server then you should update your licensing file accordingly. Please also ensure that your firewall is configured to allow incoming connections to the license server. Note that the license server may be using more ports than just 5053 since each type of license uses its own port.
As with node-locked licenses, an Internet connection is required during the activation process on the license server to install the licenses. If you need to activate your floating licenses without an Internet connection please contact us to obtain the required tools.
Also note that by default it is not possible to run the license server on a virtual machine. If you need to do so please contact us for instructions on obtaining an additional license file which will enable this functionality.
Cloud licenses are metered and paid for based on usage. These are typically used in cloud environments however it is also possible to use metered licensing on-premise. To use cloud licensing you must have been provided with a special cloud licensing file which will be named realityserver.lic which is to be installed in your RealityServer directory. Cloud licensing requires an permanent Internet connection from your RealityServer machines to our licensing server.
If you need to have your cloud license file in a different location you can use the MIG_CLOUD_LICENSE_FILE environment variable to specify an alternative. It is important to keep your cloud license file secure since anyone with access to the file can generate usage on your metered account. If your file is compromised and you need to have it revoked please contact us.
Usage is tracked in 1 minute increments and customers using cloud licensing will receive monthly invoices and usage reports.
NOTE: On Ubuntu and Debian based systems you may get an error related to RealityServer not finding a certificate bundle. This is due to this being stored in a different location on Ubuntu/Debian based distributions from Redhat/CentOS based ones. If you are running Ubuntu you can correct this by creating a symbolic link to the bundle in the correct location using the following commands.
sudo mkdir -p /etc/pki/tls/certs
sudo ln -s /etc/ssl/certs/ca-certificates.crt /etc/pki/tls/certs/ca-bundle.crtIf you are using older SPM based cloud licensing please refer to this page. Note that this legacy licensing system may be discontinued in the future.