You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

This step-by-step guide outlines the main steps for the WebSpellChecker application installation on a Linux-based server with Apache Tomcat Application Server. In this guide we will run you through the whole installation process from downloading installation packages to embedding spell/grammar checking functionality to your web-based system.


Before you begin:

  1. Check if your environment configuration meets:
    1. WebSpellChecker Server System Requirements
    2. WebSpellChecker Server Hardware Requirements
  2. Acknowledge with WebSpellChecker Server Architecture Diagram.

  3. Do you have a valid license?

    First of all you need to get a valid License Ticket ID to proceed with the license activation. Depending on the server license type, it may be a commercial (e.g. 1 year) or a 30-day trial license. Except the validity period, there is no difference between ticket types from the technical perspective.

    Good to know:

    • If you do not have a license yet, you can obtain it using one of the following ways:
    • Starting from v5.8.1 released on December 30, 2020, the license is no longer validated by or tied to the hardware characteristics of a machine or server. License for older versions of the packages is hardware-dependent. 
    • If you are migrating WebSpellChecker from one server to another, you will need to deactivate (detach) a license on the current server and then reactivate it on a new one. Check carefully the Migrating License to New Server guide under the Licensing section.
    • If you have problems with your license, contact us.

1. Download Installation Package

Download WebSpellChecker Server installation package for the corresponding version of your operating system (OS). By default, it is provided on a license purchase or renewal. You can also request it by contacting us. 

2. Install WebSpellChecker

2.1. Unpack the WebSpellChecker installation package (e.g. wsc_app_lix_x64_release_5.4.X.X_XX.tar.gz). Switch to the directory with the unpacked WebSpellChecker and execute the next command:

sudo perl automated_install.pl

2.2. 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 (WSC) 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: Change configuration settings.
Install path [/opt/WSC]:

2.3. 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 the Apache HTTP Server, i.e. 'www-data:www-data' or '33:33'.
 
Specify the files owner as user:group [nobody:nobody]: 33:33

2.4. Determine network settings. Specify a service protocol, hostname, port and virtual directory which will be used to access the application.

The default ports for Apache Tomcat Application Server are 8080 and 8443 for HTTP and HTTPS protocols respectively.

*Step 4: Specify network settings.

Specify a service protocol, hostname and the virtual directory to access the WSC application.
i.e. 'http(s)://your_host_name:8080(8443)/spellcheck'

SERVICE_HOST: https://your_host_name:8443/spellcheck

The following output confirms that all the network settings have been successfully applied:

* SERVICE_HOST  = https://your_host_name:8443/spellcheck
* PROTOCOL = https
* HOST = your_host_name
* PORT = 8443
* VIRTUAL DIRECTORY = spellcheck
 
*Preparing the ssrv.ini configuration file.
*Installing the WSC application demo samples.
*Setting a specified service_host value in wsc_fck2plugin.js and wsc_ck2plugin.js files.

2.5. Choose Web or Application Server. The properly configured Web or Application Server is required for correct work of the application. 

  • Choose Java Application Server (Apache Tomcat, Oracle WebLogic Server, Oracle GlassFish Server, etc.) option to serve static files from WebSpellChecker Server package on Apache Tomcat Application Server (Option 2) and press Enter.
Step 8: Choose Web or Application Server type.

Select a particular web or application server which will be used for the WSC application server running.

	1. Apache HTTP Server
	2. Java Application Server (Apache Tomcat, Oracle WebLogic Server, Oracle GlassFish Server, etc.)
	3. Other

Input the number from 1 to 3: 2

This section outlines the details of wscservice.war deployment on Apache Tomcat (static files and all requests to engines are served) or binding only static files and the rest of the service requests such as spelling or grammar checking, directly connecting with AppServer.

Option A: Binding of Static Files and Serving Service Requests by AppServer

To bind only static files and the rest of the service requests such as spelling or grammar checking directly connecting with AppServer:

1. Stop Apache Tomcat before modifying the configuration files. 

2. Add the following paths to the server.xml file inside the <Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true"> tag:

<Context docBase="/opt/WSC/WebComponents/WebInterface" path="/wscservice" />
<Context docBase="/opt/WSC/WebComponents/Samples" path="/wscservice/samples" />

3. If you plan to host WebSpellChecker and your web app(s) on different domains, you might face the CORS issues. To avoid this, add the Access-Control-Allow-Headers to enable cross-origin requests to the Apache Tomcat settings. For this you can use CORS filter.

4. Start Apache Tomcat after modifying the configuration files.

Option B: Serving both Static Files and Service Requests by Java Application Server (deployment of wscservice.war)

To deploy wscervice.war on Apache Tomcat for binding static files and all service requests to engines such as spelling or grammar checking: 

