View source for Dashboard Installation 5.6.x

=Lingoport Dashboard Components=
The Lingoport Dashboard, built on the [http://www.sonarqube.org/ 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 <b>Server</b>, which displays the results of Globalyzer scans and/or the Lingoport Resource Manager status in a web browser.
*A <b>Client</b>, which analyzes source code with Globalyzer and/or with LRM and uploads the information to the Dashboard Server for display.
<p></p>

=Installing the Dashboard Server =

'''The recommended method for installing the Lingoport Dashboard is to do it as part of the [[Terms_and_Definitions#stackinstaller|Stack Installer]].'''  If that method is not practical, follow the installation steps.
  
The <b>Dashboard Server</b> 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:
<OL>
<LI>Read the [[Introduction|Lingoport Suite Installation]] section, which describes how all the Lingoport applications work together. Pay close attention to the the hardware and [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|software configuration requirements]].</LI>
<LI>Select a target machine that has the <b>[[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|supported Linux Operating System]]</b></LI>
<LI>Install [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|supported <b>Java JDK</b>]] on the target machine. You can check your Java version using the command line. At the command prompt enter:<br> 
<code>java -version</code><br />
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.</LI>

<LI>Install [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|<b>MySQL</b>]] 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:
: <code>mysql -u <user> -p<password></code>

* 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 [http://dev.mysql.com/downloads 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.</LI>

<LI> Determine <b>the port</b> 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.</LI>

<LI>Download the installer jar file <code>Lingoport_Dashboard_Server-<x.x>-Installer.jar</code> (See support@lingoport.com if you don't have that information. It should have been sent in an email based on your license. )</LI>
</OL>

== Installation ==
Once you have ensured that all requirements are met, run the Dashboard Server installer.
===Installing for the First Time===
* Double-click on the <code>Lingoport_Dashboard_Server-<x.x>-Installer.jar</code> file, or
* From the command line, cd to the directory with the installer and type: 
: <code>java –jar Lingoport_Dashboard_Server-<x.x>-Installer.jar</code>
* Installation steps:
** '''Installation Path''': Leave this as the default if possible.[/var/lib/jenkins/lingoport/dashboard-server-x.x.x]
** '''MySQL Database Connection''': This defaults to the current host but very that port is correct and enter the root username and password
** '''Lingoport Dashboard MySQL Database''': Select (1) this if this is the first installation, otherwise select 0. 
** '''MySQL Lingodash Database''':  Keep the default values of lingodashuser and lingodashpwd for the new database
** '''Lingoport Dashboard Server Connection''': Leave 9000 and 9001 as the default server connections.  
** '''Select Installation Packages''': Install all packages.

===Updating Your Existing Installation===

# Stop the dashboard:
#: <code>&lt;dashboard-install-location&gt;/bin/linux_x86_64/sonar.sh stop</code>
# use <code>ps aux | grep "dashboard"</code> to confirm that the dashboard has stopped.
# Back up the database with <code>mysqldump <db_name> --user=<username> --password > <output file name> </code> 
# (Version 5.6 only):
## Retrieve a copy of the file 'sonarqube-5.6.3.zip'.
##* This file can be found in the stack installer's components folder. Or requested from Lingoport.
## Unzip the sonarqube-5.6.3.zip file under <code>/var/lib/jenkins/lingoport</code>
## This will create a directory <code>'sonarqube-5.6.3'</code> <code>(/var/lib/jenkins/lingoport/sonarqube-5.6.3)</code>. Rename the directory to be <code>'dashboard-server-5.6.1'</code> <code>(/var/lib/jenkins/lingoport/dashboard-server-5.6.1)</code>.
# From the command line, cd to the directory with the installer jar file and type:
#:<code>java –jar Lingoport_Dashboard_Server-<x.x>-Installer.jar</code>
# Make sure you do not overwrite the dashboard database.

See the section on <b>Upgrading the Dashboard Client</b> for additional upgrade instructions.

===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 <code>/var/lib/jenkins/lingoport/dashboard-server-x.x.x/logs/sonar.log</code> 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 <code>/var/lib/jenkins/lingoport/dashboard-server-5.6.1/conf/sonar.properties</code> 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:
: <code>http://<hostname>:<port></code>

For example, displaying the Dashboard on the local system with the default port 9000:
: <code>http://localhost:9000</code>
You should see the Lingoport Dashboard web page. If, instead, you see the message <i>'Sonarqube is under maintenance. Please check back later'</i>, then you need to follow the migration steps below.

[[File: maintenance.jpg|center|500px]]


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


[[File: setup.jpg|center|500px]]


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

[[File:dashboard_install.jpg|center|500px]]

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

===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.
: <code>mysql -u root -p[password]</code>
*Execute this command to remove the wildcard host for the dashboard user:
: <code>DROP USER '<lingoport dashboard user>'@'%';</code>
*Execute this command to make sure you now see just the Lingoport Dashboard user for localhost:
: <code>select user,host from mysql.user;</code>

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:
: <code>GRANT ALL PRIVILEGES ON <database>.* TO '<Dashboard User>'@'%' IDENTIFIED BY '<pwd>';</code>

=Installing the Dashboard Client =
The best way to install the Lingoport Dashboard Client is with the [[Terms_and_Definitions#stackinstaller|Stack Installer]]. If that is not feasible, follow these manual instructions. 
 
Run the client installer after the server is <i>installed and running</i>. 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.

<b>Note</b>: 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:
<OL>
<LI>Read the [[Introduction|Lingoport Suite Installation Overview]] section, which describes how all the Lingoport applications work together and the hardware and [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|software configuration requirements]].</LI>
<LI>Select a target machine that has a [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|<b>supported Linux Operating System</b>]]</LI>
<LI>Install [[Introduction#Current_versions_of_Lingoport_products_and_supporting_applications|<b>Java JDK</b>]] on the target machine. You can check your Java version using the command line. At the command prompt enter: 
<code>java -version</code>
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.</LI>

<LI>The Dashboard Server has been started and is accessible from the target machine (see the Running the Dashboard Server section above). Start <pre>http://localhost:9000</pre></LI>

<LI> Know the Globalyzer Client installation directory, if installed. Typically, this is <code>/var/lib/jenkins/globalyzer-x.y</code></LI>

<LI>Know the LRM Server installation directory, if installed. This is generally: <code>/var/lib/jenkins/lingoport/lrm-server-x.y</code></LI>

<LI>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'''</LI>
<LI>Know the Dashboard Server connection port number that you entered when you installed the Dashboard Server. The default value is '''9000'''.</LI>
<LI>Downloaded the installer jar file Lingoport_Dashboard_Client-<x.x>-Installer.jar</LI>
</OL>

== Installation ==
===Installing for the First Time===
* Double-click on the <code>Lingoport_Dashboard_Client-<x.x>-Installer.jar</code> file, or
* From the command line, cd to the directory with the installer and type: 
: <code>java –jar Lingoport_Dashboard_Client-<x.x>-Installer.jar</code>
* Installation items
** '''Target Path''': Keep the default which is <code>/var/lib/jenkins/lingoport/dashboard-client-x.y.z</code>
** '''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:  <code>https://www.globalyzer.com/gzserver</code>
** '''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: <code>/var/lib/jenkins/globalyzer-x.y.z/</code>
** '''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:
: <code>java –jar Lingoport_Dashboard_Client-<x.x>-Installer.jar</code>
* 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.
<p></p>

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