kibana/README.md

# Kibana 6.0.0-alpha1

Kibana is an open source ([Apache Licensed](https://github.com/elastic/kibana/blob/master/LICENSE.md)), browser based analytics and search dashboard for Elasticsearch. Kibana is a snap to setup and start using. Kibana strives to be easy to get started with, while also being flexible and powerful, just like Elasticsearch.

## Requirements

- Elasticsearch master
- Kibana binary package

## Installation

* Download: [http://www.elastic.co/downloads/kibana](http://www.elastic.co/downloads/kibana)
* Extract the files
* Run `bin/kibana` on unix, or `bin\kibana.bat` on Windows.
* Visit [http://localhost:5601](http://localhost:5601)

## Upgrade from previous version

* Move any custom configurations in your old kibana.yml to your new one
* Reinstall plugins
* Start or restart Kibana

## Version compatibility with Elasticsearch

Ideally, you should be running Elasticsearch and Kibana with matching version numbers. If your Elasticsearch has an older version number or a newer _major_ number than Kibana, then Kibana will fail to run. If Elasticsearch has a newer minor or patch number than Kibana, then the Kibana Server will log a warning.

_Note: The version numbers below are only examples, meant to illustrate the relationships between different types of version numbers._

| Situation                 | Example Kibana version     | Example ES version | Outcome |
| ------------------------- | -------------------------- |------------------- | ------- |
| Versions are the same.    | 5.1.2                      | 5.1.2              | 💚 OK      |
| ES patch number is newer. | 5.1.__2__                  | 5.1.__5__          | ⚠️ Logged warning      |
| ES minor number is newer. | 5.__1__.2                  | 5.__5__.0          | ⚠️ Logged warning      |
| ES major number is newer. | __5__.1.2                  | __6__.0.0          | 🚫 Fatal error      |
| ES patch number is older. | 5.1.__2__                  | 5.1.__0__          | 🚫 Fatal error      |
| ES minor number is older. | 5.__1__.2                  | 5.__0__.0          | 🚫 Fatal error      |
| ES major number is older. | __5__.1.2                  | __4__.0.0          | 🚫 Fatal error      |

## Quick Start

You're up and running! Fantastic! Kibana is now running on port 5601, so point your browser at http://YOURDOMAIN.com:5601.

The first screen you arrive at will ask you to configure an **index pattern**. An index pattern describes to Kibana how to access your data. We make the guess that you're working with log data, and we hope (because it's awesome) that you're working with Logstash. By default, we fill in `logstash-*` as your index pattern, thus the only thing you need to do is select which field contains the timestamp you'd like to use. Kibana reads your Elasticsearch mapping to find your time fields - select one from the list and hit *Create*.

Congratulations, you have an index pattern! You should now be looking at a paginated list of the fields in your index or indices, as well as some informative data about them. Kibana has automatically set this new index pattern as your default index pattern. If you'd like to know more about index patterns, pop into to the [Settings](#settings) section of the documentation.

**Did you know:** Both *indices* and *indexes* are acceptable plural forms of the word *index*. Knowledge is power.

Now that you've configured an index pattern, you're ready to hop over to the [Discover](#discover) screen and try out a few searches. Click on **Discover** in the navigation bar at the top of the screen.

## Documentation

Visit [Elastic.co](http://www.elastic.co/guide/en/kibana/current/index.html) for the full Kibana documentation.

## Snapshot Builds

For the daring, snapshot builds are available. These builds are created after each commit to the master branch, and therefore are not something you should run in production.

| platform |  |
| --- | --- |
| OSX | [tar](http://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-darwin-x86_64.tar.gz) |
| Linux x64 | [tar](http://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-linux-x86_64.tar.gz) [deb](https://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-amd64.deb) [rpm](https://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-x86_64.rpm) |
| Linux x86 | [tar](http://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-linux-x86.tar.gz) [deb](https://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-i386.deb) [rpm](https://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-i686.rpm) |
| Windows | [zip](http://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-windows-x86.zip) |
Bump to verson 6.0.0-alpha1 2016-09-08 16:23:22 +02:00			`# Kibana 6.0.0-alpha1`
test status on the readme [ci skip] 2014-03-04 19:58:10 +01:00
[Docs, Links] Changed all of the relevant links and occurences of the string elasticsearch to take into consideration the rebranding during elasitcon and keynote 2015-03-17 02:18:50 +01:00			`Kibana is an open source ([Apache Licensed](https://github.com/elastic/kibana/blob/master/LICENSE.md)), browser based analytics and search dashboard for Elasticsearch. Kibana is a snap to setup and start using. Kibana strives to be easy to get started with, while also being flexible and powerful, just like Elasticsearch.`
added readme renderability 2014-09-18 22:45:25 +02:00
add a requirements section 2014-10-06 18:49:21 +02:00			`## Requirements`

[es] upgrade to master 2015-12-12 00:55:50 +01:00			`- Elasticsearch master`
update the readme, remove java requirement 2015-01-21 22:26:38 +01:00			`- Kibana binary package`
add a requirements section 2014-10-06 18:49:21 +02:00
moved TOC above install, and re-added need help 2014-09-19 01:10:13 +02:00			`## Installation`

[cleanup] Fixed some missed changes, or hyper ones i made 2015-03-17 02:32:09 +01:00			`* Download: [http://www.elastic.co/downloads/kibana](http://www.elastic.co/downloads/kibana)`
Add upgrade notes to README Fixes #5817 2016-01-05 17:39:45 +01:00			`* Extract the files`
Update windows executable path 2015-02-19 17:52:09 +01:00			* Run `bin/kibana` on unix, or `bin\kibana.bat` on Windows.
moved TOC above install, and re-added need help 2014-09-19 01:10:13 +02:00			`* Visit [http://localhost:5601](http://localhost:5601)`

Add upgrade notes to README Fixes #5817 2016-01-05 17:39:45 +01:00			`## Upgrade from previous version`

			`* Move any custom configurations in your old kibana.yml to your new one`
Update README.md 2016-01-05 19:40:39 +01:00			`* Reinstall plugins`
Add upgrade notes to README Fixes #5817 2016-01-05 17:39:45 +01:00			`* Start or restart Kibana`

Update elasticsearch plugin to require ES to have the same version as Kibana. - Remove engineVersion from elasticsearch plugin config. - Use Kibana package.json version instead. - Use new rules, documented in README. - Log warning if ES is newer than Kibana. - Add isEsCompatibleWithKibana and kibanaVersion. - Remove versionSatisfies. 2016-09-10 00:36:09 +02:00			`## Version compatibility with Elasticsearch`

Update README to clarify that the version numbers in the compatibility chart are only examples. 2016-09-15 03:12:05 +02:00			`Ideally, you should be running Elasticsearch and Kibana with matching version numbers. If your Elasticsearch has an older version number or a newer _major_ number than Kibana, then Kibana will fail to run. If Elasticsearch has a newer minor or patch number than Kibana, then the Kibana Server will log a warning.`

			`_Note: The version numbers below are only examples, meant to illustrate the relationships between different types of version numbers._`

			`\| Situation \| Example Kibana version \| Example ES version \| Outcome \|`
			`\| ------------------------- \| -------------------------- \|------------------- \| ------- \|`
			`\| Versions are the same. \| 5.1.2 \| 5.1.2 \| 💚 OK \|`
			`\| ES patch number is newer. \| 5.1.__2__ \| 5.1.__5__ \| ⚠️ Logged warning \|`
			`\| ES minor number is newer. \| 5.__1__.2 \| 5.__5__.0 \| ⚠️ Logged warning \|`
			`\| ES major number is newer. \| __5__.1.2 \| __6__.0.0 \| 🚫 Fatal error \|`
			`\| ES patch number is older. \| 5.1.__2__ \| 5.1.__0__ \| 🚫 Fatal error \|`
			`\| ES minor number is older. \| 5.__1__.2 \| 5.__0__.0 \| 🚫 Fatal error \|`
			`\| ES major number is older. \| __5__.1.2 \| __4__.0.0 \| 🚫 Fatal error \|`
Update elasticsearch plugin to require ES to have the same version as Kibana. - Remove engineVersion from elasticsearch plugin config. - Use Kibana package.json version instead. - Use new rules, documented in README. - Log warning if ES is newer than Kibana. - Add isEsCompatibleWithKibana and kibanaVersion. - Remove versionSatisfies. 2016-09-10 00:36:09 +02:00
updated docs to start at h2, included doc files in readme 2014-09-19 00:41:08 +02:00			`## Quick Start`

			`You're up and running! Fantastic! Kibana is now running on port 5601, so point your browser at http://YOURDOMAIN.com:5601.`

removing throw 2014-10-03 21:53:47 +02:00			The first screen you arrive at will ask you to configure an index pattern. An index pattern describes to Kibana how to access your data. We make the guess that you're working with log data, and we hope (because it's awesome) that you're working with Logstash. By default, we fill in `logstash-` as your index pattern, thus the only thing you need to do is select which field contains the timestamp you'd like to use. Kibana reads your Elasticsearch mapping to find your time fields - select one from the list and hit Create*.
updated docs to start at h2, included doc files in readme 2014-09-19 00:41:08 +02:00
fix internal linking 2014-09-19 00:46:28 +02:00			`Congratulations, you have an index pattern! You should now be looking at a paginated list of the fields in your index or indices, as well as some informative data about them. Kibana has automatically set this new index pattern as your default index pattern. If you'd like to know more about index patterns, pop into to the [Settings](#settings) section of the documentation.`
updated docs to start at h2, included doc files in readme 2014-09-19 00:41:08 +02:00
			`Did you know: Both indices and indexes are acceptable plural forms of the word index. Knowledge is power.`

fix internal linking 2014-09-19 00:46:28 +02:00			`Now that you've configured an index pattern, you're ready to hop over to the [Discover](#discover) screen and try out a few searches. Click on Discover in the navigation bar at the top of the screen.`
added TOC to the readme 2014-09-19 00:45:15 +02:00
[readme] remove old docs, link to new ones, mention 1.4.4 req 2015-02-19 01:32:37 +01:00			`## Documentation`
added TOC to the readme 2014-09-19 00:45:15 +02:00
[Docs, Links] Changed all of the relevant links and occurences of the string elasticsearch to take into consideration the rebranding during elasitcon and keynote 2015-03-17 02:18:50 +01:00			`Visit [Elastic.co](http://www.elastic.co/guide/en/kibana/current/index.html) for the full Kibana documentation.`
added info about snapshot builds to the readme 2015-04-01 23:20:53 +02:00
			`## Snapshot Builds`

Revert "remove snapshot build links" 2015-08-22 03:27:39 +02:00			`For the daring, snapshot builds are available. These builds are created after each commit to the master branch, and therefore are not something you should run in production.`

Only include zip snapshot link for windows tar.gz is sufficient for all operating systems except for windows, which by default only includes zip. There's no reason to provide both links, and we intend to stop publishing the alternative links altogether at some point. 2016-05-25 00:51:33 +02:00			`\| platform \| \|`
			`\| --- \| --- \|`
Bump to verson 6.0.0-alpha1 2016-09-08 16:23:22 +02:00			`\| OSX \| [tar](http://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-darwin-x86_64.tar.gz) \|`
			`\| Linux x64 \| [tar](http://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-linux-x86_64.tar.gz) [deb](https://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-amd64.deb) [rpm](https://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-x86_64.rpm) \|`
			`\| Linux x86 \| [tar](http://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-linux-x86.tar.gz) [deb](https://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-i386.deb) [rpm](https://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-i686.rpm) \|`
			`\| Windows \| [zip](http://download.elastic.co/kibana/kibana-snapshot/kibana-6.0.0-alpha1-SNAPSHOT-windows-x86.zip) \|`