docs: consolidate windows docs and service status (#22519)
* docs: update docs/netdata-usage-on-windows * docs: Execution completed * docs: Execution completed * docs: Execution completed * docs: fix nano commands table alignment in WINDOWS_INSTALLER.md * docs(windows): fix review comments in WINDOWS_INSTALLER.md - Remove services.msc reference (not documented in the linked section) - Add caveat that MSYS2 launch commands use the default install path - Make path conversion rule generic for any drive letter * Apply suggestion from @Ancairon * docs: address Copilot review feedback in Windows installer guide * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * pr review --------- Co-authored-by: nedi-app[bot] <nedi-app[bot]@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Fotis Voutsas <fotis@netdata.cloud> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
nedi-app[bot] committed
Jun 4, 2026 at 11:00 UTC
7461f79227a647269f58c1c89e2a02caa0a41f88
3 files changed
+91
-115
docs/category-overview-pages/working-with-netdata-on-windows.md
deleted
-85
@@ -1,85 +0,0 @@
1
-# Working with Netdata on Windows
2
-
3
-This section introduces Windows-specific workflows for working with a local Netdata installation.
4
-
5
-## First step: open the bundled MSYS2 environment
6
-
7
-If Netdata is installed in the default location, you can launch its bundled MSYS2 environment by running:
8
-
9
-```text
10
-C:\Program Files\Netdata\msys2.exe
11
-```
12
-
13
-### Option 1: Run it from the Windows Run dialog
14
-
15
-1. Press `Win + R`.
16
-2. Enter `"C:\Program Files\Netdata\msys2.exe"`.
17
-3. Press `Enter`.
18
-
19
-### Option 2: Run it from PowerShell
20
-
21
-Open PowerShell and run:
22
-
23
-```powershell
24
-& "C:\Program Files\Netdata\msys2.exe"
25
-```
26
-
27
-### Option 3: Run it from Command Prompt
28
-
29
-Open Command Prompt and run:
30
-
31
-```cmd
32
-"C:\Program Files\Netdata\msys2.exe"
33
-```
34
-
35
-## What to expect
36
-
37
-When `msys2.exe` starts, it opens a shell environment for working with the Netdata files installed on your Windows system.
38
-
39
-## Writing Windows paths in Netdata config files
40
-
41
-When a Netdata setting is consumed from the MSYS side of the Windows installation, write Windows paths in MSYS format instead of native Windows drive-letter format.
42
-
43
-For example:
44
-
45
-- Windows path: `C:\Program Files\Netdata`
46
-- MSYS-style path: `/c/Program Files/Netdata`
47
-
48
-Use this pattern:
49
-
50
-- Replace the drive letter `C:` with `/c`
51
-- Replace backslashes `\` with forward slashes `/`
52
-- Keep spaces as they are
53
-
54
-This means:
55
-
56
-- `C:\Program Files\Netdata\etc\netdata` becomes `/c/Program Files/Netdata/etc/netdata/`
57
-- `C:\Program Files\Netdata\usr\bin\netdata.exe` becomes `/c/Program Files/Netdata/usr/bin/netdata.exe`
58
-
59
-## Editing config files with `edit-config`
60
-
61
-Inside the Netdata MSYS environment, use the `edit-config` helper script from `/etc/netdata/edit-config` when you want to edit Netdata configuration files.
62
-
63
-For example:
64
-
65
-```bash
66
-cd /etc/netdata
67
-./edit-config netdata.conf
68
-```
69
-
70
-For the complete `edit-config` workflow and the broader explanation of Netdata config directories, see [Netdata Agent Configuration](/docs/netdata-agent/configuration/README.md#edit-configuration-files).
71
-
72
-When `edit-config` opens the file on Windows, it uses the `nano` editor.
73
-
74
-### Basic `nano` commands for Windows users
75
-
76
-- Edit text: just type, and use the arrow keys to move around the file.
77
-- Search: press `Ctrl + W`, type the text you want to find, then press `Enter`.
78
-- Save: press `Ctrl + O`, press `Enter` to confirm the filename, then wait for nano to write the file.
79
-- Exit: press `Ctrl + X`.
80
-- Exit after editing: press `Ctrl + X`. If nano asks whether to save modified content, press `Y` to save your changes or `N` to discard them.
81
-
82
-## Related Windows documentation
83
-
84
-- [Install Netdata on Windows](/packaging/windows/WINDOWS_INSTALLER.md)
85
-- [Switching Netdata Install Types and Release Channels on Windows](/docs/install/windows-release-channels.md)
docs/netdata-agent/start-stop-restart.md
+23
-29
@@ -30,12 +30,12 @@ Restarting the Netdata Agent will cause temporary gaps in your collected metrics
30
31
### Using `systemctl`, `service`, or `init.d`
32
33
-| Action | Systemd | Non-systemd |
34
-|---------|----------------------------------|-------------------------------------------------------------------------------|
35
-| start | `sudo systemctl start netdata` | `sudo service netdata start` or `sudo /etc/init.d/netdata start` |
36
-| stop | `sudo systemctl stop netdata` | `sudo service netdata stop` or `sudo /etc/init.d/netdata stop` |
37
-| restart | `sudo systemctl restart netdata` | `sudo service netdata restart` or `sudo /etc/init.d/netdata restart` |
38
-| status | `sudo systemctl status netdata` | `sudo service netdata status` or `sudo /etc/init.d/netdata status` |
33
+| Action | Systemd | Non-systemd |
34
+|---------|----------------------------------|----------------------------------------------------------------------|
35
+| start | `sudo systemctl start netdata` | `sudo service netdata start` or `sudo /etc/init.d/netdata start` |
36
+| stop | `sudo systemctl stop netdata` | `sudo service netdata stop` or `sudo /etc/init.d/netdata stop` |
37
+| restart | `sudo systemctl restart netdata` | `sudo service netdata restart` or `sudo /etc/init.d/netdata restart` |
38
+| status | `sudo systemctl status netdata` | `sudo service netdata status` or `sudo /etc/init.d/netdata status` |
39
40
### Check status
41
@@ -85,45 +85,39 @@ sudo netdatacli reload-health
85
86
:::note
87
88
-**Administrator Access Required**
89
-
88
You will need to run PowerShell as administrator.
89
90
:::
91
94
-### Using Windows Services GUI
95
-
96
-<details>
97
-<summary><strong>Manage Through Task Manager</strong></summary><br/>
92
+### Using Task Manager
93
94
If you prefer to manage the Agent through the GUI, you can start-stop and restart the `Netdata` service from the "Services" tab of Task Manager.
95
101
-<br/>
102
-</details>
103
-
96
### Using PowerShell Commands
97
106
-- To **start** Netdata, run `Start-Service Netdata`.
107
-- To **stop** Netdata, run `Stop-Service Netdata`.
108
-- To **restart** Netdata, run `Restart-Service Netdata`.
98
+- To **check the status** of Netdata, run `Get-Service netdata`.
99
+- To **start** Netdata, run `Start-Service netdata`.
100
+- To **stop** Netdata, run `Stop-Service netdata`.
101
+- To **restart** Netdata, run `Restart-Service netdata`.
102
103
## Quick Reference
104
105
### UNIX Commands Summary
106
114
-| Task | Systemd | Non-systemd | Direct Command |
115
-|-------------------|----------------------------------|-------------------------------------------------------------------------------|----------------------------------|
116
-| **Start** | `sudo systemctl start netdata` | `sudo service netdata start` or `sudo /etc/init.d/netdata start` | `sudo netdata` |
117
-| **Stop** | `sudo systemctl stop netdata` | `sudo service netdata stop` or `sudo /etc/init.d/netdata stop` | `sudo killall netdata` |
118
-| **Restart** | `sudo systemctl restart netdata` | `sudo service netdata restart` or `sudo /etc/init.d/netdata restart` | Stop + Start |
119
-| **Status** | `sudo systemctl status netdata` | `sudo service netdata status` or `sudo /etc/init.d/netdata status` | `curl http://NODE:19999/api/v1/info` |
120
-| **Reload Health** | `sudo netdatacli reload-health` | `sudo netdatacli reload-health` | `sudo netdatacli reload-health` |
121
-| **Shutdown** | `sudo netdatacli shutdown-agent` | `sudo netdatacli shutdown-agent` | `sudo netdatacli shutdown-agent` |
107
+| Task | Systemd | Non-systemd | Direct Command |
108
+|-------------------|----------------------------------|----------------------------------------------------------------------|--------------------------------------|
109
+| **Start** | `sudo systemctl start netdata` | `sudo service netdata start` or `sudo /etc/init.d/netdata start` | `sudo netdata` |
110
+| **Stop** | `sudo systemctl stop netdata` | `sudo service netdata stop` or `sudo /etc/init.d/netdata stop` | `sudo killall netdata` |
111
+| **Restart** | `sudo systemctl restart netdata` | `sudo service netdata restart` or `sudo /etc/init.d/netdata restart` | Stop + Start |
112
+| **Status** | `sudo systemctl status netdata` | `sudo service netdata status` or `sudo /etc/init.d/netdata status` | `curl http://NODE:19999/api/v1/info` |
113
+| **Reload Health** | `sudo netdatacli reload-health` | `sudo netdatacli reload-health` | `sudo netdatacli reload-health` |
114
+| **Shutdown** | `sudo netdatacli shutdown-agent` | `sudo netdatacli shutdown-agent` | `sudo netdatacli shutdown-agent` |
115
116
### Windows Commands Summary
117
118
| Task | PowerShell Command | GUI Location |
119
|-------------|---------------------------|-----------------------------------|
127
-| **Start** | `Start-Service Netdata` | Task Manager > Services > Netdata |
128
-| **Stop** | `Stop-Service Netdata` | Task Manager > Services > Netdata |
129
-| **Restart** | `Restart-Service Netdata` | Task Manager > Services > Netdata |
120
+| **Status** | `Get-Service netdata` | Task Manager > Services > Netdata |
121
+| **Start** | `Start-Service netdata` | Task Manager > Services > Netdata |
122
+| **Stop** | `Stop-Service netdata` | Task Manager > Services > Netdata |
123
+| **Restart** | `Restart-Service netdata` | Task Manager > Services > Netdata |
packaging/windows/WINDOWS_INSTALLER.md
+68
-1
@@ -133,12 +133,20 @@ Automatic updates require internet access and are not possible on air-gapped sys
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:
@@ -151,7 +159,7 @@ By using silent installation, you agree to:
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).
154
-To start, stop, or restart the service, use Windows Services (services.msc) or command-line tools
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
@@ -234,3 +242,62 @@ Instead of daily updates, you might prefer:
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)