Docs install cleanup (#12057)
* Extensively reworked MacOS installation page. * Removing outdated information * Updated more instances of the old kickstart script * Update kickstart command with tmp directories * amend command to avoid merge conflict * Removed reviewers note
Tina Luedtke committed
Feb 2, 2022 at 14:04 UTC
d46870e3c9d0a9f1ba8721343bec378a4d163e54
13 files changed
+103
-146
README.md
+2
-2
@@ -120,9 +120,9 @@ and builds all dependencies, including those required to connect to [Netdata Clo
120
choose, and enables [automatic nightly
121
updates](https://learn.netdata.cloud/docs/agent/packaging/installer#nightly-vs-stable-releases) and [anonymous
122
statistics](https://learn.netdata.cloud/docs/agent/anonymous-statistics).
123
-
123
+<!-- candidate for reuse -->
124
```bash
125
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
125
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
126
```
127
128
To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`.
claim/README.md
+7
-7
@@ -73,7 +73,7 @@ When coming from [Nodes view page](https://learn.netdata.cloud/docs/cloud/visua
73
If you want to connect a node that is running on a Linux environment, the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
74
75
```
76
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
76
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
77
```
78
The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if you don't see
79
the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
@@ -101,7 +101,7 @@ The default user is `netdata`. Yours may be different, so pay attention to the o
101
and run the script.
102
103
```bash
104
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
104
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
105
```
106
### Connect an agent running in Docker
107
@@ -227,7 +227,7 @@ you don't see the node in your Space after 60 seconds, see the [troubleshooting
227
To connect a node that is running on a macOS environment the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/methods/macos.md#install-netdata-with-our-automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to:
228
229
```bash
230
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
230
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
231
```
232
The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if you don't see
233
the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting).
@@ -267,7 +267,7 @@ You can now move on to connecting. When you connect with the [kickstart](/packag
267
append the same proxy setting you added to `netdata.conf`.
268
269
```bash
270
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud --claim-proxy socks5h://203.0.113.0:1080
270
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud --claim-proxy http://[user:pass@]host:ip
271
```
272
273
Hit **Enter**. The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if
@@ -474,13 +474,13 @@ Our suggestion is to first run kickstart to upgrade your agent by running the co
474
**Linux**
475
476
```bash
477
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
477
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
478
```
479
480
**macOS**
481
482
```bash
483
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/
483
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install /usr/local/
484
```
485
### Claiming script
486
@@ -499,7 +499,7 @@ using `sudo`, or as the user running the Agent (typically `netdata`), and passin
499
-hostname=HOSTNAME
500
where HOSTNAME is the result of the hostname command by default.
501
-proxy=PROXY_URL
502
- where PROXY_URL is the endpoint of a SOCKS5 proxy.
502
+ where PROXY_URL is the endpoint of a HTTP or HTTPS proxy.
503
```
504
505
For example, the following command connects an Agent and adds it to rooms `room1` and `room2`:
docs/guides/export/export-netdata-metrics-graphite.md
+1
-1
@@ -32,7 +32,7 @@ If you don't have the Netdata Agent installed already, visit the [installation g
32
for the recommended instructions for your system. In most cases, you can use the one-line installation script:
33
34
```bash
35
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
35
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
36
```
37
38
Once installation finishes, open your browser and navigate to `http://NODE:19999`, replacing `NODE` with the IP address
docs/guides/monitor/lamp-stack.md
+1
-1
@@ -60,7 +60,7 @@ If you don't have the free, open-source Netdata monitoring agent installed on yo
60
kickstart command](/docs/get-started.mdx):
61
62
```bash
63
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
63
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
64
```
65
66
The Netdata Agent is now collecting metrics from your node every second. You don't need to jump into the dashboard yet,
docs/guides/monitor/pi-hole-raspberry-pi.md
+1
-1
@@ -53,7 +53,7 @@ On Raspberry Pis running Raspbian, the best way to install Netdata is our one-li
53
you to install dependencies, then compiles Netdata from source via [GitHub](https://github.com/netdata/netdata).
54
55
```bash
56
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
56
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
57
```
58
59
Once installed on a Raspberry Pi 4 with no accessories, Netdata starts collecting roughly 1,500 metrics every second and
docs/guides/step-by-step/step-00.md
+11
-3
@@ -46,9 +46,17 @@ This script will install Netdata from source, keep it up to date with nightly re
46
[registry](/registry/README.md), and sends [_anonymous statistics_](/docs/anonymous-statistics.md) about how you use
47
Netdata. We use this information to better understand how we can improve the Netdata experience for all our users.
48
49
-```bash
50
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
51
-```
49
+To install Netdata, run the following as your normal user:
50
+
51
+´´´bash
52
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
53
+´´´
54
+Or, if you have cURL but not wget (such as on macOS):
55
+
56
+´´´bash
57
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
58
+´´´
59
+
60
61
Once finished, you'll have Netdata installed, and you'll be set up to get _nightly updates_ to get the latest features,
62
improvements, and bugfixes.
docs/guides/step-by-step/step-09.md
-4
@@ -122,10 +122,6 @@ libraries to make this exporting connection exist. Since you most likely install
122
script, all you have to do is run that script again. Don't worry—any configuration changes you made along the way will
123
be retained!
124
125
-```bash
126
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
127
-```
128
-
125
Now, from your Netdata config directory, initialize and edit a `exporting.conf` file to tell Netdata where to find the
126
database you just created.
127
exporting/WALKTHROUGH.md
+2
-1
@@ -68,8 +68,9 @@ link](/packaging/installer/README.md), the Netdata devs give us several one-line
68
any issues with these one liners and their bootstrapping scripts so far (If you guys run into anything do share). Run
69
the following command in your container.
70
71
+<!-- candidate for reuse -->
72
```sh
72
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) --dont-wait
73
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --dont-wait
74
```
75
76
After the install completes you should be able to hit the Netdata dashboard at <http://localhost:19999/> (replace
exporting/prometheus/README.md
+13
-10
@@ -7,10 +7,6 @@ sidebar_label: Using Netdata with Prometheus
7
8
# Using Netdata with Prometheus
9
10
-> IMPORTANT: the format Netdata sends metrics to Prometheus has changed since Netdata v1.7. The new Prometheus exporting
11
-> connector for Netdata supports a lot more features and is aligned to the development of the rest of the Netdata
12
-> exporting connectors.
13
-
10
Prometheus is a distributed monitoring system which offers a very simple setup along with a robust data model. Recently
11
Netdata added support for Prometheus. I'm going to quickly show you how to install both Netdata and Prometheus on the
12
same server. We can then use Grafana pointed at Prometheus to obtain long term metrics Netdata offers. I'm assuming we
@@ -21,10 +17,20 @@ are starting at a fresh ubuntu shell (whether you'd like to follow along in a VM
17
### Installing Netdata
18
19
There are number of ways to install Netdata according to [Installation](/packaging/installer/README.md). The suggested way
24
-of installing the latest Netdata and keep it upgrade automatically. Using one line installation:
20
+of installing the latest Netdata and keep it upgrade automatically.
21
26
-```sh
27
-bash <(curl -Ss https://my-netdata.io/kickstart.sh)
22
+<!-- candidate for reuse -->
23
+
24
+To install Netdata, run the following as your normal user:
25
+
26
+```bash
27
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
28
+```
29
+
30
+Or, if you have cURL but not wget (such as on macOS):
31
+
32
+```bash
33
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
34
```
35
36
At this point we should have Netdata listening on port 19999. Attempt to take your browser here:
@@ -208,9 +214,6 @@ this and click on 'targets' We should see the Netdata host as a scraped target.
214
215
## Netdata support for Prometheus
216
211
-> IMPORTANT: the format Netdata sends metrics to Prometheus has changed since Netdata v1.6. The new format allows easier
212
-> queries for metrics and supports both `as collected` and normalized metrics.
213
-
217
Before explaining the changes, we have to understand the key differences between Netdata and Prometheus.
218
219
### understanding Netdata metrics
packaging/installer/methods/kickstart.md
+3
-4
@@ -19,7 +19,7 @@ The kickstart script works on all Linux distributions and macOS environments. By
19
To install Netdata, run the following as your normal user:
20
21
```bash
22
-wget -O ./kickstart.sh https://my-netdata.io/kickstart.sh && sh ./kickstart.sh
22
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
23
```
24
25
Or, if you have cURL but not wget (such as on macOS):
@@ -89,15 +89,14 @@ area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
89
- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
90
after the install.
91
- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
92
-- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of
93
- `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or `http://[user:pass@]host:ip` for an HTTP(S) proxy.
92
+- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
93
See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details.
94
- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
95
96
For example:
97
98
```bash
100
-wget -O ./kickstart.sh https://my-netdata.io/kickstart.sh && sh ./kickstart.sh --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
99
+wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2
100
```
101
102
Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](/claim/README.md#connect-an-agent-without-root-privileges) section.
packaging/installer/methods/macos.md
+59
-54
@@ -5,94 +5,102 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal
5
6
# Install Netdata on macOS
7
8
-Netdata works on macOS, albeit with some limitations. The number of charts displaying system metrics is limited, but you
9
-can use any of Netdata's [external plugins](/collectors/plugins.d/README.md) to monitor any services you might
10
-have installed on your macOS system. You could also use a macOS system as the parent node in a [streaming
11
-configuration](/streaming/README.md).
8
+Netdata works on macOS, albeit with some limitations.
9
+The number of charts displaying system metrics is limited, but you can use any of Netdata's [external plugins](/collectors/plugins.d/README.md) to monitor any services you might have installed on your macOS system.
10
+You could also use a macOS system as the parent node in a [streaming configuration](/streaming/README.md).
11
13
-We recommend you to **[install Netdata with the our automatic one-line installation script](#install-netdata-with-our-automatic-one-line-installation-script)**,
12
+You can install Netdata in one of the three following ways:
13
15
-
16
-As an alternative you also have community-created and -maintained [**Homebrew
17
-package**](#install-netdata-with-the-homebrew-package).
18
-
19
-- [Install Netdata via the Homebrew package](#install-netdata-with-the-homebrew-package)
14
+- **[Install Netdata with the our automatic one-line installation script (recommended)](#install-netdata-with-our-automatic-one-line-installation-script)**,
15
+- [Install Netdata via Homebrew](#install-netdata-with-the-homebrew-package)
16
- [Install Netdata from source](#install-netdata-from-source)
17
22
-Being community-created and -maintained we don't guarantee that the features made available on our installation script will also be available or give support to it.
18
+Each of these installation option requires [Homebrew](https://brew.sh/) for handling dependencies.
19
+
20
+> The Netdata Homebrew package is community-created and -maintained.
21
+> Community-maintained packages _may_ receive support from Netdata, but are only a best-effort affair. Learn more about [Netdata's platform support policy](/packaging/platform_support).
22
23
## Install Netdata with our automatic one-line installation script
24
26
-To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) script you will just need to run:
25
+**Local Netdata Agent installation**
26
+To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) open a new terminal and run:
27
28
```bash
29
-wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh
29
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
30
```
31
+The Netdata Agent is be installed under `/usr/local/netdata`. Dependencies are handled via Homebrew.
32
32
-With this script, you are also able to connect your nodes directly to Netdata Cloud if you wish, see more details on [Connect an agent running in macOS](/claim/README.md#connect-an-agent-running-in-macos)
33
-
34
-This currently only supports building Netdata locally, and requires dependencies to be handled either via Homebrew
35
-or MacPorts (we preferentially use Homebrew if both are found). By default, this will install Netdata under
36
-`/usr/local/netdata`.
33
+**Automatically connect to Netdata Cloud during installation**
34
+<!-- Potential reuse: https://learn.netdata.cloud/docs/agent/claim#connect-an-agent-running-in-macos-->
35
+<!--Potential reuse https://learn.netdata.cloud/docs/agent/packaging/installer/methods/kickstart#connect-node-to-netdata-cloud-during-installation The following information is copied from this link.-->
36
38
-## Install Netdata with the Homebrew package
37
+The `kickstart.sh` script accepts additional parameters to automatically [connect](/claim/README.md) your node to Netdata
38
+Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata
39
+Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect Nodes** in the [Spaces management
40
+area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces).
41
40
-If you don't have [Homebrew](https://brew.sh/) installed already, begin with their installation script:
42
+- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node
43
+ after the install.
44
+- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in.
45
+- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy.
46
+ See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details.
47
+- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`.
48
49
+For example:
50
```bash
43
-/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
51
+curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud
52
```
53
+The Netdata Agent is installed under `/usr/local/netdata` on your machine. Your machine will also show up as a node in your Netdata Cloud.
54
46
-Next, you can use Homebrew's package, which installs Netdata all its dependencies in a single step:
55
+If you experience issues while claiming your node, follow the steps in our [Troubleshooting](claim/README.md#troubleshooting) documentation.
56
+## Install Netdata via Homebrew
57
+
58
+To install Netdata and all its dependencies, run Homebrew using the following command:
59
60
```sh
61
brew install netdata
62
```
63
+Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`.
64
52
-> Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`. Use the `edit-config` script
53
-> and the files in this directory to configure Netdata. For reference, you can find stock configuration files at
54
-> `/usr/local/Cellar/netdata/{NETDATA_VERSION}/lib/netdata/conf.d/`.
65
+Use the `edit-config` script and the files in this directory to configure Netdata. For reference, you can find stock configuration files at `/usr/local/Cellar/netdata/{NETDATA_VERSION}/lib/netdata/conf.d/`.
66
67
Skip on ahead to the [What's next?](#whats-next) section to find links to helpful post-installation guides.
68
69
## Install Netdata from source
70
60
-We don't recommend installing Netdata from source on macOS, as it can be difficult to configure and install dependencies
61
-manually.
62
-
63
-First open your terminal of choice and install the Xcode development packages.
71
+We don't recommend installing Netdata from source on macOS, as it can be difficult to configure and install dependencies manually.
72
65
-```bash
66
-xcode-select --install
67
-```
73
+1. Open your terminal of choice and install the Xcode development packages:
74
69
-Click **Install** on the Software Update popup window that appears. Then, use the same terminal session to use Homebrew
70
-to install some of Netdata's prerequisites. You can omit `cmake` in case you do not want to use
71
-[Netdata Cloud](https://learn.netdata.cloud/docs/cloud/).
75
+ ```bash
76
+ xcode-select --install
77
+ ```
78
73
-```bash
74
-brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl libtool cmake
75
-```
79
+2. Click **Install** on the Software Update popup window that appears.
80
+3. Use the same terminal session to install some of Netdata's prerequisites using Homebrew. If you don't want to use [Netdata Cloud](https://learn.netdata.cloud/docs/cloud/), you can omit `cmake`.
81
77
-If you want to use the [database engine](/database/engine/README.md) to store your metrics, you need to download
82
+ ```bash
83
+ brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl libtool cmake
84
+ ```
85
+
86
+4. Optional: If you want to use the [database engine](/database/engine/README.md) to store your metrics, you need to download
87
and install the [Judy library](https://sourceforge.net/projects/judy/) before proceeding compiling Netdata.
88
80
-Next, download Netdata from our GitHub repository:
89
+5. Download Netdata from our GitHub repository:
90
82
-```bash
83
-git clone https://github.com/netdata/netdata.git --recursive
84
-```
91
+ ```bash
92
+ git clone https://github.com/netdata/netdata.git --recursive
93
+ ```
94
86
-Finally, `cd` into the newly-created directory and then start the installer script:
95
+6. `cd` into the newly-created directory and then start the installer script:
96
88
-```bash
89
-cd netdata/
90
-sudo ./netdata-installer.sh --install /usr/local
91
-```
97
+ ```bash
98
+ cd netdata/
99
+ sudo ./netdata-installer.sh --install /usr/local
100
+ ```
101
93
-> Your Netdata configuration directory will be at `/usr/local/netdata/`, and your stock configuration directory will
94
-> be at **`/usr/local/lib/netdata/conf.d/`.**
95
->
102
+> Your Netdata configuration directory will be at `/usr/local/netdata/`.
103
+> Your stock configuration directory will be at `/usr/local/lib/netdata/conf.d/`.
104
> The installer will also install a startup plist to start Netdata when your macOS system boots.
105
106
## What's next?
@@ -102,8 +110,5 @@ When you're finished with installation, check out our [single-node](/docs/quicks
110
111
Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md).
112
105
-Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and
106
-solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to
107
-external databases, and more.
113
114
[](<>)
packaging/installer/methods/source.md
-55
@@ -48,61 +48,6 @@ libraries and their header files must be copied into specific locations
48
in the source tree to be used.
49
50
### Netdata cloud
51
-
52
-Netdata Cloud functionality requires custom builds of libmosquitto and
53
-libwebsockets.
54
-
55
-#### libmosquitto
56
-
57
-Netdata maintains a custom fork of libmosquitto at
58
-https://github.com/netdata/mosquitto with patches to allow for proper
59
-integration with libwebsockets, which is needed for correct operation of
60
-Netdata Cloud functionality. To prepare this library for the build system:
61
-
62
-1. Verify the tag that Netdata expects to be used by checking the contents
63
- of `packaging/mosquitto.version` in your Netdata sources.
64
-2. Obtain the sources for that version by either:
65
- - Navigating to https://github.com/netdata/mosquitto/releases and
66
- downloading and unpacking the source code archive for that release.
67
- - Cloning the repository with `git` and checking out the required tag.
68
-3. If building on a platform other than Linux, prepare the mosquitto
69
- sources by running `cmake -D WITH_STATIC_LIBRARIES:boolean=YES .` in
70
- the mosquitto source directory.
71
-4. Build mosquitto by running `make -C lib` in the mosquitto source directory.
72
-5. In the Netdata source directory, create a directory called `externaldeps/mosquitto`.
73
-6. Copy `lib/mosquitto.h` from the mosquitto source directory to
74
- `externaldeps/mosquitto/mosquitto.h` in the Netdata source tree.
75
-7. Copy `lib/libmosquitto.a` from the mosquitto source directory to
76
- `externaldeps/mosquitto/libmosquitto.a` in the Netdata source tree. If
77
- building on a platform other than Linux, the file that needs to be
78
- copied will instead be named `lib/libmosquitto_static.a`, but it
79
- still needs to be copied to `externaldeps/mosquitto/libmosquitto.a`.
80
-
81
-#### libwebsockets
82
-
83
-Netdata uses the standard upstream version of libwebsockets located at
84
-https://github.com/warmcat/libwebsockets, but requires a build with SOCKS5
85
-support, which is not enabled by most pre-built versions. Currently,
86
-we do not support using a system copy of libwebsockets. To prepare this
87
-library for the build system:
88
-
89
-1. Verify the tag that Netdata expects to be used by checking the contents
90
- of `packaging/libwebsockets.version` in your Netdata sources.
91
-2. Obtain the sources for that version by either:
92
- - Navigating to https://github.com/warmcat/libwebsockets/releases and
93
- downloading and unpacking the source code archive for that release.
94
- - Cloning the repository with `git` and checking out the required tag.
95
-3. Prepare the libwebsockets sources by running `cmake -D
96
- LWS_WITH_SOCKS5:bool=ON .` in the libwebsockets source directory.
97
-4. Build libwebsockets by running `make` in the libwebsockets source
98
- directory.
99
-5. In the Netdata source directory, create a directory called
100
- `externaldeps/libwebsockets`.
101
-6. Copy `lib/libwebsockets.a` from the libwebsockets source directory to
102
- `externaldeps/libwebsockets/libwebsockets.a` in the Netdata source tree.
103
-7. Copy the entire contents of `include/` from the libwebsockets source
104
- directory to `externaldeps/libwebsockets/include` in the Netdata source tree.
105
-
51
#### JSON-C
52
53
Netdata requires the use of JSON-C for JSON parsing when using Netdata
web/api/exporters/prometheus/README.md
+3
-3
@@ -1,10 +1,10 @@
1
<!--
2
-title: "prometheus exporter"
2
+title: "Prometheus exporter"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/prometheus/README.md
4
-->
5
6
-# prometheus exporter
6
+# Prometheus exporter
7
8
-The prometheus exporter for Netdata is located at the [backends section for prometheus](/backends/prometheus/README.md).
8
+Read the Prometheus exporter documentation: [Using Netdata with Prometheus](/exporting/prometheus/README.md).
9
10
[](<>)