h5. Bundle installation
The Dashboard is packaged as a Matterhorn bundle, so it can be easily deployed in any Matterhorn installation. Since it depends on certain Matterhorn services to work, *it must be installed in the {{admin}} server*. In the following steps, {{$\{MH_SRC\}}} denotes the directory where the Matterhorn source code is, and {{$\{FELIX_HOME\}}} the directory where the Felix instance is installed (for Matterhorn versions under or equal to 1.3).
# Clone the necessary bundles from Teltek's Github into the {{$\{MH_SRC\}/modules}} directory.
{code:none}git clone git://github.com/teltek/galicaster-dashboard.git ${MH_SRC}/modules {code}
# Make sure your current Matterhorn version matches the one in the Dashboard {{pom.xml}} file:
#* Check your exact Matterhorn version by examining the first {{<version>}} tag within the {{$\{MH_SRC\}/pom.xml}} file.
#* Substitute that value in the {{<matterhorn.version>}} tags within the Dashboard {{pom.xml}} file.
#* You can do this in one step by running the following command from within the {{$\{MH_SRC\}/modules/galicaster-dashboard}} directory (the one you have just {{clone}}'d from git):
{code:none}
cd ${MH_SRC}/modules/galicaster-dashboard
sed -i "/<matterhorn.version>[^>]\+<\/matterhorn.version>/s//<matterhorn.version>$(grep -m 1 "<version>" ../../pom.xml | cut -d'>' -f2 | cut -d'<' -f1)<\/matterhorn.version>/" pom.xml
{code}
# Compile the bundles with Maven:
#* 1.3 and earlier:
{code:none}
cd ${MH_SRC}/modules/galicaster-dashboard
mvn clean install -DdeployTo=${FELIX_HOME}/matterhorn
{code}
#* 1.4 and above:
{code:none}
cd ${MH_SRC}/modules/galicaster-dashboard
mvn clean install -DdeployTo=${MH_SRC}
{code}
# If {{maven}} returns with no errors, the Dashboard should be available at:
{{http://your-server-url/dashboard/index.html}}.
h2. Configuration
The Dashboard service configuration file should be located in {{org.galicaster.dashboard.DashboardService.properties}}. It will not exist the first time you use the Dashboard, but the service will work correctly even if the file does not exist. Therefore, you may create the file only if you need to specify some of the configuration properties allowed by the service.
Those properties are:
* {{agent.<agent_name>.vnc.password}}: This property sets up the password required to establish a VNC connection with the agent {{<agent_name>}}.
* {{default.vnc.password}}: This property sets up a global password, which is only used when a certain agent's password is not explicitly defined.
The following example illustrates how the properties defined above are used:
When the Dashboard needs to establish a VNC connection with the agent {{GC-example}}, the password used will be, in that order:
# If defined, the value of {{agent.GC-example.vnc.password}}.
# If defined, the value of {{default.vnc.password}}.
# No password will be used.
{column}
{column:width=34%}
!button.png|align=center,width=250px!
{panel:bgColor=lightgreen|borderWidth=0}
{center}
h5. Table of contents
{center}
{toc:style=circle|maxLevel=3|printable=false}
{panel}
h4. Screencast
{widget:url=http://www.youtube.com/watch?v=9lo5YJljTtQ | width=100% }
h4. Screenshots
{center}
h5. Panel view - Mosaic layout
!panel_view.png|align=center,thumbnail,width=100%!
h5. Panel view - Table layout
!list_view.png|align=center,thumbnail,width=100%!
h5. Calendar view
!calendar_view.png|align=center,thumbnail,width=100%!
h5. Agent view
!agent_view.png|align=center,thumbnail,width=100%!
h5. Scheduler
!full_schedule.png|align=center,thumbnail,width=50%!
{center}
{column}{section}