Difference between revisions of "Lingoport Suite Installation Instructions"
Line 1: | Line 1: | ||
+ | = Things to Understand = |
||
− | |||
− | = 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 |
||
to take a moment to read over the Installation and Upgrade Order below before |
to take a moment to read over the Installation and Upgrade Order below before |
||
Line 16: | Line 15: | ||
− | = Installation and Upgrade Order |
+ | = Installation and Upgrade Order = |
# If you haven't already, read over the [[Lingoport Suite Systems Guide]] |
# If you haven't already, read over the [[Lingoport Suite Systems Guide]] |
||
Line 30: | Line 29: | ||
+ | = Installation Steps = |
||
− | = 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]]. Do not |
||
Line 43: | Line 42: | ||
− | == Install |
+ | == Install the Globalyzer Server (optional) == |
==== Deployment Scenarios ==== |
==== Deployment Scenarios ==== |
||
* [[Globalyzer Workbench for i18n Specialists]] |
* [[Globalyzer Workbench for i18n Specialists]] |
||
Line 130: | Line 129: | ||
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 |
+ | == 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. |
||
Line 256: | Line 255: | ||
− | == Setup the |
+ | == Setup the Dashboard Server System == |
==== Deployment Scenarios ==== |
==== Deployment Scenarios ==== |
||
* [[Globalyzer Lite for Continuous Globalization]] |
* [[Globalyzer Lite for Continuous Globalization]] |
||
Line 287: | Line 286: | ||
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' Machines]] |
* [[ #Install the Globalyzer Client/Workbench on the i18n Specialists' Machines]] |
||
− | * [[ #Install Globalyzer Lite on |
+ | * [[ #Install Globalyzer Lite on the Developer Machines ]] |
Revision as of 19:58, 16 October 2015
Contents
- 1 Things to Understand
- 2 Installation and Upgrade Order
- 3 Installation Steps
- 3.1 Read over the Lingoport Suite Systems Guide
- 3.2 Decide On A Deployment Scenario
- 3.3 Install the Globalyzer Server (optional)
- 3.4 Install the Globalyzer Client/Workbench on the i18n Specialists' Machines
- 3.5 Install Globalyzer Lite on the Developer Machines
- 3.6 Setup the Build Server
- 3.7 Install a Continuous Globalization Setup on the Build Server
- 3.8 Install the Lingoport Resource Manager Server on the Build Server
- 3.9 Setup the Dashboard Server System
- 4 Finishing Up
Things to Understand
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
- 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 on The Developer Machines, allowing your developers to begin their i18n work with it.
- If you have Globalyzer Lite, you can install that on #The Developer Machines in addition / instead. (See Globalyzer Lite:Lite vs the Globalyzer Workbench)
- Install/Upgrade the LRM Server on #The Build Server
- Install/Upgrade the Dashboard Server on #The Dashboard Server System
- Install/Upgrade the Dashboard Client on #The Build Server
Installation Steps
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
- Globalyzer Workbench for i18n Specialists
- Globalyzer Lite for Developers
- Globalyzer Lite for Continuous Globalization
- Globalyzer CLI for Continuous Globalization
- Globalyzer API for Continuous Globalization
- Globalyzer and Check in Verification
- Continuous Globalization
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.
If you don't 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:
- Globalyzer Workbench for i18n Specialists
- Globalyzer Lite for Developers
- Globalyzer Lite for Continuous Globalization
- Globalyzer CLI for Continuous Globalization
- Globalyzer API for Continuous Globalization
- Globalyzer and Check in Verification
- Continuous Globalization
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 Machines
This step may be performed at any time during or after the rest of the installation.
If you don't do it now, don't worry. There will be a reminder to come back here at the end of this document.
Deployment Scenarios
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
- Globalyzer Lite for Continuous Globalization
- Globalyzer CLI for Continuous Globalization
- Globalyzer API for Continuous Globalization
- LRM for Continuous Globalization
- Continuous Globalization
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
- Globalyzer Lite for Continuous Globalization
- Globalyzer CLI for Continuous Globalization
- Globalyzer API for Continuous Globalization
- Continuous Globalization
Choose one of the three following installations:
- Globalyzer Lite
- For the Globalyzer Lite for Continuous Globalization scenario.
- Globalyzer CLI
- For the Globalyzer CLI for Continuous Globalization scenario.
- Custom Globalyzer API Setup
- For the Globalyzer API for Continuous Globalization scenario.
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
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 Dashboard Server System
Deployment Scenarios
- Globalyzer Lite for Continuous Globalization
- Globalyzer CLI for Continuous Globalization
- Globalyzer API for Continuous Globalization
- LRM for Continuous Globalization
- Continuous Globalization
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:
- #Install the Globalyzer Client/Workbench on the i18n Specialists' Machines
- #Install Globalyzer Lite on the Developer Machines
The Developer Machines
TODO: LITE VS WORKBENCH The Developer machines are 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.