Installing the License Server WAR Distribution

Make sure that you have Java Servlet Container installed on the server you have selected to be the license server. Apache Tomcat 5.5 through 9.x is recommended (available at http://tomcat.apache.org). Tomcat 9.x is officially supported.

Note: Tomcat 10.x and later will not work with the license server.

Important: By default, the license server stores the statistics database and other data in the Java Servlet Container's temporary directory. If you are not using Apache Tomcat, this directory may be deleted when the server is stopped or restarted. However, you can set the oxygen.license.server.work.dir system property to specify a different path for the directory where the database is stored.

Download the HTTP license server Web Archive (.war) from the HTTP License Server website.

Configure three user roles in your installation of the Java Servlet Container (such as Apache Tomcat):

One user with the role user, used by an Oxygen application to connect to the license server. In the subsequent example, this user name is John.
Another user with the role admin, used for accessing the HTTP License Server administrative interface and the management interface. In the subsequent example, this user name is Mary.
Another user with the role manager-gui, used for accessing the Apache Tomcat Web Application Manager. In the subsequent example, this user name is tomcat.

For example, in Apache Tomcat, a typical way to achieve this is to edit the tomcat-users.xml file from your Tomcat installation (if using a Tomcat zip/tar.gz distribution, by default this configuration file is found in the /TomcatInstallFolder/conf/ directory). After adding the three users, the configuration file might look like this:

<tomcat-users xmlns="http://tomcat.apache.org/xml"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://tomcat.apache.org/xml tomcat-users.xsd"
              version="1.0">
  <!-- ... other user and role definitions ... -->
  <role rolename="user"/>
  <role rolename="admin"/>
  <role rolename="manager-gui"/>
  <user username="John" password="user_pass" roles="user"/>
  <user username="Mary" password="admin_pass" roles="admin"/>
  <user username="tomcat" password="s3cret" roles="manager-gui"/>
</tomcat-users>

Deploy the WAR file.

For example, in Apache Tomcat, go to the Web Application Manager page and log in with the user you configured with the manager-gui role (tomcat in the example above). In the WAR file to deploy section, choose the WAR file and click the Deploy button. The oXygenLicenseServlet application is now up and running, but the license key is not yet registered.

Go to the HTTP License Server administration page. By default, the address of this page is http://<server-address>/oXygenLicenseServlet. In Apache Tomcat, you can also open this page by clicking the oXygenLicenseServlet link in the manager page.

You need to authenticate with the user configured with the manager-gui role (tomcat in the example above).

Activate the license key. This process involves binding your license key to your license server deployment. The browser used in the activation process needs to have Internet access.

Note: If you cannot access the internet during the deployment, you can manually activate the license key.

Once the process is completed you cannot activate the license on another license server. Follow these steps to activate the license:

Paste your license key into the form and click Register/Activate.

Step Result: You will be redirected to an online form hosted on the Oxygen website. This form is pre-filled with an activation code that uniquely identifies your license server deployment, and your license key.
Click Register/Activate.

If the activation process is successfully completed, your license server is running. Follow the on-screen instructions to configure the Oxygen XML Author Eclipse plugin client applications.

The application's log file location is specified by the log4j.appender.R2.File property from the WEB-INF/lib/log4j.properties configuration file.

For example, in Apache Tomcat, the configuration file is located at: TomcatInstallDir/webapps/oXygenLicenseServlet/WEB-INF/lib/log4j.properties and the default log file location is TomcatInstallDir/logs/oxygenLicenseServlet.log.