# Run the image from Docker Hub

Use this option for evaluation. It does not require building an image.

{% hint style="warning" %}
The public Docker Hub images have a fixed set of installed languages and models. Use a custom build for production.
{% endhint %}

### Available tags

* **Common image**: webspellchecker/wproofreader:<code class="expression">space.vars.current\_version</code>
* **Base image**: webspellchecker/wproofreader:<code class="expression">space.vars.current\_version</code>-base

### What is preinstalled

These images have four languages installed:

* `en_US`
* `en_GB`
* `en_CA`
* `en_AU`

This cannot be changed for the public images.

AI models:

* Common image: English proofreading + autocomplete models (`WPR_AI_MODELS=1,2`)
* Base image: no AI models installed (`WPR_AI_MODELS=0`)

### Run the container

Running the container is described in the [README](https://github.com/WebSpellChecker/wproofreader-docker#create-and-run-docker-container).

Activate the license on container start using:

* `--env WPR_LICENSE_TICKET_ID=<license_ticket_id>`

`WPR_VIRTUAL_DIR` defaults to `wscservice`.

Set `--env WPR_VIRTUAL_DIR=/` to serve from the root path.

{% tabs %}
{% tab title="wscservice" %}

<pre class="language-bash"><code class="lang-bash">docker run -d \
  -p 80:8080 \
  --env WPR_PROTOCOL=2 \
  --env WPR_WEB_PORT=80 \
  --env WPR_VIRTUAL_DIR=wscservice \
  --env WPR_LICENSE_TICKET_ID=<a data-footnote-ref href="#user-content-fn-1">&#x3C;license_ticket_id></a> \
  webspellchecker/wproofreader:latest
</code></pre>

{% endtab %}

{% tab title="/" %}

```bash
docker run -d \
  -p 80:8080 \
  --env WPR_PROTOCOL=2 \
  --env WPR_WEB_PORT=80 \
  --env WPR_VIRTUAL_DIR=/ \
  --env WPR_LICENSE_TICKET_ID=<license_ticket_id> \
  webspellchecker/wproofreader:latest
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
License activation at container startup requires Internet access. For production, prefer build-time activation. See: [License activation in Docker](/v6.12.0/deployment/licensing/license-activation-in-docker.md#option-2-activate-on-container-startup).
{% endhint %}

The two common endpoints are:

{% tabs %}
{% tab title="WPR\_VIRTUAL\_DIR=wscservice" %}

* Version: `http(s)://<host>/wscservice/api?cmd=ver`
* Status: `http(s)://<host>/wscservice/api?cmd=status`
  {% endtab %}

{% tab title="WPR\_VIRTUAL\_DIR=/" %}

* Version: `http(s)://<host>/api?cmd=ver`
* Status: `http(s)://<host>/api?cmd=status`
  {% endtab %}
  {% endtabs %}

Use the checks from the [README](https://github.com/WebSpellChecker/wproofreader-docker#verify-work).

* Health and license time:
  * [Health check](/v6.12.0/api-reference/auxiliary-api-commands/health-check.md)
* Log-based license validation:
  * [License verification](/v6.12.0/deployment/licensing/license-verification.md)

### Links

* [Docker Hub](https://hub.docker.com/r/webspellchecker/wproofreader)

[^1]: Insert your license ticket here.


---

# 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/installation/docker/run-the-image-from-docker-hub.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.