OpenSearch/docs/reference/setup.asciidoc
Ryan Ernst 7e8f1c2da7
Add docs for bundled jdk (#40487)
This commit changes the note in docs about required java version to note
the existence of the bundled jdk and how to bring your own java. It also
reorganizes the zip/targz docs as zip is no longer suitable on
Linux/MacOS.
2019-03-29 09:08:32 -04:00

78 lines
2.0 KiB
Plaintext

[[setup]]
= Set up Elasticsearch
[partintro]
--
This section includes information on how to setup Elasticsearch and get it
running, including:
* Downloading
* Installing
* Starting
* Configuring
[[supported-platforms]]
[float]
== 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.
[float]
[[jvm-version]]
== Java (JVM) Version
Elasticsearch is built using Java, and includes a bundled version of
http://openjdk.java.net[OpenJDK] from the JDK maintainers (GPLv2+CE)
within each distribution. The bundled JVM exists within the `jdk` directory of
the Elasticsearch home directory.
To use your own version of Java, set the `JAVA_HOME` environment variable.
When using your own version, the bundled JVM directory may be removed.
If not using the bundled JVM, we recommend installing Java version
*{jdk} or a later version in the Java {jdk_major} release series*. We recommend
using a link:/support/matrix[supported]
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.
--
include::setup/install.asciidoc[]
include::setup/configuration.asciidoc[]
include::setup/jvm-options.asciidoc[]
include::setup/secure-settings.asciidoc[]
include::setup/logging-config.asciidoc[]
include::settings/audit-settings.asciidoc[]
include::settings/ccr-settings.asciidoc[]
include::settings/license-settings.asciidoc[]
include::settings/ml-settings.asciidoc[]
include::settings/monitoring-settings.asciidoc[]
include::settings/security-settings.asciidoc[]
include::settings/sql-settings.asciidoc[]
include::settings/notification-settings.asciidoc[]
include::setup/important-settings.asciidoc[]
include::setup/sysconfig.asciidoc[]
include::setup/bootstrap-checks.asciidoc[]
include::setup/starting.asciidoc[]
include::setup/stopping.asciidoc[]
include::setup/add-nodes.asciidoc[]