| 1 | # Install Netdata on FreeBSD |
| 2 | |
| 3 | :::info |
| 4 | |
| 5 | This guide is community-maintained and might not always reflect the latest details (like package versions). Double-check before proceeding! Want to help? [Submit a PR!](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/freebsd.md) |
| 6 | |
| 7 | ::: |
| 8 | |
| 9 | ## 1. Install dependencies |
| 10 | |
| 11 | Run as `root`: |
| 12 | |
| 13 | ```bash |
| 14 | pkg install bash e2fsprogs-libuuid git curl autoconf automake pkgconf pidof liblz4 libuv json-c cmake gmake |
| 15 | ``` |
| 16 | |
| 17 | Approve any prompts that appear. |
| 18 | |
| 19 | ## 2. Choose an Installation Method |
| 20 | |
| 21 | <details> |
| 22 | <summary><strong>Option A: Kickstart Installer (Recommended)</strong></summary> |
| 23 | |
| 24 | The simplest approach is to use our one-line [kickstart installer](/packaging/installer/methods/kickstart.md). |
| 25 | |
| 26 | - Prepare the installation command: |
| 27 | - For Netdata Cloud users: Navigate to your Space, click **Add Nodes** → Copy the command from the "Linux" tab. |
| 28 | - For standalone installation, use the example below. |
| 29 | |
| 30 | - Run the installation command: |
| 31 | ```bash |
| 32 | wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token <YOUR_TOKEN> --claim-url https://app.netdata.cloud |
| 33 | ``` |
| 34 | |
| 35 | :::note |
| 36 | |
| 37 | Replace `<YOUR_TOKEN>` with your actual claim token. |
| 38 | |
| 39 | ::: |
| 40 | |
| 41 | - After installation, access your Netdata dashboard at: |
| 42 | |
| 43 | ``` |
| 44 | http://NODE:19999 |
| 45 | ``` |
| 46 | |
| 47 | (`NODE` = your FreeBSD machine's hostname or IP) |
| 48 | |
| 49 | </details> |
| 50 | |
| 51 | ### Option B: FreeBSD Ports Installation |
| 52 | |
| 53 | Netdata is also available through the FreeBSD Ports collection: |
| 54 | |
| 55 | https://www.freshports.org/net-mgmt/netdata/ |
| 56 | |
| 57 | <details> |
| 58 | <summary><strong>Option C: Manual Installation (For Advanced Users)</strong></summary> |
| 59 | |
| 60 | - Download the latest Netdata release: |
| 61 | |
| 62 | ```bash |
| 63 | fetch https://github.com/netdata/netdata/releases/latest/download/netdata-latest.tar.gz |
| 64 | ``` |
| 65 | |
| 66 | Or download a specific version: |
| 67 | |
| 68 | ```bash |
| 69 | fetch https://github.com/netdata/netdata/releases/download/v2.3.2/netdata-v2.3.2.tar.gz |
| 70 | ``` |
| 71 | |
| 72 | - Extract the downloaded archive: |
| 73 | |
| 74 | ```bash |
| 75 | tar -xzf netdata*.tar.gz && rm netdata*.tar.gz |
| 76 | ``` |
| 77 | |
| 78 | - Install Netdata to `/opt/netdata`: |
| 79 | |
| 80 | ```bash |
| 81 | cd netdata-v* |
| 82 | ./netdata-installer.sh --install-prefix /opt |
| 83 | ``` |
| 84 | |
| 85 | - Configure Netdata to start automatically at boot: |
| 86 | |
| 87 | ```bash |
| 88 | sysrc netdata_enable="YES" |
| 89 | ``` |
| 90 | |
| 91 | - Start the Netdata service: |
| 92 | |
| 93 | ```bash |
| 94 | service netdata start |
| 95 | ``` |
| 96 | |
| 97 | </details> |
| 98 | |
| 99 | ## 3. Updating Netdata Installation |
| 100 | |
| 101 | If you enabled auto-updates with `--auto-update`, no further action is needed. |
| 102 | |
| 103 | For manual updates: |
| 104 | |
| 105 | ```bash |
| 106 | cd /opt/netdata/usr/libexec/netdata/ |
| 107 | ./netdata-updater.sh |
| 108 | ``` |
| 109 | |
| 110 | ## Optional Kickstart Parameters |
| 111 | |
| 112 | | Option | Description | |
| 113 | |------------------------------------------------------|------------------------------------------------------------------------------------------------------------| |
| 114 | | `--non-interactive` | Skip prompts and assume yes. | |
| 115 | | `--interactive` | Force interactive prompts. | |
| 116 | | `--release-channel stable` | Install stable builds (instead of nightly). | |
| 117 | | `--no-updates` | Disable auto-updates. | |
| 118 | | `--disable-telemetry` | Disable anonymous statistics. | |
| 119 | | `--native-only` | Install only if native packages are available. | |
| 120 | | `--static-only` | Install only if static builds are available. | |
| 121 | | `--install-prefix /opt` | Change installation directory. | |
| 122 | | `--prepare-offline-install-source ./netdata-offline` | Prepare offline installation source. See [Offline Install Guide](/packaging/installer/methods/offline.md). | |
| 123 | |
| 124 | ## Environment Variables (Advanced Users) |
| 125 | |
| 126 | | Variable | Purpose | |
| 127 | |-----------------------|--------------------------------------------------------------------| |
| 128 | | `TMPDIR` | Directory for temporary files. | |
| 129 | | `ROOTCMD` | Command used for privilege escalation (default: `sudo` or `doas`). | |
| 130 | | `DISABLE_TELEMETRY=1` | Disables anonymous telemetry data. | |
| 131 | |
| 132 | ## Telemetry Notice |
| 133 | |
| 134 | Anonymous usage data is collected by default. You can learn more or opt-out [here](/docs/netdata-agent/configuration/anonymous-telemetry-events.md). |