bd64b5d59 · cryptotaxi247/netdata-1

@@ -1,24 +1,54 @@

1 # Install Netdata Using Native DEB/RPM Packages

2

3 +:::note

4 +

5 Netdata provides pre-built native packages for most DEB- and RPM-based Linux distributions, following our [platform support policy](/docs/netdata-agent/versions-and-platforms.md).

6

5 -Our [kickstart.sh installer](/packaging/installer/methods/kickstart.md) uses these packages by default on supported platforms.

7 +:::

8 +

9 +Install Netdata using our [kickstart.sh installer](/packaging/installer/methods/kickstart.md), which automatically uses native packages on supported platforms.

10

7 -Add `--native-only` when running `kickstart.sh` to force native packages. The script will fail if native packages aren’t available.

11 +To ensure the installer only uses native packages, add the `--native-only` option when running `kickstart.sh`.

12

13 :::note

14

11 -Until late 2024, Netdata packages were hosted on Package Cloud. All packages are now provided exclusively from our own repositories.

15 +Our previous PackageCloud repositories are no longer updated. All packages are now available exclusively from our own repositories.

16

17 :::

18

15 ----

19 +## Repository Structure Overview

20 +

21 +Our repository system follows a structured organization:

22 +

23 +```

24 +repository.netdata.cloud/repos/

25 +├── stable/ # Stable Netdata Agent releases

26 +│ ├── debian/ # For Debian-based distributions

27 +│ │ ├── bullseye/ # Distribution codename directories

28 +│ │ ├── bookworm/

29 +│ │ └── ...

30 +│ ├── ubuntu/ # For Ubuntu-based distributions

31 +│ │ ├── focal/

32 +│ │ ├── jammy/

33 +│ │ └── ...

34 +│ ├── el/ # For RHEL-based distributions

35 +│ │ ├── 8/ # Version directories

36 +│ │ │ ├── x86_64/ # Architecture directories

37 +│ │ │ ├── aarch64/

38 +│ │ │ └── ...

39 +│ │ ├── 9/

40 +│ │ └── ...

41 +│ └── other distros...

42 +├── edge/ # Nightly builds (same structure)

43 +├── repoconfig/ # Configuration packages

44 +└── devel/ # Development builds (ignore)

45 +```

46

47 ## Manual Setup of RPM Packages

48

