Licensing

Obtaining a License File

A Squore license file is linked to the hardware of the machine Squore Server is installed on.

Once Squore Server installation is complete, and it is started, when accessing your Squore Server in your web browser you are presented with a screen that allows you to request a license.

Figure 1. The license request dialog

From there you can either:

Request a free activation key which will be used to download the evaluation license file afterward.
Enter an existing activation key in order to download the evaluation license file for your machine.
Provide directly the license file for your machine if you already have it.

If your machine does not have an internet access, click on Get a free activation key. You will be prompted to provide some necessary information in order to generate the license file manually, and then send it via mail to support@vector.com.

The License Management page will be the Squore Server default landing page if no license file can be found. In order to avoid users confusion on a production installation, a good practice would be to:

Either provide the license file at installation.
Or prevent the Squore Server from accepting remote machines requests until a license file has been deployed.

Generating the Host-Id

The host-id is a fingerprint of some of the hardware components of the machine hosting Squore Server.

To generate the host-id:

Open a terminal on the machine where you installed or plan to install Squore.
Change to the <SQUORE_HOME> folder
Run the command: java -jar ./lib/squore-hostid.jar.

Updating the License File

A Squore license key or file (squore-license.p7s) should have been provided to you by Vector Informatik GmbH under the applicable Squore licensing agreement.

Follow these steps to deploy the Squore license file:

Log into Squore Server as an administrator.
Click on ? > License:
On the License Management page, click I already have a license file or I already have an activation key:
Then, either upload your new license file and click Deploy, or enter your activation key and click Activate.

Either provide the license file at installation.
Or prevent the Squore Server from accepting remote machines requests until a license file has been deployed.

Sharing License Between Squore Servers

In this section, you will learn how to configure a Squore Server to rely on a remote license server instead of using the embedded license server.

This is especially useful when you are running a production Squore Server and a development Squore Server (or several), and you want the license file to be shared between all installations.

External accounts (single sign-on, LDAP) common to all Squore Servers will reserve only one token license, while local accounts will reserve one token license per account and per Squore Server.

Prerequisites

Make sure that both Squore Servers are installed, started and running properly. Additionally, if both servers are running on the same machine, make sure that:

The Squore Server acting as the remote license server is accepting requests from remote machines (Accepting Remote Machines Requests).
Both Squore Servers are identified as specific instances. To do so, edit the root server element and add a name attribute in <SQUORE_HOME>/server/standalone/configuration/standalone.xml file, as follows:
```
<?xml version='1.0' encoding='UTF-8'?>
<server name="production" xmlns="urn:jboss:domain:4.2">
...
</server>
```

Having both servers in different Squore versions, might lead to issues because of libraries incompatibility. Contact support at support@vector.com in case of trouble or if you want to have more details.

Configuring local Squore Server to target the Squore Server acting as a remote license server

Stop local Squore Server.
In <SQUORE_HOME>/server/standalone/configuration/squore-server.properties file, add the following property:
```
license.remote = true
```
In <SQUORE_HOME>/server/standalone/configuration/standalone.xml file, locate the outbound-socket-binding element with name attribute equal to remote-ejb.
In remote-destination element, edit host and port attributes in order to match the hostname and HTTP port of the Squore Server acting as the remote license server:
```
<outbound-socket-binding name="remote-ejb">
	<remote-destination host="<hostname>" port="<port>"/>
</outbound-socket-binding>
```
Port of Squore Server acting as remote server license is 8080 plus the offset you defined during installation. So 8180 by default.
Start local Squore Server.

The local Squore Server is now sharing the license with the Squore Server acting as the remote license server.

Changing default passwords (optional)

Default password of the ejb user is changeme. But it is possible to define your own password instead.

Squore Server acting as remote license server
1. Edit <SQUORE_HOME>/server/standalone/configuration/application-users.properties to specify the md5sum of the new password:
  # Properties declaration of users for the realm 'ApplicationRealm' which is ... # (...) ejb=b896b091324032442cb92b83fbe8501b
  To get the md5sum of a new password, execute the following command:
  
  echo -n "<new-password>" | md5sum
2. Restart Squore Server.

Local Squore Server

In <SQUORE_HOME>/server/standalone/configuration/standalone.xml file, locate the authentication-client element in elytron:15.1 subsystem.

Modify the clear-text attribute value of the credential-reference sub-element with the new password:

<subsystem xmlns="urn:wildfly:elytron:15.1" final-providers="combined-providers" disallowed-providers="OracleUcrypto">
...
    <authentication-client>
        <authentication-configuration name="ejb-auth-config" authentication-name="ejb">
            <credential-reference clear-text="<new-password>"/>
        </authentication-configuration>
        ...
    </authentication-client>
...
</subsystem>