summaryrefslogtreecommitdiff
path: root/docs/reference/setup.asciidoc
blob: 164307c640c4a8bbb6f61041f6f1db59f4a7d8c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
[[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 requires at least
http://www.oracle.com/technetwork/java/javase/downloads/index.html[Java 8] in
order to run. Only Oracle's Java and the OpenJDK are supported. The same JVM
version should be used on all Elasticsearch nodes and clients.

We recommend installing Java version *{jdk} or later*. Elasticsearch will
refuse to start if a known-bad version of Java is used.

The version of Java that Elasticsearch will use can be configured by setting
the `JAVA_HOME` environment variable.

NOTE: Elasticsearch ships with default configuration for running Elasticsearch on 64-bit server JVMs. If you are using a 32-bit client JVM,
you must remove `-server` from <<jvm-options,jvm.options>> and if you are using any 32-bit JVM you should reconfigure the thread stack size
from `-Xss1m` to `-Xss320k`.

--

include::setup/install.asciidoc[]

include::setup/configuration.asciidoc[]

include::setup/important-settings.asciidoc[]

include::setup/secure-settings.asciidoc[]

include::setup/bootstrap-checks.asciidoc[]

include::setup/sysconfig.asciidoc[]

include::setup/upgrade.asciidoc[]

include::setup/stopping.asciidoc[]