Installing WebSpellChecker Server on Linux with Nginx

1. Download Installation Package

Download WebSpellChecker Server installation package for the corresponding version of your operating system (OS). By default, it is provided on a license purchase or renewal. You can also request it by contacting us. 

2. Install WebSpellChecker

2.1. Unpack the WebSpellChecker Server installation package (e.g. wsc_app_x64_5.5.x.x_xx.tar.gz).

$ tar -xvf wsc_app_x64_5.5.x.x_xx.tar.gz

2.2. Switch to the directory with the unpacked installation package and execute automated_install.pl script.

$ sudo perl automated_install.pl

2.3. Before proceeding with installation, read and confirm the terms and conditions of WebSpellChecker Software License Agreement.

Welcome to the WebSpellChecker (WSC) application installation wizard!

Before you go ahead with the installation, make sure that your environment configuration meets the WSC application system requirements.
If you are all set, please follow carefully the wizard instructions.

PLEASE MAKE SURE YOU ARE ACKNOWLEDGED AND ACCEPT THE WEBSPELLCHECKER SOFTWARE LICENSE
AGREEMENT TERMS AND CONDITIONS PUBLISHED ON THE WEBSPELLCHECKER OFFICIAL WEBSITE.
BY DOWNLOADING OR INSTALLING THIS SOFTWARE, YOU ACCEPT THE FULL TERMS OF THIS AGREEMENT.

IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT, YOU MUST NOT INSTALL OR USE THE WEBSPELLCHECKER SOFTWARE.

2.4. Select installation path. The default installation path is /opt/WSC. However, you may decide to change it and set a desired one. As soon as you defined the installation path, press Enter to proceed.

Step 1: Check Configuration Settings.

Install path [/opt/WSC]:

2.5. Select the products you want to be installed. By default, WProofreader (Option 1) is selected.  

Step 2: Select Products.

	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
List the products you want to install. Use the comma as separator. [1]:

2.6. Confirm whether you want Demo Samples and Documentation to be installed. If so, press Enter to proceed.

Step 3: Install Demo Samples and Documentation

Do you want to install Demo Samples and Documentation? Enter 'y' or 'n' [y]:

2.7. During this step the installer copies files to the selected installation directory.

Step 4: Copy the WSC Files to the Installation Directory.

2.8. Define permissions. Set appropriate permissions for the application. Define the files' ownership, a user and group in the user:group format (e.g. 33:33). 

Step 5: Define the WSC Application Permissions.

Specify the files ownership, a user and group in the 'user:group' format. 
It can be the same user and group which are used for the Apache HTTP Server, i.e. 'www-data:www-data' or '33:33'.

Specify the files owner as user:group [nobody:nobody]: 33:33

* Setting the WSC application permissions.
You specified 33:33

2.9. Select the type of the protocol (HTTP or HTTPS) that will be used for communication with the WebSpellChecker service and a web server or Java application server. By default, HTTPS (Option 1) is selected. Press Enter to confirm the selection.

Step 6: Select Protocol Type.

Select the type of the protocol that will be used for communication with the WebSpellChecker service and a web server or application server.
If you plan to use HTTPS, please make sure you have a valid SSL certificate.

	1. HTTPS
	2. HTTP

Input the number from 1 to 2 [1]:

2.10. If you have selected HTTPS on the previous step, specify the path to a valid SSL certificate file (*.pem) and its private key file (*.pem) to establish a secure connection. Otherwise, this step is not available.

Step 7: Configure Service SSL Certificate.

Specify the path to the SSL certificate file (*.pem): /cert.pem	

Specify the path to the private key file (*.pem): /key.pem

If your SSL certificate is password-protected, provide the password.

If your SSL certificate is password-protected, please specify the password. Otherwise, leave it empty: *******

2.11. Specify the WebSpellChecker AppServer service port. The default port of AppServer is 2880. Press Enter to proceed the installation using port 2880.

Specify the service port (by default: 2880). 
If you prefer to use a custom port, make sure it is not in use by another service. [2880]:

2.11. When selecting your web server, choose Other [3] to run static files using NGINX.

Step 8: Choose either Web or Application Server Type.

Select a particular Web or Application Server to be used for the WSC Application Server running.

	1. Apache HTTP Server
	2. Java Application Server (Apache Tomcat, Oracle WebLogic Server, Oracle GlassFish Server, etc.)
	3. Other

Input the number from 1 to 3:3

sudo apt-get update
sudo apt-get  install nginx

sudo ufw allow  'Nginx Full'

systemctl status nginx

sudo cd /etc/nginx/sites-available/
sudo cp default wscservice
sudo nano wscservice

# Default server configuration
#
server {
	listen 80 default_server;
	listen [::]:80 default_server;

	# SSL configuration
	#
	# listen 443 ssl default_server;
	# listen [::]:443 ssl default_server;
	#
	# Note: You should disable gzip for SSL traffic.
	# See: https://bugs.debian.org/773332

	server_name wscservice;

	# bindings of static files
	location /wscservice/ {
		alias /opt/WSC/WebComponents/WebInterface/;
		autoindex on;
		index  index.html index.htm;

	location /wscservice/samples/ {
		alias /opt/WSC/WebComponents/Samples/;
		autoindex on;
		index  index.html index.htm;
		}
			
	location /wscservice/wscbundle/ {
		alias /opt/WSC/WebComponents/WebInterface/wscbundle/;
		autoindex on;
		add_header Access-Control-Allow-Origin '*';
		}

	# reverse proxy for proxying requests to AppServer
	location /wscservice/api {
    # location /wscservice/api/ with a slash for WebSpellChecker versions 5.15.0.0 only
    proxy_pass http://your_host:2880;
		}    

	}	
}

ln -s  /etc/nginx/sites-available/wscservice /etc/nginx/sites-enabled/wscservice

sudo systemctl restart nginx

sudo nginx -t

3. Activate License

On this step you need to choose 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. If you want to go ahead with the license activation, enter 'Y' and then proceed with the steps described in the license activation manual below.

Step 6: Activate license.

Do you want to proceed with the license activation? Enter 'y' or 'n' [y]:

Visit the License Activation on Linux guide to find out how to activate a license on a Linux server.

4. Finalize Installation

If no errors happened during the setup and everything is configured properly, you will receive a confirmation that the application has been installed.

Congratulations! The WSC application has been successfully installed to /opt/WSC directory.

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

6. Verify Operability

Now you are ready to check if the installation process of the application went well, and all the components are functioning properly.

Step 8: Verify the WSC application operability.

Check the application version, status and access the demo samples, to verify if the application works properly after the installation.

a. Version: https://your_host_name:443/spellcheck/script/ssrv.cgi?cmd=ver

b. Status: https://your_host_name:443/spellcheck/script/ssrv.cgi?cmd=status

c. Default demo samples: https://your_host_name:443/spellcheck/samples

Spell Check Engine is ACTIVE
Grammar Engine is ACTIVE
Thesaurus Engine is ACTIVE

Please find below the description of the statuses that are received from SSRV component:

'ACTIVE' status means that an Engine works properly.
'NOT ACTIVE' status means that an Engine is not enabled or does not work properly.

For more details and assistance, please contact the technical support team at [email protected].

7. Integrate WebSpellChecker

Integrate WebSpellChecker products into your web application.

Option A. Integration Guides

Visit Products and Integrations Guides to lean more how to get started with WebSpellChecker products.

Option B. Demo Samples

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.