Run the image from Docker Hub

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

The public Docker Hub images have a fixed set of installed languages and models. Use a custom build for production.

Available tags

• Common image: webspellchecker/wproofreader:6.14.0.0

• Base image: webspellchecker/wproofreader:6.14.0.0-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.

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.

wscservice

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=<license_ticket_id> \
  webspellchecker/wproofreader:latest

/

License activation at container startup requires Internet access. For production, prefer build-time activation. See: License activation in Docker.

The two common endpoints are:

WPR_VIRTUAL_DIR=wscservice

• Version: http(s)://<host>/wscservice/api?cmd=ver

• Status: http(s)://<host>/wscservice/api?cmd=status

WPR_VIRTUAL_DIR=/

Use the checks from the README.

• Health and license time:

  • Health check

• Log-based license validation:

  • License verification

Links

• Docker Hub