master
md 298 lines 10.7 KB
Rendered Raw
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](/packaging/PLATFORM_SUPPORT.md).
6
7 :::
8
9 Install Netdata using our [kickstart.sh installer](/packaging/installer/methods/kickstart.md), which automatically uses native packages on supported platforms.
10
11 To ensure the installer only uses native packages, add the `--native-only` option when running `kickstart.sh`.
12
13 :::note
14
15 Our previous PackageCloud repositories are no longer updated. All packages are now available exclusively from our own repositories.
16
17 :::
18
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
49 You can find our RPM repositories at: [https://repository.netdata.cloud/repos/index.html](https://repository.netdata.cloud/repos/index.html)
50
51 ### Available Repository Groups
52
53 | Repo | Purpose |
54 |--------------|-------------------------------|
55 | `stable` | Stable Netdata Agent releases |
56 | `edge` | Nightly builds |
57 | `repoconfig` | Configuration packages |
58 | `devel` | Dev builds (ignore) |
59
60 ### Supported Distributions
61
62 Within each repository group, you'll find directories for specific distributions:
63
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
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
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
86 Download the public key from:
87 [https://repository.netdata.cloud/netdatabot.gpg.key](https://repository.netdata.cloud/netdatabot.gpg.key)
88
89 ### Installation Steps
90
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:
95
96 ```bash
97 # For RHEL/CentOS/Fedora
98 sudo rpm -i netdata-repo-*.rpm
99 sudo dnf install netdata
100 ```
101
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
110 You can find our DEB repositories at: [https://repository.netdata.cloud/repos/index.html](https://repository.netdata.cloud/repos/index.html)
111
112 ### Available Repository Groups
113
114 | Repo | Purpose |
115 |--------------|-------------------------------|
116 | `stable` | Stable Netdata Agent releases |
117 | `edge` | Nightly builds |
118 | `repoconfig` | Configuration packages |
119 | `devel` | Dev builds (ignore) |
120
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
134 :::important
135
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
160 And the equivalent Deb822 format:
161
162 ```
163 Types: deb
164 URIs: http://repository.netdata.cloud/repos/stable/debian/
165 Suites: bullseye/
166 By-Hash: Yes
167 Enabled: Yes
168 ```
169 </details>
170
171 ### Installation Steps
172
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:
177
178 ```bash
179 # For Debian/Ubuntu
180 sudo apt install ./netdata-repo_*.deb
181 sudo apt update
182 sudo apt install netdata
183 ```
184
185 ### Manual Repository Configuration (Without Config Package)
186
187 <details>
188 <summary>If the repoconfig package is not yet available for your distribution</summary>
189 <br/>
190
191 If the repository configuration package for your distribution is not available at the [repoconfig index](https://repository.netdata.cloud/repos/repoconfig/index.html) (for example, when a new Debian or Ubuntu release is not yet covered), you can configure the APT repository manually.
192
193 :::tip
194
195 Using [kickstart.sh](/packaging/installer/methods/kickstart.md) is the recommended way to install Netdata. It handles repository setup automatically with fallback logic when a config package is not available.
196
197 :::
198
199 1. Download and dearmor the GPG key:
200
201 ```bash
202 sudo curl -fL https://repository.netdata.cloud/netdatabot.gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/netdata-archive-keyring.gpg
203 ```
204
205 2. Create the repository configuration using Deb822 format:
206
207 ```bash
208 sudo tee /etc/apt/sources.list.d/netdata.sources <<EOF
209 Types: deb
210 URIs: http://repository.netdata.cloud/repos/stable/debian/
211 Suites: YOUR_CODENAME/
212 Signed-By: /usr/share/keyrings/netdata-archive-keyring.gpg
213 By-Hash: Yes
214 Enabled: Yes
215 EOF
216 ```
217
218 Replace `YOUR_CODENAME` with your distribution codename (for example, `trixie`). Keep the trailing slash after the codename. For Ubuntu-based systems, change `debian/` to `ubuntu/` in the `URIs` line.
219
220 3. Update package lists and install Netdata:
221
222 ```bash
223 sudo apt update
224 sudo apt install netdata
225 ```
226
227 </details>
228
229 ## Example: Complete Installation on Ubuntu 22.04 (Jammy)
230
231 <details>
232 <summary>Click to view complete installation example</summary>
233 <br/>
234
235 Here's a complete example of installing Netdata on Ubuntu 22.04 using native packages:
236
237 ```bash
238 # Step 1: Download the repository configuration package
239 wget https://repository.netdata.cloud/repos/repoconfig/ubuntu/jammy/netdata-repo_latest.jammy_all.deb
240
241 # Step 2: Install the repository configuration
242 sudo apt install ./netdata-repo_latest.jammy_all.deb
243
244 # Step 3: Update package lists
245 sudo apt update
246
247 # Step 4: Install Netdata
248 sudo apt install netdata
249
250 # Step 5: Start and enable Netdata service
251 sudo systemctl enable --now netdata
252
253 # Step 6: Verify installation
254 curl localhost:19999/api/v1/info
255 ```
256
257 After installation, you can access the Netdata dashboard at `http://localhost:19999`.
258 </details>
259
260 ## Local Mirrors of the Official Netdata Repositories
261
262 You can create local mirrors of our repositories using two main approaches:
263
264 ### Recommended Mirroring Methods
265
266 | Method | Use case | Example |
267 |------------------|---------------------------------------|---------|
268 | Standard tools | For formal repository mirroring | `aptly mirror create netdata-stable http://repository.netdata.cloud/repos/stable/debian/ bullseye/` |
269 | Simple mirroring | For basic HTTP mirroring | `wget --mirror https://repository.netdata.cloud/repos/` |
270
271 ### Mirror Root URL
272
273 [https://repository.netdata.cloud/repos/](https://repository.netdata.cloud/repos/)
274
275 ### Important Mirroring Tips
276
277 :::important
278
279 * **Repository config packages:** These don't support custom mirrors (except caching proxies like `apt-cacher-ng`). Configure mirrors manually.
280 * **Build process:** Packages are built in stages by architecture (64-bit x86 first, then others). Full publishing takes several hours.
281 * **Update frequency:** Metadata updates up to six times per hour, but syncing hourly is sufficient.
282 * **Storage requirements:** A full mirror can require up to **100 GB** of space. Mirror only what you need.
283 * **Recommended sync time:** For daily syncing, **05:00–08:00 UTC** is ideal, as nightly packages are typically published by then.
284 * **GPG verification:** If using our GPG signatures, download our public key:
285 [https://repository.netdata.cloud/netdatabot.gpg.key](https://repository.netdata.cloud/netdatabot.gpg.key)
286
287 :::
288
289 ## Public Mirrors of the Official Netdata Repositories
290
291 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.
292
293 :::important
294
295 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.
296
297 :::
298