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.
|
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 NGINX web server assuming that you will be using the WProofreader SDK over HTTPS.
install_path = /opt/WSC/ products = 1 file_owner = 33:33 protocol = 1 languages_to_install = 1,2 service_port = 2880 domain_name = localhost web_port = 443 virtual_dir = wscservice #changed the web server type to NGINX web_server_type = 2 activate_license = 1 license_ticket_id = *************** |
The 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.
restarting
# | Parameter | Parameter type | Default value | Possible values | Description |
---|---|---|---|---|---|
1 | install_path | Optional | /opt/WSC/ |
| The parameter defines the installation path for the application. If a parameter is not specified in the config, the default value will be used. |
2 | rewrite_old_installation | Optional | 1 |
| The parameter is responsible for 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 file ownership, a user and group in the user:group format. |
4 | products | Optional | 1 |
| The parameter defines which product and components to install. It is not recommended to install “all products” but make your choice carefully. Use a coma as a separator for multiple options. |
5 | languages_to_install | Optional | 1,2 |
| Specifies what AI-based languages (language models) to install. Use a coma as a separator for multiple options. |
6 | install_samples | Optional | 1 |
| The parameter defines whether the demo samples and documentation should be installed. |
7 | protocol | Optional | 1 |
| Defines the protocol to be used when communicating with the service. |
8 | certificate_file | Optional |
| The parameter defines the path to the SSL certificate file (*.pem). Required for SSL connection setup. If not specified and files not replaced, a test untrusted SSL certificate will be used. | |
9 | certificate_key_file | Optional |
| The parameter defines the path to the private key file (*.pem). Required for SSL connection setup. | |
10 | certificate_password | Optional |
| Some SSL certificates are password-protected. | |
11 | service_port | Optional | 2880 |
| The parameter defines the WebSpellChecker service port number. This is the port of AppServer. |
12 | domain_name | Optional | localhost |
| |
13 | web_port | Optional | 443 |
| The parameter specifies the port number of web server or Java application server. |
14 | virtual_dir | Optional | wscservice |
| |
15 | web_server_type | Mandatory |
| The parameter specifies a type of web server which will be used for the application server running. Automated configuration for Java application servers is no longer available. | |
16 | path_to_jvm | Optional |
| 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 | 0 |
| 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 |
| The parameter specified a License Ticket ID that will be used during the license activation procedure. | |
19 | apache_version | Optional |
| The parameter defines the current version of Apache HTTP Server. It will be auto-detected. | |
20 | web_server_config_dir | Optional |
| The parameter defines the location of the Apache HTTP Server or NGINX configuration file (httpd.conf/wscservice.conf). It can be auto-defined by the installation script. Initially, it was named like this: apache_config_dir. Later, with automating the installation for NGINX, it was renamed. | |
21 | apache_auto_enable_modules | Optional | 1 |
| The parameter enables additional Apache HTTP Server mod_mime, mod_headers, proxy, proxy_http modules. They are required for proper work of the application. |
22 | restart_web_server | Optional | 0 |
| The parameter is responsible for restarting of a selected web server. It is required for changes to take effect. Initially, it was named like this: restart_apache. Later, with automating the installation for NGINX, it was renamed. |
23 | enable_proxy | Optional | 0 |
| Enable proxy server connection. |
24 | proxy_host | Optional | Proxy server host name or IP address. | ||
25 | proxy_port | Optional | TCP port number for proxy server. | ||
26 | proxy_user_name | Optional | User name to access a proxy server. | ||
27 | proxy_password | Optional |
| User password to establish a connection with proxy server. |
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. |
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.
Find the correct responses for the application version and status below.