• Created by user-4a6d8, last modified by user-232a4 on Aug 08, 2023

You may often need to change AppServer properties, settings, and parameters to do the following:

  • configure personal user dictionaries,
  • exclude the words from the dictionaries,
  • apply changes made to your AppServer,
  • upgrade or reinstall WebSpellChecker. 

To verify if WebSpellChecker AppServer works properly, you may need to run one or several of four AppServer commands described in this section:

1. Start AppServer

1.1. 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 WebSpellChecker Application Server.

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

Option C:

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

1.2. Start AppServer on Linux

To start AppServer on Linux, run the start.sh script using the following command below:

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

Or your can also run the start.sh script from the AppServer directory:

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

2. Stop AppServer

1.1. Stop AppServer on Windows

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

Option A: Go to Windows Start –> All Programs –> WebSpellChecker –> AppServer –> Stop WebSpellChecker Application Server

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

Option C:

  1. Go to Windows Start –> Control Panel –> Administrative Tools –> Services.
  2. Find WebSpellChecker Application Server Service on the list of all services.
  3. Click Stop.

1.2. Stop AppServer on Linux

To stop AppServer on a Linux-based environment, run the stop.sh script from the AppServer directory:

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

Or your can also run the stop.sh script from the AppServer directory:

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

3. Check AppServer version

To check the current version of WebSpellChecker Server package, start AppServer Service and check its version as shown below.

Option A. Connection to the AppServer service via web server acting as a reverse proxy

Web servers must be configured to act as a reverse proxy. For more details, visit Reverse proxy setup to avoid exposing 2880 port.

To verify the version, use ?cmd=ver сommand: http(s)://your_host_name/virtual_directory/api?cmd=ver

Option B. Direct connection to AppServer service

To verify the version, use ?cmd=ver сommand: http(s)://your_host_name:2880/?cmd=ver

Port 2880 is the default port used by AppServer Service.

If you specify a custom port number, use the following link: http(s)://your_host_name:port/?cmd=ver

Here is an example of the correct version response for WebSpellChecker Server:

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

Option C. Connection to the service via FastCGI, SSRV.cgi component, and web or Java application server for versions 5.5.x - 5.17.x

To verify the version, use ?cmd=ver сommand: 

http(s)://your_host_name/wscservice/script/ssrv.cgi?cmd=ver

If you specified a custom port number for a web server or a Java application server, use the following link: 

http(s)://your_host_name:port/wscservice/script/ssrv.cgi?cmd=ver

Here is the correct version response:

(c) 2000-2021 WebSpellChecker LLC

All rights reserved.

www.webspellchecker.net

Program name:ssrv
Program version:x.x.x.x x64 master:xxxxxxx (xxx) #xx for Windows or Linux

4. Check AppServer status 

To verify if WebSpellChecker Server works properly, you need to start AppServer Service and check its status.

Use ?cmd=status сommand, verify status of AppServer engines (SpellCheck, Grammar Check, and Thesaurus).

Option A. Connection to the AppServer service via web server acting as a reverse proxy

Web servers must be configured to act as a reverse proxy. For more details, visit Reverse proxy setup to avoid exposing 2880 port.

http(s)://your_host_name/virtual_directory/api?cmd=status

Option A. Direct connection to the AppServer service

To verify status of AppServer engines (SpellCheck, Grammar Check, and Thesaurus), use ?cmd=status сommand:

http(s)://your_host_name:2880/?cmd=status

The port 2880 is the default port used by AppServer Service.

Here is a correct status response:

http(s)://your_host_name:2880/?cmd=status
{
    "SpellCheckEngine": {
        "active": true
    },
    "GrammarCheckEngine": {
        "active": true
    },
    "ThesaurusEngine": {
        "active": true
    }
}

Option B. Connection to the Service via FastCGI, SSRV.cgi component and Web or Java Application Server

To verify the status of the AppServer engines (SpellCheck, Grammar Check, and Thesaurus) via FastCGI, SSRV.cgi component, and web server, use the following command:

http(s)://your_host_name/wscservice/script/ssrv.cgi?cmd=status

Here is a correct status response:

Spell Check Engine is ACTIVE
Grammar Engine is ACTIVE
Thesaurus Engine is ACTIVE

Please find below the description of the statuses that are received from SSRV component:

'ACTIVE' status means that an Engine works properly.
'NOT ACTIVE' status means that an Engine is not enabled or does not work properly.

For more details and assistance, please contact the technical support team at [email protected].


  • No labels