Build using prebuilt configuration

Use this option when you want to build from a prebuilt WProofreader base image.

It does not require an installation package. The Dockerfile pulls the base image from Docker Hub.

What you need

• Docker installed.

• The prebuilt Dockerfile: Dockerfile.ubuntu-prebuilt

• Access to Docker Hub to pull the base image during docker build.

Build the image

Required build arguments

• TAG: the base image tag. It must include the -base suffix. Example: "6.10.0.0-base".

The list of available tags is on Docker Hub.

Common build arguments

• WPR_LICENSE_TICKET_ID: activates the license during the build.

• WPR_LANGUAGES: comma-separated locales.

• WPR_AI_MODELS: comma-separated AI model IDs.

• WPR_PROTOCOL: 1 (HTTPS) or 2 (HTTP).

• WPR_DOMAIN_NAME: hostname used by samples.

• WPR_VIRTUAL_DIR: virtual directory name.

Example:

docker build -t local/wsc_app \
  --build-arg TAG=base \
  --build-arg WPR_LICENSE_TICKET_ID=<license_ticket> \
  --build-arg WPR_LANGUAGES=en_US,en_GB,en_CA,en_AU \
  --build-arg WPR_AI_MODELS=1,2 \
  --build-arg WPR_PROTOCOL=2 \
  --build-arg WPR_DOMAIN_NAME=localhost \
  --build-arg WPR_VIRTUAL_DIR=wscservice \
  -f Dockerfile.ubuntu-prebuilt .

For language short codes, see Supported languages.

Run the container

Use --env at runtime.

Full list of runtime options is in the README.

Example (HTTP):

docker run -d \
  -p 80:8080 \
  --env WPR_PROTOCOL=2 \
  --env WPR_DOMAIN_NAME=localhost \
  --env WPR_WEB_PORT=80 \
  --env WPR_VIRTUAL_DIR=wscservice \
  local/wsc_app

Mount dictionaries and certificates

Mounts are optional. Use them for persistence and for HTTPS.

Persist dictionaries and style guide

Mount /dictionaries to persist shared data outside the container.

It stores:

• User custom dictionaries

• Organization custom dictionaries

• Style Guide data

Use this mount if you:

• recreate containers and need the data to survive

• run several containers and want them to use shared resources

Example:

docker run -d \
  -p 80:8080 \
  -v /path/on/host/dictionaries:/dictionaries \
  local/wsc_app

Use your own TLS certificate

Mount /certificate and provide these files:

• cert.pem

• key.pem

Example (HTTPS):

docker run -d \
  -p 443:8443 \
  -v /path/on/host/certificate:/certificate \
  --env WPR_PROTOCOL=1 \
  --env WPR_WEB_PORT=443 \
  local/wsc_app

Verify work

Use the checks from the README.

The two common endpoints are:

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

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

Next steps

• If the target host has no Internet access, continue with Build without internet connection.

• Container options and verification are in the upstream README.