Difference between revisions of "Lingoport Suite Installation Instructions"

From Lingoport Wiki
Jump to: navigation, search
 
(20 intermediate revisions by one other user not shown)
Line 1: Line 1:
  +
= Read Me First =
   
  +
The following are instructions for installing the Globalyzer Suite.
−  
−
= Installation of the Globalyzer Suite =
  
−
The following are instructions for installing the Globalyzer Suite. You'll want
  
−
to take a moment to read over the Installation and Upgrade Order below before
  
−
proceeding. You may otherwise either read the instructions as you go or skim
  
−
them first at your preference.
  
   
 
Depending on what deployment scenarios you choose, you may not need to perform
  
Depending on what deployment scenarios you choose, you may not need to perform
Line 15: Line 11:
 
to the next.
  
to the next.
   
  +
You'll want to take a moment to read over the table of contents summary for the
  +
Installation Steps (see above) before proceeding.
   
  +
You may otherwise read the instructions as you go.
−
= Installation and Upgrade Order and Overview =
  
   
  +
= Installation Steps =
−
# If you haven't already, read over the [[Lingoport Suite Systems Guide]]
  
−
# If you haven't already, decide on one or more [[Deployment Scenarios]].
  
−
# Install/Upgrade [[The Globalyzer Server]]
  
−
# Install [[The Build Server]] pre-requisites.
  
−
# Install/Upgrade [[The Globalyzer Client/Workbench]] on the Build Server. You'll use the Workbench to test that you can connect to the Globalyzer Server.
  
−
#* At this point, you can also install it [[The Developer Machine]], allowing your developers to begin their i18n work with it.
  
−
#* If you have [[Globalyzer Lite]], you can install that on [[#The Developer Machine]] in addition / instead. (See [[Globalyzer Lite:Lite vs the Globalyzer Workbench]])
  
−
# Install/Upgrade the LRM Server on [[#The Build Server]] <!--You may follow the instructions in the LRM Installation Guide HTML file included with your LRM installation files.-->
  
−
# Install/Upgrade the Dashboard Server on [[#The Dashboard Server System]]
  
−
# Install/Upgrade the Dashboard Client on [[#The Build Server]]
  
−  
−  
−
= Full Instructions =
  
 
== Read over the Lingoport Suite Systems Guide ==
  
== Read over the Lingoport Suite Systems Guide ==
−
If you haven't already, see the [[Lingoport Suite Systems Guide]]. Do not
 +
If you haven't already, see the [[Lingoport Suite Systems Guide]] (TODO: create systems guide from information on the [[Lingoport Suite Installation]] page). Do not
 
proceed until you feel that you understand it.
  
proceed until you feel that you understand it.
   
  +
== Decide On Your Deployment Scenario(s) ==
−  
  +
If you haven't already, see the [[Deployment Scenarios]]
−
== Decide On A Deployment Scenario ==
  
−
If you haven't already, see the [[Deployment Scenarios | Deployment Scenario]]
  
 
document. Do not proceed until you have decided on one or more deployment
  
document. Do not proceed until you have decided on one or more deployment
 
scenarios. Be sure that you understand the deployment scenario(s) you have
  
scenarios. Be sure that you understand the deployment scenario(s) you have
 
chosen.
  
chosen.
   
  +
== Consider A Couple Notable Prerequisites ==
  +
Most of the prerequisites for the upcoming steps are fairly straightforward.
  +
However, a couple of them might be worth a pause. Here are some prerequisites to
  +
be particularly aware of:
  +
  +
==== LRM requires that the [[The Build Server]] use Linux ====
  +
If you're not planning on using LRM, but there's some chance that you'll change your mind, it's still probably wise to use Linux for the build server. Otherwise you'd need to reinstall all of the build server components on a Linux machine later (what a pain).
  +
  +
==== Dashboard requires that the [[The Dashboard Server]] use MySQL 5.6 or greater ====
  +
  +
==== The Following Deployment Scenarios Require A Version Control System ====
  +
* [[Globalyzer Lite for Continuous Globalization]]
  +
* [[Globalyzer CLI for Continuous Globalization]]
  +
* [[Globalyzer API for Continuous Globalization]]
  +
* [[Globalyzer and Check in Verification]]
  +
* [[LRM for Continuous Globalization]]
  +
* [[Continuous Globalization]]
  +
  +
Previous clients have used '''Git''', '''Subversion''', '''Team Foundation Server''' and even
  +
'''FTP'''. If you wish to use a different version control system, check with Lingoport
  +
first to insure compatibility.
  +
  +
If you're only looking to set up a sandbox style environment to evaluate
  +
components of the Lingoport Suite, then a version control system is not strictly
  +
necessary. However, the installation process becomes more complicated without
  +
one. If you choose to avoid using a version control system, please check in
  +
with Lingoport to avoid getting stuck later.
  +
