Dashboard Installation

Email support at lingoport.com

The Dashboard client and server are part of the standard Stack Installer and Stack Updater installations. If you would like to set up a specific Dashboard outside of the standard installations, you may want to contact support at lingoport.com to help you with the specific steps.

Previous Versions 5.6.x

Dashboard Installation 5.6.x

Lingoport Dashboard Components

The Lingoport Dashboard, built on the SonarQube platform, helps you track and share the progress of your globalization effort company-wide, by displaying both high-level and detailed views of your Globalyzer Project Scan data and your Lingoport Resource Manager (LRM) status information.

The Lingoport Dashboard is composed of two components:

• A Server, which displays the results of Globalyzer scans and/or the Lingoport Resource Manager status in a web browser.
• A Client, which analyzes source code with Globalyzer and/or with LRM and uploads the information to the Dashboard Server for display.

Installing the Dashboard Server

The recommended method for installing the Lingoport Dashboard is to do it as part of the Stack Installer. If that method is not practical, follow the installation steps.

The Dashboard Server installation creates a MySQL database which is accessed by the Dashboard Client installations.

Prerequisites

Before installing the Dashboard Server, check that you have met the following requirements:

1. Read the Lingoport Suite Installation section, which describes how all the Lingoport applications work together. Pay close attention to the the hardware and software configuration requirements.
2. Select a target machine that has the supported Linux Operating System
3. Install supported Java JDK on the target machine. You can check your Java version using the command line. At the command prompt enter:
   java -version
   The version of Java which you have on your system should be displayed. If you need to install Java, please refer to http://www.java.com/en/download/index.jsp or any Java download page which supplies the supported Java version.
