There are two main ways of running and installing elasticsearch-head
sudo elasticsearch/bin/plugin -install mobz/elasticsearch-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.
git clone git://github.com/mobz/elasticsearch-head.git
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
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.
Parameters may be appended to the url set some initial state eg.
base_uriforce elasticsearch-head to connect to a particular node.
dashboardexperimental feature to open elasticsearch-head in a mode suitable for dashboard / radiator. Accepts one parameter
auth_useradds basic auth credentials to http requests ( requires elasticsearch-http-basic plugin or a reverse proxy )
auth_passwordbasic auth password as above (note: without additional security layers, passwords are sent over the network in the clear )
To contribute to elasticsearch-head you will need the following developer tools
- create a fork of elasticsearch-head on github
- clone your fork to your machine
npm install# downloads node dev dependencies
grunt dev# 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
To contribute an internationalisation
- Follow “Contributing” instructions above
- Find your 2-character ISO 639-1 language code
- 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.jsprefixed with your langugae code
- convert english strings and fragments to your language. Formatting Rules
- Submit a pull request