Versions Compared

Old Version 22

changes.mady.by.user user-232a4

Saved on

compared with

New Version Current

changes.mady.by.user user-232a4

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This step-by-step guide is intended to outline the main steps for the automated WebSpellChecker application installation on Linux utilizing Apache HTTP Server. In this guide we will run you through the whole installation process from creating configuration file to embedding spell/grammar checking functionality to your web-based system.

Excerpt Include
IN:_include_wsc55x_server_before_you_begin_installation_tip
IN:_include_wsc55x_server_before_you_begin_installation_tip
nopaneltrue

Panel

Table of Contents
stylenone


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

Info
  • 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 = 1).

Below is an example of a simple configuration file that can be used for the automated installation of the application on a Linux-based server using Apache HTTP Server assuming that you will be using the WProofreader product or Web API over HTTPS.

Code Block
titleinstall_config.ini
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

Table below lists all available parameters and their possible values that you can use 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_pathOptional/opt/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

33:33
  • 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.

4productsMandatory1
  • 1 – WProofreader(HTML Editable Controls, CKEditor 4/5, Froala Editor, TinyMCE, Quill, etc.)
  • 2 – Web API
  • 3 – SCAYT Plugin for CKEditor 4
  • 4 – WSC Dialog Plugin for CKEditor 4
  • 5 – Select all products

The parameter defines which product and components to install. It is not recommended to install all products but make your choice carefully. WSC Dialog Plugin for CKEditor 4 requires setup of the additional FastCGI modules.

Use coma as a separator for multiple options. 

5languages_to_installOptional1
  • 0 – None
  • 1 - AI-based English (en_AI)
  • 2 - AI-based German (de_AI)
  • 3 - All

Specifies what languages to install. Use coma as a separator for multiple options. 

Status
colourGreen
titleNew | 5.8.1

6install_samplesOptional1
  • 0 – Do not install Demo Samples and Documentation.
  • 1 – Install Demo Samples and Documentation.
The parameter defines whether the demo samples and documentation should be installed.
7protocolMandatory1
  • 1 – HTTPS
  • 2 – HTTP

8certificate_fileMandatory
  • /cert.pem
The parameter defines the path to the SSL certificate file (*.pem). Required for SSL connection setup.
9certificate_key_fileMandatory
  • /key.pem
The parameter defines the path to the private key file (*.pem). Required for SSL connection setup.
10certificate_passwordOptional
  • password if any
Some SSL certificates are password-protected. 
11service_portMandatory2880
  • Any available port number in a range [1-65535]
The parameter defines the WebSpellChecker service port number. This is the port of AppServer.
12domain_nameMandatorylocalhost
  • Your domain name (e.g. webspellchecker.com)

13web_portMandatory443 or 8443
  • Any available port number in a range [1-65535] of your web server or Java application server. Here are some common ports:
    • 443
    • 80
    • 8443
    • 8080

The parameter specifies the port number of web server or Java application server.

14virtual_dirMandatorywscservice
  • Any string 

15web_server_typeMandatory1
  • 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.
16path_to_jvmOptional
  • Path to Java Virtual Machine (JVM)
The parameter defines the pass to Java Virtual Machine (JVM) that is mandatory for the grammar engine. During the final steps of setup, the AppServer will try to autodetect the path to JVM and add it to the settings. However, using the parameter you can predefine which version of JVM should be used.
17activate_licenseOptional1
  • 0 – Skip the license activation step.
  • 1 – Run the license activation step.
The parameter defines whether to run the license activation process. You can skip the license activation step if you have already activated a license or you prefer to proceed with the license activation step later.
18license_ticket_idOptional
  • Your valid license ticket ID. It can be a trial (30 day) or a commercial license (1 year).
The parameter specified a License Ticket ID that will be used during the license activation procedure.
19apache_versionOptionalCurrent Apache HTTP Server version installed
  • 2.2.x
  • 2.4.x
The parameter defines the current version of Apache HTTP Server.
20apache_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 auto-defined by the installation script.
21apache_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. 

Excerpt Include
IN:_include_mod_fastcgi_apache_webserver
IN:_include_mod_fastcgi_apache_webserver
nopaneltrue

Note

This parameter is needed when installing the WSC Dialog plugin for CKEditor 4.

22

apache_auto_enable_modules

Optional

1

  • 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.

23

restart_apache

Optional

0

  • 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.

24enable_floating_licensingOptional0
  • 0 - Do not enable the floating licensing
  • 1 - Enable the floating licensing

Status
subtletrue
colourGreen
titleNEW | 5.5.9

Status
colourRed
titleDeprecated | 5.15.0

Enable the floating licensing mechanism.

25floating_license_serverOptional
Host name/IP address of a license server and its port, e.g. 127.0.0.1:2881

Status
subtletrue
colourGreen
titleNEW | 5.5.9

Status
colourRed
titleDeprecated | 5.15.0

A host name/IP address and port number of a license server.

26enable_license_sslOptional0
  • 0 - Do not enable SSL connection between a license server and a client node of WebSpellChecker.
  • 1 - Enable SSL connection

Status
subtletrue
colourGreen
titleNEW | 5.5.9

Status
colourRed
titleDeprecated | 5.15.0

Enable SSL connection between a license server and a client node of WebSpellChecker.

27enable_proxyOptional0
  • 0 - Do not enable proxy server.
  • 1 - Enable proxy server.

Status
subtletrue
colourGreen
titleNEW | 5.10.0.3

Enable proxy server connection.

28proxy_hostOptional

Status
subtletrue
colourGreen
titleNEW | 5.10.0.3

Proxy server host name or IP address.

29proxy_portOptional

Status
subtletrue
colourGreen
titleNEW | 5.10.0.3

TCP port number for proxy server.

30proxy_user_nameOptional

Status
subtletrue
colourGreen
titleNEW | 5.10.0.3

User name to access proxy server.

31proxy_passwordOptional
  • password if any

Status
subtletrue
colourGreen
titleNEW | 5.10.0.3

User password to establish connection with proxy server.

2. Run automated install script

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

Code Block
languagepowershell
themeEmacs
$ sudo ./automated_install.pl install_config.ini

OR

Code Block
languagepowershell
themeEmacs
$ sudo perl automated_install.pl install_config.ini
Note
titleTroubleshooting

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.

Note

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. Verify operability

Excerpt Include
IN:_include_wsc55x_server_verify_operability_silent_linux
IN:_include_wsc55x_server_verify_operability_silent_linux
nopaneltrue

Find the correct responses for the application version and status below.

Excerpt Include
IN:_include_server_verify_operability_status_json
IN:_include_server_verify_operability_status_json
nopaneltrue

Excerpt Include
IN:_include_server_verify_operability_version_linux_json
IN:_include_server_verify_operability_version_linux_json
nopaneltrue

Excerpt Include
IN:_include_wsc54x_server_verify_application_operability_samples
IN:_include_wsc54x_server_verify_application_operability_samples
nopaneltrue

5. Integrate WebSpellChecker

Excerpt Include
IN:_include_wsc55x_server_integrations_products
IN:_include_wsc55x_server_integrations_products
nopaneltrue