Free and Open, Distributed, RESTful Search Engine
Find a file
Adam Locke 6dfd92c46f
[DOCS] Focus retrieving selected fields on fields parameter (#71506)
* [DOCS] Focus retrieving selected fields on fields parameter

* Incorporating changes from reviews

* Adding clarifications from review feedback

* Slight wording revisions.

* Clarify language around format parameter and move text out of callout.
2021-04-20 15:11:35 -04:00
.ci Add shell script for running builds in CI 2021-04-15 15:24:43 -07:00
.github Update the wording for the feature request issue template (#57037) 2020-05-21 16:43:15 +01:00
.idea Keep low level rest client under Apache 2 software license (#68694) 2021-02-08 11:13:31 -08:00
benchmarks Fix profiled global agg (#71575) 2021-04-13 08:36:51 -04:00
buildSrc Fix ignored spock build tools integ tests (#71769) 2021-04-16 19:16:42 +02:00
client Add Searchable Snapshots Cache Stats API to HLRC (#71858) 2021-04-20 13:35:21 +02:00
dev-tools Improve atomic push script to support worktrees (#68873) 2021-02-11 10:13:15 -08:00
distribution Update GeoIP processor documentation (#71211) 2021-04-15 13:47:09 +02:00
docs [DOCS] Focus retrieving selected fields on fields parameter (#71506) 2021-04-20 15:11:35 -04:00
gradle Re-enabling yaml tests for fips (#71822) 2021-04-19 15:24:54 +02:00
libs Rework geo mappers to index value by value (#71696) 2021-04-19 12:38:01 +01:00
licenses Keep low level rest client under Apache 2 software license (#68694) 2021-02-08 11:13:31 -08:00
modules Fix range queries on runtime double field (#71915) 2021-04-20 16:44:45 +02:00
plugins Make intervals queries fully pluggable through field mappers. (#71429) 2021-04-20 18:10:12 +02:00
qa Disable GeoIP downloader in packaging tests (#71884) 2021-04-20 18:15:39 +02:00
rest-api-spec Wait on index when polling global checkpoints (#71890) 2021-04-20 13:04:42 -06:00
server Update javadoc 2021-04-20 14:51:24 -04:00
test Remove some extra reproduce info (#71706) 2021-04-20 08:34:47 -04:00
x-pack Wait on index when polling global checkpoints (#71890) 2021-04-20 13:04:42 -06:00
.dir-locals.el Go back to 140 column limit in .dir-locals.el 2017-04-14 08:50:53 -06:00
.editorconfig Generate an IDE-compatible checkstyle configuration (#66109) 2020-12-14 13:47:28 +00:00
.gitattributes Add a CHANGELOG file for release notes. (#29450) 2018-04-18 07:42:05 -07:00
.gitignore Banish build-eclipse (#70696) 2021-03-24 16:00:52 -04:00
build.gradle Adjust bwc for percentage based frozen autoscaling (#71932) 2021-04-20 16:17:27 +02:00
CONTRIBUTING.md Add some notes on javadoc to CONTRIBUTING (#71924) 2021-04-20 13:00:17 -04:00
gradle.properties Improve error messages around detecting Java installations (#70166) 2021-03-09 10:28:23 -08:00
gradlew Update gradle wrapper to 6.6 (#59909) 2020-08-11 10:17:33 +02: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 Transform docker log4j properties at build time (#71346) 2021-04-08 09:53:10 +01:00
TESTING.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -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.