diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-11-09 08:36:07 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-11-25 11:21:20 +0000 |
commit | eae52fdaa9298e00f14b0b6256400d200db9c373 (patch) | |
tree | a3040a19bd024295ded05370853647bab9d7c225 /packaging/windows/WINDOWS_INSTALLER.md | |
parent | Adding upstream version 1.47.5. (diff) | |
download | netdata-upstream/2.0.3.tar.xz netdata-upstream/2.0.3.zip |
Adding upstream version 2.0.3.upstream/2.0.3
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'packaging/windows/WINDOWS_INSTALLER.md')
-rw-r--r-- | packaging/windows/WINDOWS_INSTALLER.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/packaging/windows/WINDOWS_INSTALLER.md b/packaging/windows/WINDOWS_INSTALLER.md new file mode 100644 index 000000000..fb727bb3e --- /dev/null +++ b/packaging/windows/WINDOWS_INSTALLER.md @@ -0,0 +1,64 @@ +# Netdata Windows Installer + +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. + +## Graphical User Interface (GUI) + +Double-clicking the installer initiates the setup process. Since Netdata adds a service to your system, you'll need to provide administrator privileges. + +The installer will then guide you through these steps: + +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! + +## Silent Mode (Command line) + +This section provides instructions for installing Netdata in silent mode, which is ideal for automated deployments. + +> **Info** +> +> 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. + +### 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. | + +### 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> +``` + +Replace `<YOUR_TOKEN>` and `<YOUR_ROOM>` with your actual Netdata Cloud Space claim token and room ID, respectively. + +> **Note** +> +> The Windows version of Netdata is intended for users on paid plans. |