Go to file
Court Ewing 68baabe72f docs: kibana developer and known plugin docs (#9477)
* docs: kibana developer docs

This is the beginning of developer-focussed docs for Kibana. The content
is mostly pulled directly from the old wiki in the github repo.

* docs: known plugins for 5.x
2016-12-13 22:37:55 -05:00
.github Add elasticsearch version to issue template 2016-07-25 11:00:27 -05:00
bin [plugin cli] Wrap arguments in quotes to preserve whitespace (#8945) 2016-11-17 10:10:24 -06:00
config Kibana Globalization - Phase 1 (#7545) 2016-12-13 17:55:48 -07:00
data [folder structure] plugins/.data -> data 2016-07-05 14:06:16 -05:00
docs docs: kibana developer and known plugin docs (#9477) 2016-12-13 22:37:55 -05:00
maps Point kibana map config at tiles.elastic.co AWS. 2016-07-25 16:20:54 -07:00
optimize [optimize] ensure the optimize directory exists with a .empty file 2015-11-02 10:36:20 -06:00
plugins [folder structure] plugins/.data -> data 2016-07-05 14:06:16 -05:00
src [eslint] reenable no-extra-semi and quotes rules (#9473) 2016-12-13 18:17:47 -07:00
style_guides Fix markdown typo in CSS style guide. (#9408) 2016-12-07 13:20:02 -08:00
tasks [eslint] reenable no-extra-semi and quotes rules (#9473) 2016-12-13 18:17:47 -07:00
test [eslint] reenable no-extra-semi and quotes rules (#9473) 2016-12-13 18:17:47 -07:00
utilities Update visualRegression task to use Handlebars instead of DoT templates. 2016-06-21 10:42:49 -07:00
webpackShims Replace compiled angular-bootstrap file with original HTML and JS source files. 2016-07-05 12:27:20 -07:00
.editorconfig Apply the same editorconfig rules to both markdown and asciidoc files 2016-09-07 11:41:41 -04:00
.eslintignore Upgrade eslint (#9357) 2016-12-12 13:44:18 -07:00
.eslintrc [eslint] reenable no-extra-semi and quotes rules (#9473) 2016-12-13 18:17:47 -07:00
.gitignore Migrate UI Framework source into Kibana. (#9192) 2016-12-12 17:54:56 -08:00
.node-version Bump node to 6.9.0 2016-10-18 13:40:27 -05:00
.npmrc Removes "global-style" setting for npm (#9256) 2016-11-29 15:43:57 -05:00
.travis.yml add travis config 2016-03-10 23:13:02 -07:00
CONTRIBUTING.md Add details on how we use Git and GitHub to CONTRIBUTING.md. (#8978) 2016-11-07 11:26:30 -08:00
FAQ.md Fix broken links in FAQ.md 2016-02-11 22:42:53 +01:00
Gruntfile.js Upgrade eslint (#9357) 2016-12-12 13:44:18 -07:00
LICENSE.md updating licence.md year to 2016 2016-08-02 13:31:02 +02:00
package.json [eslint] reenable no-extra-semi and quotes rules (#9473) 2016-12-13 18:17:47 -07:00
README.md Update README with links to resources, and remove old getting started instructions (made redundant by elastic.co getting started guide). (#9104) 2016-11-18 09:30:43 -08:00
STYLEGUIDE.md Current styleguide conventions with modern JS (#7435) 2016-11-01 21:22:59 -04:00

Kibana 6.0.0-alpha1

Kibana is your window into the Elastic Stack. Specifically, it's an open source (Apache Licensed), browser-based analytics and search dashboard for Elasticsearch.

Getting Started

If you just want to try Kibana out, check out the Elastic Stack Getting Started Page to give it a whirl.

If you're interested in diving a bit deeper and getting a taste of Kibana's capabilities, head over to the Kibana Getting Started Page.

Using a Kibana Release

If you want to use a Kibana release in production, give it a test run, or just play around:

Building and Running Kibana, and/or Contributing Code

You may want to build Kibana locally to contribute some code, test out the latest features, or try out an open PR:

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
Linux x64 tar deb rpm
Linux x86 tar deb rpm
Windows zip

Documentation

Visit Elastic.co for the full Kibana documentation.

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 ⚠️ Logged warning
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

Questions? Problems? Suggestions?

  • If you've found a bug or want to request a feature, please create a GitHub Issue. Please check to make sure someone else hasn't already created an issue for the same topic.
  • Need help using Kibana? Ask away on our Kibana Discuss Forum and a fellow community member or Elastic engineer will be glad to help you out.