Difference between revisions of "InContext Server Installation"

From Lingoport Wiki
Jump to: navigation, search
(→‎Installation Process)
(61 intermediate revisions by 4 users not shown)
Line 1: Line 1:
  +
= Checking InContext Server Installation =
  +
The typical G11n system can be installed using either the '''Lingoport Stack Installer''' or a Docker-based method. Depending on the installation method used, the process to check if the InContext Server is installed will differ.
  +
  +
== Checking Installation for Systems Installed with Lingoport Stack Installer ==
  +
If your system was installed using the Lingoport Stack Installer, check the installation with:
  +
<pre>
  +
$sudo systemctl status incontext-server
  +
</pre>
  +
Output should indicate if the service is active. If the service is not found, it needs to be installed manually.
  +
  +
== Checking Installation for Docker-based Systems ==
  +
For systems intending to use the Docker-based installation, check if the Docker container for the InContext Server is running with:
  +
<pre>
  +
$ sudo docker ps | grep incontext-server
  +
</pre>
  +
If there's no output, the container is not running, indicating the InContext Server needs to be set up or there is an issue that needs to be addressed.
  +
Users in the 'docker' group may optionally omit use of sudo.
  +
  +
= Docker-based Installation of InContext Server =
  +
For a new, simplified deployment process, the InContext Server can be installed using Docker. This section outlines the Docker-based installation process.
  +
  +
== Requirements ==
  +
* Docker installed on your system
  +
* Configuration details prepared in `install.conf`
  +
  +
== Installation Process ==
  +
# Modify the `install.conf` file with your specific configurations, including Docker Hub credentials (account with read access to the InContext Image will be shared by Lingoport), MySQL root password (to be created with an associated MySQL 8 container), and desired server port.
  +
# Execute the `InstallIncontext.sh` script with sudo privileges. This script will:
  +
#* Create necessary Docker network and volumes
  +
#* Pull the Lingoport InContext Server image from Docker Hub
  +
#* Start the InContext Server and MySQL containers with appropriate configurations
  +
  +
  +
Verify the installation by checking the Docker container status and accessing the InContext Server through the web browser.
  +
  +
== Script Execution ==
  +
<pre>
  +
$ sudo ./InstallIncontext.sh
  +
</pre>
  +
  +
You may be prompted if there is missing info in the install.conf. Ensure you follow any prompts provided by the script for a successful installation.
  +
  +
= Manual Installation =
  +
For systems not utilizing Docker or needing a specific setup, manual installation is also available.
   
 
== InContext Server Installation Requirements ==
  
== InContext Server Installation Requirements ==
  +
* Java 11
−
The InContext Server requires the following:
  
−
* Tomcat 8.5.x
 +
* MySQL 8
−
* Java 8
 +
* Tomcat 9.0.x
−
* MySQL 5.5.3+
  
   
  +
== Installation Steps - Docker ==
−
Since the Lingoport Suite already requires Java and MySQL, the only additional requirement for the InContext Server is Tomcat.
  
  +
1. Download and unzip the `IncontextServer-<version>.zip` file.
  +
2. Modify `install.conf` with necessary details.
  +
3. Execute `./install.sh` with sudo privileges.
   
  +
  +
== Installation Steps - Non-Docker ==
  +
  +
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.
   
 
== 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
 
* IncontextServerConfig.groovy
  
* IncontextServerConfig.groovy
  +
  +
  +
== Installation Steps - Non-Docker ==
  +
−
  +
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 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.
  +
  +
−
   
  +
= Running the InContext Server - Non-Docker =
−
The war file must be placed under the tomcat/webapps directory.
  
−
The incontext-server.sh file must be configured and placed in the tomcat directory.
  
−
The IncontextServerConfig.groovy file must be configured and placed in the tomcat directory.
  
−  
   
  +
To start the InContext Server:
−
== Installation Steps ==
  
  +
$sudo systemctl start incontext-server
   
  +
Then browse to: '''<nowiki>http://yourserverurl:8081/incontext-server</nowiki>'''
−
1. 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 I will refer to as <b>tomcat</b>.
  
   
  +
