diff options
Diffstat (limited to 'packaging/installer/methods')
| -rw-r--r-- | packaging/installer/methods/kickstart.md | 20 | ||||
| -rw-r--r-- | packaging/installer/methods/macos.md | 114 | ||||
| -rw-r--r-- | packaging/installer/methods/manual.md | 3 | ||||
| -rw-r--r-- | packaging/installer/methods/source.md | 55 | ||||
| -rw-r--r-- | packaging/installer/methods/synology.md | 17 |
5 files changed, 76 insertions, 133 deletions
diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md index bc7c4de95..5bd9633da 100644 --- a/packaging/installer/methods/kickstart.md +++ b/packaging/installer/methods/kickstart.md @@ -3,30 +3,27 @@ title: "Install Netdata with kickstart.sh" description: "The kickstart.sh script installs Netdata from source, including all dependencies required to connect to Netdata Cloud, with a single command." custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/kickstart.md --> +import { OneLineInstallWget, OneLineInstallCurl } from '../../../../../src/components/OneLineInstall/' # Install Netdata with kickstart.sh -  +  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) 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](packaging/installer/methods/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. To install Netdata, run the following as your normal user: -```bash -wget -O ./kickstart.sh https://my-netdata.io/kickstart.sh && sh ./kickstart.sh -``` +<OneLineInstallWget/> Or, if you have cURL but not wget (such as on macOS): -```bash -curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh -``` +<OneLineInstallCurl/> ## What does `kickstart.sh` do? @@ -89,15 +86,14 @@ area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces). - `--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. - `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in. -- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of - `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or `http://[user:pass@]host:ip` for an HTTP(S) proxy. +- `--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. See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details. - `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`. For example: ```bash -wget -O ./kickstart.sh https://my-netdata.io/kickstart.sh && sh ./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. @@ -140,7 +136,7 @@ To use `md5sum` to verify the integrity of the `kickstart.sh` script you will do run the following: ```bash -[ "dc50e88ee6e19f50dd395e1e5117a1fa" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID" +[ "2ea326514c5166eabf02622e75d10a53" = "$(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`. diff --git a/packaging/installer/methods/macos.md b/packaging/installer/methods/macos.md index 0ae1d9f23..4fa0300c6 100644 --- a/packaging/installer/methods/macos.md +++ b/packaging/installer/methods/macos.md @@ -5,94 +5,99 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal # Install Netdata on macOS -Netdata works on macOS, albeit with some limitations. 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. You could also use a macOS system as the parent node in a [streaming -configuration](/streaming/README.md). +Netdata works on macOS, albeit with some limitations. +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. +You could also use a macOS system as the parent node in a [streaming configuration](/streaming/README.md). -We recommend you to **[install Netdata with the our automatic one-line installation script](#install-netdata-with-our-automatic-one-line-installation-script)**, +You can install Netdata in one of the three following ways: - -As an alternative you also have community-created and -maintained [**Homebrew -package**](#install-netdata-with-the-homebrew-package). - -- [Install Netdata via the Homebrew package](#install-netdata-with-the-homebrew-package) +- **[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 from source](#install-netdata-from-source) -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. +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). ## Install Netdata with our automatic one-line installation script -To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) script you will just need to run: +**Local Netdata Agent installation** +To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) open a new terminal and run: ```bash -wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh +curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh ``` +The Netdata Agent is be installed under `/usr/local/netdata`. Dependencies are handled via Homebrew. -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) - -This currently only supports building Netdata locally, and requires dependencies to be handled either via Homebrew -or MacPorts (we preferentially use Homebrew if both are found). By default, this will install Netdata under -`/usr/local/netdata`. +**Automatically connect to Netdata Cloud during installation** +<!-- Potential reuse: https://learn.netdata.cloud/docs/agent/claim#connect-an-agent-running-in-macos--> +<!--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.--> -## Install Netdata with the Homebrew package +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). -If you don't have [Homebrew](https://brew.sh/) installed already, begin with their installation script: +- `--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. +- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in. +- `--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. + See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details. +- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`. +For example: ```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" +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 ``` +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. -Next, you can use Homebrew's package, which installs Netdata all its dependencies in a single step: +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: ```sh brew install netdata ``` +Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`. -> Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`. 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/`. +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/`. Skip on ahead to the [What's next?](#whats-next) section to find links to helpful post-installation guides. ## Install Netdata from source -We don't recommend installing Netdata from source on macOS, as it can be difficult to configure and install dependencies -manually. +We don't recommend installing Netdata from source on macOS, as it can be difficult to configure and install dependencies manually. -First open your terminal of choice and install the Xcode development packages. +1. Open your terminal of choice and install the Xcode development packages: -```bash -xcode-select --install -``` + ```bash + xcode-select --install + ``` -Click **Install** on the Software Update popup window that appears. Then, use the same terminal session to use Homebrew -to install some of Netdata's prerequisites. You can omit `cmake` in case you do not want to use -[Netdata Cloud](https://learn.netdata.cloud/docs/cloud/). +2. Click **Install** on the Software Update popup window that appears. +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`. -```bash -brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl@1.1 libtool cmake -``` - -If you want to use the [database engine](/database/engine/README.md) to store your metrics, you need to download -and install the [Judy library](https://sourceforge.net/projects/judy/) before proceeding compiling Netdata. + ```bash + brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl libtool cmake + ``` + +4. Download Netdata from our GitHub repository: -Next, download Netdata from our GitHub repository: + ```bash + git clone https://github.com/netdata/netdata.git --recursive + ``` -```bash -git clone https://github.com/netdata/netdata.git --recursive -``` +5. `cd` into the newly-created directory and then start the installer script: -Finally, `cd` into the newly-created directory and then start the installer script: - -```bash -cd netdata/ -sudo ./netdata-installer.sh --install /usr/local -``` + ```bash + cd netdata/ + sudo ./netdata-installer.sh --install /usr/local + ``` -> Your Netdata configuration directory will be at `/usr/local/netdata/`, and your stock configuration directory will -> be at **`/usr/local/lib/netdata/conf.d/`.** -> +> Your Netdata configuration directory will be at `/usr/local/netdata/`. +> Your stock configuration directory will be at `/usr/local/lib/netdata/conf.d/`. > The installer will also install a startup plist to start Netdata when your macOS system boots. ## What's next? @@ -102,8 +107,5 @@ 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). -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/manual.md b/packaging/installer/methods/manual.md index 73cedd24d..6d88fbd8e 100644 --- a/packaging/installer/methods/manual.md +++ b/packaging/installer/methods/manual.md @@ -220,8 +220,7 @@ cd netdata ### Connect node to Netdata Cloud during installation -Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md) or -[`kickstart-static64.sh`](/packaging/installer/methods/kickstart-64.md) methods, the `netdata-installer.sh` script does +Unlike the [`kickstart.sh`](/packaging/installer/methods/kickstart.md), the `netdata-installer.sh` script does not allow you to automatically [connect](/claim/README.md) your node to Netdata Cloud immediately after installation. See the [connect to cloud](/claim/README.md) doc for details on connecting a node with a manual installation of Netdata. diff --git a/packaging/installer/methods/source.md b/packaging/installer/methods/source.md index 5345a1a4c..737ea166a 100644 --- a/packaging/installer/methods/source.md +++ b/packaging/installer/methods/source.md @@ -48,61 +48,6 @@ libraries and their header files must be copied into specific locations in the source tree to be used. ### Netdata cloud - -Netdata Cloud functionality requires custom builds of libmosquitto and -libwebsockets. - -#### libmosquitto - -Netdata maintains a custom fork of libmosquitto at -https://github.com/netdata/mosquitto with patches to allow for proper -integration with libwebsockets, which is needed for correct operation of -Netdata Cloud functionality. To prepare this library for the build system: - -1. Verify the tag that Netdata expects to be used by checking the contents - of `packaging/mosquitto.version` in your Netdata sources. -2. Obtain the sources for that version by either: - - Navigating to https://github.com/netdata/mosquitto/releases and - downloading and unpacking the source code archive for that release. - - Cloning the repository with `git` and checking out the required tag. -3. If building on a platform other than Linux, prepare the mosquitto - sources by running `cmake -D WITH_STATIC_LIBRARIES:boolean=YES .` in - the mosquitto source directory. -4. Build mosquitto by running `make -C lib` in the mosquitto source directory. -5. In the Netdata source directory, create a directory called `externaldeps/mosquitto`. -6. Copy `lib/mosquitto.h` from the mosquitto source directory to - `externaldeps/mosquitto/mosquitto.h` in the Netdata source tree. -7. Copy `lib/libmosquitto.a` from the mosquitto source directory to - `externaldeps/mosquitto/libmosquitto.a` in the Netdata source tree. If - building on a platform other than Linux, the file that needs to be - copied will instead be named `lib/libmosquitto_static.a`, but it - still needs to be copied to `externaldeps/mosquitto/libmosquitto.a`. - -#### libwebsockets - -Netdata uses the standard upstream version of libwebsockets located at -https://github.com/warmcat/libwebsockets, but requires a build with SOCKS5 -support, which is not enabled by most pre-built versions. Currently, -we do not support using a system copy of libwebsockets. To prepare this -library for the build system: - -1. Verify the tag that Netdata expects to be used by checking the contents - of `packaging/libwebsockets.version` in your Netdata sources. -2. Obtain the sources for that version by either: - - Navigating to https://github.com/warmcat/libwebsockets/releases and - downloading and unpacking the source code archive for that release. - - Cloning the repository with `git` and checking out the required tag. -3. Prepare the libwebsockets sources by running `cmake -D - LWS_WITH_SOCKS5:bool=ON .` in the libwebsockets source directory. -4. Build libwebsockets by running `make` in the libwebsockets source - directory. -5. In the Netdata source directory, create a directory called - `externaldeps/libwebsockets`. -6. Copy `lib/libwebsockets.a` from the libwebsockets source directory to - `externaldeps/libwebsockets/libwebsockets.a` in the Netdata source tree. -7. Copy the entire contents of `include/` from the libwebsockets source - directory to `externaldeps/libwebsockets/include` in the Netdata source tree. - #### JSON-C Netdata requires the use of JSON-C for JSON parsing when using Netdata diff --git a/packaging/installer/methods/synology.md b/packaging/installer/methods/synology.md index 07b1596fd..8e55924c1 100644 --- a/packaging/installer/methods/synology.md +++ b/packaging/installer/methods/synology.md @@ -6,14 +6,15 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal # Install Netdata on Synology -The documentation previously recommended installing the Debian Chroot package from the Synology community package -sources and then running Netdata from within the chroot. This does not work, as the chroot environment does not have -access to `/proc`, and therefore exposes very few metrics to Netdata. Additionally, [this -issue](https://github.com/SynoCommunity/spksrc/issues/2758), still open as of 2018/06/24, indicates that the Debian -Chroot package is not suitable for DSM versions greater than version 5 and may corrupt system libraries and render the -NAS unable to boot. - -The good news is that the [64-bit static installer](kickstart-64.md) works fine if your NAS is one that uses the amd64 architecture. It +> 💡 This document is maintained by Netdata's community, and may not be completely up-to-date. Please double-check the +> details of the installation process, before proceeding. +> +> You can help improve this document by +> [submitting a PR](https://github.com/netdata/netdata/edit/master/packaging/installer/methods/synology.md) +> with your recommended improvements or changes. Thank you! + + +The good news is that our [one-line installation script](kickstart.md) works fine if your NAS is one that uses the amd64 architecture. It will install the content into `/opt/netdata`, making future removal safe and simple. ## Run as netdata user |