4. Install MySQL on the Dashboard 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 at the supported version, 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 (username, password and port number) during the installation.
5. Determine the port you will use for connection to the Dashboard Server; the default is 9000. You will need to enter the connection port during the Dashboard Server installation.
6. Download the installer jar file Lingoport_Dashboard_Server-<x.x>-Installer.zip (See support@lingoport.com if you don't have that information. It should have been sent in an email based on your license. )

Installation

Once you have ensured that all requirements are met, run the Dashboard Server installer.

Installing for the First Time

• Unzip the Lingoport_Dashboard_Server-<x.x>-Installer.zip file, or
• From the command line, cd to the directory with the installer and type:

unzip Lingoport_Dashboard_Server-<x.x>-Installer.zip

• Installation steps:
  • MySQL Database Creation:

   1. Log in to MySQL as the user you will use for dashboard
   mysql -u username -p
   2. Create lingodash database
   CREATE DATABASE lingodash;

• Set conf/sonar.proerties: It's under dashboard-server-x.x.x/conf/sonar.properties. You need to setup

   sonar.jdbc.username=
   sonar.jdbc.password=
   sonar.jdbc.url=jdbc:mysql://localhost:[your_port] [your_database_name]?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false

   example: sonar.jdbc.url=jdbc:mysql://localhost:3306/ lingodash?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false

• Start Dashboard Server:

   Run <dashboard-install-location>/bin//linux-x86-64/sonar.sh start

Updating Your Existing Installation

If you already upgraded your system using lingoport-stack-updater, you need four more steps:

1. Browse to http://<hostname>:<port>/setup (note: the default dashboard installation does not use any port number, so it is http://<hostname>/setup) and click the 'upgrade' button
2. From the command line, cd to the (/var/lib/jenkins/lingoport/sonarqube-6.7.7/bin/linux-x86-64/) directory and type:

   ./sonar.sh stop

3. From the command line, cd to the (/var/lib/jenkins/lingoport/dashboard-server-7.8.1/bin/linux-x86-64/) directory and type:

   ./sonar.sh start

4. Browse to http://<hostname>:<port>/setup (or http://<hostname>/setup) and click the 'upgrade' button

Now your dashboard server has been upgraded.

If you hope to upgrade Dashboard Server without using lingoport-stack-updater, here are the steps

1. Stop the dashboard:

   <dashboard-install-location>/bin/linux_x86_64/sonar.sh stop

2. use ps aux | grep "dashboard" to confirm that the dashboard has stopped.
3. Back up the database with mysqldump <db_name> --user=<username> --password > <output file name>
4. Retrieve a copy of the file 'Lingoport_Dashboard_Server-7.8.1-Installer.zip' and 'sonarqube-6.7.7.zip'
   • These files can be found in the stack installer's components folder. Or requested from Lingoport.
5. Unzip the Lingoport_Dashboard_Server-7.8.1-Installer.zip file under /var/lib/jenkins/lingoport
6. Unzip the sonarqube-6.7.7.zip file under /var/lib/jenkins/lingoport
7. These will create two directories 'dashboard-server-7.8.1' (/var/lib/jenkins/lingoport/dashboard-server-7.8.1) and 'sonarqube-6.7.7' (/var/lib/jenkins/lingoport/sonarqube-6.7.7)
8. From the command line, cd to the (/var/lib/jenkins/lingoport/sonarqube-6.7.7) directory and type:

   vi conf/sonar.properties and modify it based on /var/lib/jenkins/lingoport/sonarqube-5.7.*/conf/sonar.properties

9. From the command line, cd to the (/var/lib/jenkins/lingoport/dashboard-server-7.8.1) directory and type:

   vi conf/sonar.properties and modify it based on /var/lib/jenkins/lingoport/sonarqube-5.7.*/conf/sonar.properties

10. From the command line, cd to the (/var/lib/jenkins/lingoport/sonarqube-6.7.7/bin/linux-x86-64/) directory and type:

    sonar.sh start

11. Browse to http://<hostname>:<port>/setup and click the 'upgrade' button

1. From the command line, cd to the (/var/lib/jenkins/lingoport/sonarqube-6.7.7/bin/linux-x86-64/) directory and type:

   sonar.sh stop

2. From the command line, cd to the (/var/lib/jenkins/lingoport/dashboard-server-7.8.1/bin/linux-x86-64/) directory and type:

   sonar.sh start

3. Browse to http://<hostname>:<port>/setup and click the 'upgrade' button

Now your dashboard server already upgraded.

Running the Dashboard Server

After installation, follow these steps to ensure that the server is running and can be successfully displayed:

• From the command line, cd to the bin directory of where you installed the Dashboard Server and then cd to the appropriate directory for your specific operating system. For example:

> cd /var/lib/jenkins/lingoport/dashboard-server-x.x.x/bin/linux-x86-64/

• On the Linux command line, enter:

> ./sonar.sh start
Starting SonarQube...
Started SonarQube.

> ./sonar.sh status
SonarQube is running (5497).

• Check the /var/lib/jenkins/lingoport/dashboard-server-x.x.x/logs/sonar.log file to make sure there are no errors.
  • It is possible that the connection port is being used by another process. In this case, you may either keep 9000 or 9090 for the Dashboard Server and kill the other process, or modify the Dashboard port number by adjusting the sonar.web.port property in the /var/lib/jenkins/lingoport/dashboard-server-7.8.*/conf/sonar.properties file.

sonar.web.port=9000

• To start the server, open a browser from the server system or another computer that has access to the server and enter:

http://<hostname>:<port>

For example, displaying the Dashboard on the local system with the default port 9000:

http://localhost:9000

You should see the Lingoport Dashboard web page. If, instead, you see the message 'Sonarqube is under maintenance. Please check back later', then you need to follow the migration steps below.

• Browse to http://localhost:9000/setup and click the 'upgrade' button

• Analyze your projects with the Dashboard Client in order to get fresh measures.

At this point, the server has been installed successfully and the Lingoport Dashboard Client can be installed.

Config Quality Gates

• To config your dashboard quality gates, please log in your account
• Click "Quality Gates" at the top menu bar
• Click "Create" button at the left side to create lingoport guality gate
• Name lingoport quality gate as Lingoport way, and save it
• Click "Add Condition" button at the right side
• Select "LRM # of Critical Resource Issues" as Metric, input 0 as Error number then click "Add Condition" button to save it
• Click "Add Condition" button at the right side
• Select "LRM Tanslation Issues" as Metric, input 0 as Error number then click "Add Condition" button to save it
• Click "Set as Default" button at top left to set lingoport guality gate as default

When You Want to Limit Dashboard Server Access

By default, the Dashboard Server allows installed Dashboard Clients on other machines to push Globalyzer scan and LRM status information to the Server. If instead you want only the Dashboard Client that is installed on the Dashboard Server local machine to be able to access the Dashboard Server, follow these steps:

• Log into MySQL on the system where you installed the Dashboard Server, as the root user.

mysql -u root -p[password]

• Execute this command to remove the wildcard host for the dashboard user:

DROP USER '<lingoport dashboard user>'@'%';

• Execute this command to make sure you now see just the Lingoport Dashboard user for localhost:

select user,host from mysql.user;

You can also be more specific about which hosts you will allow to remotely run the Dashboard Client and push status to the Dashboard database on the Dashboard Server. The following shows granting privileges to all hosts (i.e. undoing what we did above) – but you can change it to a specific host:

GRANT ALL PRIVILEGES ON <database>.* TO '<Dashboard User>'@'%' IDENTIFIED BY '<pwd>';

Installing the Dashboard Client

The best way to install the Lingoport Dashboard Client is with the Stack Installer. If that is not feasible, follow these manual instructions.

Run the client installer after the server is installed and running. Typically, the Dashboard Client is installed on a build system, where it can be run as part of a nightly build, pushing up Globalyzer and LRM status to the Dashboard Server.

Note: You will need to rerun the Dashboard Client installer whenever you upgrade the Globalyzer Client and/or the LRM Server.

Prerequisites

Before installing the Dashboard Client, check that you have met the following requirements:

1. Read the Lingoport Suite Installation Overview section, which describes how all the Lingoport applications work together and the hardware and software configuration requirements.
2. Select a target machine that has a supported Linux Operating System
3. Install Java JDK on the target machine. You can check your Java version using the command line. At the command prompt enter: java -version The version of Java which you have on your system should be displayed. If you need to install Java, please refer to http://www.java.com/en/download/index.jsp or any Java download page which supplies Java.
4. The Dashboard Server has been started and is accessible from the target machine (see the Running the Dashboard Server section above). Start

   http://localhost:9000

5. Know the Globalyzer Client installation directory, if installed. Typically, this is /var/lib/jenkins/globalyzer-x.y
6. Know the LRM Server installation directory, if installed. This is generally: /var/lib/jenkins/lingoport/lrm-server-x.y
7. Know the Host name and Port number to access the Dashboard database you set up when you installed the Dashboard Server. The hostname is localhost and the port defaults to 3306
8. Know the Dashboard Server connection port number that you entered when you installed the Dashboard Server. The default value is 9000.
9. Downloaded the installer jar file Lingoport_Dashboard_Client-<x.x>-Installer.jar

Installation

Installing for the First Time

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

java –jar Lingoport_Dashboard_Client-<x.x>-Installer.jar

• Installation items
  • Target Path: Keep the default which is /var/lib/jenkins/lingoport/dashboard-client-x.y.z
  • Dashboard Server Host: localhost
  • Dashboard Server Port: 9000
  • Globalyzer Settings: Select Globalyzer Settings if Globalyzer is installed.
  • Globalyzer Connection Settings: This is the URL for the Globalyzer Server that hosts your rulesets. If Lingoport hosts your rulesets, this will be: https://www.globalyzer.com/gzserver
  • Login: The login that is used to access the rulesets on the Globalyzer Server
  • Globalyzer Client Path: The path to the installed Globalyzer client on the current system. Often: /var/lib/jenkins/globalyzer-x.y.z/
  • Installation Packages: Install all packages.
• Follow instructions in the User's Guide (see Next Steps) to create a Dashboard project and upload data to the Dashboard Server.

Updating Your Existing Installation

If you are upgrading your Dashboard Client to a newer version, make sure that you update any scripts referencing the old version.

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

java –jar Lingoport_Dashboard_Client-<x.x>-Installer.jar

• If you are using Jenkins or another application to run the Dashboard Client as part of a continuous integration system, you may need to update the Dashboard references to point to the newly installed Dashboard Client.
• For each Dashboard Project, rerun the scripts to scan with Globalyzer and/or LRM and reload the data to the Dashboard.

Next Steps

If this is a new installation, you will need to configure your Dashboard Project and start displaying the status of your application's internationalization and localization efforts. For instructions on these and other capabilities, see the Dashboard User's Guide, located in the lingoport directory of your Server and Client installations.

Lingoport Customer Support

If you experience difficulties during the installation of the Lingoport Dashboard, please contact support@lingoport.com.