Difference between revisions of "Localyzer Installation"

From Lingoport Wiki
Jump to: navigation, search
(→‎Installing the LRM Server)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  +
== Stack Installer/Updater ==
−
== Lingoport Resource Manager Overview ==
  
  +
The recommended way to install Localyzer is via the [[Installation and Configuration|Stack Installer]] or the Stack Updater.
−
The Lingoport Resource Manager System is composed of several items that work together. (See the diagram at [[Components Diagram]]):
  
  +
This page is kept in case a Localyzer patch for an existing version of the Lingoport Suite is needed.
−
# '''Lingoport Resource Manager''': The [[Terms_and_Definitions#LRMServer|LRM 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. The '''[[Terms_and_Definitions#LRMDatabase|LRM Database]]''' is created during the LRM Server installation.
 
  +
−
# '''Jenkins''': [[Terms_and_Definitions#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.
  
  +
== Localyzer Overview ==
  +
Localyzer or as formerly known, the Lingoport Resource Manager System, is composed of several items that work together. (See the diagram at [[Components Diagram]]):
  +
# '''Localyzer''': The [[Terms_and_Definitions#LRMServer|Localyzer]] 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 Localyzer. The '''[[Terms_and_Definitions#LRMDatabase|Localyzer Database]]''' is created during the Localyzer installation.
  +
# '''Jenkins''': [[Terms_and_Definitions#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 Localyzer. The Jenkins setup is the subject of another guide.
 
# '''Dashboard''': the [[Terms_and_Definitions#LingoportDashboard|Lingoport Dashboard]] aggregates and displays data from both the Resource Manager and [[Terms_and_Definitions|Globalyzer]]. Its installation is the subject of another guide.
  
