Before you begin:
  • Make sure that the version of the WebSpellChecker application version that you are trying to install using the automated installation script is 4.8.3.2 and higher.
  • Check if your environment configuration meets the WebSpellChecker Server System Requirements.

1. Create Configuration File

Before you run the automated_install.pl script, you need to prepare a special configuration file and specify proper values for all the required installation parameters. This information will be used by the script for the automated installation of the WebSpellChecker application on your server.

1.1. Configuration File Syntax

  • Configuration file has a simple structure resembling *.ini files. 
  • Each row of the file should contain one parameter with an assigned corresponding value.
  • You are allowed to use indentation, spaces and tabs and add blank lines.
  • You can comment some of the parameters using a hash sign “#” at the very beginning of the row with a parameter name (e.g. #run_license_request = 0).
install_config.ini
#This is an example of a simple configuration file that can be used for the automated installation of the application on a Linux-based server with Apache HTTP Server.
install_path = opt/WSC/ 
rewrite_old_installation = 1
file_owner = 33:33
service_host = https://your_host_name:443/spellcheck
web_server_type  = 1
apache_install_mod_fastcgi = 1
apache_auto_enable_modules = 1
#run_license_request = 0

1.2. Configuration File Parameters

In the table below, you will find a list of all available parameters and their possible values that you can used in the configuration file. Some of the parameters are mandatory and must be defined. The rest of the parameters are optional. If you do not define values for the optional parameters, they will be either auto-defined by the script or the default values will be used accordingly. 

#Parameter

Parameter Type

Default ValuePossible ValuesDescription
1install_pathOptionalopt/WSC/
  • opt/WSC/
  • Any other appropriate location on the server
The parameter defines the installation path for the application.
2rewrite_old_installationOptional1
  • 0 – Do not create a backup file
  • 1 – Create a backup file (WSC.bak)
The parameter is responsible for a backup file creation. If you have an existing copy of the application in the specified install_path, the script will reserve the whole folder in a WSC.bak file.
3file_owner

Mandatory


  • user:group (e.g. 33:33)

The parameter sets permissions for the application. It should define the files ownership, a user and group in the user:group format.

4service_hostMandatory

The parameter defines a hostname, protocol, virtual directory and port which will be used to access the application.

You shouldn't forget to indicate a port number when setting a service_host parameter. You may use any available port except 2880. It is used by WebSpellChecker Application Server.

5web_server_typeMandatory
  • 1 – Apache HTTP Server
  • 2 – Java Application Server (Apache Tomcat, Oracle WebLogic Server, Oracle GlassFish Server, etc.)
  • 3 – Other
The parameter specifies a type of web or application server which will be used for the application server running.
6run_license_requestOptional0
  • 0 – Run the license activation step.
  • 1 – Skip the license activation step.
The parameter defines whether to run or not to run the license activation process. You can skip the license activation step if you already have a license activated or you prefer to proceed with the license activation step later.
7apache_versionOptionalCurrent Apache HTTP Server version installed
  • 2.2.x
  • 2.4.x
The parameters defines the current version of Apache HTTP Server.
8apache_config_dirOptionalCurrent Apache HTTP Server configuration directory
  • /etc/apache2
  • /etc/apache2/conf.d
The parameter defines location of the Apache HTTP Server configuration file (httpd.conf). It can be autodefined by the installation script.
9apache_install_mod_fastcgiOptional0
  • 0 – Do not install a generic mod_fastcgi module shipped with the installation package.
  • 1 – Install a generic mod_fastcgi from the package.

The parameter installs a generic mod_fastcgi module which is shipped with the installation package. 

The mod_fastcgi module is required for the proper work of the application. 

It is recommended to use a certain external mod_fastcgi module which is specifically tailored for your system. However, you may decide to stick with a generic one shipped with the package.

10apache_auto_enable_modulesOptional1
  • 0 – Do not enable extra modules.
  • 1 – Enable all required extra modules.
The parameter enables additional Apache HTTP Server mod_mime and mod_headers modules. They are required for a proper work of the application.
11restart_apacheOptional0
  • 0 – Do not restart Apache HTTP Server.
  • 1 – Restart Apache HTTP Server.
The parameter is responsible for restart of Apache HTTP Server. It is required for changes to take effect.

2. Run Automated Install Script

As soon as a configuration file with all the required parameters defined, you need to run the automated_install.pl script with the configuration file as a first parameter as follows:

$ sudo ./automated_install.pl install_config.ini

OR

$ sudo perl automated_install.pl install_config.ini

Troubleshooting

If you specified a non-existing parameter in the configuration file, the automated installation will instantly fail and throw an error message indicating an incorrect parameter. Moreover, with an incorrect  parameter, the script may suggest possible valid parameters and their default values. However, if there is an error in a specified value, the installation will fail only on the specific step and might not give you a clear message for error handling.

3. Activate License

If you assigned “1” as a value for the run_license_request parameter, you need to proceed with the license activation procedure according to the manual below.


 Click here to learn how to activate a license on a Linux server...

Visit the Licensing WebSpellChecker on Linux guide to find out how to activate a license on a Linux server.

4. Configure Grammar

The new versions of WebSpellChecker Server provides multi-language grammar support.

The grammar engine requires the additional configuration steps. Please visit Enabling Grammar Engine with AppServer 5.0 to find out more how to enable grammar checking feature.

5. Integrate WebSpellChecker

Integrate WebSpellChecker products into your web application.

Option A. Integration Guides

Visit Integrating WebSpellChecker Server guides to lean more how to get started with WebSpellChecker products.

New WebSpellChecker Proofreader

Try our new product WebSpellChecker Proofreader. It is based on SpellCheckAsYouType (SCAYT) core and is designed to simplify the integration and combine functionality of proofread as you type functionality and proofread in a dialog.

Get the next benefits when using WebSpellChecker Proofreader:

  • Easy to get started. A single script for all editable fields in a web app;
  • Auto-search functionality which detects editable fields on a web page and enables proofreading functionality;
  • Proofread as you type functionality on multiply languages. Spell checking functionality is supported for 16 default languages and 152 additional languages, grammar checking functionality is available for 14 out of 16 default languages.
  • Simplified box with corrections for spelling and grammar problems. 
  • A new badge button with the WebSpellChecker Proofreader settings.
  • Supported in all modern browsers such as Chrome, Firefox, Internet Explorer 11+, MS Edge, and Safari;

Please visit Get Started with Server WSC Proofreader (autoSearch) for guidance.

Option B. Demo Samples

Depending on the type of elements (HTML native elements, rich text editors) where the spelling/grammar check functionality is needed, you may choose and use the demo samples that are shipped with the WebSpellChecker Server package accordingly. 

To access the default samples, go to the following page:  https://your_host_name:port/spellcheck/samples/. The default samples contains all the necessary samples and instructions that will help with the integration of the WebSpellChecker products. Moreover, each sample contains detailed development documentation with a list of methods and parameters available.