Difference between revisions of "InContext Server Installation"

From Lingoport Wiki
Jump to: navigation, search
(Installation Steps)
(Checking InContext Server Installation)
(48 intermediate revisions by 3 users not shown)
Line 1: Line 1:
   
  +
= Checking InContext Server Installation =
  +
The typical G11n system is installed using the '''Lingoport Stack Installer'''.
  +
If that is the case, then the InContext Server should have been '''installed''' at that time. If your system was updated with '''Lingoport Stack Updater''', the InContext Server needs to be installed manually.
  +
  +
To check:
  +
  +
$sudo systemctl status incontext-server
  +
  +
and output:
  +
  +
● incontext-server.service - InContext Server Service
  +
Loaded: loaded (/etc/systemd/system/incontext-server.service; disabled; vendor preset: disabled)
  +
Active: inactive (dead)
  +
  +
If the output says something about the service not found, then it needs to be installed following the [[#Installation_Steps|Installation Steps]] below.
  +
  +
If the service exists, then proceed to the [[#Running_the_InContext_Server|Running the InContext Server]] below and start the service.
  +
  +
= Installing Manually =
 
== InContext Server Installation Requirements ==
 
== InContext Server Installation Requirements ==
 
The InContext Server requires the following:
 
The InContext Server requires the following:
* Tomcat 8.5.x
 
 
* Java 8
 
* Java 8
 
* MySQL 5.5.3+
 
* MySQL 5.5.3+
   
Since the Lingoport Suite already requires Java and MySQL, the only additional requirement for the InContext Server is Tomcat.
+
Since the Lingoport Suite already requires Java and MySQL, the only additional requirement for the InContext Server is Tomcat. The InContext Server provided by Lingoport installs Tomcat 8.5.x.
   
 
== InContext Server Files ==
 
== InContext Server Files ==
There are three files that comprise the InContext Server:
+
There are three files that comprise the InContext Server. The Lingoport InContext Server automated installation process will put these files in the appropriate location.
 
* incontext-server.war
 
* incontext-server.war
 
* incontext-server.sh
 
* incontext-server.sh
Line 15: Line 33:
   
 
The <b>incontext-server.war</b> is the server itself and must be placed under the <b>tomcat</b>/webapps directory. <br>
 
The <b>incontext-server.war</b> is the server itself and must be placed under the <b>tomcat</b>/webapps directory. <br>
The <b>incontext-server.sh</b> file is a script for starting/stopping the Server and must be configured and placed in the <b>tomcat</b> directory. <br>
+
The <b>incontext-server.sh</b> file is a script for starting/stopping the InContext Server and must be configured and placed in the <b>tomcat</b> directory. <br>
 
The <b>IncontextServerConfig.groovy</b> file is the configuration file for the InContext Server and must be configured and placed in the <b>tomcat</b> directory.
 
The <b>IncontextServerConfig.groovy</b> file is the configuration file for the InContext Server and must be configured and placed in the <b>tomcat</b> directory.
   
 
== Installation Steps ==
 
== Installation Steps ==
   
1. Download and unzip the incontext-server-<version>.zip file from our SFTP site. The zip file contains three files: incontext-server.war, incontext-server.sh, and IncontextServerConfig.groovy.
+
1. Download and unzip the '''IncontextServer-<version>.zip''' file from our SFTP site.
  +
  +
2. Change directory: <code>'''cd incontext-server'''</code>
  +
  +
3. Modify <b>install.conf</b> to set the values required by the install. Any information left blank will be prompted by the install script.
  +
*<code>MYSQL_ROOT_PASS</code> - this is the password that was used or created by the Stack Installer or Stack Updater.
  +
*<code>INCONTEXT_MYSQL_USER / INCONTEXT_MYSQL_PASS</code> - this is a new MySQL username and password.
  +
*<code>INSTALL_TOMCAT_HERE='/usr/local/tomcat'</code> - Unless there is reason to change the location, leave it at the default.
  +
4. Run the install script (note you must have sudo privileges): <code>./<b>install.sh</b></code>. If it is successful, one should see:
   
  +
Incontext Server successfully installed.
2. Download and install the latest Tomcat 8.5.x from <b>https://tomcat.apache.org/download-80</b> and place it in, for example, /usr/local/tomcat, which will be referred to as <b>tomcat</b>.
 
   
  +
= Running the InContext Server =
3. Modify <b>tomcat</b>/conf/server.xml and change the port number from 8080 (used by Jenkins) to 8081.
 
   
  +
To start the InContext Server:
4. Create an empty MySQL database. You may use <b>incontext</b> or any database name you would like:
 
  +
$sudo systemctl start incontext-server
shell> mysql -u root –p<your_password>
 
mysql> CREATE DATABASE <b>incontext</b> DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
 
   
  +
Then browse to: '''<nowiki>http://yourserverurl:8081/incontext-server</nowiki>'''
5. Create a database user and password, replacing dbuser and dbpass with your configured values:
 
shell> mysql -u root –p<your_password>
 
mysql> GRANT ALL PRIVILEGES ON *.* TO '<b>dbuser</b>'@'localhost' IDENTIFIED BY '<b>dbpass</b>' WITH GRANT OPTION;
 
mysql> GRANT ALL PRIVILEGES ON *.* TO '<b>dbuser</b>'@'%' IDENTIFIED BY '<b>dbpass</b>' WITH GRANT OPTION;
 
   
  +
[[File:InContextServerLogin.jpg |600px]]
6. Configure the following values in the <b>incontext-server.sh</b> file for your environment and place the file in the <b>tomcat</b> directory:
 
* export CATALINA_HOME=<b>/usr/local/tomcat</b>
 
* export JAVA_HOME="<b>/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.191.b12-1.el7_6.x86_64/jre</b>"
 
* export JRE_HOME="<b>/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.191.b12-1.el7_6.x86_64/jre</b>"
 
   
7. Configure the following values in the <b>IncontextServerConfig.groovy</b> file for your environment and place the file in the <b>tomcat</b> directory:
 
* String dbname = "<b>incontext</b>"
 
* String dbuser = "<b>dbuser</b>"
 
* String dbpass = "<b>dbpass</b>"
 
   
  +
To stop the InContext Server:
8. Copy the <b>incontext-server.war</b> file to the <b>tomcat</b>/webapps directory
 
  +
$sudo systemctl stop incontext-server
   
  +
To check the status of the InContext Server:
9. Launch the server:
 
  +
$sudo systemctl status incontext-server
> cd <b>tomcat</b>
 
> ./incontext-server.sh start
 
   
  +
= Next Steps =
The InContext Server should be launched; browse to: http://yourserverurl:8081/incontext-server
 
  +
To continue installing InContext for Translation go to: [[InContext_Capture_Installation | InContext Capture Installation]]
   
  +
For information on how to proceed after installation, please see the:
Note: To stop the Server:
 
  +
[[InContext Server Users Guide]]
> cd <b>tomcat</b>
 
> ./incontext-server.sh stop -force
 

Revision as of 17:34, 6 May 2019

Checking InContext Server Installation

The typical G11n system is installed using the Lingoport Stack Installer. If that is the case, then the InContext Server should have been installed at that time. If your system was updated with Lingoport Stack Updater, the InContext Server needs to be installed manually.

To check:

$sudo systemctl status incontext-server

and output:

● incontext-server.service - InContext Server Service
  Loaded: loaded (/etc/systemd/system/incontext-server.service; disabled; vendor preset: disabled)
  Active: inactive (dead)

If the output says something about the service not found, then it needs to be installed following the Installation Steps below.

If the service exists, then proceed to the Running the InContext Server below and start the service.

Installing Manually

InContext Server Installation Requirements

The InContext Server requires the following:

  • Java 8
  • MySQL 5.5.3+

Since the Lingoport Suite already requires Java and MySQL, the only additional requirement for the InContext Server is Tomcat. The InContext Server provided by Lingoport installs Tomcat 8.5.x.

InContext Server Files

There are three files that comprise the InContext Server. The Lingoport InContext Server automated installation process will put these files in the appropriate location.

  • incontext-server.war
  • incontext-server.sh
  • IncontextServerConfig.groovy

The incontext-server.war is the server itself and must be placed under the tomcat/webapps directory.
The incontext-server.sh file is a script for starting/stopping the InContext Server and must be configured and placed in the tomcat directory.
The IncontextServerConfig.groovy file is the configuration file for the InContext Server and must be configured and placed in the tomcat directory.

Installation Steps

1. Download and unzip the IncontextServer-<version>.zip file from our SFTP site.

2. Change directory: cd incontext-server

3. Modify install.conf to set the values required by the install. Any information left blank will be prompted by the install script.

  • MYSQL_ROOT_PASS - this is the password that was used or created by the Stack Installer or Stack Updater.
  • INCONTEXT_MYSQL_USER / INCONTEXT_MYSQL_PASS - this is a new MySQL username and password.
  • INSTALL_TOMCAT_HERE='/usr/local/tomcat' - Unless there is reason to change the location, leave it at the default.

4. Run the install script (note you must have sudo privileges): ./install.sh. If it is successful, one should see:

Incontext Server successfully installed.

Running the InContext Server

To start the InContext Server:

$sudo systemctl start incontext-server

Then browse to: http://yourserverurl:8081/incontext-server

InContextServerLogin.jpg


To stop the InContext Server:

$sudo systemctl stop incontext-server

To check the status of the InContext Server:

$sudo systemctl status incontext-server

Next Steps

To continue installing InContext for Translation go to: InContext Capture Installation

For information on how to proceed after installation, please see the: InContext Server Users Guide