1. Overview

Floating licensing (FL) is a licensing model with a license server that runs the license management process and distributes licenses to a number of client application servers within the network. Such a licensing model is appropriate for software which is running in environments with dynamic hardware configuration, e.g. ephemeral or virtual containers or environments.

The FL is also available for the WebSpellChecker licenses management as a part of the FL mechanism. It makes it possible to automate the process of the WebSpellChecker application licensing in virtual environments with dynamic hardware configuration. 

The WebSpellChecker FL mechanism coordinates the work of a License Server and monitors how it controls and delivers licenses to a number of connected WebSpellChecker applications.

The License Server is shipped as a separate light-weight package that contains only a core component called AppServer with the FL mechanism. It doesn't include any spell or grammar checking functionality as it is aimed at the license delivering process.

Using the FL mechanism for the WebSpellChecker licenses management process allows:

  • Automating license activation process. No need to perform the manual steps with the license activation on each server with the WebSpellChecker application.
  • Simplifying process of the application maintenance in virtualized environments with varying hardware configuration. 
  • Integrating the WebSpellChecker application installation and upgrade processes into deployment procedure of your application.



2. Floating Licensing Deployment Scheme

3. Setup Floating License Server

3.1. Download License Server Installation Package

The License Server installation package is either Windows- or Linux-based distribution. A number of parallel installations is managed by the license key. Such a License Server installation package and a proper license key can be provided upon request to support@webspellchecker.net.

3.2. Install License Server

License Server must be installed on the server with the hardware configuration which will remain stable and constant over time. The failure of License Server will affect the work of all the connected applications.

  • Unpack the License Server installation package. Switch to the directory with the unpacked License Server and run the next command:
sudo perl automated_install.pl
  • Select installation path. The default installation path is /opt/WSC. However, you may decide to change it and set a desired one. As soon as you defined the installation path, press Enter to proceed further.
Welcome to the WebSpellChecker License Server application installation wizard! Before you go ahead with the installation, make sure that your environment configuration meets the WSC application system requirements. If you are all set, please follow carefully the wizard instructions. PLEASE MAKE SURE YOU ARE ACKNOWLEDGED AND ACCEPT THE WEBSPELLCHECKER SOFTWARE LICENSE AGREEMENT TERMS AND CONDITIONS PUBLISHED ON THE WEBSPELLCHECKER OFFICIAL WEBSITE. BY DOWNLOADING OR INSTALLING THIS SOFTWARE, YOU ACCEPT THE FULL TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT, YOU MUST NOT INSTALL OR USE THE WEBSPELLCHECKER SOFTWARE. 

Step 1: Check configuration settings. Install path [/opt/WSC]:
  • Define permissions. Set appropriate permissions for the application. You should define the files ownership, a user and group in the user:group format (e.g. 33:33). 
Step 2: Copy the WSC files to the installation directory. 

Step 3: Define the WSC application permissions. Specify the files ownership, a user and group in the 'user:group' format. It can be the same user and group which are used for Apache HTTP Server, i.e. 'www-data:www-data' or '33:33'. Specify the files owner as user:group [nobody:nobody]: 33:33

3.3. Activate License

Run the license activation process to go ahead with the license activation. For details, refer to License Activation on Linux guide

Press Enter and then proceed with the required steps to activate a license.

Step 4: Do you want to proceed with the license activation? Enter 'y' or 'n' [y]:
Specify your License Ticket ID: Your_License_Ticket_ID

Do you want the installer to attempt to activate your license automatically? The automatic activation requires the Internet connection available on this machine. Otherwise, please proceed with the manual activation instead. Enter 'y' or 'n'. [y]:

Congratulations! Your license is confirmed and activated successfully.

3.4. Configure License Server Port (Optional)

The port of License Server is used for communication with the allowed number of concurrently running copies of the WebSpellChecker Application servers. By default, the License Server is installed on 2881 port. If you want to change the default port for License Server, follow the steps below:

1. Navigate to <WebSpellChecker_Installation_Path>/WSC/LicServer/ directory.

2. Stop LicServer using the stop.sh script which is located in <WebSpellChecker_Installation_Path>/WSC/LicServer directory:

sudo sh <WebSpellChecker_Installation_Path>/WSC/LicServer/stop.sh

or 

./<WebSpellChecker_Installation_Dir>/WSC/AppServer/# sh stop.sh

3. Open the LicServerX.xml configuration file which is located in <WebSpellChecker_Installation_Path>/WSC/LicServer directory. 

4. In the LicServerX.xml file, locate the <Port> ...</Port> tag  and change its value to your custom one. Make sure that this port is not used and opened for inbound and outbound connections.

<!-- Port to which the LicServer will listen. The default is 2881 --> <Port>2881</Port>

5. Start LicServer using the start.sh script which is located in <WebSpellChecker_Installation_Path>/WSC/LicServer directory:

sudo sh <WebSpellChecker_Installation_Path>/WSC/LicServer/start.sh

or 

./<WebSpellChecker_Installation_Dir>/WSC/AppServer/# sh start.sh

4. Setup WebSpellChecker Application

4.1. Install WebSpellChecker

Proceed with the application setup following one of the installation manuals below if you do not have WebSpellChecker installed yet. Otherwise, jump to the step with the connection setup to License Server.

Important: Since you are going to use the FL mechanism, you has to skip the License Activation step. You do not need to activate a license on each server with the application. The licensing will be performed by a License Server.


 Installing WebSpellChecker Application on Windows...

 Installing WebSpellChecker Application on Linux...

4.2. Setup Connection with License Server


Specify a host name / IP address and a port number of License Server to establish connection with AppServer of the current WebSpellChecker installation. AppServer will be sending License Requests to the bounded License Server.

  • Open <WebSpellChecker_Installation_Path>/WSC/AppServer/AppServerX.xml
  • Find the <LicenseServer>...</LicenseServer> parameter tag in the AppServerX.xml file
  • Specify a host name / IP address and a port number of License Server as in the example:
<!-- LicenseServer parameter defines a license server where AppServer will call when its license is expired asking for a new license. -->
<LicenseServer>localhost</LicenseServer>

4.3. Start AppServer

Use the next instructions and commands to start AppServer. It is required for the changes to take effect.


Start AppServer on Windows

There are three possible options how you can start AppServer on Windows-based environments.

Option A: Go to Windows Start –> All Programs –> WebSpellChecker –> AppServer –> Start AppServer Service

Option B: Open Command Prompt –> Switch to [WebSpellChecker_Installation_Path]/AppServer –> Run AppServerX -start

Option C:

  • Go to Windows Start –> Control Panel –> Administrative Tools –> Services
  • Find WebSpellChecker Application Server Service on the list of all services
  • Click Start


Start AppServer on Linux

Run the start.sh script to start AppServer using the following command below:

sudo sh <WebSpellChecker_Installation_Path>/WSC/AppServer/start.sh

5. Verify Licensing Process

First of all, you need to check the application version and status. The version check will confirm the exact version of the application that you are running. The status check will provide you the health statuses of the main application engines: Spell Check, Grammar, Thesaurus.

  • Version: http(s)://your_host_name:[port]/spellcheck/script/ssrv.cgi?cmd=ver
  • Status: http(s)://your_host_name:[port]/spellcheck/script/ssrv.cgi?cmd=status

In addition to the version and status checks, you have to ensure that integrated spell/grammar checking functionality works properly in your web-system after the migration. Go to your web-system and check the controls where you expect to have spell/grammar checking.