WebSpellChecker.net Wiki

Installation and Configuration of WebSpellChecker application under Tomcat

Install WSC Licensed Version on Windows

Please follow the step-by-step instructions to install the WebSpellChecker application on your web server: Run installation package (e.g. WSC_SCAYT.<VERSION>.EXE). The installation Wizard will start. The installation process starts with the “Welcome” dialog.

Click Next to proceed.

License Agreement

In the following dialog, you must read and accept the terms and conditions of the WebSpellChecker.net License Agreement.

Please accept the License Agreement and click Next to proceed.

WebSpellChecker System Requirements

The following dialog will tell you about the WebSpellChecker system requirements.

Note! If your computer does not conform to these requirements, WebSpellChecker won't run on your computer.

Click Next to proceed.

Select Components

The following dialog allows you to select components that you want to install.

Click Next to proceed.

Note! Don't change the options for the next testing tasks (WebInterface testing, Functionality testing etc.)

Choose Destination Location

The following dialog box will ask you to choose the destination location.

Note! The default destination location is ”%ProgramFiles%\WebSpellChecker”

Click Next to proceed.

Web Server Settings

The following dialog box is labeled “Web Server Settings”. It defines the web server which will be used to run WebInterface, proxy and samples.

Choose Apache Tomcat 7.0+ option and click Next to proceed.

Web Site Settings

The following dialog box is labeled “Web Site Settings”. It allows you to select the installation point. By default “localhost:8080” for Apache Tomcat Web Server.

Click Next to proceed.

Select Program Manager Group

The following “Select Program Manager Group” dialog appears. This dialog allows you to choose the name of the program as a Start Menu Item.

Click Next to proceed.

Start Installation

The following dialog is labeled “Start Installation”.

Click Next to start the installation process.

After the installation process is finished, the “Installation Complete” dialog appears.

Note! You can enable the “Run Application Server to request a license” option that allows you to check the license.

To close the installation program dialog, click Finish.

License appliance and Deploy

To complete the installation you need to proceed with the following actions.

  1. Activate the license according the manual

Install WSC Licensed Version on Linux

Please unpack the content of the WSC_SCAYT.<VERSION>.tar.gz to your home directory, change your working directory to “WSC” and execute the following command:

perl automated_install.pl

License agreement

Please read the WebSpellChecker.net License agreement and accept it to proceed.

Permissions

In the following dialog please define the WebSpellChecker.net application permissions.

Network settings

Then please specify hostname, protocol and the virtual directory to adjust network settings.

Note! http://localhost:8080/spellcheck/ by default for Apache Tomcat Web Server

The following output illustrates that all network settings were successfully applied.

Choose Apache Tomcat 7.0+ to proceed installation process.

Set Environment Variable

Export WSC_DIR environment variable pointed to WSC installation file (e.g. WSC_DIR=/opt/WSC).

License appliance and Deploy

To finish up the installation you need to proceed with the following steps:

  1. Install license according to the manual
  2. Run the WebSpellChecker Application Server. It can be done following the manual.

Configuration of WSC application under Apache Tomcat Web Server

Prepare build folder

  • Create a build folder (Important: the name of the folder shouldn't include spaces)
  • Copy two folders (WebInterface and Samples) from $WSC_DIR\WebComponents\ into the build folder
  • In the build folder, rename Samples to “samples” and move it to the “WebInterface” directory
  • Copy spellcheck.war and rewarpper-1.0-jar-with-dependencies.jar from $WSC_DIR]\WebComponents\J2EEServersComponents to the build folder

Repack spellcheck.war

  • Run CMD (Terminal on Linux/Unix OS)
  • Navigate to the build folder and run next command:
java -jar rewarpper-1.0-jar-with-dependencies.jar spellcheck.war WebInterface/
  • Wait until repacking process will be finished

Deploy application into Apache Tomcat Web Server

  • Open configs.properties located in:
    [installation_path]\WebComponents\J2EEServersComponents
  • Update configs.properties with the path to the ssrv.cgi component from the installed WSC package in your system

For Windows:

[installation_path]\\WebSpellChecker\\WebComponents\\WebInterface\\script\\ssrv.cgi 

For Linux:

 /opt/WSC/WebComponents/WebInterface/script/ssrv.cgi 
  • Copy the following files to the \conf directory of your Tomcat install:
[installation_path]\WebComponents\J2EEServersComponents\configs.properties 
  • Put repacked spellcheck.war from build folder to \webapps directory of your Tomcat
    Note! spellcheck.war should be automatically unpacked, if something goes wrong - unpack it by yourself
  • Start Apache Tomcat Web Server (stop and then start if it already run)

Verify deploying results

The WebSpellChecker.net package has been set up on Apache Tomcat Web Server.

  • Check version:
http://domain/spellcheck/script/ssrv.cgi?cmd=ver
  • Check status:
http://domain/spellcheck/script/ssrv.cgi?cmd=status

Correct response for Windows is: Correct response for Linux is:

Known issue! It shows ERR_INCOMPLETE_CHUNKED_ENCODING in the browser, but in Apache Tomcat logs it shows the correct response.

  • Try to access the sample pages:
http://domain/spellcheck/samples/

Logging mechanism

The main configuration file names log4j.xml and locates in /webapps/spellcheck/WEB-INF/classes/ folder.

It contains the logging handlers of two types.

1. consoleAppender

Writing the servlet's stdout information. If the Tomcat is configured to use Catalina.out as standard destination log file for System.out and System.err the information will be written there as well.

2. fileAppender

Designed to write the servlet's technical information to the defined log file.

Parameters:

append - if it gets the 'false' value the log file will be overwritten on each Tomcat restart. If it gets 'true' value data will be appended to the defined log file despite restart actions.

file - defines log file name. Use absolute path or default Tomcat's path variables as ${catalina.home}. Please note that you have to make sure that the variable is defined.

Default value:

<param name="file" value="${catalina.home}/logs/webspellcheck.log"/>

Examples:

<param name="file" value="/usr/local/tomcat/logs/webspellchecker.log"/>
<param name="file" value="${catalina.home}/logs/spellcheck.log"/>
<param name="file" value="/dev/null"/>

maxFileSize - stands for log size management. Once the log is grown to a point the backup file will be created. In order to ensure optimal log rotation should be used in conjunction with “maxBackupIndex” parameter(see below).

maxBackupIndex - defines the number of backup files to be created. If set to zero the log file be always rotated without backups.