<!-- TODO maybe add a page and link for [[SVN] -->
  +
<!-- TODO instructions for installation without VCS -->
  +
  +
These prerequisites will be mentioned again in the sections where they are relevant.
   
−
== Install The Globalyzer Server (optional) ==
 +
== Install the Globalyzer Server (optional) ==
 
==== Deployment Scenarios ====
  
==== Deployment Scenarios ====
 
* [[Globalyzer Workbench for i18n Specialists]]
  
* [[Globalyzer Workbench for i18n Specialists]]
Line 52: Line 68:
 
* [[Globalyzer and Check in Verification]]
  
* [[Globalyzer and Check in Verification]]
 
* [[Continuous Globalization]]
  
* [[Continuous Globalization]]
  +
  +
==== Installation ====
   
 
This is an optional step. You company may have elected to use Lingoport's
  
This is an optional step. You company may have elected to use Lingoport's
Line 61: Line 79:
   
 
<!--
  
<!--
−
NEEDS REVISING == Test the Globalyzer Server by Installing the Globalyzer Client/Workbench ==
 +
NEEDS REVISING === Verify the Server installation ===
−
NEEDS REVISING TODO: is being able to connect to the globalyzer server via a browser a sufficient condition to confirm that the Globalyzer Server is working? (Ask Mary)
 +
NEEDS REVISING TODO: is being able to connect to the globalyzer server via a
  +
NEEDS REVISING browser a sufficient condition to confirm that the Globalyzer Server is working?
−
NEEDS REVISING Necessary for:
  
−
NEEDS REVISING * [[Globalyzer Workbench for i18n Specialists]]
 +
NEEDS REVISING (Ask Mary)
−
NEEDS REVISING * [[Globalyzer Lite for Developers]]
  
−
NEEDS REVISING * [[Globalyzer Lite for Continuous Globalization]]
  
−
NEEDS REVISING * [[Globalyzer CLI for Continuous Globalization]]
  
−
NEEDS REVISING * [[Globalyzer API for Continuous Globalization]]
  
−
NEEDS REVISING * [[Globalyzer and Check in Verification]]
  
−
NEEDS REVISING * [[Continuous Globalization]]
  
 
NEEDS REVISING
 
NEEDS REVISING
 
NEEDS REVISING The Client should be installed on the '''Build Server''' once a Globalyzer
  
NEEDS REVISING The Client should be installed on the '''Build Server''' once a Globalyzer
Line 93: Line 105:
 
-->
  
-->
   
  +
==== Verification ====
−
== Install the Globalyzer Client/Workbench on the i18n Specialists' Machines==
  
  +
TODO: Add a verification step after each installation step.
  +
  +
==== Post Install ====
  +
TODO: They need a license, username, and account!
  +
  +
== Install the Globalyzer Client/Workbench on i18n Specialists' Machines==
 
This section may be completed at any time after the Globalyzer Server has been
  
This section may be completed at any time after the Globalyzer Server has been
 
setup and verified. We recommend doing it now. That way the i18n
  
setup and verified. We recommend doing it now. That way the i18n
 
specialists at your company may begin work on crafting rule sets while you
  
specialists at your company may begin work on crafting rule sets while you
 
perform the rest of the installation.
  
perform the rest of the installation.
  +
  +
If you don't want to do it now, don't worry. There will be a reminder to come
  +
back here at the end of this document.
   
 
==== Deployment Scenarios ====
  
==== Deployment Scenarios ====
Line 112: Line 133:
   
 
==== Prerequisites ====
  
==== Prerequisites ====
−
* '''Java 7 ''JDK'' ''' or greater. A JDK is required (do not use a JRE).
 +
* [http://www.oracle.com/technetwork/java/javase/downloads/index.html '''Java 7 ''JDK'' ''' or greater]. A JDK is required (do not use a JRE).
−
* '''MySQL 5.1''' or greater (optional).
 +
* [https://www.mysql.com/downloads/ '''MySQL 5.6''' or greater] (optional).
−
** The Globalyzer Client can use either '''MySQL''' or '''HSQLDB'''. If you choose MySQL, you will need '''MySQL 5.1''' or greater. If you choose HSQLDB, you do not need to install anything.
 +
** The Globalyzer Client can use either '''MySQL''' or '''HSQLDB'''. If you choose MySQL, you will need '''MySQL 5.6''' or greater. If you choose HSQLDB, you do not need to install anything.
   
 
==== Installation ====
  
==== Installation ====
Line 122: Line 143:
 
link at the bottom of the page. Read and follow the instructions. You may
  
link at the bottom of the page. Read and follow the instructions. You may
 
install with any configuration - with or without the optional packages.
  
install with any configuration - with or without the optional packages.
  +
  +
TODO: Login stuff
  +
==== Verification ====
  +
Open the Globalyzer Workbench and enter valid login credentials to the server.
  +
If you don't currently know any login credentials you'll either need to:
  +
* Use your admin account on the Globalyzer Server to create a user (If you've installed the server yourself)
  +
* Refer to the credentials Lingoport has given you (If you are using [http://www.globalyzer.com www.globalyzer.com].
  +
  +
If you're able to log in successfully, you should be good to go.
   
 
==== Post Installation ====
  
==== Post Installation ====
Line 127: Line 157:
 
way they can work in parallel while you complete the rest of the installation.
  
way they can work in parallel while you complete the rest of the installation.
   
−
== Install Globalyzer Lite on The Developer Machine ==
 +
== Install Globalyzer Lite on the Developer Machines ==
 
This step may be performed at any time during or after the rest of the
  
This step may be performed at any time during or after the rest of the
 
installation.
  
installation.
  +
  +
If you don't want to do it now, don't worry. There will be a reminder to come back here
  +
at the end of this document.
   
 
==== Deployment Scenarios ====
  
==== Deployment Scenarios ====
−
This is necessary for the following deployment scenario:
  
 
* [[Globalyzer Lite for Developers]]
  
* [[Globalyzer Lite for Developers]]
   
 
==== Prerequisites ====
  
==== Prerequisites ====
−
* '''Java 7 JRE''' or greater.
 +
* [https://www.java.com/en/download/ '''Java 7 JRE (or JDK)''' or greater].
   
 
==== Installation ====
  
==== Installation ====
Line 146: Line 178:
 
* install-lite.bat (Windows).
  
* install-lite.bat (Windows).
   
  +
==== Verification ====
  +
This step is optional.
  +
  +
If you have not yet created a rule set on the Globalyzer Server, create one.
  +
(Again, Lingoport's is at [https://www.globalyzer.com www.globalyzer.com]). Pick
  +
a language based on the source code present on the developer machine (If no
  +
language is present, hop on [https://github.com github] and copy a source file
  +
from your favorite repository).
  +
  +
Next, create a simple Project Definition xml file using the rule set. See the
  +
README for a template. Point it at a directory containing some code. Now execute
  +
Lite:
  +
<code>java -jar globalyzer-lite.jar TheProjectDefinitionFileYouCreated.xml</code>
  +
  +
Lite should run. No errors should occur. A report should be generated at the
  +
report location you have specified. Don't worry if the report contains no
  +
issues, or contains false positives. The rule set may need to be fine tuned, or
  +
the file may contain no i18n issues.
  +
  +
==== Post Installation ====
  +
A README file in the globalyzer-lite-#.#.# directory contains basic instructions
  +
for using Globalyzer Lite.
  +
  +
Check the [[https://www.globalyzer.com/gzserver/help/referenceLite/toc.html Globalyzer Lite Help Pages]] for more detailed instructions.
  +
  +
TODO: add a verification step
  +
TODO: add a what to do after step (reference docs on globalyer.com)
   
 
== Setup the Build Server ==
  
== Setup the Build Server ==
 
==== Deployment Scenarios ====
  
==== Deployment Scenarios ====
−
This is necessary for the following deployment scenarios:
  
 
* [[Globalyzer Lite for Continuous Globalization]]
  
* [[Globalyzer Lite for Continuous Globalization]]
 
* [[Globalyzer CLI for Continuous Globalization]]
  
* [[Globalyzer CLI for Continuous Globalization]]
Line 157: Line 215:
   
 
It may also be necessary for the following:
  
It may also be necessary for the following:
−
* [[globalyzer and check in verification]]
 +
* [[Globalyzer and check in verification]]
 
Although custom modifications will be needed based on your currently setup
  
Although custom modifications will be needed based on your currently setup
−
code gate(s) / build systems. these modifications can vary significantly, and
 +
code gate(s) / build systems. These modifications can vary significantly, and
 
are beyond the scope of this document.
  
are beyond the scope of this document.
   
−
==== Base Prerequisites ====
 +
==== Base Prerequisites for the Build Server ====
 
There are several options here. Before proceeding, install the following
  
There are several options here. Before proceeding, install the following
 
prerequisites. They are necessary regardless of which option you pick.
  
prerequisites. They are necessary regardless of which option you pick.
   
 
The following are necessary for
  
The following are necessary for
−
* The OS for the build server must be '''Linux''', preferably Ubuntu.
 +
* The OS for the build server must be '''Linux''', preferably [http://www.ubuntu.com/ Ubuntu].
  +
** If you are 100% sure you will not be using LRM, this is not required. However, if there's a chance you might want to use it later, it's probably best to stick with Linux. Otherwise you might have to migrate the entire build server setup from Windows to Linux later (what a pain).
−
* '''Java 7 ''JDK'' ''' or greater. The JDK is required by Globalyzer.
  
  +
* [http://www.oracle.com/technetwork/java/javase/downloads/index.html '''Java 7 ''JDK'' ''' or greater]. The JDK is required by Globalyzer.
−
* A Version Control System Client (we've previously supported Git, SVN, TFS and FTP).
  
  +
* A Version Control System Client
−
* '''Jenkins 1.620''' or greater.
  
  +
** Previous clients have used [[Git]], Subversion, Team Foundation Server and even FTP.
  +
** If you wish to use a different version control system, check with us first. It should still probably work, but will need to be integrated with Jenkins.
  +
** TODO add link to [[Git]] (from [[Installation and Configuration]])
  +
** TODO maybe add a page and link for [[SVN]
  +
* [https://jenkins-ci.org/ '''Jenkins -v 1.625.2 LTS or 1.638''' or greater].
 
** Jenkins, a continuous integration tool, is required. Jenkins enables nightly scanning and scheduled Dashboard updates. Additionally, Jenkins scripts, added as part of the LRM configuration, enable round-trip automation for managing resource files.
  
** Jenkins, a continuous integration tool, is required. Jenkins enables nightly scanning and scheduled Dashboard updates. Additionally, Jenkins scripts, added as part of the LRM configuration, enable round-trip automation for managing resource files.
−  
   
 
== Install a Continuous Globalization Setup on the Build Server ==
  
== Install a Continuous Globalization Setup on the Build Server ==
 
==== Deployment Scenarios ====
  
==== Deployment Scenarios ====
−
For any of the following deployment scenarios:
  
 
* [[Globalyzer Lite for Continuous Globalization]]
  
* [[Globalyzer Lite for Continuous Globalization]]
 
* [[Globalyzer CLI for Continuous Globalization]]
  
* [[Globalyzer CLI for Continuous Globalization]]
Line 184: Line 245:
 
Choose one of the three following installations:
  
Choose one of the three following installations:
   
−
# Globalyzer Lite
 +
# [[#Option 1: Globalyzer Lite]]
 
#* For the [[Globalyzer Lite for Continuous Globalization]] scenario.
  
#* For the [[Globalyzer Lite for Continuous Globalization]] scenario.
−
# Globalyzer CLI
 +
# [[#Option 2: Globalyzer CLI]]
 
#* For the [[Globalyzer CLI for Continuous Globalization]] scenario.
  
#* For the [[Globalyzer CLI for Continuous Globalization]] scenario.
−
# Custom Globalyzer API Setup
 +
# [[#Option 3: Custom Globalyzer API Setup]]
 
#* For the [[Globalyzer API for Continuous Globalization]] scenario.
  
#* For the [[Globalyzer API for Continuous Globalization]] scenario.
   
Line 194: Line 255:
 
For the [[Globalyzer Lite for Continuous Globalization]] scenario.
  
For the [[Globalyzer Lite for Continuous Globalization]] scenario.
   
  +
==== Prerequisites ====
  +
See [[#Base Prerequisites for the Build Server]]
  +
  +
==== Installation ====
 
Acquire a copy of the globalyzer-lite-#.#.#.zip file (# = version numbers).
  
Acquire a copy of the globalyzer-lite-#.#.#.zip file (# = version numbers).
 
Unzip the zip file at a location where jenkins has full permissions to access
  
Unzip the zip file at a location where jenkins has full permissions to access
Line 204: Line 269:
 
Verify that the jenkins user has full permissions globalyzer-lite-#.#.# directory and its
  
Verify that the jenkins user has full permissions globalyzer-lite-#.#.# directory and its
 
contents before continuing.
  
contents before continuing.
  +
  +
==== Verification ====
  +
Now is a good time to double check that the 'jenkins' user has full permissions
  +
to Lite's install directory.
  +
  +
You may also want to run a test-scan with Lite as the jenkins user. Put some
  +
source code on your machine, and create a rule set for the appropriate
  +
programming language on the Globalyzer Server (Again, Lingoport's server is at
  +
[http://www.globalyzer.com www.globalyzer.com]). A newly created rule set is
  +
fine for now. Or you may use any previously created one.
  +
  +
Next, follow Lite's README's instructions for setting up a project definition
  +
file. Log in as the jenkins user, then execute Lite.
  +
:<code>java -jar globalyzer-lite.jar YourProjectDefinitionFile.xml</code>
  +
  +
Check that Lite does not encounter any errors and successfully generated a
  +
report. Don't worry if the report has false positives, or is empty. The code
  +
may not contain i18n issues, and the rule set may need to be fine tuned.
   
 
=== Option 2: Globalyzer CLI ===
  
=== Option 2: Globalyzer CLI ===
 
For the [[Globalyzer CLI for Continuous Globalization]] scenario.
  
For the [[Globalyzer CLI for Continuous Globalization]] scenario.
   
  +
TODO: remove this if not needed (depending on Mary's response).
−
==== Prerequisites ====
  
−
* '''MySQL 5.1''' or greater (optional).
  
−
** The Globalyzer Client can use either '''MySQL''' or '''HSQLDB'''. If you choose MySQL, you will need '''MySQL 5.1''' or greater. If you choose HSQLDB, you do not need to install anything.
  
−  
 
Note: This step is only necessary if you did not already install the Globalyzer
  
Note: This step is only necessary if you did not already install the Globalyzer
 
Client in a location where the 'jenkins' user has full permissions to it.
  
Client in a location where the 'jenkins' user has full permissions to it.
   
  +
==== Prerequisites ====
  +
* The [[#Base Prerequisites for the Build Server]]
  +
* [https://www.mysql.com/downloads/ '''MySQL 5.6''' or greater] (optional).
  +
** The Globalyzer Client can use either '''MySQL''' or '''HSQLDB'''. If you choose MySQL, you will need '''MySQL 5.6''' or greater. If you choose HSQLDB, you do not need to install anything.
  +
  +
==== Installation ====
 
Log in to the Globalyzer Server and click on the Client download link at the
  
Log in to the Globalyzer Server and click on the Client download link at the
 
bottom of the (post login) page. If you have not configured your own Globalyzer
  
bottom of the (post login) page. If you have not configured your own Globalyzer
Line 227: Line 313:
 
* Install all optional packages (Globalyzer CLI, Globalyzer Ant Tasks). They will be installed by default. <!-- TODO: Are either of these necessary if deploying with (Lite / the API) instead? (they are optional for the api) -->
  
* Install all optional packages (Globalyzer CLI, Globalyzer Ant Tasks). They will be installed by default. <!-- TODO: Are either of these necessary if deploying with (Lite / the API) instead? (they are optional for the api) -->
   
  +
==== Verification ====
 
Now is a good time to double check that the 'jenkins' user has full permissions
  
Now is a good time to double check that the 'jenkins' user has full permissions
−
to the client install directory.
 +
to the Client's install directory.
  +
  +
You may also attempt to scan some source code. See the
  +
[https://www.globalyzer.com/gzserver/help/referenceCommandLine/cmd-line-client.html Globalyzer Command Line Client Reference]. You'll first want to log in (you'll need a username and password on the Globalyzer Server). Then you'll want to scan your code (see "Scan Command and Options").
   
 
=== Option 3: Custom Globalyzer API Setup ===
  
=== Option 3: Custom Globalyzer API Setup ===
  +
==== Prerequisites ====
  +
See [[#Base Prerequisites for the Build Server]]
  +
  +
==== Installation ====
 
For the [[Globalyzer API for Continuous Globalization]] scenario.
  
For the [[Globalyzer API for Continuous Globalization]] scenario.
   
−
This options is nebulous, and may be set up at your own discretion. You will
 +
This option offers a lot of power, and may take on a variety of forms.
  +
−
quite possibly (but not necessary) want to set up '''MySQL 5.1''' (or greater)
  
  +
may be set up at your own discretion. You will
  +
quite possibly (but not necessary) want to set up '''MySQL 5.6''' (or greater)
 
for use with the Globalyzer API.
  
for use with the Globalyzer API.
   
 
TODO: Go to [[http://www.globalyzer.com | www.globalyzer.com ]] and read up on the API
  
TODO: Go to [[http://www.globalyzer.com | www.globalyzer.com ]] and read up on the API
   
  +
==== Verification ====
  +
Now that you've set up program(s) to utilize the API, check that it/they can scan
  +
source code and generate reports. Make sure they're runnable by the 'jenkins' user.
   
 
== Install the Lingoport Resource Manager Server on the Build Server ==
  
== Install the Lingoport Resource Manager Server on the Build Server ==
 
==== Deployment Scenarios ====
  
==== Deployment Scenarios ====
−
This is necessary for the following deployment scenarios:
  
 
* [[LRM for Continuous Globalization]]
  
* [[LRM for Continuous Globalization]]
 
* [[Continuous Globalization]]
  
* [[Continuous Globalization]]
   
−
==== Installation ====
 +
==== Prerequisites ====
  +
All [[#Base Prerequisites for the Build Server]]
  +
* The OS for the build server must be '''Linux''', preferably [http://www.ubuntu.com/ Ubuntu].
  +
  +
==== Pre-Installation ====
 
You will probably want to be familiar with the pages under [[About LRM]] before
  
You will probably want to be familiar with the pages under [[About LRM]] before
 
continuing. It's good to know what you are dealing with.
  
continuing. It's good to know what you are dealing with.
   
  +
==== Installation ====
 
The LRM Installation is a complicated process. Follow the instructions under
  
The LRM Installation is a complicated process. Follow the instructions under
 
[[Installation and Configuration | LRM Installation and Configuration]].
  
[[Installation and Configuration | LRM Installation and Configuration]].
   
  +
==== Verification ====
  +
TODO
   
−
== Setup the The Dashboard Server System ==
 +
== Setup the Dashboard Server System ==
 
==== Deployment Scenarios ====
  
==== Deployment Scenarios ====
−
This is necessary for the following deployment scenarios:
  
 
* [[Globalyzer Lite for Continuous Globalization]]
  
* [[Globalyzer Lite for Continuous Globalization]]
 
* [[Globalyzer CLI for Continuous Globalization]]
  
* [[Globalyzer CLI for Continuous Globalization]]
Line 271: Line 375:
   
 
==== Prerequisites ====
  
==== Prerequisites ====
−
* '''MySQL 5.1''' or greater.
 +
* [https://www.mysql.com/downloads/ '''MySQL 5.6''' or greater].
−
* '''Java 7 ''JRE'' ''' or greater.
 +
* [https://www.java.com/en/download/ '''Java 7 JRE (or JDK)''' or greater].
   
 
==== Installation ====
  
==== Installation ====
Line 278: Line 382:
 
instructions.
  
instructions.
   
  +
==== Verification ====
  +
Open a web browser on any computer within the same network as the Dashboard Server
  +
and browser to the server url/ip followed by the dashboard's port if necessary.
  +
The Dashboard page should load.
  +
  +
: If you're typing in an IP, it should look something like this: 10.1.10.235
  +
: Alternatively the server url might look something like this: devlingo
  +
  +
== TODO: Installing the Dashboard Client ==
   
 
= Finishing Up =
  
= Finishing Up =
Line 285: Line 398:
 
If you plan to use the Globalyzer Workbench and/or Globalyzer Lite, but skipped
  
If you plan to use the Globalyzer Workbench and/or Globalyzer Lite, but skipped
 
their installation steps, then now is the time to go back and do them. See:
  
their installation steps, then now is the time to go back and do them. See:
−
* [[ #Install the Globalyzer Client/Workbench on the i18n Specialists' Machine(s) ]]
 +
* [[ #Install the Globalyzer Client/Workbench on i18n Specialists' Machines]]
−
* [[ #Install Globalyzer Lite on The Developer Machine ]]
 +
* [[ #Install Globalyzer Lite on the Developer Machines ]]
−  
−  
−
== The Developer Machine ==
  
−
TODO: LITE VS WORKBENCH
  
−
The individual Developer machine is where you install the Globalyzer Workbench
  
−
so that internationalization and localization issues can be addressed.
  
−  
−
==== Prerequisites ====
  
−
* Install Java 7 JDK or greater. The JDK is required by Globalyzer.
  
−
* '''MySQL 5.1''' or greater (optional).
  
−
** The Globalyzer Client can use either '''MySQL''' or '''HSQLDB'''. If you choose MySQL, you will need '''MySQL 5.1''' or greater. If you choose HSQLDB, you do not need to install anything.
  
−  
−
==== Installation ====
  
−
* Install the '''Globalyzer Client'''.
  

Latest revision as of 20:28, 11 July 2018

Contents

Read Me First

The following are instructions for installing the Globalyzer Suite.

Depending on what deployment scenarios you choose, you may not need to perform all of the following steps. If a step is not listed as relevant to your deployment scenario, you may skip over it. However, unless otherwise noted, the instructions are meant to be followed in sequential order. If you skip ahead of a relevant step, then things will break! For the same reason, it would be wise to troubleshoot any issues that you encounter in a section before moving on to the next.

You'll want to take a moment to read over the table of contents summary for the Installation Steps (see above) before proceeding.

You may otherwise read the instructions as you go.

Installation Steps

Read over the Lingoport Suite Systems Guide

If you haven't already, see the Lingoport Suite Systems Guide (TODO: create systems guide from information on the Lingoport Suite Installation page). Do not proceed until you feel that you understand it.

Decide On Your Deployment Scenario(s)

If you haven't already, see the Deployment Scenarios document. Do not proceed until you have decided on one or more deployment scenarios. Be sure that you understand the deployment scenario(s) you have chosen.

Consider A Couple Notable Prerequisites

Most of the prerequisites for the upcoming steps are fairly straightforward. However, a couple of them might be worth a pause. Here are some prerequisites to be particularly aware of:

LRM requires that the The Build Server use Linux

If you're not planning on using LRM, but there's some chance that you'll change your mind, it's still probably wise to use Linux for the build server. Otherwise you'd need to reinstall all of the build server components on a Linux machine later (what a pain).

Dashboard requires that the The Dashboard Server use MySQL 5.6 or greater

The Following Deployment Scenarios Require A Version Control System

Previous clients have used Git, Subversion, Team Foundation Server and even FTP. If you wish to use a different version control system, check with Lingoport first to insure compatibility.

If you're only looking to set up a sandbox style environment to evaluate components of the Lingoport Suite, then a version control system is not strictly necessary. However, the installation process becomes more complicated without one. If you choose to avoid using a version control system, please check in with Lingoport to avoid getting stuck later.

These prerequisites will be mentioned again in the sections where they are relevant.

Install the Globalyzer Server (optional)

Deployment Scenarios

Installation

This is an optional step. You company may have elected to use Lingoport's Globalyzer Server at www.globalyzer.com.

If you are performing this step, you should receive detailed instructions along with your Globalyzer Server installation files. Pay special attention to Globalyzer_Server_Setup&Admin_<version>.doc.


Verification

TODO: Add a verification step after each installation step.

Post Install

TODO: They need a license, username, and account!

Install the Globalyzer Client/Workbench on i18n Specialists' Machines

This section may be completed at any time after the Globalyzer Server has been setup and verified. We recommend doing it now. That way the i18n specialists at your company may begin work on crafting rule sets while you perform the rest of the installation.

If you don't want to do it now, don't worry. There will be a reminder to come back here at the end of this document.

Deployment Scenarios

This is directly necessary for the Globalyzer Workbench for i18n Specialists deployment scenario. The other scenarios that use Globalyzer also require this by proxy, since they will require you to craft rule sets:

Prerequisites

  • Java 7 JDK or greater. A JDK is required (do not use a JRE).
  • MySQL 5.6 or greater (optional).
    • The Globalyzer Client can use either MySQL or HSQLDB. If you choose MySQL, you will need MySQL 5.6 or greater. If you choose HSQLDB, you do not need to install anything.

Installation

Log in to the Globalyzer Server (either www.globalyzer.com or your own internal server) and click the Client download link at the bottom of the page. Read and follow the instructions. You may install with any configuration - with or without the optional packages.

TODO: Login stuff

Verification

Open the Globalyzer Workbench and enter valid login credentials to the server. If you don't currently know any login credentials you'll either need to:

  • Use your admin account on the Globalyzer Server to create a user (If you've installed the server yourself)
  • Refer to the credentials Lingoport has given you (If you are using www.globalyzer.com.

If you're able to log in successfully, you should be good to go.

Post Installation

Now may be a good time to have i18n specialists begin crafting rule sets. That way they can work in parallel while you complete the rest of the installation.

Install Globalyzer Lite on the Developer Machines

This step may be performed at any time during or after the rest of the installation.

If you don't want to do it now, don't worry. There will be a reminder to come back here at the end of this document.

Deployment Scenarios

Prerequisites

Installation

Unzip the globalyzer-lite-#.#.#.zip file at a location of your choosing. (# = version number).

From the globalyzer-lite-#.#.# directory, run either:

  • install-lite.sh (Linux)
  • install-lite.bat (Windows).

Verification

This step is optional.

If you have not yet created a rule set on the Globalyzer Server, create one. (Again, Lingoport's is at www.globalyzer.com). Pick a language based on the source code present on the developer machine (If no language is present, hop on github and copy a source file from your favorite repository).

Next, create a simple Project Definition xml file using the rule set. See the README for a template. Point it at a directory containing some code. Now execute Lite: java -jar globalyzer-lite.jar TheProjectDefinitionFileYouCreated.xml

Lite should run. No errors should occur. A report should be generated at the report location you have specified. Don't worry if the report contains no issues, or contains false positives. The rule set may need to be fine tuned, or the file may contain no i18n issues.

Post Installation

A README file in the globalyzer-lite-#.#.# directory contains basic instructions for using Globalyzer Lite.

Check the [Globalyzer Lite Help Pages] for more detailed instructions.

TODO: add a verification step TODO: add a what to do after step (reference docs on globalyer.com)

Setup the Build Server

Deployment Scenarios

It may also be necessary for the following:

Although custom modifications will be needed based on your currently setup code gate(s) / build systems. These modifications can vary significantly, and are beyond the scope of this document.

Base Prerequisites for the Build Server

There are several options here. Before proceeding, install the following prerequisites. They are necessary regardless of which option you pick.

The following are necessary for

  • The OS for the build server must be Linux, preferably Ubuntu.
    • If you are 100% sure you will not be using LRM, this is not required. However, if there's a chance you might want to use it later, it's probably best to stick with Linux. Otherwise you might have to migrate the entire build server setup from Windows to Linux later (what a pain).
  • Java 7 JDK or greater. The JDK is required by Globalyzer.
  • A Version Control System Client
    • Previous clients have used Git, Subversion, Team Foundation Server and even FTP.
    • If you wish to use a different version control system, check with us first. It should still probably work, but will need to be integrated with Jenkins.
    • TODO add link to Git (from Installation and Configuration)
    • TODO maybe add a page and link for [[SVN]
  • Jenkins -v 1.625.2 LTS or 1.638 or greater.
    • Jenkins, a continuous integration tool, is required. Jenkins enables nightly scanning and scheduled Dashboard updates. Additionally, Jenkins scripts, added as part of the LRM configuration, enable round-trip automation for managing resource files.

Install a Continuous Globalization Setup on the Build Server

Deployment Scenarios

Choose one of the three following installations:

  1. #Option 1: Globalyzer Lite
  2. #Option 2: Globalyzer CLI
  3. #Option 3: Custom Globalyzer API Setup

Option 1: Globalyzer Lite

For the Globalyzer Lite for Continuous Globalization scenario.

Prerequisites

See #Base Prerequisites for the Build Server

Installation

Acquire a copy of the globalyzer-lite-#.#.#.zip file (# = version numbers). Unzip the zip file at a location where jenkins has full permissions to access

  • If it exists, /home/jenkins/ is good.
  • Alternatively, create a 'lingoport' directory under /var/lib/jenkins/ and unzip there.

Unzipping will create a globalyzer-lite-#.#.# directory. Cd to the globalyzer-lite-#.#.# directory, then run 'install-lite.sh'.

Verify that the jenkins user has full permissions globalyzer-lite-#.#.# directory and its contents before continuing.

Verification

Now is a good time to double check that the 'jenkins' user has full permissions to Lite's install directory.

You may also want to run a test-scan with Lite as the jenkins user. Put some source code on your machine, and create a rule set for the appropriate programming language on the Globalyzer Server (Again, Lingoport's server is at www.globalyzer.com). A newly created rule set is fine for now. Or you may use any previously created one.

Next, follow Lite's README's instructions for setting up a project definition file. Log in as the jenkins user, then execute Lite.

java -jar globalyzer-lite.jar YourProjectDefinitionFile.xml

Check that Lite does not encounter any errors and successfully generated a report. Don't worry if the report has false positives, or is empty. The code may not contain i18n issues, and the rule set may need to be fine tuned.

Option 2: Globalyzer CLI

For the Globalyzer CLI for Continuous Globalization scenario.

TODO: remove this if not needed (depending on Mary's response). Note: This step is only necessary if you did not already install the Globalyzer Client in a location where the 'jenkins' user has full permissions to it.

Prerequisites

Installation

Log in to the Globalyzer Server and click on the Client download link at the bottom of the (post login) page. If you have not configured your own Globalyzer Server, use www.globalyzer.com.

Follow the instructions on the page reached from the client download link. Note that if you have a copy of the Globalyzer Client installer in your downloads folder, you may use it again. Take special care to:

  • Install the Globalyzer Client in a location where the 'jenkins' user will have full permissions.
    • You may wish to install the client as the 'jenkins' user.
  • Install all optional packages (Globalyzer CLI, Globalyzer Ant Tasks). They will be installed by default.

Verification

Now is a good time to double check that the 'jenkins' user has full permissions to the Client's install directory.

You may also attempt to scan some source code. See the Globalyzer Command Line Client Reference. You'll first want to log in (you'll need a username and password on the Globalyzer Server). Then you'll want to scan your code (see "Scan Command and Options").

Option 3: Custom Globalyzer API Setup

Prerequisites

See #Base Prerequisites for the Build Server

Installation

For the Globalyzer API for Continuous Globalization scenario.

This option offers a lot of power, and may take on a variety of forms.

may be set up at your own discretion. You will quite possibly (but not necessary) want to set up MySQL 5.6 (or greater) for use with the Globalyzer API.

TODO: Go to [| www.globalyzer.com ] and read up on the API

Verification

Now that you've set up program(s) to utilize the API, check that it/they can scan source code and generate reports. Make sure they're runnable by the 'jenkins' user.

Install the Lingoport Resource Manager Server on the Build Server

Deployment Scenarios

Prerequisites

All #Base Prerequisites for the Build Server

  • The OS for the build server must be Linux, preferably Ubuntu.

Pre-Installation

You will probably want to be familiar with the pages under About LRM before continuing. It's good to know what you are dealing with.

Installation

The LRM Installation is a complicated process. Follow the instructions under LRM Installation and Configuration.

Verification

TODO

Setup the Dashboard Server System

Deployment Scenarios

It is also recommended for:


Prerequisites

Installation

See the Dashboard Installation page for the full instructions.

Verification

Open a web browser on any computer within the same network as the Dashboard Server and browser to the server url/ip followed by the dashboard's port if necessary. The Dashboard page should load.

If you're typing in an IP, it should look something like this: 10.1.10.235
Alternatively the server url might look something like this: devlingo

TODO: Installing the Dashboard Client

Finishing Up

If you installed either LRM or the dashboard, but did not get through all of their configuration steps, now is the time to go back and complete these steps.

If you plan to use the Globalyzer Workbench and/or Globalyzer Lite, but skipped their installation steps, then now is the time to go back and do them. See:

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