View Source

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

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 Value

Possible Values

Description

1

install_path

Optional

/opt/WSC/

/opt/WSC/
Any other appropriate location on the server

The parameter defines the installation path for the application.

2

rewrite_old_installation

Optional

1

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.

3

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

4

products

Mandatory

1

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.

5

languages_to_install

Optional

1

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.

6

install_samples

Optional

1

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.

7

protocol

Mandatory

1

1 – HTTPS
2 – HTTP

8

certificate_file

Mandatory

/cert.pem

The parameter defines the path to the SSL certificate file (*.pem). Required for SSL connection setup.

9

certificate_key_file

Mandatory

/key.pem

The parameter defines the path to the private key file (*.pem). Required for SSL connection setup.

10

certificate_password

Optional

password if any

Some SSL certificates are password-protected.

11

service_port

Mandatory

2880

Any available port number in a range [1-65535]

The parameter defines the WebSpellChecker service port number. This is the port of AppServer.

12

domain_name

Mandatory

localhost

Your domain name (e.g. webspellchecker.com)

13

web_port

Mandatory

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

14

virtual_dir

Mandatory

wscservice

Any string

15

web_server_type

Mandatory

1

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.

16

path_to_jvm

Optional

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.

17

activate_license

Optional

1

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.

18

license_ticket_id

Optional

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.

19

apache_version

Optional

Current Apache HTTP Server version installed

2.2.x
2.4.x

The parameter defines the current version of Apache HTTP Server.

20

apache_config_dir

Optional

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

21

apache_install_mod_fastcgi

Optional

0

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.

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.

24

enable_floating_licensing

Optional

0

0 - Do not enable the floating licensing
1 - Enable the floating licensing

Enable the floating licensing mechanism.

25

floating_license_server

Optional

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

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

26

enable_license_ssl

Optional

0

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

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

27

enable_proxy

Optional

0

0 - Do not enable proxy server.
1 - Enable proxy server.

Enable proxy server connection.

28

proxy_host

Optional

Proxy server host name or IP address.

29

proxy_port

Optional

TCP port number for proxy server.

30

proxy_user_name

Optional

User name to access proxy server.

31

proxy_password

Optional

password if any

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:

$ sudo ./automated_install.pl install_config.ini

OR

$ sudo perl automated_install.pl install_config.ini

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

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

1. Create configuration file

1.1. Configuration file syntax

1.2. Configuration file parameters

2. Run automated install script

3. Activate license

4. Verify operability

5. Integrate WebSpellChecker