1. Set and check the WSC_DIR environment variable. It must be pointed to the WebSpellChecker Server installation directory (for example, WSC_DIR=/opt/WSC as in example below):

export WSC_DIR=/opt/WSC
echo @WSC_DIR

2. Deploy wscservice.war on your Apache Tomcat Application Server. 

  • Copy the wscservice.war file from <WSC_DIR>/J2EEServerComponents to the Apache Tomcat /webapps directory.
  • Start Apache Tomcat, or stop and then start if it is already running.

Note that the wscservice.war file should be unpacked automatically. Otherwise, unpack it manually.

3. Activate License

On this step you need to choose whether to run the license activation process. You can skip the license activation step if you already have a license activated or you prefer to proceed with the license activation step later. If you want to go ahead with the license activation, enter Yes and then proceed with the steps described in the license activation manual below.

Step 6: Activate license.

Do you want to proceed with the license activation process and run a request license? Enter yes or no [yes]: yes

Visit the License Activation on Linux guide to find out how to activate a license on a Linux server.

4. Finalize Installation


Congratulations! The WSC application has been successfully installed to /opt/WSC directory.

Step 10: Finalize the WSC application configuration under a chosen Web or Application Server:

Configure the WSC application under the Java Application Server using the next manual:

http://wiki.webspellchecker.net/doku.php?id=installationandconfiguration:licensed:tomcat

5. Configure Grammar Engine

The Grammar engine requires Java 8 and higher. The installation script tries to auto-detect a path to an existing Java Virtual Machine (JVM). If the path is not found, you will be asked to specify the path to JVM.

You have an option to set a path to JVM manually or change the auto-detected path to your custom one. Refer to Enabling Grammar Engine guide to find out more.

6. Verify Operability

Now you are ready to check if the installation process of the application went well, and all the components are functioning properly.

Step 12: Verify the WSC Application Operability.

Check the application version, status, and access to the demo samples to verify if the application works properly after the installation.

a. Version: 

https://localhost:2880/?cmd=ver

b. Status:

https://localhost:2880/?cmd=status

c. Default demo samples:

https://localhost/wscservice/samples/

WebSpellChecker Server Status

Here is a correct status response of WebSpellChecker Server:

{
    "SpellCheckEngine": {
        "active": true
    },
    "GrammarCheckEngine": {
        "active": true,
    },
    "EnglishAIModel": {
        "active": true
    },
    "GermanAIModel": {
        "active": true
    },
    "SpanishAIModel": {
        "active": true,
    },
    "EnglishAutocomplete": {
        "active": true,
    }
}

WebSpellChecker Server Version

Here is a correct version response for WebSpellChecker Server 5.x.x.x on a Linux server:

{
    "Copyright": "(c) 2000-2023 WebSpellChecker LLC",
    "ProductWebsite": "webspellchecker.com",
    "ProgramVersion": "5.x.x.x x64 master:xxxxxxxx (xxxx) #xx",
    "PackageVersion": "5.x.x.x master:xxxxxxx (xxx) #xx"
}

WebSpellChecker Demo Samples

Here is the correct view of the WebSpellChecker demo samples:


7. Integrate WebSpellChecker

Integrate WebSpellChecker products into your web application.

Option A. Integration Guides

Visit Products and Integrations Guides to lean more how to get started with WebSpellChecker products.

WProofreader

Try our WProofreader. It is based on SpellCheckAsYouType (SCAYT) core, designed to simplify the integration and combine functionality of proofread as you type functionality and proofread in a dialog.

Here are the main benefits of using WProofreader:

  • Easy to get started. A single script for all editable fields in a web app;
  • Auto-search functionality which detects editable fields on a web page and enables proofreading functionality;
  • Proofread as you type functionality on multiply languages. Spell checking functionality is supported for 16 default languages and 152 additional languages, grammar checking functionality is available for 14 out of 16 default languages;
  • Simplified box with corrections for spelling and grammar problems;
  • A new badge button with the WebSpellChecker Proofreader settings;

  • Supported in all modern browsers such as Chrome, Firefox, Internet Explorer 11+, MS Edge, and Safari.

Refer to Get Started with WProofreader Server (autoSearch) guide for more information.

Option B. Demo Samples

Depending on the type of elements (HTML native elements, rich text editors) where the spelling/grammar check functionality is needed, you may choose and use the demo samples shipped with the WebSpellChecker Server package. 

To access the default samples, go to the following page:  https://your_host_name:port/spellcheck/samples/. The default samples contain all the necessary samples and instructions that will help with the integration of the WebSpellChecker products. Moreover, each sample contains detailed development documentation with a list of methods and parameters available.


  • No labels