Update windows documentation (#18703)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Fotis Voutsas committed
Oct 7, 2024 at 14:45 UTC
942a55066d04b027662e731aa918881119998533
1 file changed
+21
-7
packaging/windows/WINDOWS_INSTALLER.md
+21
-7
@@ -2,9 +2,14 @@
2
3
Netdata offers a convenient Windows installer for easy setup. This executable provides two distinct installation modes, outlined below.
4
5
+> **Note**
6
+>
7
+> This feature is currently only available for Nightly releases, and the installer can be found in our [nightlies repo](https://github.com/netdata/netdata-nightlies)
8
+
9
## Graphical User Interface (GUI)
10
11
Double-clicking the installer initiates the setup process. Since Netdata adds a service to your system, you'll need to provide administrator privileges.
12
+
13
The installer will then guide you through these steps:
14
15
1. **Welcome**: This screen provides a summary of the actions the installer will perform.
@@ -13,18 +18,23 @@ The installer will then guide you through these steps:
18
- [GPLv3 License](/LICENSE): Read the GNU General Public License v3, which governs the Netdata software.
19
3. **Destination**: Choose the installation directory. By default, Netdata installs in `C:\Program Files\Netdata`.
20
4. **Installation**: The installer will copy the necessary files to the chosen directory.
16
-5. **Claiming**: [Connecting](/src/claim/README.md) your Netdata Agent to your Netdata Cloud Space. Here's what you can configure:
17
- - **Token**: The claiming token for your Netdata Cloud Space.
18
- - **Rooms**: Specify the Room IDs where you want your node to appear (comma-separated list).
19
- - **Proxy**: Enter the address of a proxy server if required for communication with Netdata Cloud.
21
+5. **Connect to Netdata Cloud**: To [connect](/src/claim/README.md) your Agent to your Netdata Cloud Space you need to provide the following:
22
+ - **Claim Token**: The Claim Token that securely authenticates and links your Agent to your Space.
23
+ - **Room IDs**: A comma-separated list of Room IDs where you want to add your Agent.
24
+ - **Proxy address**: The address of a proxy server, if one is required for communication with Netdata Cloud.
25
- **Insecure connection**: By default, Netdata verifies the server's certificate. Enabling this option bypasses verification (use only if necessary).
26
- **Open Terminal**: Select this option to launch the `MSYS2` terminal after installation completes.
27
6. **Finish**: The installation process is complete!
28
24
-## Silent Mode
29
+## Silent Mode (Command line)
30
31
This section provides instructions for installing Netdata in silent mode, which is ideal for automated deployments.
27
-Silent mode skips displaying license agreements, but requires explicitly accepting them using the `/A` option.
32
+
33
+> **Info**
34
+>
35
+> Run the installer as admin to avoid the Windows prompt.
36
+>
37
+> Silent mode skips displaying license agreements, but requires explicitly accepting them using the `/A` option.
38
39
### Available Options
40
@@ -35,7 +45,7 @@ Silent mode skips displaying license agreements, but requires explicitly accepti
45
| `/D` | Specifies the desired installation directory (defaults to `C:\Program Files\Netdata`). |
46
| `/T` | Opens the `MSYS2` terminal after installation. |
47
| `/I` | Forces insecure connections, bypassing hostname verification (use only if absolutely necessary). |
38
-| `/TOKEN=` | Sets the claiming token for your Netdata Cloud Space. |
48
+| `/TOKEN=` | Sets the Claim Token for your Netdata Cloud Space. |
49
| `/ROOMS=` | Comma-separated list of Room IDs where you want your node to appear. |
50
| `/PROXY=` | Sets the proxy server address if your network requires one. |
51
@@ -48,3 +58,7 @@ netdata-installer.exe /S /A /TOKEN=<YOUR_TOKEN> /ROOMS=<YOUR_ROOM>
58
```
59
60
Replace `<YOUR_TOKEN>` and `<YOUR_ROOM>` with your actual Netdata Cloud Space claim token and room ID, respectively.
61
+
62
+## Uninstalling
63
+
64
+To uninstall Netdata, run the `uninstall.exe` file in your Netdata installation directory, typically `<YOUR_INSTALL_LOCATION>\Netdata`.