elasticsearch/docs/reference/setup/install.asciidoc
David Turner 72afc2e314 Bring-your-own JDK docs improvements (#96404)
- Bury these docs a little more, there's no need for them to be on the landing page for "Set up Elasticsearch".

- Clarify the responsibilities for JDK updates.
2023-06-01 08:46:33 +01:00

93 lines
2.7 KiB
Text

[[install-elasticsearch]]
== Installing Elasticsearch
[discrete]
=== Hosted Elasticsearch
{ess-leadin}
[discrete]
=== Installing Elasticsearch Yourself
Elasticsearch is provided in the following package formats:
[horizontal]
Linux and MacOS `tar.gz` archives::
The `tar.gz` archives are available for installation on any Linux distribution and MacOS.
+
<<targz>>
Windows `.zip` archive::
The `zip` archive is suitable for installation on Windows.
+
<<zip-windows>>
`deb`::
The `deb` package is suitable for Debian, Ubuntu, and other Debian-based
systems. Debian packages may be downloaded from the Elasticsearch website or
from our Debian repository.
+
<<deb>>
`rpm`::
The `rpm` package is suitable for installation on Red Hat, Centos, SLES,
OpenSuSE and other RPM-based systems. RPMs may be downloaded from the
Elasticsearch website or from our RPM repository.
+
<<rpm>>
`docker`::
Images are available for running Elasticsearch as Docker containers. They may be
downloaded from the Elastic Docker Registry.
+
{ref}/docker.html[Install {es} with Docker]
`brew`::
Formulae are available from the Elastic Homebrew tap for installing
{es} on macOS with the Homebrew package manager.
+
{ref}/brew.html[Install {es} on macOS with Homebrew]
[discrete]
[[jvm-version]]
=== Java (JVM) Version
{es} 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.
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, it is
best to use the latest release of a link:/support/matrix[supported]
https://www.oracle.com/technetwork/java/eol-135779.html[LTS version of Java].
{es} is closely coupled to certain OpenJDK-specific features, so it may not
work correctly with other JVMs. {es} will refuse to start if a known-bad
version of Java is used.
If you use a JVM other than the bundled one, you are responsible for reacting
to announcements related to its security issues and bug fixes, and must
yourself determine whether each update is necessary or not. In contrast, the
bundled JVM is treated as an integral part of {es}, which means that Elastic
takes responsibility for keeping it up to date. Security issues and bugs within
the bundled JVM are treated as if they were within {es} itself.
The bundled JVM is located within the `jdk` subdirectory of the {es} home
directory. You may remove this directory if using your own JVM.
include::install/targz.asciidoc[]
include::install/zip-windows.asciidoc[]
include::install/deb.asciidoc[]
include::install/rpm.asciidoc[]
include::install/docker.asciidoc[]
include::install/brew.asciidoc[]