mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
ba14aaa004
* [DOCS] Add Docker-based quickstart instructions to README & ES guide * Removed attributes * Added basic tutorial * Fixed headings * Edit * [DOCS] Adding basic dev setup instructions to the ES guide * Incorporated security config from Kibana docs * Update README.asciidoc Co-authored-by: Adam Locke <adam.locke@elastic.co> * Update README.asciidoc Co-authored-by: Adam Locke <adam.locke@elastic.co> * Added callouts for version attributes * Update README.asciidoc Co-authored-by: Adam Locke <adam.locke@elastic.co> * Update README.asciidoc Co-authored-by: Adam Locke <adam.locke@elastic.co> * Added README content to guide topic * Snippet test fixes * Incorporated review feedback * Remove version * Update docs/reference/setup/run-elasticsearch-locally.asciidoc * Added info about security on by default * Fix xrefs * Update docs/reference/setup/run-elasticsearch-locally.asciidoc * Fix headers * Edits Co-authored-by: Adam Locke <adam.locke@elastic.co>
127 lines
3.4 KiB
Text
127 lines
3.4 KiB
Text
[[setup]]
|
|
= Set up {es}
|
|
|
|
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.
|
|
|
|
[discrete]
|
|
[[dedicated-host]]
|
|
== Use dedicated hosts
|
|
|
|
In production, we recommend you run {es} on a dedicated host or as a primary
|
|
service. Several {es} features, such as automatic JVM heap sizing, assume it's
|
|
the only resource-intensive application on the host or container. For example,
|
|
you might run {metricbeat} alongside {es} for cluster statistics, but a
|
|
resource-heavy {ls} deployment should be on its own host.
|
|
|
|
include::setup/install.asciidoc[]
|
|
|
|
include::setup/run-elasticsearch-locally.asciidoc[]
|
|
|
|
include::setup/configuration.asciidoc[]
|
|
|
|
include::setup/important-settings.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/health-diagnostic-settings.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/snapshot-settings.asciidoc[]
|
|
|
|
include::settings/transform-settings.asciidoc[]
|
|
|
|
include::modules/threadpool.asciidoc[]
|
|
|
|
include::settings/notification-settings.asciidoc[]
|
|
|
|
include::setup/advanced-configuration.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[]
|