# 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](#mainappservercommands-startappserverwindowslinux1.startappserver)
  * 1.1. [Start AppServer on Windows](#mainappservercommands-1.1.startappserveronwindows)
  * 1.2. [Start AppServer on Linux](#mainappservercommands-1.2.startappserveronlinux)
* 2\. [Stop AppServer](#mainappservercommands-stopappserverwindowslinux2.stopappserver)
  * 2.1. [Stop AppServer on Windows](#mainappservercommands-1.1.stopappserveronwindows)
  * 2.2. [Stop AppServer on Linux](#mainappservercommands-1.2.stopappserveronlinux)
* 3\. [Check AppServer version](#mainappservercommands-3.checkappserverversion)
* [Option A. Connection to the AppServer service via web server acting as a reverse proxy](#mainappservercommands-optiona.connectiontotheappserverserviceviawebserveractingasareverseproxy)
* [Option B. Direct connection to AppServer service](#mainappservercommands-optionb.directconnectiontoappserverservice)
* 4\. [Check AppServer status](#mainappservercommands-4.checkappserverstatus)
* [Option A. Connection to the AppServer service via web server acting as a reverse proxy](#mainappservercommands-optiona.connectiontotheappserverserviceviawebserveractingasareverseproxy.1)
* [Option B. Direct connection to the AppServer service](#mainappservercommands-optionb.directconnectiontotheappserverservice)

### 1. Start application <a href="#mainappservercommands-startappserverwindowslinux1.startappserver" id="mainappservercommands-startappserverwindowslinux1.startappserver"></a>

{% tabs %}
{% tab title="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.
   {% endtab %}

{% tab title="Linux" %}
**1.2. Start AppServer on Linux**

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

```javascript
sudo sh <WebSpellChecker_Installation_Path>/WebSpellChecker/AppServer/start.sh
```

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

```javascript
/<WebSpellChecker_Installation_Dir>/WebSpellChecker/AppServer/# sh start.sh
```

{% endtab %}
{% endtabs %}

### 2. Stop application <a href="#mainappservercommands-stopappserverwindowslinux2.stopappserver" id="mainappservercommands-stopappserverwindowslinux2.stopappserver"></a>

{% tabs %}
{% tab title="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.
  {% endtab %}

{% tab title="Linux" %}
**2.2. Stop AppServer on Linux**

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

```javascript
sudo sh <WebSpellChecker_Installation_Path>/WebSpellChecker/AppServer/stop.sh
```

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

```javascript
/<WebSpellChecker_Installation_Dir>/WebSpellChecker/AppServer/# sh stop.sh
```

{% endtab %}
{% endtabs %}

### 3. Check application version <a href="#mainappservercommands-3.checkappserverversion" id="mainappservercommands-3.checkappserverversion"></a>

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:

```json
{
    "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 <a href="#mainappservercommands-4.checkappserverstatus" id="mainappservercommands-4.checkappserverstatus"></a>

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 <a href="#mainappservercommands-optiona.connectiontotheappserverserviceviawebserveractingasareverseproxy.1" id="mainappservercommands-optiona.connectiontotheappserverserviceviawebserveractingasareverseproxy.1"></a>

Web servers must be configured to act as a reverse proxy. For more details, visit [Reverse proxy setup to avoid exposing 2880 port](/v6.12.0/deployment/configuration/web-server/reverse-proxy-setup-to-avoid-exposing-2880-port.md).

http(s)://your\_host\_name/virtual\_directory/api?cmd=status

#### **Option B. Direct connection to the AppServer service** <a href="#mainappservercommands-optionb.directconnectiontotheappserverservice" id="mainappservercommands-optionb.directconnectiontotheappserverservice"></a>

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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.wproofreader.com/v6.12.0/deployment/configuration/application-server/main-appserver-commands.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.