sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-09-02 13:11:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: document Windows installer UI autostart behavior (#715)

Browse Source 
Add silent installation section to the Windows install page covering
the AUTOSTART MSI property and the fixed EXE silent install default.
Update Intune and Acronis deployment guides to mention autostart.
This commit is contained in:
shuuri-labs
2026-04-29 13:14:36 +02:00
committed by GitHub
parent fbf6283191
commit 10114fc7d7
3 changed files with 57 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
src/pages/get-started/install/windows.mdx
View File

@@ -14,6 +14,60 @@ The NetBird client (agent) allows a peer to join a pre-existing NetBird deployme
To uninstall the client and service, you can use Add/Remove programs
</Note>
## Silent and Automated Installation
Both installers support silent (unattended) installation for use with RMM tools, MDM platforms, and scripted deployments. By default, silent installations automatically configure the NetBird UI to start at user login, so the system tray icon is available without manual intervention.
### EXE Installer (NSIS)
Run the EXE installer with the `/S` flag for a silent installation:
```bash
netbird_installer_<VERSION>_windows_amd64.exe /S
```
The UI tray autostart is enabled by default for both interactive and silent installs. The installer writes the autostart entry to `HKLM\Software\Microsoft\Windows\CurrentVersion\Run`, which applies to all users on the machine.
### MSI Installer
Run the MSI installer with `msiexec` for a silent installation:
```bash
msiexec /i netbird_installer_<VERSION>_windows_amd64.msi /quiet
```
The MSI installer includes an `AUTOSTART` property that defaults to `1` (enabled). When enabled, it registers `netbird-ui.exe` in `HKLM\Software\Microsoft\Windows\CurrentVersion\Run` so the UI tray starts automatically at login for all users.
To disable the UI tray autostart during installation:
```bash
msiexec /i netbird_installer_<VERSION>_windows_amd64.msi AUTOSTART=0 /quiet
```
<Note>
Disabling `AUTOSTART` only prevents the UI tray from launching at login. The NetBird background service still runs and maintains connectivity regardless of this setting.
</Note>
### Combining with a Setup Key
For fully automated deployments where peers should register without user interaction, combine silent installation with a [setup key](/manage/peers/register-machines-using-setup-keys):
```bash
netbird_installer_<VERSION>_windows_amd64.exe /S
netbird up --setup-key <SETUP KEY>
```
Or with the MSI installer:
```bash
msiexec /i netbird_installer_<VERSION>_windows_amd64.msi /quiet
netbird up --setup-key <SETUP KEY>
```
<Note>
For MDM-specific deployment guides, see [Deploy with Intune](/manage/integrations/mdm-deployment/intune-netbird-integration) or [Deploy with Acronis](/manage/for-partners/acronis-integration).
</Note>
## Running NetBird with SSO Login
### Desktop UI Application
If you installed the Desktop UI client, you can launch it and click on Connect.