Page History
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 |
|---|
|
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 utilizing Apache HTTP Server assuming that you will be using the WProofreader product or Web API over HTTPS.
| Code Block | ||
|---|---|---|
| ||
install_path = opt/WSC/ rewrite_old_installationproducts = 1 file_owner = 33:33 service_host protocol = 1 certificate_file = https://your_host_name:443/spellcheck web_server_type = 1 apache_install_mod_fastcgi/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 #licenselicense_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 |
| service_host | Mandatory |
| ||||||||||
| 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 |
| Note |
|---|
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. |
- 1 – Apache HTTP Server
- 2 – Java Application Server (Apache Tomcat, Oracle WebLogic Server, Oracle GlassFish Server, etc.)
- 3 – Other
- 0 – Skip the license activation step.
- 1 – Run the license activation step.
- You valid license ticket ID. It can be a trial (30 day) or a commercial license (1 year).
- 2.2.x
- 2.4.x
- /etc/apache2
- /etc/apache2/conf.d
- 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 nopanel true
| Note |
|---|
This parameter is needed in case of the installation of WSC Dialog plugin for CKEditor 4. |
- 0 – Do not enable extra modules.
- 1 – Enable all required extra modules.
- 0 – Do not restart Apache HTTP Server.
- 1 – Restart Apache HTTP Server.
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:
| Code Block | ||||
|---|---|---|---|---|
| ||||
$ sudo ./automated_install.pl install_config.ini |
OR
| Code Block | ||||
|---|---|---|---|---|
| ||||
$ sudo perl automated_install.pl install_config.ini |
| Note | ||
|---|---|---|
| ||
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 manual manually.
4. Configure Grammar Engine
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|
5. Integrate WebSpellChecker
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|