19 -Repositories: [https://repository.netdata.cloud/repos/index.html](https://repository.netdata.cloud/repos/index.html)

49 +You can find our RPM repositories at: [https://repository.netdata.cloud/repos/index.html](https://repository.netdata.cloud/repos/index.html)

50

21 -Available groups:

51 +### Available Repository Groups

52

53 | Repo | Purpose |

54 |--------------|-------------------------------|

@@ -27,26 +57,38 @@ Available groups:

57 | `repoconfig` | Configuration packages |

58 | `devel` | Dev builds (ignore) |

59

30 -Supported distributions:

60 +### Supported Distributions

61 +

62 +Within each repository group, you'll find directories for specific distributions:

63

32 -- `amazonlinux`

33 -- `el` (RHEL, CentOS, AlmaLinux, Rocky Linux)

34 -- `fedora`

35 -- `ol` (Oracle Linux)

36 -- `opensuse`

64 +| Repository Directory | Primary Distribution | Compatible Distributions |

65 +|---------------------|----------------------|--------------------------|

66 +| `amazonlinux` | Amazon Linux | Binary-compatible Amazon Linux based distros |

67 +| `el` | Red Hat Enterprise Linux | CentOS, AlmaLinux, Rocky Linux, and other binary-compatible distros |

68 +| `fedora` | Fedora | Binary-compatible Fedora-based distros |

69 +| `ol` | Oracle Linux | Binary-compatible Oracle Linux based distros |

70 +| `opensuse` | openSUSE | Binary-compatible SUSE-based distros |

71

38 -Example repository for RHEL 9 x86_64:

72 +### Repository Structure

73 +

74 +Each distribution has:

75 +1. Directories for each supported release version

76 +2. Subdirectories for each supported CPU architecture containing the actual packages

77 +

78 +**Example:** For RHEL 9 on 64-bit x86, you'll find the stable repository at:

79 [https://repository.netdata.cloud/repos/stable/el/9/x86_64/](https://repository.netdata.cloud/repos/stable/el/9/x86_64/)

80

41 -GPG Key fingerprint:

81 +### Package Signing

82 +

83 +Our RPM packages and repository metadata are signed with a GPG key with a username of `Netdatabot` and the fingerprint:

84 `6E155DC153906B73765A74A99DD4A74CECFA8F4F`

85

44 -Public key:

86 +Download the public key from:

87 [https://repository.netdata.cloud/netdatabot.gpg.key](https://repository.netdata.cloud/netdatabot.gpg.key)

88

47 -### Steps

89 +### Installation Steps

90

49 -1. Download config package:

91 +1. Download the appropriate config package for your distribution:

92 [https://repository.netdata.cloud/repos/repoconfig/index.html](https://repository.netdata.cloud/repos/repoconfig/index.html)

93

94 2. Install it with your package manager:

@@ -57,17 +99,17 @@ Public key:

99 sudo dnf install netdata

100 ```

101

60 - > **Note**

61 - > On RHEL systems, EPEL repository is required.

62 - > Our config packages handle this automatically — if not, install epel-release manually.

63 -

64 ----

102 + :::note

103 +

104 + On RHEL and other `el` repository distributions, some Netdata dependencies are in the EPEL repository. Our config packages typically handle this automatically, but if you encounter issues, install `epel-release` manually.

105 +

106 + :::

107

108 ## Manual Setup of DEB Packages

109

68 -Repositories: [https://repository.netdata.cloud/repos/index.html](https://repository.netdata.cloud/repos/index.html)

110 +You can find our DEB repositories at: [https://repository.netdata.cloud/repos/index.html](https://repository.netdata.cloud/repos/index.html)

111

70 -Available groups:

112 +### Available Repository Groups

113

114 | Repo | Purpose |

115 |--------------|-------------------------------|

@@ -76,18 +118,46 @@ Available groups:

118 | `repoconfig` | Configuration packages |

119 | `devel` | Dev builds (ignore) |

120

79 -Supported distributions:

121 +### Supported Distributions

122 +

123 +Within each repository group, you'll find directories for specific distributions:

124 +

125 +- `debian`: For Debian Linux and binary-compatible distributions

126 +- `ubuntu`: For Ubuntu Linux and binary-compatible distributions

127 +

128 +### Repository Structure

129 +

130 +Our DEB repositories use a **flat repository structure** (per Debian standards) and support **by-hash** metadata retrieval for improved reliability.

131 +

132 +Each directory contains subdirectories for supported releases, named by codename (e.g., `bullseye/`, `jammy/`).

133

81 -- `debian`

82 -- `ubuntu`

134 +:::important

135

84 -APT source for Debian 11 (Bullseye):

136 +When configuring repository URLs, include the trailing slash (`/`) after the codename. This is required for the repository to be processed correctly.

137 +

138 +:::

139 +

140 +### Package Signing

141 +

142 +Our DEB packages and repository metadata are signed with a GPG key with a username of `Netdatabot` and the fingerprint:

143 +`6E155DC153906B73765A74A99DD4A74CECFA8F4F`

144 +

145 +Download the public key from:

146 +[https://repository.netdata.cloud/netdatabot.gpg.key](https://repository.netdata.cloud/netdatabot.gpg.key)

147 +

148 +### Example Configuration

149 +

150 +<details>

151 +<summary>Click to view example APT configuration</summary>

152 +<br/>

153 +

154 +Here's an example APT sources entry for Debian 11 (Bullseye) stable releases:

155

156 ```

157 deb by-hash=yes http://repository.netdata.cloud/repos/stable/debian/ bullseye/

158 ```

159

90 -Deb822 format:

160 +And the equivalent Deb822 format:

161

162 ```

163 Types: deb

@@ -96,16 +166,11 @@ Suites: bullseye/

166 By-Hash: Yes

167 Enabled: Yes

168 ```

169 +</details>

170

100 -GPG Key fingerprint:

101 -`6E155DC153906B73765A74A99DD4A74CECFA8F4F`

102 -

103 -Public key:

104 -[https://repository.netdata.cloud/netdatabot.gpg.key](https://repository.netdata.cloud/netdatabot.gpg.key)

105 -

106 -### Steps

171 +### Installation Steps

172

108 -1. Download config package:

173 +1. Download the appropriate config package for your distribution:

174 [https://repository.netdata.cloud/repos/repoconfig/index.html](https://repository.netdata.cloud/repos/repoconfig/index.html)

175

176 2. Install it using your package manager:

@@ -117,46 +182,73 @@ Public key:

182 sudo apt install netdata

183 ```

184

120 ----

185 +## Example: Complete Installation on Ubuntu 22.04 (Jammy)

186 +

187 +<details>

188 +<summary>Click to view complete installation example</summary>

189 +<br/>

190 +

191 +Here's a complete example of installing Netdata on Ubuntu 22.04 using native packages:

192 +

193 +```bash

194 +# Step 1: Download the repository configuration package

195 +wget https://repository.netdata.cloud/repos/repoconfig/ubuntu/jammy/netdata-repo_latest.jammy_all.deb

196 +

197 +# Step 2: Install the repository configuration

198 +sudo apt install ./netdata-repo_latest.jammy_all.deb

199 +

200 +# Step 3: Update package lists

201 +sudo apt update

202 +

203 +# Step 4: Install Netdata

204 +sudo apt install netdata

205 +

206 +# Step 5: Start and enable Netdata service

207 +sudo systemctl enable --now netdata

208 +

209 +# Step 6: Verify installation

210 +curl localhost:19999/api/v1/info

211 +```

212 +

213 +After installation, you can access the Netdata dashboard at `http://localhost:19999`.

214 +</details>

215

216 ## Local Mirrors of the Official Netdata Repositories

217

124 -You can mirror Netdata’s repositories:

218 +You can create local mirrors of our repositories using two main approaches:

219

126 -### Recommended Methods:

220 +### Recommended Mirroring Methods

221

128 -| Method | Use case |

129 -|------------------|---------------------------------------|

130 -| Standard tools | e.g., Aptly (APT) or `reposync` (RPM) |

131 -| Simple mirroring | Use `wget --mirror` or similar tools |

222 +| Method | Use case | Example |

223 +|------------------|---------------------------------------|---------|

224 +| Standard tools | For formal repository mirroring | `aptly mirror create netdata-stable http://repository.netdata.cloud/repos/stable/debian/ bullseye/` |

225 +| Simple mirroring | For basic HTTP mirroring | `wget --mirror https://repository.netdata.cloud/repos/` |

226 +

227 +### Mirror Root URL

228

133 -Mirror root URL:

229 [https://repository.netdata.cloud/repos/](https://repository.netdata.cloud/repos/)

230

136 ----

231 +### Important Mirroring Tips

232

138 -### Mirror Tips:

233 +:::important

234

140 -- Config packages don’t support custom mirrors — configure mirrors manually.

141 -- Packages are built in stages by architecture.

142 -- Metadata updates up to six times/hour.

143 -- Full mirror can require up to **100 GB**.

144 -- Ideal sync window: **05:00–08:00 UTC**.

145 -- Fetch a GPG key from:

235 +* **Repository config packages:** These don't support custom mirrors (except caching proxies like `apt-cacher-ng`). Configure mirrors manually.

236 +* **Build process:** Packages are built in stages by architecture (64-bit x86 first, then others). Full publishing takes several hours.

237 +* **Update frequency:** Metadata updates up to six times per hour, but syncing hourly is sufficient.

238 +* **Storage requirements:** A full mirror can require up to **100 GB** of space. Mirror only what you need.

239 +* **Recommended sync time:** For daily syncing, **05:00–08:00 UTC** is ideal, as nightly packages are typically published by then.

240 +* **GPG verification:** If using our GPG signatures, download our public key:

241 [https://repository.netdata.cloud/netdatabot.gpg.key](https://repository.netdata.cloud/netdatabot.gpg.key)

242

148 ----

243 +:::

244

245 ## Public Mirrors of the Official Netdata Repositories

246

152 -:::note

247 +There are currently no official public mirrors of our repositories. If you wish to provide a public mirror of our repositories, you are welcome to do so.

248

154 -**There are no official public mirrors**.

249 +:::important

250

156 -:::

251 +Please clearly inform your users that your mirror is not officially supported by Netdata. We recommend following industry best practices for repository mirroring and security.

252

158 -If you wish to provide a public mirror of Netdata repositories:

253 +:::

254

160 -- You’re free to do so.

161 -- Please clearly state to your users that it is *not* an official mirror.

162 -- Follow best practices for repository mirroring and security.

\ No newline at end of file

Update documentation for native DEB/RPM packages (#20257)