Difference between revisions of "Lingoport Suite Installation Instructions"

From Lingoport Wiki
Jump to: navigation, search
Line 1: Line 1:
  +
  +
 
= Installation of the Globalyzer Suite =
  
= Installation of the Globalyzer Suite =
 
The following are instructions for installing the Globalyzer Suite. You'll want
  
The following are instructions for installing the Globalyzer Suite. You'll want
Line 12: Line 14:
 
wise to troubleshoot any issues that you encounter in a section before moving on
  
wise to troubleshoot any issues that you encounter in a section before moving on
 
to the next.
  
to the next.
  +
   
 
= Installation and Upgrade Order and Overview =
  
= Installation and Upgrade Order and Overview =
Line 25: Line 28:
 
# Install/Upgrade the Dashboard Server on [[#The Dashboard Server System]]
  
# Install/Upgrade the Dashboard Server on [[#The Dashboard Server System]]
 
# Install/Upgrade the Dashboard Client on [[#The Build Server]]
  
# Install/Upgrade the Dashboard Client on [[#The Build Server]]
  +
   
 
= Full Instructions =
  
= Full Instructions =
Line 56: Line 60:
 
Globalyzer_Server_Setup&Admin_<version>.doc.
  
Globalyzer_Server_Setup&Admin_<version>.doc.
   
  +
<!--
−  
 
NEEDS REVISING == Test the Globalyzer Server by Installing the Globalyzer Client/Workbench ==
  
NEEDS REVISING == Test the Globalyzer Server by Installing the Globalyzer Client/Workbench ==
 
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 browser a sufficient condition to confirm that the Globalyzer Server is working? (Ask Mary)
Line 72: Line 76:
 
