Browse Source

Update Windows Documentation (#18928)

* update_doc: Upate user documentation with current MSI

* update_doc: Rename CLOUDLICENSE to CLOUDUILICENSE

* Update WINDOWS_INSTALLER.md

* Update UPDATE.md

* Update UNINSTALL.md

* update_doc: remove unnecessary lines

* update_doc: remove slash before arguemtn

* update

* update

* yamllint please

---------

Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Co-authored-by: ilyam8 <ilya@netdata.cloud>
thiagoftsm 4 months ago
parent
commit
dea559c7d4

+ 20 - 22
integrations/deploy.yaml

@@ -560,13 +560,15 @@
   install_description: |
     Netdata offers a convenient Windows installer for easy setup. This executable provides two distinct installation modes, outlined below.
 
-    The Windows installer is currently under beta, and thus it is only available in the nightly release channel. A stable version will be released soon.
-
     ## Graphical User Interface (GUI)
 
-    1. Download the Netdata [Windows installer](https://github.com/netdata/netdata-nightlies/releases) from the latest nightly release.
-    2. Run the `.exe` file and proceed with the installation process.
-    3. At a minimum, you will need your Netdata Cloud Space's claim token to connect your Agent to your Space.
+    **Download the MSI Installer**:
+      - [Stable version](https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi)
+      - [Nightly version](https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi)
+
+    Double-click the installer to start the installation process. As Netdata adds a service to your system, you'll need to provide administrator privileges.
+
+    Once installed, you can access your Netdata dashboard at `localhost:19999`.
 
     ## Silent Mode (Command line)
 
@@ -577,28 +579,24 @@
         - channel: stable
           command: |
             $ProgressPreference = 'SilentlyContinue';
-            Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-installer-x64.exe -OutFile "netdata-installer-x64.exe";
-            .\netdata-installer-x64.exe /S /A `
-            {% if $showClaimingOptions %}/TOKEN={% claim_token %} /ROOMS={% $claim_rooms %}{% /if %}
+            Invoke-WebRequest https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi -OutFile "netdata-x64.msi";
+            msiexec /qn /i netdata-x64.msi {% if $showClaimingOptions %}TOKEN={% claim_token %} ROOMS={% $claim_rooms %}{% /if %}
         - channel: nightly
           command: |
             $ProgressPreference = 'SilentlyContinue';
-            Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-installer-x64.exe -OutFile "netdata-installer-x64.exe";
-            .\netdata-installer-x64.exe /S /A `
-            {% if $showClaimingOptions %}/TOKEN={% claim_token %} /ROOMS={% $claim_rooms %}{% /if %}
+            Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi -OutFile "netdata-x64.msi";
+            .\msiexec /qn /i netdata-x64.msi {% if $showClaimingOptions %}/TOKEN={% claim_token %} /ROOMS={% $claim_rooms %}{% /if %}
   additional_info: |
-    ### Available Options
+    ### Available CLI Options
 
-    | Option    | Description                                                                                      |
-    |-----------|--------------------------------------------------------------------------------------------------|
-    | `/S`      | Enables silent mode installation.                                                                |
-    | `/A`      | Accepts all Netdata licenses. This option is mandatory for silent installations.                 |
-    | `/D`      | Specifies the desired installation directory (defaults to `C:\Program Files\Netdata`).           |
-    | `/T`      | Opens the `MSYS2` terminal after installation.                                                   |
-    | `/I`      | Forces insecure connections, bypassing hostname verification (use only if absolutely necessary). |
-    | `/TOKEN=` | Sets the Claim Token for your Netdata Cloud Space.                                               |
-    | `/ROOMS=` | Comma-separated list of Room IDs where you want your node to appear.                             |
-    | `/PROXY=` | Sets the proxy server address if your network requires one.                                      |
+    | Option       | Description                                                                                      |
+    |--------------|--------------------------------------------------------------------------------------------------|
+    | `/qn`        | Enables silent mode installation.                                                                |
+    | `/i`         | Specifies the path to the MSI installer file.                                                    |
+    | `INSECURE=1` | Forces insecure connections, bypassing hostname verification (use only if absolutely necessary). |
+    | `TOKEN=`     | Sets the Claim Token for your Netdata Cloud Space.                                               |
+    | `ROOMS=`     | Comma-separated list of Room IDs where you want your node to appear.                             |
+    | `PROXY=`     | Sets the proxy server address if your network requires one.                                      |
   related_resources: {}
   most_popular: true
   platform_info:

+ 1 - 4
packaging/installer/UNINSTALL.md

@@ -80,7 +80,4 @@ chmod +x ./netdata-uninstaller.sh
 
 ## Windows
 
-Currently, the Windows version of Netdata is in beta. To uninstall Netdata on Windows:
-
-1. Locate the `Uninstall.exe` file in your Netdata installation directory.
-2. Double-click the `Uninstall.exe` file and follow the on-screen instructions.
+To uninstall Netdata on Windows, use the standard application uninstaller in your **Settings** app or **Control Panel**.

+ 5 - 5
packaging/installer/UPDATE.md

@@ -1,9 +1,9 @@
 # Update Netdata
 
-The update process can differ based on the install type:
+The update process can differ based on the installation type:
 
 - Install types starting with `binpkg` or ending with `build` or `static` can be updated using our [kickstart script update method](#unix).
-- Installs with an install type of `custom` usually indicate installing a third-party package through the system package manager. To update these installs, you should update the package just like you would any other package on your system.
+- Installs with an installation type of `custom` usually indicate installing a third-party package through the system package manager. To update these installations, you should update the package just like you would any other package on your system.
 - macOS users should check [our update instructions for macOS](#macos).
 - Manually built installs should check [our update instructions for manual builds](#manual-installation-from-git).
 
@@ -38,7 +38,7 @@ wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /
 
 > **Note**
 >
-> if you installed Netdata using an installation prefix, you will need to add an `--install-prefix` option specifying that prefix to make sure it finds the existing install.
+> if you installed Netdata using an installation prefix, you will need to add an `--install-prefix` option specifying that prefix to make sure it finds the existing installation.
 
 If you see a line starting with `--- Would attempt to update existing installation by running the updater script located at:`, then our [kickstart script update method](#unix) will work for you.
 
@@ -47,7 +47,7 @@ Otherwise, it should either indicate that the installation type is not supported
 ## UNIX
 
 In most cases, you can update Netdata using our one-line kickstart script. This script will automatically
-run the update script installed as part of the initial install and preserve the existing install options you specified.
+run the update script installed as part of the initial install and preserve the existing installation options you specified.
 
 If you installed Netdata using an installation prefix, you will need to add an `--install-prefix` option specifying that prefix to this command to make sure it finds Netdata.
 
@@ -57,7 +57,7 @@ wget -O /tmp/netdata-kickstart.sh https://get.netdata.cloud/kickstart.sh && sh /
 
 ## Windows
 
-To update a Windows Netdata installation, download the executable and proceed to reinstall the Agent. This will update the installation.
+To update Netdata, [download](/packaging/windows/WINDOWS_INSTALLER.md#download-the-msi-installer) the latest installer and reinstall the Agent.
 
 > **Note**
 >

+ 22 - 32
packaging/windows/WINDOWS_INSTALLER.md

@@ -2,29 +2,21 @@
 
 Netdata offers a convenient Windows installer for easy setup. This executable provides two distinct installation modes, outlined below.
 
-> **Note**
->
-> This feature is currently under beta and only available for Nightly releases, and the installer can be found in our [nightlies repo](https://github.com/netdata/netdata-nightlies). A stable version will be released soon.
+## Download the MSI Installer
 
-## Graphical User Interface (GUI)
+You can download the Netdata Windows installer (MSI) from the official releases page:
 
-Double-clicking the installer initiates the setup process. Since Netdata adds a service to your system, you'll need to provide administrator privileges.
+| Version                                                                                          | Description                                                                                                                                                               |
+|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Stable](https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi)            | This is the recommended version for most users as it provides the most reliable and well-tested features.                                                                 |
+| [Nightly](https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi) | Offers the latest features but may contain bugs or instabilities. Use this option if you require access to the newest features and are comfortable with potential issues. |
+
+## Graphical User Interface (GUI)
 
-The installer will then guide you through these steps:
+1. **Double-click** the installer to begin the setup process.
+2. **Grant Administrator Privileges**: You'll need to provide administrator permissions to install the Netdata service.
 
-1. **Welcome**: This screen provides a summary of the actions the installer will perform.
-2. **License Agreements**:
-    - [Netdata Cloud UI License](https://app.netdata.cloud/LICENSE.txt): Review and accept the license terms to proceed.
-    - [GPLv3 License](/LICENSE): Read the GNU General Public License v3, which governs the Netdata software.
-3. **Destination**: Choose the installation directory. By default, Netdata installs in `C:\Program Files\Netdata`.
-4. **Installation**: The installer will copy the necessary files to the chosen directory.
-5. **Connect to Netdata Cloud**: To [connect](/src/claim/README.md) your Agent to your Netdata Cloud Space you need to provide the following:
-    - **Claim Token**: The Claim Token that securely authenticates and links your Agent to your Space.
-    - **Room IDs**: A comma-separated list of Room IDs where you want to add your Agent.
-    - **Proxy address**: The address of a proxy server, if one is required for communication with Netdata Cloud.
-    - **Insecure connection**: By default, Netdata verifies the server's certificate. Enabling this option bypasses verification (use only if necessary).
-    - **Open Terminal**: Select this option to launch the `MSYS2` terminal after installation completes.
-6. **Finish**: The installation process is complete!
+Once installed, you can access your Netdata dashboard at `localhost:19999`.
 
 ## Silent Mode (Command line)
 
@@ -34,30 +26,28 @@ This section provides instructions for installing Netdata in silent mode, which
 >
 > Run the installer as admin to avoid the Windows prompt.
 >
-> Silent mode skips displaying license agreements, but requires explicitly accepting them using the `/A` option.
+> Using silent mode implicitly accepts the terms of the [GPL-3](https://raw.githubusercontent.com/netdata/netdata/refs/heads/master/LICENSE) (Netdata Agent) and [NCUL1](https://app.netdata.cloud/LICENSE.txt) (Netdata Web Interface) licenses, skipping the display of agreements.
 
 ### Available Options
 
-| Option    | Description                                                                                      |
-|-----------|--------------------------------------------------------------------------------------------------|
-| `/S`      | Enables silent mode installation.                                                                |
-| `/A`      | Accepts all Netdata licenses. This option is mandatory for silent installations.                 |
-| `/D`      | Specifies the desired installation directory (defaults to `C:\Program Files\Netdata`).           |
-| `/T`      | Opens the `MSYS2` terminal after installation.                                                   |
-| `/I`      | Forces insecure connections, bypassing hostname verification (use only if absolutely necessary). |
-| `/TOKEN=` | Sets the Claim Token for your Netdata Cloud Space.                                               |
-| `/ROOMS=` | Comma-separated list of Room IDs where you want your node to appear.                             |
-| `/PROXY=` | Sets the proxy server address if your network requires one.                                      |
+| Option       | Description                                                                                      |
+|--------------|--------------------------------------------------------------------------------------------------|
+| `/qn`        | Enables silent mode installation.                                                                |
+| `/i`         | Specifies the path to the MSI installer file.                                                    |
+| `INSECURE=1` | Forces insecure connections, bypassing hostname verification (use only if absolutely necessary). |
+| `TOKEN=`     | Sets the Claim Token for your Netdata Cloud Space.                                               |
+| `ROOMS=`     | Comma-separated list of Room IDs where you want your node to appear.                             |
+| `PROXY=`     | Sets the proxy server address if your network requires one.                                      |
 
 ### Example Usage
 
 Connect your Agent to your Netdata Cloud Space with token `<YOUR_TOKEN>` and room `<YOUR_ROOM>`:
 
 ```bash
-netdata-installer-x64.exe /S /A /TOKEN=<YOUR_TOKEN> /ROOMS=<YOUR_ROOM>
+msiexec /qn /i netdata-x64.msi TOKEN="<YOUR_TOKEN>" ROOMS="<YOUR_ROOM>"
 ```
 
-Replace `<YOUR_TOKEN>` and `<YOUR_ROOM>` with your actual Netdata Cloud Space claim token and room ID, respectively.
+Replace `<YOUR_TOKEN>` and `<YOUR_ROOM>` with your Netdata Cloud Space claim token and room ID, respectively.
 
 > **Note**
 >