Windows documentation (#22021)
thiagoftsm committed
Mar 24, 2026 at 12:17 UTC
cc8f52788827b6736c173a5218669905e5be6106
1 file changed
+85
docs/category-overview-pages/working-with-netdata-on-windows.md
new
+85
@@ -0,0 +1,85 @@
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)