Free and Open, Distributed, RESTful Search Engine
Find a file
2021-10-04 11:17:27 +02:00
.ci Increase CI job data retention period 2021-09-29 08:38:05 -07:00
.github Add GitHub action for synchronizing commits from master to main branch 2021-08-24 15:51:33 -07:00
.idea [ML] Adding new trained model allocation service (#75778) 2021-08-03 13:06:14 -04:00
benchmarks Interrupt aggregation reduce phase if the search task is cancelled (#71714) 2021-10-01 07:22:40 -10:00
build-conventions Add LZ4 compressor with Java9 perf improvements (#77153) 2021-09-09 12:53:35 -06:00
build-tools Remove special handling for Azul JDKs in the build (#78281) 2021-09-27 12:29:10 -07:00
build-tools-internal Update to new lucene snapshot (#78548) 2021-10-01 12:07:42 +01:00
ccr/images [DOCS] Update remote cluster docs (#77043) 2021-09-22 16:02:33 -04:00
client Feature upgrade rest stubs (#77827) 2021-09-29 16:25:15 -04:00
dev-tools Improve atomic push script to support worktrees (#68873) 2021-02-11 10:13:15 -08:00
distribution Ensure docker test fixture preProcess task is always executed (#78421) 2021-09-29 08:07:50 -07:00
docs [DOCS] Troubleshoot the flood-stage watermark error (#78519) 2021-10-01 08:32:53 -04:00
gradle/wrapper Update Gradle wrapper to 7.2 (#75894) 2021-08-18 05:11:28 -04:00
libs Add 'show' command to the keystore CLI (#76693) 2021-09-23 12:37:20 +10:00
licenses Keep low level rest client under Apache 2 software license (#68694) 2021-02-08 11:13:31 -08:00
modules Interrupt aggregation reduce phase if the search task is cancelled (#71714) 2021-10-01 07:22:40 -10:00
plugins Update to new lucene snapshot (#78548) 2021-10-01 12:07:42 +01:00
qa Mute "tsdb" yaml test (#78599) 2021-10-04 11:17:27 +02:00
rest-api-spec TSDB: snapshot/restore test (#78022) 2021-10-01 16:14:56 -04:00
server Refactor SnapshotsInProgress to Track Snapshots By Repository (#77984) 2021-10-04 09:57:46 +02:00
test Refactor SnapshotsInProgress to Track Snapshots By Repository (#77984) 2021-10-04 09:57:46 +02:00
x-pack Refactor SnapshotsInProgress to Track Snapshots By Repository (#77984) 2021-10-04 09:57:46 +02:00
.backportrc.json Add version constant for 7.16.0 2021-08-18 08:21:50 -07:00
.dir-locals.el Go back to 140 column limit in .dir-locals.el 2017-04-14 08:50:53 -06:00
.editorconfig Fix compiler warnings in :server - part 3 (#76024) 2021-08-10 15:05:55 +01:00
.git-blame-ignore-revs fix git blame after autoformtting (#77040) 2021-08-31 10:55:52 -04: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 Remove example-plugins included build (#78408) 2021-09-28 14:31:21 -07:00
BUILDING.md Do not create unused testCluster (#77581) 2021-09-23 03:45:59 -04:00
CONTRIBUTING.md Document general gradle build guidelines (#76551) 2021-09-01 09:32:01 +02: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 Update sources with new SSPL+Elastic-2.0 license headers 2021-02-02 16:10:53 -08:00
README.asciidoc [DOCS] Refactor quick start guide and README (#71331) 2021-04-20 09:32:21 -04:00
settings.gradle Remove example-plugins included build (#78408) 2021-09-28 14:31:21 -07:00
TESTING.asciidoc [DOCS] Fix link (#73810) 2021-06-07 09:55:20 -04: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.