Free and Open, Distributed, RESTful Search Engine
Find a file
2022-02-22 07:47:44 -08:00
.ci Make pull request BWC testing a matrix job for better parallelization 2022-02-16 10:56:05 -08:00
.github Update test-failure Issue Template to include "needs:triage" label #83226 2022-01-27 18:42:12 -05:00
.idea Upgrade Checkstyle to 9.3 (#83314) 2022-02-07 10:34:43 +00:00
benchmarks Feature usage actions for archive (#83931) 2022-02-16 08:31:41 +01:00
build-conventions Remove usage of deprecated Provider#forUseAtConfigurationTime (#83932) 2022-02-15 08:06:22 -05:00
build-tools Replace deprecated api in artifact transforms (#84015) 2022-02-16 06:10:54 -05:00
build-tools-internal Upgrade to lucene-9.1.0-snapshot-1336263051c (#83667) 2022-02-22 09:53:20 +01:00
ccr/images [DOCS] Update remote cluster docs (#77043) 2021-09-22 16:02:33 -04:00
client Remove all "user" related methods from HLRC (#84011) 2022-02-17 10:46:06 +11:00
dev-tools Improve atomic push script to support worktrees (#68873) 2021-02-11 10:13:15 -08:00
distribution Upgrade to lucene-9.1.0-snapshot-1336263051c (#83667) 2022-02-22 09:53:20 +01:00
docs [DOCS] Add read_pipeline privilege to transform setup (#84151) 2022-02-22 07:47:44 -08:00
gradle/wrapper Update gradle wrapper to 7.4 (#81963) 2022-02-14 09:48:54 +01:00
libs Upgrade to lucene-9.1.0-snapshot-1336263051c (#83667) 2022-02-22 09:53:20 +01:00
licenses Keep low level rest client under Apache 2 software license (#68694) 2021-02-08 11:13:31 -08:00
modules Shrink slow log for inner_hits (#84143) 2022-02-22 09:54:43 -05:00
plugins Upgrade to lucene-9.1.0-snapshot-1336263051c (#83667) 2022-02-22 09:53:20 +01:00
qa Upgrade to lucene-9.1.0-snapshot-1336263051c (#83667) 2022-02-22 09:53:20 +01:00
rest-api-spec Upgrade to lucene-9.1.0-snapshot-1336263051c (#83667) 2022-02-22 09:53:20 +01:00
server Update error message after lucene upgrade (#84228) 2022-02-22 16:21:15 +01:00
test Upgrade to lucene-9.1.0-snapshot-1336263051c (#83667) 2022-02-22 09:53:20 +01:00
x-pack Upgrade to lucene-9.1.0-snapshot-1336263051c (#83667) 2022-02-22 09:53:20 +01:00
.backportrc.json Bump version to 8.2 2022-02-02 12:40:50 -08:00
.dir-locals.el Go back to 140 column limit in .dir-locals.el 2017-04-14 08:50:53 -06:00
.editorconfig Formatting escape hatch (#81806) 2021-12-16 16:18:34 +00:00
.git-blame-ignore-revs Fix typo in instructions for ignore-revs (#80058) 2021-11-04 12:10:55 +11:00
.gitattributes Assert no carriage returns in release notes test samples (#77238) 2021-09-07 20:45:23 +01:00
.gitignore Move custom checkstyle rule implementations to build-conventions project (#74017) 2021-06-10 16:06:44 -07:00
build.gradle Add CI matrix configuration for snapshot BWC versions (#83990) 2022-02-15 14:40:21 -08:00
BUILDING.md Document how to test a dev version of a 3party dependency (#78962) 2021-10-13 05:23:37 -04:00
CHANGELOG.md Add changelog (#83830) 2022-02-11 13:29:22 +00:00
CONTRIBUTING.md [docs] Mention JDK 17 in the Contributing docs (#84018) 2022-02-16 15:52:20 +01:00
gradle.properties Fix Spotless failing with InvocationTargetException on JDK 16 (#73246) 2021-05-20 08:46:20 +02:00
gradlew Update Gradle wrapper to 7.2 (#75894) 2021-08-18 05:11:28 -04:00
gradlew.bat Update gradle wrapper to 6.6 (#59909) 2020-08-11 10:17:33 +02:00
LICENSE.txt Update sources with new SSPL+Elastic-2.0 license headers 2021-02-02 16:10:53 -08:00
NOTICE.txt Remove Joda dependency (#79007) 2021-10-13 17:37:31 -07:00
README.asciidoc [DOCS] Refactor quick start guide and README (#71331) 2021-04-20 09:32:21 -04:00
settings.gradle Check whether stdout is a real console (#79882) 2021-10-28 14:06:33 +11:00
TESTING.asciidoc Fix typo in TESTING.asciidoc (#83120) 2022-01-26 17:01:19 +00:00
Vagrantfile Introduce ES_JAVA_HOME (#68954) 2021-02-17 12:41:23 -05:00

= 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.