[[File:InContextServerLogin.jpg |600px]]
−
2. Modify <b>tomcat</b>/conf/server.xml and change the port number from 8080 (used by Jenkins) to 8081
  
   
−
3. Create an empty MySQL database. You may use <b>incontext</b> or any database name you would like:
 
−
shell> mysql -u root –p<your_password>
 
−
mysql> CREATE DATABASE <b>incontext</b> DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
 
   
  +
To stop the InContext Server:
−
4. Create a database user and password, replacing dbuser and dbpass with your configured values:
  
  +
$sudo systemctl stop incontext-server
−
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;
  
   
  +
To check the status of the InContext Server:
−
5. 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:
  
  +
$sudo systemctl status incontext-server
−
* 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>"
  
   
−
6. 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>"
  
   
  +
= Next Steps =
−
7. Copy the <b>incontext-server.war</b> file to the <b>tomcat</b>/webapps directory
  
  +
Whether installed via Docker or manually, the next steps involve configuring and using the InContext Server for your localization needs. For more details on post-installation setup and usage, refer to the InContext Server Users Guide.
   
  +
[[InContext_Capture_Installation | InContext Capture Installation]] provides additional resources for setting up InContext for Translation.
−
8. Launch the server:
  
−
> cd <b>tomcat</b>
  
−
> ./incontext-server.sh start
  
   
  +
For information on how to proceed after installation, please see the:
−
The InContext Server should be launched and you can browse to: http://yourserverurl:8081/incontext-server
  
  +
[[InContext Server Users Guide]]

Revision as of 22:03, 1 March 2024

Checking InContext Server Installation

The typical G11n system can be installed using either the Lingoport Stack Installer or a Docker-based method. Depending on the installation method used, the process to check if the InContext Server is installed will differ.

Checking Installation for Systems Installed with Lingoport Stack Installer

If your system was installed using the Lingoport Stack Installer, check the installation with: 

$sudo systemctl status incontext-server

Output should indicate if the service is active. If the service is not found, it needs to be installed manually.

Checking Installation for Docker-based Systems

For systems intending to use the Docker-based installation, check if the Docker container for the InContext Server is running with: 

$ sudo docker ps | grep incontext-server

If there's no output, the container is not running, indicating the InContext Server needs to be set up or there is an issue that needs to be addressed. Users in the 'docker' group may optionally omit use of sudo.

Docker-based Installation of InContext Server

For a new, simplified deployment process, the InContext Server can be installed using Docker. This section outlines the Docker-based installation process.

Requirements

  • Docker installed on your system
  • Configuration details prepared in `install.conf`

Installation Process

  1. Modify the `install.conf` file with your specific configurations, including Docker Hub credentials (account with read access to the InContext Image will be shared by Lingoport), MySQL root password (to be created with an associated MySQL 8 container), and desired server port.
  2. Execute the `InstallIncontext.sh` script with sudo privileges. This script will:
    • Create necessary Docker network and volumes
    • Pull the Lingoport InContext Server image from Docker Hub
    • Start the InContext Server and MySQL containers with appropriate configurations


Verify the installation by checking the Docker container status and accessing the InContext Server through the web browser.

Script Execution

$ sudo ./InstallIncontext.sh

You may be prompted if there is missing info in the install.conf. Ensure you follow any prompts provided by the script for a successful installation.

Manual Installation

For systems not utilizing Docker or needing a specific setup, manual installation is also available.

InContext Server Installation Requirements

  • Java 11
  • MySQL 8
  • Tomcat 9.0.x

Installation Steps - Docker

1. Download and unzip the `IncontextServer-<version>.zip` file. 2. Modify `install.conf` with necessary details. 3. Execute `./install.sh` with sudo privileges.


Installation Steps - Non-Docker

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.

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


Installation Steps - Non-Docker

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

−

Running the InContext Server - Non-Docker

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

Whether installed via Docker or manually, the next steps involve configuring and using the InContext Server for your localization needs. For more details on post-installation setup and usage, refer to the InContext Server Users Guide.

InContext Capture Installation provides additional resources for setting up InContext for Translation.

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

Retrieved from "http://wiki.lingoport.com/index.php?title=InContext_Server_Installation&oldid=98445"