netdata/packaging/installer/methods/packages.md

Install Netdata using native DEB/RPM packages

For most common Linux distributions that use either DEB or RPM packages, Netdata provides pre-built native packages for current releases in-line with our official platform support policy. These packages will be used by default when attempting to install on a supported platform using our kickstart.sh installer script.

When using the kickstart script, you can force usage of native DEB or RPM packages by passing the option --native-only when invoking the script. This will cause it to only attempt to use native packages for the install, and fail if it cannot do so.

Note

In July 2022, we switched hosting of our native packages from Package Cloud to self-hosted repositories. We still maintain the Package cloud repositories, but they are not guaranteed to work and may be removed without prior warning.

When selecting a repository configuration package, note that the version 2 packages provide configuration for our self-hosted repositories, and then version 1 packages provide configuration for Package Cloud.

Manual setup of RPM packages

Netdata’s official RPM repositories are hosted at https://repo.netdata.cloud/repos. We provide four groups of repositories at that top level:

• stable: Contains packages for stable releases of the Netdata Agent.
• edge: Contains packages for nightly builds of the Netdata Agent.
• repoconfig: Provides packages that set up configuration files for using the other repositories.
• devel: Is used for one-off development builds of the Netdata Agent, and can simply be ignored by users.

Within each top level group of repositories, there are directories for each supported group of distributions:

• amazonlinux: Is for Amazon Linux and binary compatible distros.
• el: Is for Red Hat Enterprise Linux and binary compatible distros that are not covered by other repos, such as CentOS, Alma Linux, and Rocky Linux.
• fedora: Is for Fedora and binary compatible distros.
• ol: Is for Oracle Linux and binary compatible distros.
• opensuse: Is for openSUSE and binary compatible distros.

Under each of those directories is a directory for each supported release of that distribution, and under that a directory for each supported CPU architecture which contains the actual repository.

For example, for stable release packages for RHEL 9 on 64-bit x86, the full URL for the repository would be https://repo.netdata.cloud/repos/stable/el/9/x86_64/

Our RPM packages and repository metadata are signed using a GPG key with a user name of ‘Netdatabot’. The current key fingerprint is 6588FDD7B14721FE7C3115E6F9177B5265F56346. The associated public key can be fetched from https://repo.netdata.cloud/netdatabot.gpg.key.

If you are explicitly configuring a system to use our repositories, the recommended setup is to download the appropriate repository configuration package from https://repo.netdata.cloud/repos/repoconfig and install it directly on the target system using the system package manager. This will ensure any packages needed to use the repository are also installed, and will help enable a seamless transition if we ever need to change our infrastructure.

Note

On RHEL and other systems that use the el repositories, some of the dependencies for Netdata can only be found in the EPEL repository, which is not enabled or installed by default on most of these systems. This additional repository should be pulled in automatically by our repository config packages, but if it is not you may need to manually install epel-release to be able to successfully install the Netdata packages.

Manual setup of DEB packages

Netdata’s official DEB repositories are hosted at https://repo.netdata.cloud/repos. We provide four groups of repositories at that top level:

• stable: Contains packages for stable releases of the Netdata Agent.
• edge: Contains packages for nightly builds of the Netdata Agent.
• repoconfig: Provides packages that set up configuration files for using the other repositories.
• devel: Is used for one-off development builds of the Netdata Agent, and can simply be ignored by users.

Within each top level group of repositories, there are directories for each supported group of distributions:

• debian: Is for Debian Linux and binary compatible distros.
• ubuntu: Is for Ubuntu Linux and binary compatible distros.

Under each of these directories is a directory for each supported release, corresponding to the release codename.

These repositories are set up as what Debian calls ‘flat repositories’, and are available via both HTTP and HTTPS.

As a result of this structure, the required APT sources entry for stable packages for Debian 11 (Bullseye) is:

deb http://repo.netdata.cloud/repos/stable/debian/ bullseye/

Note the / at the end of the codename, this is required for the repository to be processed correctly.

Our DEB packages and repository metadata are signed using a GPG key with a user name of ‘Netdatabot’. The current key fingerprint is 6588FDD7B14721FE7C3115E6F9177B5265F56346. The associated public key can be fetched from https://repo.netdata.cloud/netdatabot.gpg.key.

If you are explicitly configuring a system to use our repositories, the recommended setup is to download the appropriate repository configuration package from https://repo.netdata.cloud/repos/repoconfig and install it directly on the target system using the system package manager. This will ensure any packages needed to use the repository are also installed, and will help enable a seamless transition if we ever need to change our infrastructure.

Local mirrors of the official Netdata repositories

Local mirrors of our official repositories can be created in one of two ways:

1. Using the standard tooling for mirroring the type of repository you want a local mirror of, such as Aptly for APT repositories, or reposync for RPM repositories. For this approach, please consult the documentation for the specific tool you are using for info on how to mirror the repositories.
2. Using a regular website mirroring tool, such as GNU wget’s --mirror option. For this approach, simply point your mirroring tool at https://repo.netdata.cloud/repos/, and everything should just work.

We do not provide official support for mirroring our repositories, but we do have some tips for anyone looking to do so:

• Our robots.txt file explicitly disallows indexing, so if you’re using a regular website mirroring tool, you wil need to tell it to ignore robots.txt (for example, if using GNU wget, add -e robots=off to the options you pass) to ensure that it actually retrieves everything.
• Excluding special cases of caching proxies (such as apt-cacher-ng), our repository configuration packages DO NOT work with custom local mirrors. Thus, you will need to manually configure your systems to use your local mirror.
• Packages are published as they are built, with 64-bit x86 packages being built first, followed by 32-bit x86, and then non-x86 packages in alphabetical order of the CPU architecture. Because of the number of different packages being built, this means that packages for a given nightly build or stable release are typically published over the course of a few hours, usually starting about 15-20 minutes after the build or release is started.
• Repository metadata is updated every hour on the hour, and the process may take anywhere from a few seconds to more than 20 minutes. Because of this, it makes little sense to sync your mirror more frequently than once an hour, and it’s generally preferred to start syncing at least 30 minutes into the hour.
• A full mirror of all of our repositories currently requires up to 100 GB of storage space, though the exact amount of space needed fluctuates over time. Because of this, users seeking to mirror our repositories are encouraged to mirror only those repositories they actually need instead of mirroring everything.
• If syncing daily (or less frequently), some time between 05:00 and 08:00 UTC each day is usually the safest time to do so, as publishing nightly packages will almost always be done by this point, and publishing of stable releases typically happens after that time window.
• If you intend to use our existing GPG signatures on the repository metadata and packages, you probably also want a local copy of our public GPG key, which can be fetched from https://repo.netdata.cloud/netdatabot.gpg.key.

Public mirrors of the official Netdata repositories

There are no official public mirrors of our repositories.

If you wish to provide a public mirror of our official repositories, you are free to do so, but we kindly ask that you make it clear to your users that your mirror is not an official mirror of our repositories.