2013-08-28 19:24:34 -04:00
|
|
|
[[setup]]
|
2020-06-01 11:27:27 -04:00
|
|
|
= Set up {es}
|
2013-08-28 19:24:34 -04:00
|
|
|
|
|
|
|
[partintro]
|
|
|
|
--
|
2016-04-03 10:09:24 -04:00
|
|
|
This section includes information on how to setup Elasticsearch and get it
|
|
|
|
running, including:
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2016-04-03 10:09:24 -04:00
|
|
|
* Downloading
|
|
|
|
* Installing
|
|
|
|
* Starting
|
|
|
|
* Configuring
|
2014-02-06 11:01:58 -05:00
|
|
|
|
2015-10-09 06:27:05 -04:00
|
|
|
[[supported-platforms]]
|
|
|
|
[float]
|
|
|
|
== Supported platforms
|
|
|
|
|
|
|
|
The matrix of officially supported operating systems and JVMs is available here:
|
2017-12-14 07:47:50 -05:00
|
|
|
link:/support/matrix[Support Matrix]. Elasticsearch is tested on the listed
|
2015-10-09 06:27:05 -04:00
|
|
|
platforms, but it is possible that it will work on other platforms too.
|
|
|
|
|
2014-09-11 05:13:19 -04:00
|
|
|
[float]
|
|
|
|
[[jvm-version]]
|
2016-04-03 10:09:24 -04:00
|
|
|
== Java (JVM) Version
|
2014-09-11 05:13:19 -04:00
|
|
|
|
2019-03-29 09:04:46 -04:00
|
|
|
Elasticsearch is built using Java, and includes a bundled version of
|
|
|
|
http://openjdk.java.net[OpenJDK] from the JDK maintainers (GPLv2+CE)
|
2019-04-18 16:17:16 -04:00
|
|
|
within each distribution. The bundled JVM is the recommended JVM and
|
|
|
|
is located within the `jdk` directory of the Elasticsearch home directory.
|
2019-03-29 09:04:46 -04:00
|
|
|
|
|
|
|
To use your own version of Java, set the `JAVA_HOME` environment variable.
|
2019-04-18 16:17:16 -04:00
|
|
|
If you must use a version of Java that is different from the bundled JVM,
|
|
|
|
we recommend using a link:/support/matrix[supported]
|
2017-12-14 07:47:50 -05:00
|
|
|
http://www.oracle.com/technetwork/java/eol-135779.html[LTS version of Java].
|
|
|
|
Elasticsearch will refuse to start if a known-bad version of Java is used.
|
2019-04-18 16:17:16 -04:00
|
|
|
The bundled JVM directory may be removed when using your own JVM.
|
2014-09-11 05:13:19 -04:00
|
|
|
|
2013-08-28 19:24:34 -04:00
|
|
|
--
|
|
|
|
|
2016-04-03 10:09:24 -04:00
|
|
|
include::setup/install.asciidoc[]
|
2013-08-28 19:24:34 -04:00
|
|
|
|
2016-04-03 10:09:24 -04:00
|
|
|
include::setup/configuration.asciidoc[]
|
2013-09-23 11:24:31 -04:00
|
|
|
|
2017-12-12 10:24:37 -05:00
|
|
|
include::setup/jvm-options.asciidoc[]
|
|
|
|
|
2017-01-30 17:56:45 -05:00
|
|
|
include::setup/secure-settings.asciidoc[]
|
|
|
|
|
2020-06-01 09:44:32 -04:00
|
|
|
include::settings/ccr-settings.asciidoc[]
|
2017-07-21 05:24:27 -04:00
|
|
|
|
2020-06-01 09:44:32 -04:00
|
|
|
include::modules/indices/circuit_breaker.asciidoc[]
|
2019-03-14 17:22:06 -04:00
|
|
|
|
2020-06-01 09:44:32 -04:00
|
|
|
include::modules/indices/recovery.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/indices/indexing_buffer.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/indices/fielddata.asciidoc[]
|
2019-03-14 17:22:06 -04:00
|
|
|
|
2019-04-05 19:38:31 -04:00
|
|
|
include::settings/ilm-settings.asciidoc[]
|
|
|
|
|
2019-03-14 17:22:06 -04:00
|
|
|
include::settings/license-settings.asciidoc[]
|
|
|
|
|
2020-06-01 09:44:32 -04:00
|
|
|
include::setup/logging-config.asciidoc[]
|
|
|
|
|
2019-03-14 17:22:06 -04:00
|
|
|
include::settings/ml-settings.asciidoc[]
|
|
|
|
|
2019-03-18 14:11:52 -04:00
|
|
|
include::settings/monitoring-settings.asciidoc[]
|
|
|
|
|
2020-06-01 12:04:15 -04:00
|
|
|
include::modules/node.asciidoc[]
|
|
|
|
|
2020-06-01 11:27:27 -04:00
|
|
|
include::modules/network.asciidoc[]
|
|
|
|
|
2020-06-01 09:44:32 -04:00
|
|
|
include::modules/indices/query_cache.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/indices/request_cache.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/indices/search-settings.asciidoc[]
|
|
|
|
|
2019-03-14 17:22:06 -04:00
|
|
|
include::settings/security-settings.asciidoc[]
|
|
|
|
|
2020-06-01 09:44:32 -04:00
|
|
|
include::settings/audit-settings.asciidoc[]
|
|
|
|
|
2020-05-08 17:22:27 -04:00
|
|
|
include::settings/slm-settings.asciidoc[]
|
|
|
|
|
2019-03-14 17:22:06 -04:00
|
|
|
include::settings/sql-settings.asciidoc[]
|
|
|
|
|
2020-03-02 04:48:09 -05:00
|
|
|
include::settings/transform-settings.asciidoc[]
|
|
|
|
|
2020-06-01 10:56:28 -04:00
|
|
|
include::modules/transport.asciidoc[]
|
|
|
|
|
2020-06-01 11:46:16 -04:00
|
|
|
include::modules/threadpool.asciidoc[]
|
|
|
|
|
2019-03-14 17:22:06 -04:00
|
|
|
include::settings/notification-settings.asciidoc[]
|
|
|
|
|
2017-07-21 05:24:27 -04:00
|
|
|
include::setup/important-settings.asciidoc[]
|
2016-05-27 06:03:35 -04:00
|
|
|
|
2016-04-03 10:09:24 -04:00
|
|
|
include::setup/sysconfig.asciidoc[]
|
2014-04-01 12:28:08 -04:00
|
|
|
|
2017-07-21 05:24:27 -04:00
|
|
|
include::setup/bootstrap-checks.asciidoc[]
|
|
|
|
|
2020-06-01 10:28:34 -04:00
|
|
|
include::setup/bootstrap-checks-xes.asciidoc[]
|
|
|
|
|
2018-07-03 16:40:37 -04:00
|
|
|
include::setup/starting.asciidoc[]
|
|
|
|
|
2016-07-07 14:44:03 -04:00
|
|
|
include::setup/stopping.asciidoc[]
|
2019-01-15 14:11:01 -05:00
|
|
|
|
|
|
|
include::setup/add-nodes.asciidoc[]
|
2019-11-12 08:49:11 -05:00
|
|
|
|
2020-06-01 10:07:50 -04:00
|
|
|
include::setup/restart-cluster.asciidoc[]
|
|
|
|
|
2020-06-01 10:28:34 -04:00
|
|
|
include::modules/remote-clusters.asciidoc[]
|
|
|
|
|
2020-06-01 10:07:50 -04:00
|
|
|
include::setup/setup-xes.asciidoc[]
|
|
|
|
|
|
|
|
include::setup/setup-xclient.asciidoc[]
|
|
|
|
|
|
|
|
include::modules/plugins.asciidoc[]
|