Main AppServer commands

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

• configure user-level custom dictionaries,

• exclude the words from the dictionaries,

• apply changes made to your AppServer,

• upgrade or reinstall WebSpellChecker.

To verify if the application 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

  • 1.2. Start AppServer on Linux

• 2. Stop AppServer

  • 2.1. Stop AppServer on Windows

  • 2.2. Stop AppServer on Linux

• 3. Check AppServer version

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

• Option B. Direct connection to AppServer service

• 4. Check AppServer status

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

• Option B. Direct connection to the AppServer service

1. Start application

Windows

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.

Linux

2. Stop application

Windows

2.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:

• Go to Windows Start –> Control Panel –> Administrative Tools –> Services.

• Find WebSpellChecker Application Server Service on the list of all services.

• Click Stop.

Linux

3. Check application version

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

To verify the version, use ?cmd=ver command:

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

If you deployed the application bypassing the use of a web server, check the application version directly connecting to the application server via port 2880. This is the default port that the application server listens to, unless it was changed manually to the custom one.

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

Here is an example of the correct version response:

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

4. Check status

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

Use ?cmd=status command, verify status of AppServer engines (SpellCheck, Grammar Check, and AI-based language engines).

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 B. Direct connection to the AppServer service

To verify status of AppServer engines (SpellCheck, Grammar Check, and AI-based language engines), use ?cmd=status command:

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

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,
    },
    "EnglishAIModel": {
        "active": true
    },
    "GermanAIModel": {
        "active": true
    },
    "SpanishAIModel": {
        "active": true,
    },
    "EnglishAutocomplete": {
        "active": true,
    }
}