OpenSearch/docs/reference/setup.asciidoc
Adam Locke 20d04081ec
[7.x] [DOCS] Add supported ESS settings to ES docs (#57953) (#58981)
* Adding ESS icons to supported ES settings.

* Adding new file for supported ESS settings.

* Adding supported ESS settings for HTTP and disk-based shard allocation.

* Adding more supported settings for ESS.

* Adding descriptions for each Cloud section, plus additional settings.

* Adding new warehouse file for Cloud, plus additional settings.

* Adding node settings for Cloud.

* Adding audit settings for Cloud.

* Resolving merge conflict.

* Adding SAML settings (part 1).

* Adding SAML realm encryption and signing settings.

* Adding SAML SSL settings.

* Adding Kerberos realm settings.

* Adding OpenID Connect Realm settings.

* Adding OpenID Connect SSL settings.

* Resolving leftover Git merge markers.

* Removing Cloud settings page and link to it.

* Add link to mapping source

* Update docs/reference/docs/reindex.asciidoc

* Incorporate edit of HTTP settings

* Remove "cloud" from tag and ID

* Remove "cloud" from tag and update description

* Remove "cloud" from tag and ID

* Change "whitelists" to "specifies"

* Remove "cloud" from end tag

* Removing cloud from IDs and tags.

* Changing link reference to fix build issue.

* Adding index management page for missing settings.

* Removing warehouse file for Cloud and moving settings elsewhere.

* Clarifying true/false usage of http.detailed_errors.enabled.

* Changing underscore to dash in link to fix ci build.
2020-07-02 19:40:45 -04:00

129 lines
3.1 KiB
Plaintext

[[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]]
[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 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 `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]
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.
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::modules/http.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/sql-settings.asciidoc[]
include::settings/transform-settings.asciidoc[]
include::modules/transport.asciidoc[]
include::modules/threadpool.asciidoc[]
include::settings/notification-settings.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::setup/setup-xes.asciidoc[]
include::setup/setup-xclient.asciidoc[]
include::modules/plugins.asciidoc[]