Cleanup of macOS installation docs (#7925)
* First pass through macos doc * Some cleanup, mention of Judy * A bit of final cleanup * Remove depth
Joel Hans committed
Feb 3, 2020 at 08:14 UTC
5455d8a99fab4e1e5472ef8f90c7d81a5e1c5a2d
1 file changed
+50
-18
packaging/installer/methods/macos.md
+50
-18
@@ -1,42 +1,74 @@
1
# Install Netdata on macOS
2
3
-Netdata on macOS still has limited charts, but external plugins do work.
3
+Netdata works on macOS, albeit with some limitations. The number of charts displaying system metrics is limited, but you
4
+can use any of Netdata's [external plugins](../../../collectors/plugins.d/README.md) to monitor any services you might
5
+have installed on your macOS system. You could also use a macOS system as the master node in a [streaming
6
+configuration](../../../streaming/README.md).
7
5
-## With Homebrew
8
+We recommend installing Netdata with the community-created and -maintained [**Homebrew
9
+package**](#install-netdata-with-the-homebrew-package).
10
7
-You can either install Netdata with [Homebrew](https://brew.sh/)
11
+- [Install Netdata via the Homebrew package](#install-netdata-with-the-homebrew-package)
12
+- [Install Netdata from source](#install-netdata-from-source)
13
+
14
+## Install Netdata with the Homebrew package
15
+
16
+If you don't have [Homebrew](https://brew.sh/) installed already, begin with their installation script:
17
+
18
+```bash
19
+/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
20
+```
21
+
22
+Next, you can use Homebrew's package, which installs Netdata all its dependencies in a single step:
23
24
```sh
25
brew install netdata
26
```
27
13
-## From source
28
+> Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`. Use the `edit-config` script
29
+> and the files in this directory to configure Netdata. For reference, you can find stock configuration files at
30
+> `/usr/local/Cellar/netdata/{NETDATA_VERSION}/lib/netdata/conf.d/`.
31
15
-or from source:
32
+Skip on ahead to the [What's next?](#whats-next) section to find links to helpful post-installation guides.
33
17
-```sh
18
-# install Xcode Command Line Tools
34
+## Install Netdata from source
35
+
36
+We don't recommend installing Netdata from source on macOS, as it can be difficult to configure and install dependencies
37
+manually.
38
+
39
+First open your terminal of choice and install the Xcode development packages.
40
+
41
+```bash
42
xcode-select --install
43
```
44
22
-click `Install` in the software update popup window, then
45
+Click **Install** on the Software Update popup window that appears. Then, use the same terminal session to use Homebrew
46
+to install some of Netdata's prerequisites.
47
24
-```sh
25
-# install HomeBrew package manager
26
-/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
48
+```bash
49
+brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl@1.1
50
+```
51
+
52
+If you want to use the [database engine](../../../database/engine/README.md) to store your metrics, you need to download
53
+and install the [Judy library](https://sourceforge.net/projects/judy/) before proceeding compiling Netdata.
54
28
-# install required packages
29
-brew install ossp-uuid autoconf automake pkg-config
55
+Next, download Netdata from our GitHub repository:
56
+
57
+```bash
58
+git clone https://github.com/netdata/netdata.git
59
+```
60
31
-# download Netdata
32
-git clone https://github.com/netdata/netdata.git --depth=100
61
+Finally, `cd` into the newly-created directory and then start the installer script:
62
34
-# install Netdata in /usr/local/netdata
35
-cd netdata
63
+```bash
64
+cd netdata/
65
sudo ./netdata-installer.sh --install /usr/local
66
```
67
39
-The installer will also install a startup plist to start Netdata when your Mac boots.
68
+> Your Netdata configuration directory will be at `/usr/local/netdata/`, and your stock configuration directory will
69
+> be at **`/usr/local/lib/netdata/conf.d/`.**
70
+>
71
+> The installer will also install a startup plist to start Netdata when your Mac boots.
72
73
## What's next?
74