sdnr/wt/devicemanager/provider/src/main/resources/elasticsearch/plugins/head/README.textile

   1 h1. elasticsearch-head
   2
   3 h2. A web front end for an Elasticsearch cluster
   4
   5 h3. "http://mobz.github.io/elasticsearch-head":http://mobz.github.io/elasticsearch-head
   6
   7 h2. Installing and Running
   8
   9 There are two main ways of running and installing elasticsearch-head
  10
  11 h4. Running as a plugin of Elasticsearch
  12
  13 * Install elasticsearch-head:
  14   - for Elasticsearch 5.x:
  15     site plugins are not supported. Run elasticsearch-head "as a standalone server":#running-with-built-in-server
  16   - for Elasticsearch 2.x - 4.x:
  17     @sudo elasticsearch/bin/plugin install mobz/elasticsearch-head@
  18   - for Elasticsearch 1.x:
  19     @sudo elasticsearch/bin/plugin -install mobz/elasticsearch-head/1.x@
  20   - for Elasticsearch 0.9:
  21     @sudo elasticsearch/bin/plugin -install mobz/elasticsearch-head/0.9@
  22
  23 * @open http://localhost:9200/_plugin/head/@
  24
  25 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;
  26 * elasticsearch-head automatically connects to the node that is running it
  27
  28 Note on different Elasticsearch installation path:
  29 * If you've installed the .deb package, then the plugin executable will be available at @/usr/share/elasticsearch/bin/plugin@.
  30 * If you've installed Elasticsearch via Homebrew, plugin executable will be available at @/usr/local/Cellar/elasticsearch/(elasticsearch version)/libexec/bin/plugin@.
  31
  32 h4. Running with built in server
  33
  34 * enable "cors":http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-http.html by adding @http.cors.enabled: true@ in elasticsearch configuration. Don't forget to also set @http.cors.allow-origin@ because no origin allowed by default. @http.cors.allow-origin: "*"@ is valid value, however it's considered as a security risk as your cluster is open to cross origin from *anywhere*. Check Elasticsearch documentation on this parameter:  https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html#modules-http
  35 * @git clone git://github.com/mobz/elasticsearch-head.git@
  36 * @cd elasticsearch-head@
  37 * @npm install@
  38 * @grunt server@
  39 * @open@ "http://localhost:9100/":http://localhost:9100/
  40
  41 This will start a local webserver running on port 9100 serving elasticsearch-head
  42 * Best option if you are likely to connect to several different clusters
  43
  44 h4. Alternatives
  45
  46 h5. Running from the filesystem
  47
  48 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.
  49
  50 h4. URL Parameters
  51
  52 Parameters may be appended to the url to set an initial state eg. @head/index.html?base_uri=http://node-01.example.com:9200@
  53
  54 * @base_uri@ force elasticsearch-head to connect to a particular node.
  55 * @dashboard@ experimental feature to open elasticsearch-head in a mode suitable for dashboard / radiator. Accepts one parameter @dashboard=cluster@
  56 * @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 )
  57 * @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* )
  58
  59 h4. Contributing
  60
  61 To contribute to elasticsearch-head you will need the following developer tools
  62
  63 # git and a "github":https://github.com/ account
  64 # "node ( including npm )":http://nodejs.org/download
  65 # "grunt-cli":http://gruntjs.com/getting-started
  66 # (to run jasmine tests) "phantomjs":http://phantomjs.org
  67
  68 Then
  69
  70 # create a fork of elasticsearch-head on github
  71 # clone your fork to your machine
  72 # @cd elasticsearch-head@
  73 # @npm install@ # downloads node dev dependencies
  74 # @grunt dev@ # builds the distribution files, then watches the src directory for changes
  75
  76 Changes to both _site and src directories *must* be committed, to allow people to
  77 run elasticsearch-head without running dev tools and follow existing dev patterns,
  78 such as indenting with tabs.
  79
  80 h5. Contributing an Internationalisation
  81
  82
  83 * Chinese by "darkcount":https://github.com/hangxin1940
  84 * English (primary) by "Ben Birch":https://twitter.com/mobz
  85 * French by "David Pilato":https://twitter.com/dadoonet
  86 * Portuguese by "caiodangelo":https://github.com/caiodangelo
  87 * Turkish by "Cemre Mengu":https://github.com/cemremengu
  88
  89 To contribute an internationalisation
  90
  91 # Follow "Contributing" instructions above
  92 # Find your 2-character "ISO 639-1 language code":http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
  93 # edit _site/index.html to add your 2 letter language code to the data-langs attribute of this line @<script src="_site/i18n.js" data-baseDir="_site/lang" data-langs="en,fr,your_lang_here"></script>@
  94 # make a copy of @src/app/langs/en_strings.js@ prefixed with your language code
  95 # convert english strings and fragments to your language. "Formatting Rules":http://docs.oracle.com/javase/tutorial/i18n/format/messageintro.html
  96 # Submit a pull request
  97
  98 !http://mobz.github.com/elasticsearch-head/screenshots/clusterOverview.png(ClusterOverview Screenshot)!