Difference between revisions of "Localyzer Installation"

From Lingoport Wiki
Jump to: navigation, search
(Prerequisites)
(Resource Manager Installation)
Line 1: Line 1:
 
== Resource Manager Installation ==
 
== Resource Manager Installation ==
  +
===Overview===
 
The Lingoport Resource Manager System is composed of three items (See the diagram at [[Components Diagram]]):
 
The Lingoport Resource Manager System is composed of three items (See the diagram at [[Components Diagram]]):
 
# '''Lingoport Resource Manager''': The Server keeps track of all the actions and the expected results. The server is best located on one central system. This section describes the installation of LRM.
 
# '''Lingoport Resource Manager''': The Server keeps track of all the actions and the expected results. The server is best located on one central system. This section describes the installation of LRM.

Revision as of 19:49, 16 June 2015

Resource Manager Installation

Overview

The Lingoport Resource Manager System is composed of three items (See the diagram at Components Diagram):

  1. Lingoport Resource Manager: The Server keeps track of all the actions and the expected results. The server is best located on one central system. This section describes the installation of LRM.
  2. Jenkins: Jenkins orchestrates the execution of the commands, such as verifying files to be sent for translation via a light Java application. Jenkins needs to communicate with the Lingoport Resource Manager server and is best co-located with LRM. The Jenkins setup is the subject of another guide.
  3. Dashboard: the Lingoport Dashboard aggregates and displays data from both the Resource Manager and Globalyzer. Its installation is the subject of another guide.


The Dashboard typically needs to have access to the lrm-cli.jar files in order to generate the xml report files and use those xml to push the files over to the Dashboard.

Prerequisites

  1. Read the Lingoport Suite Installation, which describes how all the Lingoport applications work together and the hardware and software configuration requirements.
  2. Supported OS: Linux
  3. Installed Java 7 or greater JRE on the target machine. You can check your Java version using the command line. At the command prompt enter: java -version The version of Java which you have on your system should be displayed. If you need to install Java, please refer to http://www.java.com/en/download/index.jsp or any Java download page which supplies Java 7 or above.
  4. Installed MySQL 5.1 or higher on a database server. MySQL Download site. If the database server is not the same machine as the LRM server, then you will need to install the MySQL 5.x Client (only need Client) on the LRM server so that it can access the database on the separate database server.
    • You can verify that you have a sufficiently up-to-date version of MySQL using the command prompt. In the command prompt type:
    mysql -u <user> -p<password>
    • If MySQL is installed on your system, information on the version will be displayed after entering a valid username and password. If MySQL is not version 5.1 or higher, please refer to a download site, such as MySQL Download and install an up-to-date version.
    • You will need to enter the MySQL credentials (host, username, password and port number) during the installation.
  5. Jenkins, the latest version. See the Jenkins download site to get the latest version.
  6. Received the Licensing information from Lingoport. When your company purchased LRM you should have been sent an email containing the licensing information. The licensing information will include the following:
    • group name
    • number of licenses in the license
    • expiration date for the license
    • license key. This is a 10-digit number generated by Lingoport.
    This licensing information will be required for the server installation. If you do not have the licensing information of the jar file, please contact support@lingoport.com. Please keep it handy while you perform the install.
  7. You may many licenses, one per group. This must have been specified during the sales process.
  8. Installer jar file: you must have the Lingoport_Resource_Manager_Server-<x.x>-Installer.jar file.
  9. MySQL Time Zone: MySQL time zone must be non-ambiguous. An example of an ambiguous time zone is 'MST' whereas 'America/Denver' is a non-ambiguous time zone. Refer to MySQL documentation for your specific OS to set time zones appropriately.
    • For Windows, you should be able to type SET GLOBAL time_zone = 'America/Denver’ at the MySQL prompt.
    • For Linux, you could for instance type mysql_tzinfo_to_sql /usr/share/zoneinfo/|mysql -u root mysql -p from the command line and then SET GLOBAL time_zone = 'America/Denver’ at the MySQL prompt.
    • For MacOS, you may for instance type mysql_tzinfo_to_sql /usr/share/zoneinfo/|mysql -D mysql -u root mysql -p from the command line and then SET GLOBAL time_zone = 'America/Denver’ at the MySQL prompt.

LRM Installation

Run the installer, as the user Jenkins who runs the jobs, by either:

  • double clicking on the Lingoport_Resource_Manager_Server-<x.x>-Installer.jar
  • running “java –jar Lingoport_Resource_Manager_Server-<x.x>-Installer.jar“ at the command prompt.

The Lingoport Resource Manager will then prompt you for license information and database settings to create the database tables in MySQL.

Once you have retrieved your licensing information and ensured that all requirements are met, run the LRM Server installer.

Installing for the First Time

  • Double-click on the Lingoport_Resource_Manager_Server-<x.x>-Installer.jar file, or
  • From the command line, cd to the directory with the installer and type:
   java –jar Lingoport_Resource_Manager_Server-<x.x>-Installer.jar

The installer will prompt you for license information and database settings to create the MySQL LRM database. The installer will also prompt you for the LRM and the L10nStreamlining directory location. These will default to <home>/Lingoport_Data/LRM and <home>/Lingoport_Data/L10nStreamlining. When installation completes, the L10nStreamlining directory will have been created, but the LRM directory is created when the first project is generated.

Updating Your Existing Installation

If you are upgrading your LRM Server to a newer version, make sure that you do not overwrite the existing database.

  • Double-click on the Lingoport_Resource_Manager_Server-<x.x>-Installer.jar file, or
  • From the command line, cd to the directory with the installer jar file and type:
   java –jar Lingoport_Resource_Manager_Server-<x.x>-Installer.jar

On the Type of Installation page, be sure to select Update Server.

Adding or Updating the License

Depending on your licensing agreement, you will have a license for one or more groups. Each group must have a license. To update or add a new license to your current installation, open a command prompt and type:

  • To update an existing license for a group

java -jar <LRM_INSTALLATION_PATH>lrm-cli.jar --update-license --group-name <group> --number-of-licenses <number> --date <YYYY-MM-DD> --license-key <key>

  • To add a new license for a group:

java -jar <LRM_INSTALLATION_PATH>/lrm-cli.jar --create-group <groupname> --number-of-licenses <number> --date <YYYY-MM-DD> --license-key <key>

  • To verify that the new license has been installed with the correct information

java -jar <LRM_INSTALLATION_PATH>/lrm-cli.jar --list-groups

Group Name

A group name must conform to the following specification: A set of alphanumeric characters without the following special characters:

  • < (less than)
  • > (greater than)
  •  : (colon)
  • " (double quote)
  • / (forward slash)
  • \ (backslash)
  • | (vertical bar or pipe)
  •  ? (question mark)
  • * (asterisk)
  • (space)
  •  % (percentage)