NEEDS REVISING [http://www.globalyzer.com www.globalyzer.com]). This is a good test that you
  
NEEDS REVISING [http://www.globalyzer.com www.globalyzer.com]). This is a good test that you
 
NEEDS REVISING can connect to the Server, and that the server is working.
  
NEEDS REVISING can connect to the Server, and that the server is working.
  +
  +
NEEDS REVISING Once the Workbench is installed, follow the instructions on the install page to
  +
NEEDS REVISING start it. A login prompt will open. If you've installed the Globalyzer Server
  +
NEEDS REVISING internally, open the "Connections" tab and change the server URL to point to
  +
NEEDS REVISING your Globalyzer Server. Enter your credentials and attempt to log in.
  +
NEEDS REVISING
  +
NEEDS REVISING If the login is successful, and Globalyzer opens without any error dialogues,
  +
NEEDS REVISING then this indicates that both the Globalyzer Client and Globalyzer Server are
  +
NEEDS REVISING working properly. If you've installed the Globalyzer Server internally, well
  +
NEEDS REVISING done! Otherwise, this is still useful confirmation that you can connect to and
  +
NEEDS REVISING use [http://www.globalyzer.com www.globalyzer.com].
  +
NEEDS REVISING
  +
NEEDS REVISING If the login is not successful, then you'll need to troubleshoot why. It's
  +
NEEDS REVISING probably best to double check your login and connection information before
  +
NEEDS REVISING proceeding into deeper troubleshooting.
  +
-->
   
 
== Install the Globalyzer Client/Workbench on the i18n Specialists' Machines==
  
== Install the Globalyzer Client/Workbench on the 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.
  +
 
==== Deployment Scenarios ====
  
==== Deployment Scenarios ====
 
This is directly necessary for the [[Globalyzer Workbench for i18n Specialists]]
  
This is directly necessary for the [[Globalyzer Workbench for i18n Specialists]]
Line 85: Line 110:
 
* [[Globalyzer and Check in Verification]]
  
* [[Globalyzer and Check in Verification]]
 
* [[Continuous Globalization]]
  
* [[Continuous Globalization]]
−  
−
This may be done at any time after the Globalyzer Server has been set up and the
  
−
connection has been verified. You may wish to do it now, however, so that the
  
−
i18n specialists can begin crafting rule sets while you set up the rest of your
  
−
infrastructure.
  
   
 
==== Prerequisites ====
  
==== Prerequisites ====
Line 106: Line 126:
 
Now may be a good time to have i18n specialists begin crafting rule sets. That
  
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.
  
way they can work in parallel while you complete the rest of the installation.
−  
−
== Setup a Method for Performing Globalyzer Scans on the Build Server ==
  
−
==== Deployment Scenarios ====
  
−
This is necessary if you intend to use any
  
−
[[Deployment Scenarios | Deployment Scenario(s)]] that involve a regular build
  
−
process.
  
−  
−
Relevant deployment scenarios:
  
−
* [[Globalyzer Lite for Continuous Globalization]]
  
−
* [[Globalyzer CLI for Continuous Globalization]]
  
−
* [[Globalyzer API for Continuous Globalization]]
  
−
* [[Continuous Globalization]]
  
−  
−
It may also be necessary for the following:
  
−
* [[globalyzer and check in verification]]
  
−
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.
  
−  
−
==== Prerequisites ====
  
−
* '''Java 7 ''JDK'' ''' or greater. The JDK is required (do not use the JRE).
  
−
* '''MySQL 5.1''' or greater (optional). TODO: not needed for Lite
  
−
** 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 ====
  
−
On the Build Server, 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 [http://www.globalyzer.com www.globalyzer.com].
  
−  
−
Note:
  
−
: If you will be using the Globalyzer CLI from the build server, and Jenkins is already installed, then you may with to install the Globalyzer Client somewhere that the 'jenkins' user has full permissions to. You may even wish to install it as the jenkins user. This is completely optional at this point, but will save you from needing to re-install the workbench later on.
  
−  
−
: If you're using either Globalyzer Lite, or the Globalyzer API instead, then do not worry about this.
  
−  
−
Follow the instructions on the download page. If you're trying to make the
  
−
install accessible to the jenkins user, <!-- TODO: worry about this part later! -->
  
−
then be sure to include all optional
  
−
packages (Globalyzer CLI, Globalyzer Ant Tasks). They will be installed by
  
−
default.
  
−
<!-- TODO: Are the ANT tasks needed if using Lite/The Globalyzer API (both ant tasks and the CLI are optional when using the API) -->
  
−  
−
Once the Workbench is installed, follow the instructions on the install page to
  
−
start it. A login prompt will open. If you've installed the Globalyzer Server
  
−
internally, open the "Connections" tab and change the server URL to point to
  
−
your Globalyzer Server. Enter your credentials and attempt to log in.
  
−  
−
If the login is successful, and Globalyzer opens without any error dialogues,
  
−
then this indicates that both the Globalyzer Client and Globalyzer Server are
  
−
working properly. If you've installed the Globalyzer Server internally, well
  
−
done! Otherwise, this is still useful confirmation that you can connect to and
  
−
use [http://www.globalyzer.com www.globalyzer.com].
  
−  
−
If the login is not successful, then you'll need to troubleshoot why. It's
  
−
probably best to double check your login and connection information before
  
−
proceeding into deeper troubleshooting.
  
−  
   
 
== Install Globalyzer Lite on The Developer Machine ==
  
== Install Globalyzer Lite on The Developer Machine ==
Line 211: Line 175:
   
 
== Install a Continuous Globalization Setup on the Build Server ==
  
== Install a Continuous Globalization Setup on the Build Server ==
  +
==== Deployment Scenarios ====
 
For any of the following deployment scenarios:
  
For any of the following deployment scenarios:
 
* [[Globalyzer Lite for Continuous Globalization]]
  
* [[Globalyzer Lite for Continuous Globalization]]
Line 281: Line 246:
 
* [[Continuous Globalization]]
  
* [[Continuous Globalization]]
   
  +
==== 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.

Revision as of 19:46, 16 October 2015


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


Installation and Upgrade Order and Overview

  1. If you haven't already, read over the Lingoport Suite Systems Guide
  2. If you haven't already, decide on one or more Deployment Scenarios.
  3. Install/Upgrade The Globalyzer Server
  4. Install The Build Server pre-requisites.
  5. 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.
  6. Install/Upgrade the LRM Server on #The Build Server
  7. Install/Upgrade the Dashboard Server on #The Dashboard Server System
  8. Install/Upgrade the Dashboard Client on #The Build Server


Full Instructions

Read over the Lingoport Suite Systems Guide

If you haven't already, see the Lingoport Suite Systems Guide. Do not proceed until you feel that you understand it.


Decide On A Deployment Scenario

If you haven't already, see the Deployment Scenario 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.


Install The Globalyzer Server (optional)

Deployment Scenarios

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.


Install the Globalyzer Client/Workbench on the 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.

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

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.

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 Machine

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

Deployment Scenarios

This is necessary for the following deployment scenario:

Prerequisites

  • Java 7 JRE or greater.

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


Setup the Build Server

Deployment Scenarios

This is necessary for the following 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

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.
  • 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).
  • Jenkins 1.620 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

For any of the following deployment scenarios:

Choose one of the three following installations:

  1. Globalyzer Lite
  2. Globalyzer CLI
  3. Custom Globalyzer API Setup

Option 1: Globalyzer Lite

For the Globalyzer Lite for Continuous Globalization scenario.

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.

Option 2: Globalyzer CLI

For the Globalyzer CLI for Continuous Globalization scenario.

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 Client in a location where the 'jenkins' user has full permissions to it.

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.

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

Option 3: Custom Globalyzer API Setup

For the Globalyzer API for Continuous Globalization scenario.

This options is nebulous, and may be set up at your own discretion. You will quite possibly (but not necessary) want to set up MySQL 5.1 (or greater) for use with the Globalyzer API.

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


Install the Lingoport Resource Manager Server on the Build Server

Deployment Scenarios

This is necessary for the following deployment scenarios:

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.

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


Setup the The Dashboard Server System

Deployment Scenarios

This is necessary for the following deployment scenarios:

It is also recommended for:


Prerequisites

  • MySQL 5.1 or greater.
  • Java 7 JRE or greater.

Installation

See the Dashboard Installation page for the full instructions.


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:


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.
Retrieved from "http://wiki.lingoport.com/index.php?title=Lingoport_Suite_Installation_Instructions&oldid=87575"