0
0
mirror of https://github.com/netdata/netdata.git synced 2024-11-21 23:38:07 +00:00
netdata_netdata/packaging/windows/WINDOWS_INSTALLER.md
thiagoftsm dea559c7d4
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>
2024-11-07 16:34:59 -05:00

55 lines
3.4 KiB
Markdown

# Netdata Windows Installer
Netdata offers a convenient Windows installer for easy setup. This executable provides two distinct installation modes, outlined below.
## Download the MSI Installer
You can download the Netdata Windows installer (MSI) from the official releases page:
| 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)
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.
Once installed, you can access your Netdata dashboard at `localhost:19999`.
## 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.
>
> 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 |
|--------------|--------------------------------------------------------------------------------------------------|
| `/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
msiexec /qn /i netdata-x64.msi TOKEN="<YOUR_TOKEN>" ROOMS="<YOUR_ROOM>"
```
Replace `<YOUR_TOKEN>` and `<YOUR_ROOM>` with your Netdata Cloud Space claim token and room ID, respectively.
> **Note**
>
> The Windows version of Netdata is intended for users on paid plans.