Skip to content

Commit fdfa2cd

Browse files
committed
[DOCS] Add brew install instructions. Closes #42914 (#42915)
1 parent 508c38a commit fdfa2cd

File tree

3 files changed

+82
-4
lines changed

3 files changed

+82
-4
lines changed

docs/reference/getting-started.asciidoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,11 @@ NOTE: Elasticsearch includes a bundled version of http://openjdk.java.net[OpenJD
118118
from the JDK maintainers (GPLv2+CE). To use your own version of Java,
119119
see the <<jvm-version, JVM version requirements>>
120120

121-
The binaries are available from http://www.elastic.co/downloads[`www.elastic.co/downloads`]
122-
along with all the releases that have been made in the past. For each release, platform
123-
dependent archive versions are available for Windows, Linux and MacOS, as well as `DEB` and `RPM`
124-
packages for Linux, and `MSI` installation packages for Windows.
121+
The binaries are available from http://www.elastic.co/downloads[`www.elastic.co/downloads`].
122+
Platform dependent archives are available for Windows, Linux and macOS. In addition,
123+
`DEB` and `RPM` packages are available for Linux, and an `MSI` installation package
124+
is available for Windows. You can also use the Elastic Homebrew tap to <<brew,install
125+
using the brew package manager>> on macOS.
125126

126127
[float]
127128
=== Installation example on Linux

docs/reference/setup/install.asciidoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@ downloaded from the Elastic Docker Registry.
5959
+
6060
{ref}/docker.html[Install {es} with Docker]
6161

62+
`brew`::
63+
64+
Formulae are available from the Elastic Homebrew tap for installing
65+
{es} on macOS with the Homebrew package manager.
66+
+
67+
{ref}/brew.html[Install {es} on macOS with Homebrew]
68+
6269
[float]
6370
[[config-mgmt-tools]]
6471
=== Configuration Management Tools
@@ -84,3 +91,4 @@ include::install/windows.asciidoc[]
8491

8592
include::install/docker.asciidoc[]
8693

94+
include::install/brew.asciidoc[]
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
[[brew]]
2+
=== Install {es} on macOS with Homebrew
3+
4+
Elastic publishes Homebrew formulae so you can install {es} with the
5+
https://brew.sh/[Homebrew] package manager.
6+
7+
To install with Homebrew, you first need to tap the
8+
Elastic Homebrew repository:
9+
10+
[source,sh]
11+
-------------------------
12+
brew tap elastic/tap
13+
-------------------------
14+
15+
Once you've tapped the Elastic Homebrew repo, you can use `brew install` to
16+
install the default distribution of {es}:
17+
18+
[source,sh]
19+
-------------------------
20+
brew install elastic/tap/elasticsearch-full
21+
-------------------------
22+
23+
This installs the most recently released default distribution of {es}.
24+
To install the OSS distribution, specify `elastic/tap/elasticsearch-oss`.
25+
26+
[[brew-layout]]
27+
==== Directory layout for Homebrew installs
28+
29+
When you install {es} with `brew install` the config files, logs,
30+
and data directory are stored in the following locations.
31+
32+
[cols="<h,<,<m,<m",options="header",]
33+
|=======================================================================
34+
| Type | Description | Default Location | Setting
35+
| home
36+
| Elasticsearch home directory or `$ES_HOME`
37+
| /usr/local/var/homebrew/linked/elasticsearch
38+
d|
39+
40+
| bin
41+
| Binary scripts including `elasticsearch` to start a node
42+
and `elasticsearch-plugin` to install plugins
43+
| /usr/local/var/homebrew/linked/elasticsearch/bin
44+
d|
45+
46+
| conf
47+
| Configuration files including `elasticsearch.yml`
48+
| /usr/local/etc/elasticsearch
49+
| <<config-files-location,ES_PATH_CONF>>
50+
51+
| data
52+
| The location of the data files of each index / shard allocated
53+
on the node. Can hold multiple locations.
54+
| /usr/local/var/lib/elasticsearch
55+
| path.data
56+
57+
| logs
58+
| Log files location.
59+
| /usr/local/var/log/elasticsearch
60+
| path.logs
61+
62+
| plugins
63+
| Plugin files location. Each plugin will be contained in a subdirectory.
64+
| /usr/local/var/homebrew/linked/elasticsearch/plugins
65+
|
66+
67+
|=======================================================================
68+
69+
include::next-steps.asciidoc[]

0 commit comments

Comments
 (0)