A web front end for an elastic search cluster
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
h2. A web front end for an Elasticsearch cluster
There are multiple ways of running elasticsearch-head.
h4. Running with built in server
@git clone git://github.com/mobz/[email protected]
@npm [email protected]
@npm run [email protected]
This will start a local webserver running on port 9100 serving elasticsearch-head
h4. Running with docker
for Elasticsearch 5.x: @docker run -p 9100:9100 mobz/elasticsearch-head:[email protected]
for Elasticsearch 2.x: @docker run -p 9100:9100 mobz/elasticsearch-head:[email protected]
for Elasticsearch 1.x: @docker run -p 9100:9100 mobz/elasticsearch-head:[email protected]
for fans of alpine there is @mobz/elasticsearch-head:[email protected]
h4. Running as a Chrome extension
h4. Running as a plugin of Elasticsearch (deprecated)
for Elasticsearch 5.x, 6.x, and 7.x: site plugins are not supported. Run "as a standalone server":#running-with-built-in-server
for Elasticsearch 2.x: @sudo elasticsearch/bin/plugin install mobz/[email protected]
for Elasticsearch 1.x: @sudo elasticsearch/bin/plugin -install mobz/elasticsearch-head/[email protected]
for Elasticsearch 0.x: @sudo elasticsearch/bin/plugin -install mobz/elasticsearch-head/[email protected]
This will automatically download the appropriate 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
h4. Running with the local proxy
This is an experimental feature which creates a local proxy for many remote elasticsearch clusters
h3. Connecting to elasticsearch
By default elasticsearch exposes a http rest API on port 9200 which elasticsearch-head connects to.
h4. Enable CORS in elasticsearch
When not running as a Chrome extension or as a plugin of elasticsearch (which is not even possible from version 5), you must enable "CORS":https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html in elasticsearch, or else your browser will reject elasticsearch-head's requests due to violation of the same-origin policy.
In elasticsearch configuration;
h4. Basic Authentication
elasticsearch-head will add basic auth headers to each request if you pass in the "correct url parameters":#url-parameters You will also need to add @http.cors.allow-headers: [email protected] to the elasticsearch configuration
elasticsearch x-pack requires basic authentication and CORS as described above. Make sure you have the correct CORS setup and then open es-head with a url like "http://localhost:9100/?auth_user=elastic&auth_password=changeme"
h4. URL Parameters
Parameters may be appended to the url to set an initial state eg. @head/index.html?base_uri=http://node-01.example.com:[email protected]
To contribute to elasticsearch-head you will need the following developer tools
Changes to both _site and src directories must be committed, to allow people to run elasticsearch-head without running dev tools and follow existing dev patterns, such as indenting with tabs.
h5. Contributing an Internationalisation
To contribute an internationalisation