mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +00:00
5a2c6f0d4f
Plugin discovery documentation contained information about installing Elasticsearch 2.0 and installing an oracle JDK, both of which is no longer valid. While noticing that the instructions used cleartext HTTP to install packages, this commit replaces HTTPs links instead of HTTP where possible. In addition a few community links have been removed, as they do not seem to exist anymore. Co-authored-by: Alexander Reelsen <alexander@reelsen.net>
176 lines
5.8 KiB
Plaintext
176 lines
5.8 KiB
Plaintext
[[targz]]
|
|
=== Install Elasticsearch from archive on Linux or MacOS
|
|
|
|
Elasticsearch is as a `.tar.gz` archive for Linux and MacOS.
|
|
|
|
include::license.asciidoc[]
|
|
|
|
The latest stable version of Elasticsearch can be found on the
|
|
link:/downloads/elasticsearch[Download Elasticsearch] page.
|
|
Other versions can be found on the
|
|
link:/downloads/past-releases[Past Releases page].
|
|
|
|
NOTE: Elasticsearch includes a bundled version of https://openjdk.java.net[OpenJDK]
|
|
from the JDK maintainers (GPLv2+CE). To use your own version of Java,
|
|
see the <<jvm-version, JVM version requirements>>
|
|
|
|
[[install-linux]]
|
|
==== Download and install archive for Linux
|
|
|
|
ifeval::["{release-state}"=="unreleased"]
|
|
|
|
Version {version} of Elasticsearch has not yet been released.
|
|
|
|
endif::[]
|
|
|
|
ifeval::["{release-state}"!="unreleased"]
|
|
|
|
The Linux archive for Elasticsearch v{version} can be downloaded and installed as follows:
|
|
|
|
["source","sh",subs="attributes"]
|
|
--------------------------------------------
|
|
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}-linux-x86_64.tar.gz
|
|
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}-linux-x86_64.tar.gz.sha512
|
|
shasum -a 512 -c elasticsearch-{version}-linux-x86_64.tar.gz.sha512 <1>
|
|
tar -xzf elasticsearch-{version}-linux-x86_64.tar.gz
|
|
cd elasticsearch-{version}/ <2>
|
|
--------------------------------------------
|
|
<1> Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output
|
|
`elasticsearch-{version}-linux-x86_64.tar.gz: OK`.
|
|
<2> This directory is known as `$ES_HOME`.
|
|
|
|
Alternatively, you can download the following package, which includes only
|
|
Apache 2.0 licensed code:
|
|
https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-oss-{version}-linux-x86_64.tar.gz
|
|
|
|
endif::[]
|
|
|
|
[[install-macos]]
|
|
==== Download and install archive for MacOS
|
|
|
|
ifeval::["{release-state}"=="unreleased"]
|
|
|
|
Version {version} of Elasticsearch has not yet been released.
|
|
|
|
endif::[]
|
|
|
|
ifeval::["{release-state}"!="unreleased"]
|
|
|
|
The MacOS archive for Elasticsearch v{version} can be downloaded and installed as follows:
|
|
|
|
["source","sh",subs="attributes"]
|
|
--------------------------------------------
|
|
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}-darwin-x86_64.tar.gz
|
|
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-{version}-darwin-x86_64.tar.gz.sha512
|
|
shasum -a 512 -c elasticsearch-{version}-darwin-x86_64.tar.gz.sha512 <1>
|
|
tar -xzf elasticsearch-{version}-darwin-x86_64.tar.gz
|
|
cd elasticsearch-{version}/ <2>
|
|
--------------------------------------------
|
|
<1> Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output
|
|
`elasticsearch-{version}-darwin-x86_64.tar.gz: OK`.
|
|
<2> This directory is known as `$ES_HOME`.
|
|
|
|
Alternatively, you can download the following package, which includes only
|
|
Apache 2.0 licensed code:
|
|
https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-oss-{version}-darwin-x86_64.tar.gz
|
|
|
|
endif::[]
|
|
|
|
ifdef::include-xpack[]
|
|
[role="xpack"]
|
|
[[targz-enable-indices]]
|
|
==== Enable automatic creation of system indices
|
|
|
|
include::xpack-indices.asciidoc[]
|
|
|
|
endif::include-xpack[]
|
|
|
|
[[targz-running]]
|
|
include::targz-start.asciidoc[]
|
|
|
|
include::check-running.asciidoc[]
|
|
|
|
Log printing to `stdout` can be disabled using the `-q` or `--quiet`
|
|
option on the command line.
|
|
|
|
[[setup-installation-daemon]]
|
|
include::targz-daemon.asciidoc[]
|
|
|
|
[[targz-configuring]]
|
|
==== Configuring Elasticsearch on the command line
|
|
|
|
Elasticsearch loads its configuration from the `$ES_HOME/config/elasticsearch.yml`
|
|
file by default. The format of this config file is explained in
|
|
<<settings>>.
|
|
|
|
Any settings that can be specified in the config file can also be specified on
|
|
the command line, using the `-E` syntax as follows:
|
|
|
|
[source,sh]
|
|
--------------------------------------------
|
|
./bin/elasticsearch -d -Ecluster.name=my_cluster -Enode.name=node_1
|
|
--------------------------------------------
|
|
|
|
TIP: Typically, any cluster-wide settings (like `cluster.name`) should be
|
|
added to the `elasticsearch.yml` config file, while any node-specific settings
|
|
such as `node.name` could be specified on the command line.
|
|
|
|
[[targz-layout]]
|
|
==== Directory layout of archives
|
|
|
|
The archive distributions are entirely self-contained. All files and
|
|
directories are, by default, contained within `$ES_HOME` -- the directory
|
|
created when unpacking the archive.
|
|
|
|
This is very convenient because you don't have to create any directories to
|
|
start using Elasticsearch, and uninstalling Elasticsearch is as easy as
|
|
removing the `$ES_HOME` directory. However, it is advisable to change the
|
|
default locations of the config directory, the data directory, and the logs
|
|
directory so that you do not delete important data later on.
|
|
|
|
|
|
[cols="<h,<,<m,<m",options="header",]
|
|
|=======================================================================
|
|
| Type | Description | Default Location | Setting
|
|
| home
|
|
| Elasticsearch home directory or `$ES_HOME`
|
|
d| Directory created by unpacking the archive
|
|
|
|
|
|
|
| bin
|
|
| Binary scripts including `elasticsearch` to start a node
|
|
and `elasticsearch-plugin` to install plugins
|
|
| $ES_HOME/bin
|
|
d|
|
|
|
|
| conf
|
|
| Configuration files including `elasticsearch.yml`
|
|
| $ES_HOME/config
|
|
| <<config-files-location,ES_PATH_CONF>>
|
|
|
|
| data
|
|
| The location of the data files of each index / shard allocated
|
|
on the node. Can hold multiple locations.
|
|
| $ES_HOME/data
|
|
| path.data
|
|
|
|
| logs
|
|
| Log files location.
|
|
| $ES_HOME/logs
|
|
| path.logs
|
|
|
|
| plugins
|
|
| Plugin files location. Each plugin will be contained in a subdirectory.
|
|
| $ES_HOME/plugins
|
|
|
|
|
|
|
| repo
|
|
| Shared file system repository locations. Can hold multiple locations. A file system repository can be placed in to any subdirectory of any directory specified here.
|
|
d| Not configured
|
|
| path.repo
|
|
|
|
|=======================================================================
|
|
|
|
|
|
include::next-steps.asciidoc[]
|