h1. elasticsearch-head

h2. A web front end for an Elasticsearch cluster

h3. "http://mobz.github.com/elasticsearch-head":http://mobz.github.com/elasticsearch-head

h2. Installing and Running

There are two main ways of running and installing elasticsearch-head

h4. Running as a plugin of Elasticsearch

* @sudo elasticsearch/bin/plugin -install mobz/elasticsearch-head@
* @open http://localhost:9200/_plugin/head/@

This will automatically download the latest version of elasticsearch-head from github and run it as a plugin within the elasticsearch cluster. In this mode;
* elasticsearch-head automatically connects to the node that is running it
* If you've installed the .deb package, then the plugin exectuable will be available at /usr/share/elasticsearch/bin/plugin.
* Will not work with elasticsearch prior to version 0.17

h4. Running with built in server

* @git clone git://github.com/mobz/elasticsearch-head.git@
* @cd elasticsearch-head@
* @npm install@
* @grunt server@
* @open@ "http://localhost:9100/":http://localhost:9100/

This will start a local webserver running on port 9100 serving elasticsearch-head
* Best option if you are likely to connect to serveral different clusters

h4. Alternatives

h5. Running from the filesystem

elastisearch-head is a standalone webapp written in good-ol' html5. This means, you can put it up on any webserver, run it directly from the filesystem, use it on an ipad, or put it on a floppy disk and carry it with you.

h4. URL Parameters

Parameters may be appended to the url set some initial state eg. @head/index.html?base_uri=http://node-01.example.com:9200@

* @base_uri@ force elasticsearch-head to connect to a particular node.
* @dashboard@ experimental feature to open elasticsearch-head in a mode suitable for dashoboard / radiator. Accepts one parameter @dashboard=cluster@ 
* @auth_user@ adds basic auth credentials to http requests ( requires "elasticsearch-http-basic":https://github.com/karussell/elasticsearch-http-basic plugin or a reverse proxy )
* @auth_password@ basic auth password as above (note: without "additional security layers":http://security.stackexchange.com/questions/988/is-basic-auth-secure-if-done-over-https, passwords are sent over the network *in the clear* )

h4. Contributing

To contribute to elasticsearch-head you will need the following developer tools

# git and a "github":https://github.com/ account
# "node ( including npm )":http://nodejs.org/download
# "grunt-cli":http://gruntjs.com/getting-started
# (to run jasmine tests) "phantomjs":http://phantomjs.org

Then

# create a fork of elasticsearch-head on github
# clone your fork to your machine
# @cd elasticsearch-head@
# @npm install@ # downloads node dev dependencies
# @grunt default watch@ # builds the distribution files, then watches the src directory for changes

Changes to both dist and src directories *must* be committed, to allow people to run head without running dev tools
and folllow existing dev patterns, such as indenting with tabs

h5. Contributing an Internationalisation

# English (primary) by "Ben Birch":https://twitter.com/mobz
# French by "David Pilato":https://twitter.com/dadoonet
# Portuguese by "caiodangelo":https://github.com/caiodangelo

To contribute an internationalisation

# Follow "Contributing" instructions above
# Find your 2-character "ISO 639-1 language code":http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes 
# edit index.html to add your 2 letter language code to the data-langs attribute of this line @<script src="dist/i18n.js" data-baseDir="dist/lang" data-langs="en,fr,your_lang_here"></script>@
# make a copy of @src/app/langs/en_strings.js@ prefixed with your langugae code
# convert english strings and fragments to your language. "Formatting Rules":http://docs.oracle.com/javase/tutorial/i18n/format/messageintro.html
# Submit a pull request

!http://mobz.github.com/elasticsearch-head/screenshots/clusterOverview.png(ClusterOverview Screenshot)!
