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. #activate_license = 0).
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 utilizing Apache HTTP Server assuming that you will be using the WProofreader product or Web API over HTTPS.
install_path = opt/WSC/ products = 1 file_owner = 33:33 protocol = 1 certificate_file = /opt/WSC/cert/cert.pem certificate_key_file = /opt/WSC/cert/key.pem certificate_password = *************** service_port = 2880 domain_name = localhost web_port = 443 virtual_dir = wscservice web_server_type = 1 apache_auto_enable_modules = 1 activate_license = 1 license_ticket_id = ***************
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 Value | Possible Values | Description |
|---|---|---|---|---|---|
| 1 | install_path | Optional | opt/WSC/ |
| The parameter defines the installation path for the application. |
| 2 | rewrite_old_installation | Optional | 1 |
| 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. |
| 3 | file_owner | Mandatory | 33:33 |
| The parameter sets permissions for the application. It should define the files ownership, a user and group in the user:group format. |
| 4 | products | Mandatory | 1 |
| |
| 5 | install_samples | Optional | 1 |
| |
| 6 | protocol | Mandatory | 1 |
| |
| 7 | certificate_file | Mandatory | |||
| 8 | certificate_key_file | Mandatory | |||
| 9 | certificate_password | Optional | |||
| 10 | service_port | Mandatory | 2880 | ||
| 11 | domain_name | Mandatory | localhost | ||
| 12 | web_port | Mandatory | 443 or 8443 |
| |
| 13 | virtual_dir | Mandatory | wscservice | ||
| 14 | web_server_type | Mandatory | 1 |
| The parameter specifies a type of web or application server which will be used for the application server running. |
| 15 | path_to_jvm | Optional | |||
| 16 | activate_license | Optional | 1 |
| 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. |
| 17 | license_ticket_id | Optional |
| The parameter specified a License Ticket ID that will be used during the license activation procedure. | |
| 18 | apache_version | Optional | Current Apache HTTP Server version installed |
| The parameter defines the current version of Apache HTTP Server. |
| 19 | apache_config_dir | Optional | Current Apache HTTP Server configuration directory |
| The parameter defines location of the Apache HTTP Server configuration file (httpd.conf). It can be autodefined by the installation script. |
| 20 | apache_install_mod_fastcgi | Optional | 0 |
| 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. This parameter is needed in case of the installation of WSC Dialog plugin for CKEditor 4. |
| 21 | apache_auto_enable_modules | Optional | 1 |
| The parameter enables additional Apache HTTP Server mod_mime and mod_headers modules. They are required for a proper work of the application. |
| 22 | restart_apache | Optional | 0 |
| 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 install_config.ini 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 activate_license parameter, the installer will attempt to activate a license automatically using a License Ticket ID.
The automatic license activation mode requires the Internet connection available on the machine where you are trying to install WebSpellChecker.
Otherwise, you need to proceed with the license activation procedure according to the License Activation on Linux manually.
4. Configure Grammar Engine
The Grammar engine requires Java 8 and higher. The installation script tries to auto-detect a path to an existing Java Virtual Machine (JVM). If the path is not found, you will be asked to specify the path to JVM. You have an option to set a path to JVM manually or change the auto-detected path to your custom one. Refer to Enabling Grammar Engine guide to find out more.
5. Integrate WebSpellChecker
Integrate WebSpellChecker products into your web application. Visit Products and Integrations Guides to lean more how to get started with WebSpellChecker products. WProofreader Try our WProofreader. It is based on SpellCheckAsYouType (SCAYT) core, designed to simplify the integration and combine functionality of proofread as you type functionality and proofread in a dialog. Here are the main benefits of using WProofreader: Supported in all modern browsers such as Chrome, Firefox, Internet Explorer 11+, MS Edge, and Safari. Refer to Get Started with WProofreader Server (autoSearch) guide for more information. 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 shipped with the WebSpellChecker Server package. To access the default samples, go to the following page: https://your_host_name:port/spellcheck/samples/. The default samples contain 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.Option A. Integration Guides
Option B. Demo Samples
