Go to file
Artem Prigoda df9cc6b7b5
Update required JAVA_HOME variables for running tests (#80145)
I believe ES gets tested now against only JDK 8, 11, and 17, so you would need to have only `JAVA8_HOME`, `JAVA11_HOME`, and `JAVA17_HOME` set up in order to run the tests locally.
2021-11-04 10:42:43 +01:00
.ci Add Amazon Linux and remove Debian 9 from testing matrix 2021-11-03 12:11:42 -07:00
.github
.idea
benchmarks add benchmark to test xcontent parser filter performance (#80069) 2021-11-03 13:04:39 -04:00
build-conventions Reformat Elasticsearch source 2021-10-27 08:19:51 -07:00
build-tools Check for multiple javadocs in java headers (#79603) 2021-10-29 08:32:11 +02:00
build-tools-internal Bump bundled JDK to 17.0.1 (#80034) 2021-11-03 15:01:20 -07:00
ccr/images
client Check for multiple javadocs in java headers (#79603) 2021-10-29 08:32:11 +02:00
dev-tools
distribution Check whether stdout is a real console (#79882) 2021-10-28 14:06:33 +11:00
docs Bump bundled JDK to 17.0.1 (#80034) 2021-11-03 15:01:20 -07:00
gradle/wrapper
libs Fix xcontent test deprecated (#80173) 2021-11-03 10:37:46 -04:00
licenses
modules Script: support boolean fields in Fields API (#80043) 2021-11-03 21:18:54 -05:00
plugins Upgrade Lucene 9 snapshot cc2a31f2be8 (#80213) 2021-11-02 15:50:33 -04:00
qa Script: Time series compile and cache evict metrics (#79078) 2021-11-03 13:13:42 -05:00
rest-api-spec Correct description in kNN search rest spec (#80313) 2021-11-03 14:53:18 -07:00
server Script: support boolean fields in Fields API (#80043) 2021-11-03 21:18:54 -05:00
test Script: support boolean fields in Fields API (#80043) 2021-11-03 21:18:54 -05:00
x-pack fix delete-auto-follow-pattern task name (#80194) 2021-11-04 08:06:58 +01:00
.backportrc.json Update backport configuration to support prerelease version qualifiers 2021-10-27 10:34:39 -07:00
.dir-locals.el
.editorconfig
.git-blame-ignore-revs Fix typo in instructions for ignore-revs (#80058) 2021-11-04 12:10:55 +11:00
.gitattributes
.gitignore
BUILDING.md
CONTRIBUTING.md Update required JAVA_HOME variables for running tests (#80145) 2021-11-04 10:42:43 +01:00
LICENSE.txt
NOTICE.txt
README.asciidoc
TESTING.asciidoc
Vagrantfile
build.gradle Update backport configuration to support prerelease version qualifiers 2021-10-27 10:34:39 -07:00
gradle.properties
gradlew
gradlew.bat
settings.gradle Check whether stdout is a real console (#79882) 2021-10-28 14:06:33 +11:00

README.asciidoc

= Elasticsearch

Elasticsearch is the distributed, RESTful search and analytics engine at the
heart of the https://www.elastic.co/products[Elastic Stack]. You can use
Elasticsearch to store, search, and manage data for:

* Logs
* Metrics
* A search backend
* Application monitoring
* Endpoint security

\... and more!

To learn more about Elasticsearch's features and capabilities, see our
https://www.elastic.co/products/elasticsearch[product page].

[[get-started]]
== Get started

The simplest way to set up Elasticsearch is to create a managed deployment with
https://www.elastic.co/cloud/as-a-service[Elasticsearch Service on Elastic
Cloud].

If you prefer to install and manage Elasticsearch yourself, you can download
the latest version from 
https://www.elastic.co/downloads/elasticsearch[elastic.co/downloads/elasticsearch].

For more installation options, see the
https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html[Elasticsearch installation
documentation].

[[upgrade]]
== Upgrade

To upgrade from an earlier version of Elasticsearch, see the
https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html[Elasticsearch upgrade
documentation].

[[build-source]]
== Build from source

Elasticsearch uses https://gradle.org[Gradle] for its build system.

To build a distribution for your local OS and print its output location upon
completion, run:
----
./gradlew localDistro
----

To build a distribution for another platform, run the related command:
----
./gradlew :distribution:archives:linux-tar:assemble
./gradlew :distribution:archives:darwin-tar:assemble
./gradlew :distribution:archives:windows-zip:assemble
----

To build distributions for all supported platforms, run:
----
./gradlew assemble
----

Distributions are output to `distributions/archives`.

To run the test suite, see xref:TESTING.asciidoc[TESTING].

[[docs]]
== Documentation

For the complete Elasticsearch documentation visit
https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html[elastic.co].

For information about our documentation processes, see the
xref:docs/README.asciidoc[docs README].

[[contribute]]
== Contribute

For contribution guidelines, see xref:CONTRIBUTING.md[CONTRIBUTING]. 

[[questions]]
== Questions? Problems? Suggestions?

* To report a bug or request a feature, create a
https://github.com/elastic/elasticsearch/issues/new/choose[GitHub Issue]. Please
ensure someone else hasn't created an issue for the same topic.

* Need help using Elasticsearch? Reach out on the
https://discuss.elastic.co[Elastic Forum] or https://ela.st/slack[Slack]. A
fellow community member or Elastic engineer will be happy to help you out.