diff options
Diffstat (limited to 'packaging/installer/methods')
| -rw-r--r-- | packaging/installer/methods/cloud-providers.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/freebsd.md | 15 | ||||
| -rw-r--r-- | packaging/installer/methods/freenas.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/kickstart.md | 32 | ||||
| -rw-r--r-- | packaging/installer/methods/kubernetes.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/macos.md | 8 | ||||
| -rw-r--r-- | packaging/installer/methods/manual.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/offline.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/pfsense.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/source.md | 2 | ||||
| -rw-r--r-- | packaging/installer/methods/synology.md | 6 |
11 files changed, 39 insertions, 36 deletions
diff --git a/packaging/installer/methods/cloud-providers.md b/packaging/installer/methods/cloud-providers.md index 08c0ed9da..bc5c9aae2 100644 --- a/packaging/installer/methods/cloud-providers.md +++ b/packaging/installer/methods/cloud-providers.md @@ -123,4 +123,4 @@ Name: Netdata Click **Add** to apply your new inbound security rule. -[](<>) + diff --git a/packaging/installer/methods/freebsd.md b/packaging/installer/methods/freebsd.md index 9c3db900f..12b55d6ad 100644 --- a/packaging/installer/methods/freebsd.md +++ b/packaging/installer/methods/freebsd.md @@ -93,16 +93,15 @@ The `netdata-updater.sh` script will update your Agent. | `--disable-plugin-nfacct` | Disable nfacct plugin. Default: enable it when libmnl and libnetfilter_acct are available| | `--enable-plugin-xenstat` | Enable the xenstat plugin. Default: enable it when libxenstat and libyajl are available| | `--disable-plugin-xenstat` | Disable the xenstat plugin| -| `--enable-backend-kinesis` | Enable AWS Kinesis backend. Default: enable it when libaws_cpp_sdk_kinesis and libraries (it depends on are available)| -| `--disable-backend-kinesis` | Disable AWS Kinesis backend. Default: enable it when libaws_cpp_sdk_kinesis and libraries (it depends on are available)| -| `--enable-backend-prometheus-remote-write` | Enable Prometheus remote write backend. Default: enable it when libprotobuf and libsnappy are available| -| `--disable-backend-prometheus-remote-write` | Disable Prometheus remote write backend. Default: enable it when libprotobuf and libsnappy are available| -| `--enable-backend-mongodb` | Enable MongoDB backend. Default: enable it when libmongoc is available| -| `--disable-backend-mongodb` | Disable MongoDB backend| +| `--disable-exporting-kinesis` | Disable AWS Kinesis exporting connector. Default: enable it when libaws_cpp_sdk_kinesis and libraries (it depends on are available)| +| `--enable-exporting-prometheus-remote-write` | Enable Prometheus remote write exporting connector. Default: enable it when libprotobuf and libsnappy are available| +| `--disable-exporting-prometheus-remote-write` | Disable Prometheus remote write exporting connector. Default: enable it when libprotobuf and libsnappy are available| +| `--enable-exporting-mongodb` | Enable MongoDB exporting connector. Default: enable it when libmongoc is available| +| `--disable-exporting-mongodb` | Disable MongoDB exporting connector| | `--enable-lto` | Enable Link-Time-Optimization. Default: enabled| | `--disable-lto` | Disable Link-Time-Optimization. Default: enabled| | `--disable-x86-sse` | Disable SSE instructions. By default SSE optimizations are enabled| | `--zlib-is-really-here` or `--libs-are-really-here` | If you get errors about missing zlib or libuuid but you know it is available, you might have a broken pkg-config. Use this option to proceed without checking pkg-config| -|`--disable-telemetry` | Use this flag to opt-out from our anonymous telemetry program. (DO_NOT_TRACK=1)| +|`--disable-telemetry` | Use this flag to opt-out from our anonymous telemetry program. (DISABLE_TELEMETRY=1)| + -[](<>) diff --git a/packaging/installer/methods/freenas.md b/packaging/installer/methods/freenas.md index a0dafdff8..a69f1e3fb 100644 --- a/packaging/installer/methods/freenas.md +++ b/packaging/installer/methods/freenas.md @@ -21,4 +21,4 @@ To start the Netdata service: service netdata start ``` -[](<>) + diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md index 5bd9633da..2ff20cfd6 100644 --- a/packaging/installer/methods/kickstart.md +++ b/packaging/installer/methods/kickstart.md @@ -12,7 +12,7 @@ import { OneLineInstallWget, OneLineInstallCurl } from '../../../../../src/compo This page covers detailed instructions on using and configuring the automatic one-line installation script named `kickstart.sh`. -The kickstart script works on all Linux distributions and macOS environments. By default, automatic nightly updates are enabled. If you are installing on macOS, make sure to check the [install documentation for macOS](packaging/installer/methods/macos.md) before continuing. +The kickstart script works on all Linux distributions and macOS environments. By default, automatic nightly updates are enabled. If you are installing on macOS, make sure to check the [install documentation for macOS](macos.md) before continuing. > If you are unsure whether you want nightly or stable releases, read the [installation guide](/packaging/installer/README.md#nightly-vs-stable-releases). > If you want to turn off [automatic updates](/packaging/installer/README.md#automatic-updates), use the `--no-updates` option. You can find more installation options below. @@ -48,7 +48,8 @@ The `kickstart.sh` script accepts a number of optional parameters to control how - `--non-interactive`: Don’t prompt for anything and assume yes whenever possible, overriding any automatic detection of an interactive run. - `--interactive`: Act as if running interactively, even if automatic detection indicates a run is non-interactive. - `--dont-wait`: Synonym for `--non-interactive` -- `--dont-start-it`: Don’t auto-start the daemon after installing. This parameter is not gauranteed to work. +- `--dry-run`: Show what the installer would do, but don’t actually do any of it. +- `--dont-start-it`: Don’t auto-start the daemon after installing. This parameter is not guaranteed to work. - `--nightly-channel`: Use a nightly build instead of a stable release (this is the default). - `--stable-channel`: Use a stable release instead of a nightly build. - `--auto-update`: Enable automatic updates (this is the default). @@ -63,6 +64,9 @@ The `kickstart.sh` script accepts a number of optional parameters to control how use runtime configuration to disable cloud support. - `--require-cloud`: Only install if Netdata Cloud can be enabled. Overrides `--disable-cloud`. - `--install`: Specify an installation prefix for local builds (by default, we use a sane prefix based on the type of system). +- `--old-install-prefix`: Specify the custom local build's installation prefix that should be removed. +- `--uninstall`: Uninstall an existing installation of Netdata. +- `--reinstall-clean`: Performs an uninstall of Netdata and clean installation. Additionally, the following environment variables may be used to further customize how the script runs (most users should not need to use special values for any of these): @@ -73,15 +77,21 @@ should not need to use special values for any of these): - `ROOTCMD`: Used to specify a command to use to run another command with root privileges if needed. By default we try to use sudo, doas, or pkexec (in that order of preference), but if you need special options for one of those to work, or have a different tool to do the same thing on your system, you can specify it here. -- `DO_NOT_TRACK`: If set to a value other than 0, behave as if `--disable-telemetry` was specified. +- `DISABLE_TELEMETRY`: If set to a value other than 0, behave as if `--disable-telemetry` was specified. - `NETDATA_INSTALLER_OPTIONS`: Specifies extra options to pass to the static installer or local build script. ### Connect node to Netdata Cloud during installation -The `kickstart.sh` script accepts additional parameters to automatically [connect](/claim/README.md) your node to Netdata -Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata -Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect Nodes** in the [Spaces management -area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces). +The `kickstart.sh` script accepts additional parameters to automatically [connect](/claim/README.md) your node to Netdata Cloud immediately after installation. + +> Note: You either need to run the command with root privileges or run it with the user that is running the agent. More details: [Connect an agent without root privileges](/claim/README.md#connect-an-agent-without-root-privileges) section. + +To automatically claim nodes after installation: + +1. Sign in to [Netdata Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces) +2. Go to the [Spaces management area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces) +3. Click on **Connect Nodes** +4. Find the `token` and `rooms` strings and specify your nodes: - `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node after the install. @@ -93,11 +103,9 @@ area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces). For example: ```bash -wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2 +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 ``` -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. - ### Native packages We publish official DEB/RPM packages for a number of common Linux distributions as part of our releases and nightly @@ -136,7 +144,7 @@ To use `md5sum` to verify the integrity of the `kickstart.sh` script you will do run the following: ```bash -[ "2ea326514c5166eabf02622e75d10a53" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID" +[ "<checksum-will-be-added-in-documentation-processing>" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID" ``` If the script is valid, this command will return `OK, VALID`. @@ -152,4 +160,4 @@ Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to external databases, and more. -[](<>) + diff --git a/packaging/installer/methods/kubernetes.md b/packaging/installer/methods/kubernetes.md index f12850665..216703a33 100644 --- a/packaging/installer/methods/kubernetes.md +++ b/packaging/installer/methods/kubernetes.md @@ -194,4 +194,4 @@ utilization metrics, and application metrics. - [Netdata Helm chart](https://github.com/netdata/helmchart) - [Netdata service discovery](https://github.com/netdata/agent-service-discovery/) -[](<>) + diff --git a/packaging/installer/methods/macos.md b/packaging/installer/methods/macos.md index 4fa0300c6..7257e1a60 100644 --- a/packaging/installer/methods/macos.md +++ b/packaging/installer/methods/macos.md @@ -12,13 +12,13 @@ You could also use a macOS system as the parent node in a [streaming configurati You can install Netdata in one of the three following ways: - **[Install Netdata with the our automatic one-line installation script (recommended)](#install-netdata-with-our-automatic-one-line-installation-script)**, -- [Install Netdata via Homebrew](#install-netdata-with-the-homebrew-package) +- [Install Netdata via Homebrew](#install-netdata-via-homebrew) - [Install Netdata from source](#install-netdata-from-source) Each of these installation option requires [Homebrew](https://brew.sh/) for handling dependencies. > The Netdata Homebrew package is community-created and -maintained. -> 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). +> 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.md). ## Install Netdata with our automatic one-line installation script @@ -52,7 +52,7 @@ curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/n ``` 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. -If you experience issues while claiming your node, follow the steps in our [Troubleshooting](claim/README.md#troubleshooting) documentation. +If you experience issues while claiming your node, follow the steps in our [Troubleshooting](/claim/README.md#troubleshooting) documentation. ## Install Netdata via Homebrew To install Netdata and all its dependencies, run Homebrew using the following command: @@ -108,4 +108,4 @@ When you're finished with installation, check out our [single-node](/docs/quicks Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md). -[](<>) + diff --git a/packaging/installer/methods/manual.md b/packaging/installer/methods/manual.md index 6d88fbd8e..aaf1451df 100644 --- a/packaging/installer/methods/manual.md +++ b/packaging/installer/methods/manual.md @@ -244,4 +244,4 @@ Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to external databases, and more. -[](<>) + diff --git a/packaging/installer/methods/offline.md b/packaging/installer/methods/offline.md index c978dd613..53390c71b 100644 --- a/packaging/installer/methods/offline.md +++ b/packaging/installer/methods/offline.md @@ -86,5 +86,3 @@ Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md). Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to external databases, and more. - -[]() diff --git a/packaging/installer/methods/pfsense.md b/packaging/installer/methods/pfsense.md index 6d9de7606..f0d730036 100644 --- a/packaging/installer/methods/pfsense.md +++ b/packaging/installer/methods/pfsense.md @@ -81,4 +81,4 @@ workaround from <https://redmine.pfsense.org/issues/6643> **Note:** In pfSense, the Netdata configuration files are located under `/usr/local/etc/netdata`. -[](<>) + diff --git a/packaging/installer/methods/source.md b/packaging/installer/methods/source.md index 737ea166a..a25323f0c 100644 --- a/packaging/installer/methods/source.md +++ b/packaging/installer/methods/source.md @@ -234,4 +234,4 @@ repository](https://github.com/netdata/kernel-collector/blob/master/README.md), which outlines both the required dependencies, as well as multiple options for building the code. -[](<>) + diff --git a/packaging/installer/methods/synology.md b/packaging/installer/methods/synology.md index 8e55924c1..30ec3035c 100644 --- a/packaging/installer/methods/synology.md +++ b/packaging/installer/methods/synology.md @@ -34,9 +34,7 @@ chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/net chown -R netdata:root /opt/netdata/var/log/netdata ``` -4. Uncomment and set `web files owner` to `root`, and `web files group` to `netdata` in - the `/opt/netdata/etc/netdata/netdata.conf`. -5. Restart Netdata +4. Restart Netdata ```sh /etc/rc.netdata restart @@ -58,4 +56,4 @@ installed. You'll have to do this manually: 3. Make sure `/etc/rc.netdata` is executable: `chmod 0755 /etc/rc.netdata`. -[](<>) + |