# '''Dashboard''': the [[Terms_and_Definitions#LingoportDashboard|Lingoport Dashboard]] aggregates and displays data from both the Resource Manager and [[Terms_and_Definitions|Globalyzer]]. Its installation is the subject of another guide.
   
 
The [[Terms_and_Definitions#LingoportDashboardClient|Dashboard Client]] typically needs to have access to the <code>lrm-cli.jar</code> files in order to generate the XML report files and subsequently push the files over to the [[Terms_and_Definitions#LingoportDashboardServer|Dashboard Server]].
  
The [[Terms_and_Definitions#LingoportDashboardClient|Dashboard Client]] typically needs to have access to the <code>lrm-cli.jar</code> files in order to generate the XML report files and subsequently push the files over to the [[Terms_and_Definitions#LingoportDashboardServer|Dashboard Server]].
   
  +
== Install using the Stack Installer ==
−
The easiest way to install LRM on a typical system is to use the [[Terms_and_Definitions#stackinstaller|Stack Installer]]. It will install and configure LRM and its supporting components. If you cannot use the [[Terms_and_Definitions#stackinstaller|Stack Installer]], follow the instructions below.
  
  +
The easiest way to install Localyzer on a typical system is to use the [[Terms_and_Definitions#stackinstaller|Stack Installer]]. It will install and configure Localyzer and its supporting components. Once the Stack Installer has completed, continue to [[LRM_Installation#Next_Steps|Next Steps]].
  +
  +
If you cannot use the [[Terms_and_Definitions#stackinstaller|Stack Installer]], follow the instructions below.
   
 
== Install Jenkins==
  
== Install Jenkins==
−
LRM should be installed with under the Jenkins user. If you have not done so yet, install Jenkins from [https://jenkins-ci.org/ jenkins-ci.org], install it, and start it as a daemon.
+
Localyzer should be installed with under the Jenkins user. If you have not done so yet, install Jenkins from [https://jenkins-ci.org/ jenkins-ci.org], install it, and start it as a daemon.
   
 
Check that the location of the 'workspace' is <b>${JENKINS_HOME}/jobs/${ITEM_FULLNAME}/workspace</b>. This location can be found by going to <code>Jenkins -> Manage Jenkins</code> select <code>Configure System</code> and click on <code>Advanced...</code> near the top right page. Look for <code>Workspace Root Directory</code>.
 
Check that the location of the 'workspace' is <b>${JENKINS_HOME}/jobs/${ITEM_FULLNAME}/workspace</b>. This location can be found by going to <code>Jenkins -> Manage Jenkins</code> select <code>Configure System</code> and click on <code>Advanced...</code> near the top right page. Look for <code>Workspace Root Directory</code>.
Line 18: Line 25:
 
Check which <b>Unix user is running the Jenkins job</b>. Check the System Information by selecting <code>Manage Jenkins -> System Information</code> and search for USER.
  
Check which <b>Unix user is running the Jenkins job</b>. Check the System Information by selecting <code>Manage Jenkins -> System Information</code> and search for USER.
   
−
== Installing LRM ==
 +
== Installing Localyzer ==
   
 
===Prerequisites ===
  
===Prerequisites ===
−
Before continuing see [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|current supported software versions]]. These are the versions that need to be on the LRM Server. Review the [[Lingoport Suite Installation]], which describes how all the Lingoport applications work together and the hardware and software configuration requirements,
 +
Before continuing see [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|current supported software versions]]. These are the versions that need to be on the Localyzer Server. Review the [[Lingoport Suite Installation]], which describes how all the Lingoport applications work together and the hardware and software configuration requirements,
 
<OL>
  
<OL>
 
<LI><b>Linux</b>: The supported Operating system is Linux, preferably CentOS. Verify that the correct version is running on the server. </LI>
 
<LI><b>Linux</b>: The supported Operating system is Linux, preferably CentOS. Verify that the correct version is running on the server. </LI>
Line 28: Line 35:
 
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 the supported version of Java or above.</LI>
  
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 the supported version of Java or above.</LI>
   
−
<LI><b>MySQL</b>: Install the supported version <b>MySQL </b> on a database server. If the database server is not the same machine as the LRM Server, then you will need to install the MySQL Client (only need Client) on the LRM Server so that it can access the database on the separate database server.
 +
<LI><b>MySQL</b>: Install the supported version <b>MySQL </b> on a database server. If the database server is not the same machine as the Localyzer Server, then you will need to install the MySQL Client (only need Client) on the Localyzer 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:
  
* You can verify that you have a sufficiently up-to-date version of MySQL using the command prompt. In the command prompt type:
Line 37: Line 44:
 
* You will need to enter the MySQL credentials (host, username, password and port number) during the installation.</LI>
  
* You will need to enter the MySQL credentials (host, username, password and port number) during the installation.</LI>
   
−
<LI><b>Jenkins</b>: The latest version should be installed. See [[#Install Jenkins]]. Complete the installation of Jenkins and identify its user before attempting to install LRM.</LI>
 +
<LI><b>Jenkins</b>: The latest version should be installed. See [[#Install Jenkins]]. Complete the installation of Jenkins and identify its user before attempting to install Localyzer.</LI>
−
<LI><b>LRM Licensing information</b>: When your company purchased LRM you should have been sent an email containing the licensing information. The licensing information will include the following:
 +
<LI><b>Localyzer Licensing information</b>: When your company purchased Localyzer you should have been sent an email containing the licensing information. The licensing information will include the following:
 
* group name
  
* group name
 
* number of licenses in the license
  
* number of licenses in the license
Line 45: Line 52:
 
This licensing information will be required for the server installation. If you do not have the licensing information of the jar file, please contact <code>support@lingoport.com</code>. Please keep it handy while you perform the install.</LI> You may have many licenses, one per group. This must have been specified during the sales process.
  
This licensing information will be required for the server installation. If you do not have the licensing information of the jar file, please contact <code>support@lingoport.com</code>. Please keep it handy while you perform the install.</LI> You may have many licenses, one per group. This must have been specified during the sales process.
   
−
<LI><b>Installer jar file</b>: You must have the <b>Lingoport_Resource_Manager_Server-<x.x>-Installer.jar</b> file. Where <b><x.x></b> is the current supported version of LRM</LI>
 +
<LI><b>Installer jar file</b>: You must have the <b>Lingoport_Resource_Manager_Server-<x.x>-Installer.jar</b> file. Where <b><x.x></b> is the current supported version of Localyzer</LI>
   
 
<LI><b>MySQL Time Zone</b>: 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.
 
<LI><b>MySQL Time Zone</b>: 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.
Line 54: Line 61:
 
</OL>
  
</OL>
   
−
===Installing the LRM Server ===
 +
===Installing Localyzer ===
 
Once you have retrieved your licensing information and ensured that all requirements are met (see previous section), log into the server as the <b>Unix user who will be running the Jenkins jobs</b>. This is usually the Jenkins user.
 
Once you have retrieved your licensing information and ensured that all requirements are met (see previous section), log into the server as the <b>Unix user who will be running the Jenkins jobs</b>. This is usually the Jenkins user.
   
Line 61: Line 68:
   
 
There are two variations to the install.
 
There are two variations to the install.
−
# '''Initial LRM Installation''': The LRM installer will create the LRM Database and the <code>Lingoport_Data/L10nStreamlining</code> directory. The path to the <code>Lingoport_Data/LRM</code> will be established.
+
# '''Initial Localyzer Installation''': The Localyzer installer will create the Localyzer Database and the <code>Lingoport_Data/L10nStreamlining</code> directory. The path to the <code>Lingoport_Data/LRM</code> will be established.
−
# '''Upgrading LRM''': Use this when upgrading your LRM Server to a newer version, this will make sure the existing LRM Database is not overwritten.
 +
# '''Upgrading Localyzer''': Use this when upgrading your Localyzer to a newer version, this will make sure the existing Localyzer Database is not overwritten.
   
   
−
A '''headless installation''' is used to install LRM without a windowing system. An XML installation file with the correct options specified is used from the command line.
+
A '''headless installation''' is used to installLocalyzer without a windowing system. An XML installation file with the correct options specified is used from the command line.
 
 
−
Please note that '''<code><x.x></code>''' is used in these instructions as a placeholder for the current version of LRM. To see the current version see
+
Please note that '''<code><x.x></code>''' is used in these instructions as a placeholder for the current version of Localyzer. To see the current version see [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|current supported software versions]].
  +
−
====Initial LRM Installation====
  
  +
====Initial Localyzer Installation====
   
 
Verify that you are logged in as the <b>Unix user who will be running the Jenkins jobs</b>.
  
Verify that you are logged in as the <b>Unix user who will be running the Jenkins jobs</b>.
Line 76: Line 84:
 
::<code>java –jar Lingoport_Resource_Manager_Server-<x.x>-Installer.jar</code>
  
::<code>java –jar Lingoport_Resource_Manager_Server-<x.x>-Installer.jar</code>
   
−
The installer will prompt you for the install location, license information and database settings to create the MySQL LRM database.
 +
The installer will prompt you for the install location, license information and database settings to create the MySQL Localyzer database.
−
The installer will also prompt you for the LRM and the L10nStreamlining directory location. These will default to <code><home>/Lingoport_Data/LRM</code> and <code><home>/Lingoport_Data/L10nStreamlining</code>. When installation completes, the L10nStreamlining directory will have been created, but the LRM directory is created when the first [[Terms_and_Definitions#LRMproject|LRM project]] is generated.
 +
The installer will also prompt you for the Localyzer and the L10nStreamlining directory location. These will default to <code><home>/Lingoport_Data/LRM</code> and <code><home>/Lingoport_Data/L10nStreamlining</code>. When installation completes, the L10nStreamlining directory will have been created, but the LRM directory is created when the first [[Terms_and_Definitions#LRMproject|Localyzer project]] is generated.
   
 
To verify the installation, from the command line:
  
To verify the installation, from the command line:
Line 84: Line 92:
 
> java -jar <install location>/lrm-cli.jar --help
  
> java -jar <install location>/lrm-cli.jar --help
 
</pre>
  
</pre>
−
This should show the current version of LRM and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.
 +
This should show the current version of Localyzer and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.
   
−
====Updating An Existing LRM Installation====
 +
====Updating An Existing Localyzer Installation====
 
Verify that you are logged in as the <b>Unix user who will be running the Jenkins jobs</b>.
  
Verify that you are logged in as the <b>Unix user who will be running the Jenkins jobs</b>.
   
−
If you are upgrading your LRM Server to a newer version, make sure that you do not overwrite the existing database.
 +
If you are upgrading your Localyzer to a newer version, make sure that you do not overwrite the existing database.
 
*Double-click on the <code>Lingoport_Resource_Manager_Server-<x.x>-Installer.jar</code> file, or
  
*Double-click on the <code>Lingoport_Resource_Manager_Server-<x.x>-Installer.jar</code> file, or
 
*From the command line, cd to the directory with the installer jar file and type:
  
*From the command line, cd to the directory with the installer jar file and type:
Line 101: Line 109:
 
> java -jar <install location>/lrm-cli.jar --help
  
> java -jar <install location>/lrm-cli.jar --help
 
</pre>
  
</pre>
−
This should show the current version of LRM and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.
 +
This should show the current version of Localyzer and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.
   
 
====Headless Installation====
  
====Headless Installation====
 
Verify that you are logged in as the <b>Unix user who will be running the Jenkins jobs</b>.
  
Verify that you are logged in as the <b>Unix user who will be running the Jenkins jobs</b>.
   
−
To install LRM without a windowing system or from a command line, use an XML installation file. The XML installation files can be generated from a first installation or an update using a windowing system on the last page of the installer. That file can be modified to fit other installations. To run a [[Terms_and_Definitions#headless|headless installation]], from the command line, cd to the directory with the installer and type:
 +
To install or update Localyzer without a windowing system or from a command line, use an XML installation file. The XML installation files can be generated from a first installation or an update using a windowing system on the last page of the installer. That file can be modified to fit other installations. To run a [[Terms_and_Definitions#headless|headless installation]], from the command line, cd to the directory with the installer and type:
 
:<code>java –jar Lingoport_Resource_Manager_Server-<x.x>-Installer.jar headlessinstaller.xml</code>
  
:<code>java –jar Lingoport_Resource_Manager_Server-<x.x>-Installer.jar headlessinstaller.xml</code>
   
Line 114: Line 122:
 
> java -jar <install location>/lrm-cli.jar --help
  
> java -jar <install location>/lrm-cli.jar --help
 
</pre>
  
</pre>
−
This should show the current version of LRM and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.
 +
This should show the current version of Localyzer and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.
   
 
===Adding or Updating the License===
  
===Adding or Updating the License===
Line 143: Line 151:
 
* % (percentage)
  
* % (percentage)
   
  +
= Next Steps =
−
= Global Email Configuration =
  
  +
After the installation, there is a
−
== Basic Configuration ==
  
−
To send notifications to email recipients, the '''<code>config_email_global.xml</code>''' needs to be configured under '''<code><jenkins USER>/Lingoport_Data/L10nStreamlining/config</code>'''
 
−
The specification need in particular to be set for the smtp-host, the smtp-auth, the email-sender, the sender-password, and the jenkins-url for your system.
 
−
<pre>
  
−
<smtp-host>smtp.gmail.com</smtp-host>
  
−
<smtp-auth>mail.smtps.auth</smtp-auth>
  
−
<email-sender>mailuser@company.com</email-sender>
  
−
<sender-password>mailuserpwd</sender-password>
  
−
<jenkins-url>http://jenkins.company.com:8080/</jenkins-url>
  
−
</pre>
  
   
  +
If this is a new installation, you will need to configure your [[Terms_and_Definitions#LRMProject|Localyzer Project]] and start managing your application's [[Terms_and_Definitions#resourcefiles|resource files]]. This involves configuring [[Terms_and_Definitions#Jenkins|Jenkins]] with tabs, the jobs, the users, and the authorizations. See [[LRM Jenkins Configure System| Localyzer Jenkins Configure System]].
−
== Encrypted Password ==
  
−
The <code><sender-password></code> can be configured with the <code>encrypted</code> attribute set to true, as in
  
−
<pre>
  
−
...
  
−
<email-sender>mailuser@company.com</email-sender>
  
−
<sender-password encrypted="true">UUIasd455</sender-password>
  
−
...
  
−
</pre>
  
−  
−
To encrypt the password, use the <code>encrypt</code> command line on <code>lrm-common.jar</code> file. For instance:
  
−  
−
'''<code>> java -jar <LRM_INSTALLATION_PATH>/lib/lpcommon.jar --encrypt</code>'''
  
−  
−
which will prompt you for the text (here the password) to encrypt and will provide the result on the console.
  
−  
−
== Nothing to Prep Email ==
  
−
To notify that when executing the command to send translation, no translations were found, the <code>send-no-files-to-prep-email</code> defaults to be set to 1. This may become annoying if you are prepping every night for instance and no changes happen. The notification system would then send a "Nothing to Prep" email. If you would rather no mails were sent in this case, set <code>send-no-files-to-prep-email</code> to 0.
  
−
'''<pre>
  
−
<send-no-files-to-prep-email>0</send-no-files-to-prep-email>
  
−
</pre>'''
  
−  
−
= Next Steps =
 
−
If this is a new installation, you will need to configure your [[Terms_and_Definitions#LRMProject|LRM Project]] and start managing your application's [[Terms_and_Definitions#resourcefiles|resource files]]. This involves configuring [[Terms_and_Definitions#Jenkins|Jenkins]] with tabs, the jobs, the users, and the authorizations. See [[LRM Jenkins Configure System]].
 
   
−
LRM works with the [[Terms_and_Definitions#LingoportDashboard|Lingoport Dashboard]]. If you have the Dashboard currently installed, make sure it is configured to point to the current LRM installation. You may want to update the Dashboard installation to do so. If you are going to install the Dashboard later, then don't worry for now. This will be part of the Dashboard installation process.
 +
Localyzer works with the [[Terms_and_Definitions#LingoportDashboard|Lingoport Dashboard]]. If you have the Dashboard currently installed, make sure it is configured to point to the current Localyzer installation. You may want to update the Dashboard installation to do so. If you are going to install the Dashboard later, then don't worry for now. This will be part of the Dashboard installation process.
   
−
<b>Important MySQL Configuration Note</b>
 +
<b>Important MySQL Configuration Note: </b>
−
If you see the following error when running LRM commands: <b>Packet for query is too large</b>
 +
If you see the following error when running Localyzer commands: <b>Packet for query is too large</b>
 
you will need to increase the max_allowed_packet variable of your MySQL database server to either 16 or 32 megabytes in the Lingoport directory of your Server and Client installations.
  
you will need to increase the max_allowed_packet variable of your MySQL database server to either 16 or 32 megabytes in the Lingoport directory of your Server and Client installations.
   
 
= Lingoport Customer Support =
  
= Lingoport Customer Support =
−
If you experience difficulties during the installation of the Lingoport Resource Manager, please contact '''support@lingoport.com'''.
 +
If you experience difficulties during the installation or update of the Lingoport Resource Manager, please contact '''support@lingoport.com'''.

Latest revision as of 14:11, 12 July 2021

Stack Installer/Updater

The recommended way to install Localyzer is via the Stack Installer or the Stack Updater. This page is kept in case a Localyzer patch for an existing version of the Lingoport Suite is needed.

Localyzer Overview

Localyzer or as formerly known, the Lingoport Resource Manager System, is composed of several items that work together. (See the diagram at Components Diagram):

  1. Localyzer: The Localyzer 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 Localyzer. The Localyzer Database is created during the Localyzer installation.
  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 Localyzer. 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 Client typically needs to have access to the lrm-cli.jar files in order to generate the XML report files and subsequently push the files over to the Dashboard Server.

Install using the Stack Installer

The easiest way to install Localyzer on a typical system is to use the Stack Installer. It will install and configure Localyzer and its supporting components. Once the Stack Installer has completed, continue to Next Steps.

If you cannot use the Stack Installer, follow the instructions below.

Install Jenkins

Localyzer should be installed with under the Jenkins user. If you have not done so yet, install Jenkins from jenkins-ci.org, install it, and start it as a daemon.

Check that the location of the 'workspace' is ${JENKINS_HOME}/jobs/${ITEM_FULLNAME}/workspace. This location can be found by going to Jenkins -> Manage Jenkins select Configure System and click on Advanced... near the top right page. Look for Workspace Root Directory.

This is very important. A different Workspace Root Directory will cause real problems!

Check which Unix user is running the Jenkins job. Check the System Information by selecting Manage Jenkins -> System Information and search for USER.

Installing Localyzer

Prerequisites

Before continuing see current supported software versions. These are the versions that need to be on the Localyzer Server. Review the Lingoport Suite Installation, which describes how all the Lingoport applications work together and the hardware and software configuration requirements,

  1. Linux: The supported Operating system is Linux, preferably CentOS. Verify that the correct version is running on the server.
  2. Java: Install the supported version of the Java JDK on the target machine. You can check the 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 the supported version of Java or above.
  3. MySQL: Install the supported version MySQL on a database server. If the database server is not the same machine as the Localyzer Server, then you will need to install the MySQL Client (only need Client) on the Localyzer 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 the supported version 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.
  4. Jenkins: The latest version should be installed. See #Install Jenkins. Complete the installation of Jenkins and identify its user before attempting to install Localyzer.
  5. Localyzer Licensing information: When your company purchased Localyzer 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.
    6. You may have many licenses, one per group. This must have been specified during the sales process.
  6. Installer jar file: You must have the Lingoport_Resource_Manager_Server-<x.x>-Installer.jar file. Where <x.x> is the current supported version of Localyzer
  7. 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 Linux, 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.

Installing Localyzer

Once you have retrieved your licensing information and ensured that all requirements are met (see previous section), log into the server as the Unix user who will be running the Jenkins jobs. This is usually the Jenkins user.

  • IMPORTANT: Which Unix user will do all the installation?
    • Unix user who will be running the Jenkins jobs

There are two variations to the install.

  1. Initial Localyzer Installation: The Localyzer installer will create the Localyzer Database and the Lingoport_Data/L10nStreamlining directory. The path to the Lingoport_Data/LRM will be established.
  2. Upgrading Localyzer: Use this when upgrading your Localyzer to a newer version, this will make sure the existing Localyzer Database is not overwritten.


A headless installation is used to installLocalyzer without a windowing system. An XML installation file with the correct options specified is used from the command line.

Please note that <x.x> is used in these instructions as a placeholder for the current version of Localyzer. To see the current version see current supported software versions.

Initial Localyzer Installation

Verify that you are logged in as the Unix user who will be running the Jenkins jobs.

  • 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

The installer will prompt you for the install location, license information and database settings to create the MySQL Localyzer database. The installer will also prompt you for the Localyzer 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 Localyzer project is generated.

To verify the installation, from the command line: 

> java -jar <install location>/lrm-cli.jar --version
> java -jar <install location>/lrm-cli.jar --help

This should show the current version of Localyzer and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.

Updating An Existing Localyzer Installation

Verify that you are logged in as the Unix user who will be running the Jenkins jobs.

If you are upgrading your Localyzer 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.

To verify the installation, from the command line: 

> java -jar <install location>/lrm-cli.jar --version
> java -jar <install location>/lrm-cli.jar --help

This should show the current version of Localyzer and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.

Headless Installation

Verify that you are logged in as the Unix user who will be running the Jenkins jobs.

To install or update Localyzer without a windowing system or from a command line, use an XML installation file. The XML installation files can be generated from a first installation or an update using a windowing system on the last page of the installer. That file can be modified to fit other installations. To run a headless installation, from the command line, cd to the directory with the installer and type:

java –jar Lingoport_Resource_Manager_Server-<x.x>-Installer.jar headlessinstaller.xml

To verify the installation, from the command line: 

> java -jar <install location>/lrm-cli.jar --version
> java -jar <install location>/lrm-cli.jar --help

This should show the current version of Localyzer and the help text. If either of these commands errors, something is incorrect and must be fixed before moving on.

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:

  • 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>
  • 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>
  • Verify that the new license has been installed with the correct information:
java -jar <LRM_INSTALLATION_PATH>/lrm-cli.jar --list-groups

Group Name

The group name must be established before Lingoport can issue a license key. 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)

Next Steps

After the installation, there is a

If this is a new installation, you will need to configure your Localyzer Project and start managing your application's resource files. This involves configuring Jenkins with tabs, the jobs, the users, and the authorizations. See Localyzer Jenkins Configure System.

Localyzer works with the Lingoport Dashboard. If you have the Dashboard currently installed, make sure it is configured to point to the current Localyzer installation. You may want to update the Dashboard installation to do so. If you are going to install the Dashboard later, then don't worry for now. This will be part of the Dashboard installation process.

Important MySQL Configuration Note: If you see the following error when running Localyzer commands: Packet for query is too large you will need to increase the max_allowed_packet variable of your MySQL database server to either 16 or 32 megabytes in the Lingoport directory of your Server and Client installations.

Lingoport Customer Support

If you experience difficulties during the installation or update of the Lingoport Resource Manager, please contact support@lingoport.com.

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