elasticsearch/docs/reference/setup.asciidoc
Jason Tedor 0cd4863585
Introduce ES_JAVA_HOME (#68954)
This commit introduces a dedicated envirnoment variable ES_JAVA_HOME to
determine the JDK used to start (if not using the bundled JDK). This
environment variable will replace JAVA_HOME. The reason that we are
making this change is because JAVA_HOME is a common environment variable
and sometimes users have it set in their environment from other JDK
applications that they have installed on their system. In this case,
they would accidentally end up not using the bundled JDK despite their
intentions. By using a dedicated environment variable specific to
Elasticsearch, we avoid this potential for conflict. With this commit,
we introduce the new environment variable, and deprecate the use of
JAVA_HOME. We will remove support for JAVA_HOME in a future commit.
2021-02-17 12:41:23 -05:00

120 lines
3 KiB
Text

[[setup]]
= Set up {es}
[partintro]
--
This section includes information on how to setup Elasticsearch and get it
running, including:
* Downloading
* Installing
* Starting
* Configuring
[[supported-platforms]]
[discrete]
== Supported platforms
The matrix of officially supported operating systems and JVMs is available here:
link:/support/matrix[Support Matrix]. Elasticsearch is tested on the listed
platforms, but it is possible that it will work on other platforms too.
[discrete]
[[jvm-version]]
== Java (JVM) Version
Elasticsearch is built using Java, and includes a bundled version of
https://openjdk.java.net[OpenJDK] from the JDK maintainers (GPLv2+CE)
within each distribution. The bundled JVM is the recommended JVM and
is located within the `jdk` directory of the Elasticsearch home directory.
To use your own version of Java, set the `ES_JAVA_HOME` environment variable.
If you must use a version of Java that is different from the bundled JVM,
we recommend using a link:/support/matrix[supported]
https://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.
The bundled JVM directory may be removed when using your own JVM.
--
include::setup/install.asciidoc[]
include::setup/configuration.asciidoc[]
include::setup/jvm-options.asciidoc[]
include::setup/secure-settings.asciidoc[]
include::settings/audit-settings.asciidoc[]
include::modules/indices/circuit_breaker.asciidoc[]
include::modules/cluster.asciidoc[]
include::settings/ccr-settings.asciidoc[]
include::modules/discovery/discovery-settings.asciidoc[]
include::modules/indices/fielddata.asciidoc[]
include::settings/ilm-settings.asciidoc[]
include::modules/indices/index_management.asciidoc[]
include::modules/indices/recovery.asciidoc[]
include::modules/indices/indexing_buffer.asciidoc[]
include::settings/license-settings.asciidoc[]
include::modules/gateway.asciidoc[]
include::setup/logging-config.asciidoc[]
include::settings/ml-settings.asciidoc[]
include::settings/monitoring-settings.asciidoc[]
include::modules/node.asciidoc[]
include::modules/network.asciidoc[]
include::modules/indices/query_cache.asciidoc[]
include::modules/indices/search-settings.asciidoc[]
include::settings/security-settings.asciidoc[]
include::modules/indices/request_cache.asciidoc[]
include::settings/slm-settings.asciidoc[]
include::settings/transform-settings.asciidoc[]
include::modules/threadpool.asciidoc[]
include::settings/notification-settings.asciidoc[]
include::setup/advanced-configuration.asciidoc[]
include::setup/important-settings.asciidoc[]
include::setup/sysconfig.asciidoc[]
include::setup/bootstrap-checks.asciidoc[]
include::setup/bootstrap-checks-xes.asciidoc[]
include::setup/starting.asciidoc[]
include::setup/stopping.asciidoc[]
include::modules/discovery.asciidoc[]
include::setup/add-nodes.asciidoc[]
include::setup/restart-cluster.asciidoc[]
include::modules/remote-clusters.asciidoc[]
include::modules/plugins.asciidoc[]