master
md 303 lines 12.4 KB
Rendered Raw
1 # Install Netdata on Windows
2
3 Netdata provides a simple Windows installer for quick setup.
4
5 :::note
6
7 The Windows Agent is available for users with paid Netdata subscriptions.
8 Free users will have limited functionality.
9
10 :::
11
12 ## Limitations for Free Users
13
14 | Agent Type | Limitation |
15 |------------------|---------------------------------------------------------------------------------------|
16 | Standalone Agent | UI is locked — No local monitoring |
17 | Child Agent | No monitoring data in parent dashboard when streaming to a Linux-based Netdata parent |
18
19 ## Download the Windows Installer (MSI)
20
21 Choose the version that suits your needs:
22
23 | Version | Download Link | Recommended For |
24 |---------|-----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
25 | Stable | [Download Stable](https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi) | Most users — stable, well-tested |
26 | Nightly | [Download Nightly](https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi) | Users who need the latest features and can handle potential bugs |
27
28 ## Silent Installation (Command Line)
29
30 :::warning
31
32 Silent installation isn’t supported on Windows Server versions earlier than 2019 due to TLS compatibility issues.
33
34 Use the [GUI installer](#graphical-installation-gui) instead.
35
36 :::
37
38 Use silent mode to deploy Netdata without user interaction (ideal for automation).
39
40 :::tip
41
42 Run the command prompt as Administrator.
43
44 :::
45
46 ### Installation Command Options
47
48 | Option | Description |
49 |-----------------|---------------------------------------------------------------------------|
50 | `/qn` | Enables silent mode (no user interaction) |
51 | `/i` | Specifies the path to the MSI installer |
52 | `TOKEN=` | Claim token from your Netdata Cloud Space |
53 | `ROOMS=` | Comma-separated Room IDs for your node |
54 | `PROXY=` | (Optional) Proxy address if required |
55 | `INSECURE=1` | (Optional) Allow insecure connections (hostname verification disabled) |
56 | `REINSTALL=ALL` | (Optional) It forces a complete reinstallation of all Netdata components. |
57
58 ### Example Command
59
60 Install Netdata and connect to your Cloud Space:
61
62 ```bash
63 msiexec /qn /i netdata-x64.msi TOKEN="<YOUR_TOKEN>" ROOMS="<YOUR_ROOMS>"
64 ```
65
66 Replace:
67
68 - `<YOUR_TOKEN>` with your claim token
69 - `<YOUR_ROOMS>` with your Room ID(s)
70
71 ### Download & Install in One Command (PowerShell)
72
73 ```powershell
74 $ProgressPreference = 'SilentlyContinue'; Invoke-WebRequest https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi -OutFile "netdata-x64.msi"; msiexec /qn /i netdata-x64.msi TOKEN=<YOUR_TOKEN> ROOMS=<YOUR_ROOMS>
75 ```
76
77 ## Graphical Installation (GUI)
78
79 1. Download the `.msi` installer.
80 2. Double-click to run it.
81 3. Grant Administrator privileges when prompted.
82 4. Complete the setup wizard.
83
84 ## Offline (Air-gapped) Installation
85
86 Use this method to install Netdata on a Windows system with no internet access.
87
88 ### Step 1: Download the MSI
89
90 On an internet-connected machine, download the MSI installer using one of the links from the [Download the Windows Installer](#download-the-windows-installer-msi) table above.
91
92 ### Step 2: Transfer to the Offline System
93
94 Copy the downloaded `.msi` file to the offline Windows system using a USB drive, network share, or other secure transfer method.
95
96 ### Step 3: Install Without Cloud Parameters
97
98 Open a command prompt as Administrator and run a silent install **without** `TOKEN` or `ROOMS` parameters:
99
100 ```powershell
101 msiexec /qn /i netdata-x64.msi
102 ```
103
104 :::note
105
106 This offline method uses `msiexec /qn` to install from a locally available MSI. On Windows Server versions earlier than 2019, the *automated download* commands in this document may fail due to TLS compatibility issues—download the MSI on another machine (Step 1) or use the [GUI installer](#graphical-installation-gui).
107
108 :::
109
110 In an air-gapped environment, Netdata Cloud features are unavailable. The Agent runs in standalone local mode.
111
112 :::tip
113
114 Paid/enterprise users can use the local Dashboard for full monitoring without Cloud connectivity.
115
116 :::
117
118 :::note
119
120 Free users on standalone Agents have limited functionality — the UI is locked and there is no local monitoring. See [Limitations for Free Users](#limitations-for-free-users) for details.
121
122 :::
123
124 ### Step 4: Access the Local Dashboard
125
126 See [Access Netdata Dashboard](#access-netdata-dashboard).
127
128 :::caution
129
130 Automatic updates require internet access and are not possible on air-gapped systems. To update, repeat the transfer process with a newer MSI.
131
132 :::
133
134 ## Access Netdata Dashboard
135
136 After installation, verify the Netdata service is running:
137
138 ```powershell
139 Get-Service netdata
140 ```
141
142 After installation, open your browser and go to:
143
144 ```
145 http://localhost:19999
146 ```
147
148 If your subscription and installation mode allow local monitoring, you should see the Netdata Dashboard — a real-time metrics overview with system CPU, memory, disk, and network charts updating every second.
149
150 ## License Information
151
152 By using silent installation, you agree to:
153
154 - [GPL-3 License](https://raw.githubusercontent.com/netdata/netdata/refs/heads/master/LICENSE) — Netdata Agent
155 - [NCUL1 License](https://app.netdata.cloud/LICENSE.txt) — Netdata Web Interface
156
157 ## Where is Netdata?
158
159 When Netdata is installed on Windows, it automatically registers as a Windows Service and appears in
160 **Add or remove programs** (also known as **Programs and Features** or **Apps & features** in newer Windows versions).
161 The service can be monitored through the [Netdata Dashboard](http://localhost:19999).
162 To start, stop, or restart the service, use the [PowerShell commands described in Service Control](/docs/netdata-agent/start-stop-restart.md#windows).
163
164 ## Automatic Updates
165
166 For users who want to keep their Windows agents automatically updated with the latest releases, you can set up automated updates.
167
168 :::tip
169
170 **What You'll Learn**
171
172 How to set up automatic Netdata updates on Windows nodes using PowerShell and Task Scheduler.
173
174 :::
175
176 ### How to set up
177
178 This setup will automatically download and install the latest Netdata build (stable or nightly) daily at your preferred time.
179
180 **1. Create the directory and updater script**
181
182 Run one of these PowerShell commands **as Administrator** (choose stable or nightly):
183
184 :::info
185
186 **Administrator Rights Required**
187
188 Creating directories in ProgramData and running Task Scheduler with the highest privileges requires administrator access.
189
190 Right-click on PowerShell and select "Run as administrator" before running these commands.
191
192 :::
193
194 - Stable version
195
196 ```powershell
197 New-Item -Path "$env:PROGRAMDATA\Netdata" -ItemType Directory -Force
198 @'
199 Invoke-WebRequest https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi -OutFile $env:PROGRAMDATA\Netdata\netdata-x64.msi
200 msiexec /qn /i $env:PROGRAMDATA\Netdata\netdata-x64.msi TOKEN="<CLAIM_TOKEN>" ROOMS="<ROOM_ID>"
201 '@ | Out-File -FilePath "$env:PROGRAMDATA\Netdata\netdata-updater.ps1" -Encoding UTF8
202 ```
203
204 - Nightly version
205
206 ```powershell
207 New-Item -Path "$env:PROGRAMDATA\Netdata" -ItemType Directory -Force
208 @'
209 Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi -OutFile $env:PROGRAMDATA\Netdata\netdata-x64.msi
210 msiexec /qn /i $env:PROGRAMDATA\Netdata\netdata-x64.msi TOKEN="<CLAIM_TOKEN>" ROOMS="<ROOM_ID>"
211 '@ | Out-File -FilePath "$env:PROGRAMDATA\Netdata\netdata-updater.ps1" -Encoding UTF8
212 ```
213
214 :::info
215
216 **Configuration Required**
217
218 Replace `<CLAIM_TOKEN>` with your Netdata Cloud claim token and `<ROOM_ID>` with your room identifier.
219
220 :::
221
222 **2. Create an entry in `Task Scheduler`**
223
224 | Tab | Setting | Value |
225 |--------------|--------------------------------------|--------------------------------------------------------------------------------------|
226 | **General** | Run whether user is logged in or not | ✓ Checked |
227 | | Run with highest privileges | ✓ Checked |
228 | | Configure for | Windows Vista, Windows Server 2008 |
229 | **Triggers** | Schedule | Daily |
230 | | Time | Your preferred time (e.g., 7AM UTC) |
231 | **Actions** | Program/Script | `powershell` |
232 | | Arguments | `-noprofile -executionpolicy bypass -file %PROGRAMDATA%\Netdata\netdata-updater.ps1` |
233
234 :::tip
235
236 **Alternative Scheduling Options**
237
238 Instead of daily updates, you might prefer:
239
240 - Weekly updates (select "Weekly" in **Triggers tab**)
241 - Multiple times per day for critical systems
242 - Only on specific days of the week
243
244 :::
245
246 ## Working with Netdata on Windows
247
248 Netdata on Windows includes a bundled MSYS2 environment for working with Netdata configuration files and other internals.
249
250 ### Open the MSYS2 environment
251
252 Launch the bundled MSYS2 shell using one of these methods (the paths below assume Netdata is installed in the default location):
253
254 - **Windows Run dialog**: Press `Win + R`, enter `"C:\Program Files\Netdata\msys2.exe"`, and press `Enter`.
255 - **PowerShell**: `& "C:\Program Files\Netdata\msys2.exe"`
256 - **Command Prompt**: `"C:\Program Files\Netdata\msys2.exe"`
257
258 When `msys2.exe` starts, it opens a shell environment for working with the Netdata files installed on your system.
259
260 ### Writing Windows paths in MSYS format
261
262 Netdata configuration files consumed from the MSYS side require MSYS-style paths instead of native Windows drive-letter format.
263
264 Conversion pattern:
265
266 - Replace the drive letter with its lowercase equivalent preceded by `/` (e.g., `C:``/c`, `D:``/d`)
267 - Replace backslashes `\` with forward slashes `/`
268 - Keep spaces in the path, but quote or escape the full path when using it in shell commands
269
270 Examples:
271
272 | Windows path | MSYS-style path |
273 |------------------------------------------------|------------------------------------------------|
274 | `C:\Program Files\Netdata\etc\netdata` | `/c/Program Files/Netdata/etc/netdata/` |
275 | `C:\Program Files\Netdata\usr\bin\netdata.exe` | `/c/Program Files/Netdata/usr/bin/netdata.exe` |
276
277 ### Editing configuration files
278
279 Inside the MSYS2 environment, use the `edit-config` helper to edit Netdata configuration files:
280
281 ```bash
282 cd /etc/netdata
283 ./edit-config netdata.conf
284 ```
285
286 For the complete `edit-config` workflow and configuration directory layout, see [Netdata Agent Configuration](/docs/netdata-agent/configuration/README.md#edit-configuration-files).
287
288 On Windows, `edit-config` opens files with the `nano` editor.
289
290 ### Basic nano commands
291
292 | Action | Keybinding |
293 |-----------------------|------------------------------------------------|
294 | Edit text | Type normally, use arrow keys to navigate |
295 | Search | `Ctrl + W`, type search text, `Enter` |
296 | Save | `Ctrl + O`, `Enter` to confirm filename |
297 | Exit | `Ctrl + X` |
298 | Exit with save prompt | `Ctrl + X`, then `Y` to save or `N` to discard |
299
300 ## Related Windows documentation
301
302 - [Service Control](/docs/netdata-agent/start-stop-restart.md#windows) — Start, stop, restart, and check status of the Netdata Agent
303 - [Switching Install Types and Release Channels on Windows](/docs/install/windows-release-channels.md)