"Fossies" - the Fresh Open Source Software Archive

Member "netdata-v1.26.0/packaging/installer/README.md" (14 Oct 2020, 12221 Bytes) of package /linux/misc/netdata-v1.26.0.tar.gz:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

Installation guide

Netdata is a monitoring agent designed to run on all your systems: physical and virtual servers, containers, even IoT/edge devices. Netdata runs on Linux, FreeBSD, macOS, Kubernetes, Docker, and all their derivatives.

The best way to install Netdata is with our automatic one-line installation script, which works with all Linux distributions, or our .deb/rpm packages, which seamlessly install with your distribution's package manager.

If you want to install Netdata with Docker, on a Kubernetes cluster, or a different operating system, see Have a different operating system, or want to try another method?

Some third parties, such as the packaging teams at various Linux distributions, distribute old, broken, or altered packages. We recommend you install Netdata using one of the methods listed below to guarantee you get the latest checksum-verified packages.

Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read about the information collected, and learn how to-opt, on our anonymous statistics page.

The usage statistics are vital for us, as we use them to discover bugs and prioritize new features. We thank you for actively contributing to Netdata's future.

Automatic one-line installation script

This method is fully automatic on all Linux distributions, including Ubuntu, Debian, Fedora, CentOS, and others.

To install Netdata from source, including all dependencies required to connect to Netdata Cloud, and get automatic nightly updates, run the following as your normal user:

bash <(curl -Ss https://my-netdata.io/kickstart.sh)

To see more information about this installation script, including how to disable automatic updates, get nightly vs. stable releases, or disable anonymous statistics, see the kickstart.sh method page.

Scroll down for details about automatic updates or nightly vs. stable releases.

When you finish installing Netdata, be sure to visit our step-by-step guide for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.

Or, if you're a monitoring and system administration pro, skip ahead to our getting started guide for a quick overview.

Have a different operating system, or want to try another method?

Netdata works on many different operating systems, each with a few possible installation methods. To see the full list of approved methods for each operating system/version we support, see our distribution matrix.

Below, you can find a few additional installation methods, followed by separate instructions for a variety of unique operating systems.

Alternative methods

Install with .deb or .rpm packages Install with .deb or .rpm packages

Install with a pre-built static binary for 64-bit systems Install with a pre-built static binary for 64-bit systems

Install Netdata on Docker Install Netdata on Docker

Install Netdata on Kubernetes Install Netdata on a Kubernetes cluster

Install Netdata on cloud providers (GCP/AWS/Azure) Install Netdata on cloud providers (GCP/AWS/Azure)

Install Netdata on macOS Install Netdata on macOS

Install Netdata on FreeBSD Install Netdata on FreeBSD

Install from a Git checkout Install from a Git checkout

Install on offline/air-gapped systems Install on offline/air-gapped systems

Installation on PFSense Installation on PFSense

Install Netdata on Synology Install Netdata on Synology

Manual installation on FreeNAS Manual installation on FreeNAS

Manual installation on Alpine Manual installation on Alpine

Build manually from source Build manually from source

Automatic updates

By default, Netdata's installation scripts enable automatic updates for both nightly and stable release channels.

If you would prefer to update your Netdata agent manually, you can disable automatic updates by using the --no-updates option when you install or update Netdata using the automatic one-line installation script.

bash <(curl -Ss https://my-netdata.io/kickstart.sh) --no-updates

With automatic updates disabled, you can choose exactly when and how you update Netdata.

Nightly vs. stable releases

The Netdata team maintains two releases of the Netdata agent: nightly and stable. By default, Netdata's installation scripts will give you automatic, nightly updates, as that is our recommended configuration.

Nightly: We create nightly builds every 24 hours. They contain fully-tested code that fixes bugs or security flaws, or introduces new features to Netdata. Every nightly release is a candidate for then becoming a stable release—when we're ready, we simply change the release tags on GitHub. That means nightly releases are stable and proven to function correctly in the vast majority of Netdata use cases. That's why nightly is the best choice for most Netdata users.

Stable: We create stable releases whenever we believe the code has reached a major milestone. Most often, stable releases correlate with the introduction of new, significant features. Stable releases might be a better choice for those who run Netdata in mission-critical production systems, as updates will come more infrequently, and only after the community helps fix any bugs that might have been introduced in previous releases.

Pros of using nightly releases:

Pros of using stable releases:

Installation notes and known issues

We are tracking a few issues related to installation and packaging.

Older distributions (Ubuntu 14.04, Debian 8, CentOS 6) and OpenSSL

If you're running an older Linux distribution or one that has reached EOL, such as Ubuntu 14.04 LTS, Debian 8, or CentOS 6, your Agent may not be able to securely connect to Netdata Cloud due to an outdated version of OpenSSL. These old versions of OpenSSL cannot perform hostname validation, which helps securely encrypt SSL connections.

We recommend you reinstall Netdata with a static build, which uses an up-to-date version of OpenSSL with hostname validation enabled.

If you choose to continue using the outdated version of OpenSSL, your node will still connect to Netdata Cloud, albeit with hostname verification disabled. Without verification, your Netdata Cloud connection could be vulnerable to man-in-the-middle attacks.

CentOS 6 and CentOS 8

To install the Agent on certain CentOS and RHEL systems, you must enable non-default repositories, such as EPEL or PowerTools, to gather hard dependencies. See the CentOS 6 and CentOS 8 sections for more information.

Access to file is not permitted

If you see an error similar to Access to file is not permitted: /usr/share/netdata/web//index.html when you try to visit the Agent dashboard at http://NODE:19999, you need to update Netdata's permissions to match those of your system.

Run ls -la /usr/share/netdata/web/index.html to find the file's permissions. You may need to change this path based on the error you're seeing in your browser. In the below example, the file is owned by the user netdata and the group netdata.

ls -la /usr/share/netdata/web/index.html
-rw-r--r--. 1 netdata netdata 89377 May  5 06:30 /usr/share/netdata/web/index.html

Open your netdata.conf file and find the [web] section, plus the web files owner/web files group settings. Edit the lines to match the output from ls -la above and uncomment them if necessary.

    web files owner = netdata
    web files group = netdata

Save the file, restart the Netdata Agent, and try accessing the dashboard again.

Multiple versions of OpenSSL

We've received reports from the community about issues with running the kickstart.sh script on systems that have both a distribution-installed version of OpenSSL and a manually-installed local version. The Agent's installer cannot handle both.

We recommend you install Netdata with the static binary to avoid the issue altogether. Or, you can manually remove one version of OpenSSL to remove the conflict.

Clang compiler on Linux

Our current build process has some issues when using certain configurations of the clang C compiler on Linux. See the section on nonrepresentable section on output errors for a workaround.