Add notices to FreeBSD/pfSense docs that they are community-supported (#10171)
* Add notice about community-maintained * Update Netdata version * Tweak a few commands * Add curl example to freebsd * Update version
Joel Hans committed
Nov 3, 2020 at 11:18 UTC
e681907b218f3fbde3bbbd2e00549dac12541578
2 files changed
+63
-24
packaging/installer/methods/freebsd.md
+17
-3
@@ -1,13 +1,20 @@
1
<!--
2
----
2
title: "Install Netdata on FreeBSD"
3
+description: "Install Netdata on FreeBSD to monitor the health and performance of bare metal or VMs with thousands of real-time, per-second metrics."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md
5
----
5
-->
6
7
# Install Netdata on FreeBSD
8
9
+> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the
10
+> details of the installation process, such as version numbers for downloadable packages, before proceeding.
11
+>
12
+> You can help improve this document by [submitting a
13
+> PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md) with your recommended
14
+> improvements or changes. Thank you!
15
+
16
## Install latest version
17
+
18
This is how to install the latest Netdata version on FreeBSD:
19
20
Install required packages (**need root permission**):
@@ -19,9 +26,16 @@ pkg install bash e2fsprogs-libuuid git curl autoconf automake pkgconf pidof Judy
26
Download Netdata:
27
28
```sh
22
-fetch https://github.com/netdata/netdata/releases/download/v1.25.0/netdata-v1.25.0.tar.gz
29
+fetch https://github.com/netdata/netdata/releases/download/v1.26.0/netdata-v1.26.0.tar.gz
30
```
31
32
+> ⚠️ Verify the latest version by either navigating to [Netdata's latest
33
+> release](https://github.com/netdata/netdata/releases/latest) or using `curl`:
34
+>
35
+> ```bash
36
+> basename $(curl -Ls -o /dev/null -w %{url_effective} https://github.com/netdata/netdata/releases/latest)
37
+> ```
38
+
39
Unzip the downloaded file:
40
41
```sh
packaging/installer/methods/pfsense.md
+46
-21
@@ -1,47 +1,72 @@
1
<!--
2
----
2
title: "Install Netdata on pfSense"
3
+description: "Install Netdata on pfSense to monitor the health and performance of firewalls with thousands of real-time, per-second metrics."
4
custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md
5
----
5
-->
6
7
# Install Netdata on pfSense
8
10
-To install Netdata on pfSense, run the following commands (within a shell or under the **Diagnostics/Command** prompt
11
-within the pfSense web interface).
9
+> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the
10
+> details of the installation process, such as version numbers for downloadable packages, before proceeding.
11
+>
12
+> You can help improve this document by [submitting a
13
+> PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/pfsense.md) with your recommended
14
+> improvements or changes. Thank you!
15
13
-Note that the first four packages are downloaded from the pfSense repository for maintaining compatibility with pfSense,
14
-Netdata, Judy and Python are downloaded from the FreeBSD repository.
16
+## Install prerequisites/dependencies
17
16
-```sh
18
+To install Netdata on pfSense, first run the following command (within a shell or under the **Diagnostics/Command**
19
+prompt within the pfSense web interface).
20
+
21
+```bash
22
pkg install -y pkgconf bash e2fsprogs-libuuid libuv nano
23
+```
24
+
25
+Then run the following commands to download various dependencies from the FreeBSD repository.
26
+
27
+```sh
28
pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/Judy-1.0.5_2.txz
19
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-certifi-2020.4.5.1.txz
29
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/json-c-0.15_1.txz
30
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-certifi-2020.6.20.txz
31
pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-asn1crypto-1.3.0.txz
21
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-pycparser-2.19.txz
22
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-cffi-1.14.0.txz
23
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-six-1.14.0.txz
32
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-pycparser-2.20.txz
33
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-cffi-1.14.3.txz
34
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-six-1.15.0.txz
35
pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-cryptography-2.6.1.txz
25
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-idna-2.8.txz
36
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-idna-2.10.txz
37
pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-openssl-19.0.0.txz
38
pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-pysocks-1.7.1.txz
28
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-urllib3-1.25.7,1.txz
29
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-yaml-5.2.txz
30
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/netdata-1.20.0_3.txz
39
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-urllib3-1.25.11,1.txz
40
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/py37-yaml-5.3.1.txz
41
```
42
33
-**Note:** If you receive a `Not Found` error during the last two commands above, you will either need to manually look
34
-in the [repo folder](http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/) for the latest available package and use its
35
-URL instead, or you can try manually changing the Netdata version in the URL to the latest version.
43
+> ⚠️ If any of the above commands return a `Not Found` error, you need to manually search for the latest package in the
44
+> [FreeBSD repository](https://www.freebsd.org/ports/). Search for the package's name, such as `py37-cffi`, find the
45
+> latest version number, and update the command accordingly.
46
+
47
+> ⚠️ On pfSense 2.4.5, Python version 3.7 may be installed by the system, in which case you should should not install
48
+> Python from the FreeBSD repository as instructed above.
49
37
-**Note:** On pfSense 2.4.5, Python version 3.7 may be installed by the system, in which case you should should not install Python from the FreeBSD repository as instructed above.
50
+> ⚠️ If you are using the `apcupsd` collector, you need to make sure that apcupsd is up before starting Netdata.
51
+> Otherwise a infinitely running `cat` process triggered by the default activated apcuspd charts plugin will eat up CPU
52
+> and RAM (`/tmp/.netdata-charts.d-*/run-*`). This also applies to `OPNsense`.
53
+
54
+## Install Netdata
55
+
56
+You can now install Netdata from the FreeBSD repository.
57
+
58
+```bash
59
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/netdata-1.26.0.txz
60
+```
61
+
62
+> ⚠️ If the above command returns a `Not Found` error, you need to manually search for the latest version of Netdata in
63
+> the [FreeBSD repository](https://www.freebsd.org/ports/). Search for `netdata`, find the latest version number, and
64
+> update the command accordingly.
65
66
You must edit `/usr/local/etc/netdata/netdata.conf` and change `bind to = 127.0.0.1` to `bind to = 0.0.0.0`.
67
68
To start Netdata manually, run `service netdata onestart`.
69
43
-**Warning:** If you are using the `apcupsd` collector, you need to make sure that apcupsd is up before starting Netdata. Otherwise a infinitely running `cat` process triggered by the default activated apcuspd charts plugin will eat up CPU and RAM (`/tmp/.netdata-charts.d-*/run-*`). This also applies to `OPNsense`.
44
-
70
Visit the Netdata dashboard to confirm it's working: `http://<pfsenseIP>:19999`
71
72
To start Netdata automatically every boot, add `service netdata onestart` as a Shellcmd entry within the pfSense web