Skip to content

Installation and Quick Start

Jump to bottom
Andrew Thanalertvisuti edited this page Jul 27, 2015 · 3 revisions

Requirements

  • A modern web browser. The latest version of Chrome and Firefox have been tested to work. Safari also works, except for the "Export to File" feature for saving dashboards. We recommend that you use Chrome or Firefox while building dashboards.
  • Solr 5 or 4 (Solr server's endpoint must be open, or a proxy configured to allow access to it).
  • A webserver (optional).

Installation Options

Run Banana Web App within your existing Solr instance

Solr 5 Instructions

  1. Run Solr at least once to create the webapp directory:

     cd $SOLR_HOME/bin/
 ./solr start

  2. Copy banana folder to $SOLR_HOME/server/solr-webapp/webapp/

  3. Browse to http://localhost:8983/solr/banana/src/index.html

Solr 4 Instructions

  1. Run Solr at least once to create the webapp directories:

     cd $SOLR_HOME/example
 java -jar start.jar

  2. Copy banana folder to $SOLR_HOME/example/solr-webapp/webapp/

  3. Browse to http://localhost:8983/solr/banana/src/index.html

NOTES: If your Solr server/port is different from localhost:8983, edit banana/src/config.js and banana/src/app/dashboards/default.json to enter the hostname and port that you are using. Remember that banana runs within the client browser, so provide a fully qualified domain name (FQDN), because the hostname and port number you provide should be resolvable from the client machines.

If you have not created the data collections and ingested data into Solr, you will see an error message saying "Collection not found at .." You can use any connector to get data into Solr. If you want to use LogStash, please go to the Solr Output Plug-in for LogStash Page for code, documentation and examples.

Complete SLK Stack

Lucidworks has packaged Solr, LogStash (with a Solr Output Plug-in), and Banana (the Solr port of Kibana), along with example collections and dashboards in order to rapidly enable proof-of-concepts and initial development/testing. See http://www.lucidworks.com/lucidworks-silk/.

Building and installing from a WAR file

Pull the source code of Banana version that you want from the repo with the release branch; For example, version 1.5.0 will be tagged as v1.5.0. Then run a command line "ant" from within the banana directory to build the war file.

cd $BANANA_REPO_HOME  
ant

The war file will be called banana-buildnumber.war and will be located in $BANANA_REPO_HOME/build

cp $BANANA_REPO_HOME/build/banana-buildnumber.war $SOLR_HOME/example/webapps/banana.war   
cp $BANANA_REPO_HOME/jetty/banana-context.xml $SOLR_HOME/example/contexts/

Run Solr:

cd $SOLR_HOME/example/
java -jar start.jar

Browse to http://localhost:8983/banana (or the FQDN of your solr server).

Banana Web App run in a WebServer

Banana is an AngularJS app and can be run in any webserver that has access to Solr. You will need to enable CORS on the Solr instances that you query, or configure a proxy that makes requests to banana and Solr as same-origin. We typically recommend the latter approach.

Storing Dashboards in Solr

If you want to save and load dashboards from Solr, create a collection using the configuration files provided in either the resources/banana-int-solr-4.4 (for Solr 4.4) directory or the resources/banana-int-solr-4.5 directory (for Solr 4.5 and above). If you are using Solr Cloud, you will need to upload the configuration into ZooKeeper and then create the collection using that configuration.

The Solr server configured in config.js will serve as the default node for each dashboard; you can configure each dashboard to point to a different Solr endpoint as long as your webserver and Solr put out the correct CORS headers. See the README file under the resources/enable-cors directory for a guide.

Clone this wiki locally