You can install WebSpellChecker Server using a Docker image available at Docker Hub. There is a prebuilt non-SSL image of WebSpellChecker/WProofreader based on the latest Ubuntu with Nginx.

You may benefit from using a Docker image when evaluating WebSpellChecker, whereas for production purposes or a real setup, you need to create a custom image using a Dockerfile. 

To create and use a custom Docker image, navigate to wproofreader-docker repo and familiarize with detailed instructions and further steps descriptions. 

This repository contains the following items:

  • Files directory where: 
    • configureFiles.pl a script which customizes the samples providing the correct path for these samples and sets up a shared directory for working with custom and user dictionaries;
    • configureWebServer.pl –  a script that configures the nginx web server for processing static files and service requests;
    • startService.sh – a script that starts all services required to launch WebSpellChecker when running the container, including configureFiles.pl and configureWebServer.pl on container startup.
  • Dockerfile –  a file describing the sequence of commands required to create a Docker image with WebSpellChecker Server based on the latest Ubuntu;
  • DockerfileCentOS –  a file describing the sequence of commands required to create a Docker image with WebSpellChecker Server based on the latest CentOS;
  • DockerfileRedHat –  a file describing the sequence of commands required to create a Docker image with WebSpellChecker Server based on the latest Red Hat Universal Base Image 8;
  • README.md – a file containing instructions on how to create and use a custom Docker image, its settings, as well as instructions on launching the container from this Docker image and description of further steps.

Further Steps

After a Docker container with WProofreader is up and running, integrate it into your web application following the instructions of the following sections: