mirror of
https://github.com/netbirdio/docs.git
synced 2026-09-19 13:29:04 +02:00
Updates for the NetBird 0.75 update (#881)
This commit is contained in:
PizzaLovingNerd
@@ -102,7 +102,7 @@ The command will check if the peer is logged in and connect to the management se
|
||||
--disable-ssh-auth Disable SSH JWT authentication. If enabled, any peer with network access can connect without user authentication.
|
||||
--dns-resolver-address string Sets a custom address for NetBird's local DNS resolver. If set, the agent won't attempt to discover the best IP and port to listen on. An empty string "" clears the previous configuration. E.g. --dns-resolver-address 127.0.0.1:5053 or --dns-resolver-address ""
|
||||
--dns-router-interval duration DNS route update interval (default 1m0s)
|
||||
--enable-lazy-connection Enable the lazy connection feature. If enabled, the client will establish connections on-demand. Note: this setting may be overridden by management configuration.
|
||||
--enable-lazy-connection Deprecated and no longer used. Lazy connections are controlled by Management and the NB_LAZY_CONN environment variable.
|
||||
--enable-rosenpass [Experimental] Enable Rosenpass feature. If enabled, the connection will be post-quantum secured via Rosenpass.
|
||||
--enable-ssh-local-port-forwarding Enable local port forwarding for SSH server
|
||||
--enable-ssh-remote-port-forwarding Enable remote port forwarding for SSH server
|
||||
@@ -799,8 +799,15 @@ netbird debug [command]
|
||||
|
||||
### debug bundle
|
||||
Generates a compressed archive containing diagnostic information, which can be used for troubleshooting.
|
||||
The file will be generated in a temporary directory and the path will be printed to the console.
|
||||
The file is only accessible as root/Administrator.
|
||||
The file will be generated in the daemon's temporary directory and the path will be printed to the console. With a
|
||||
standard service installation, the location is `/tmp/netbird.debug.<number>.zip` on Linux and macOS, and
|
||||
`C:\Windows\Temp\netbird.debug.<number>.zip` on Windows. A custom operating-system temporary directory can change this
|
||||
path.
|
||||
|
||||
The local ZIP is created whether or not `--upload-bundle` is used. With `--upload-bundle`, the command also prints an
|
||||
upload key that you can share with the NetBird team.
|
||||
The file belongs to the daemon service account (`root` on standard Linux and macOS installations and `LocalSystem` on
|
||||
Windows), so elevated permissions may be required to access it directly.
|
||||
|
||||
#### Usage
|
||||
To create a debug bundle:
|
||||
|
||||
@@ -41,10 +41,10 @@ With the client installed, you now need to connect it to your network.
|
||||
|
||||
|
||||
|
||||
1. After installation, find the NetBird icon in your system tray or menu bar.
|
||||
2. Click the icon and select **Connect**.
|
||||
3. This will open a new browser tab, prompting you to authorize the new device. Authenticate using the same IdP you used to sign up.
|
||||
4. Once authorized, you will see a "Login successful" message. The onboarding UI will update to show that your first peer is connected, displaying its name and assigned NetBird IP address.
|
||||
1. Launch the NetBird desktop app. On first launch, the welcome screen points you to the system tray on Windows and Linux or the menu bar on macOS, then asks whether you use NetBird Cloud or a self-hosted deployment.
|
||||
2. Click **Connect** in the main window or tray/menu-bar menu.
|
||||
3. NetBird opens a browser tab so you can authorize the device with the same identity provider you used to sign up.
|
||||
4. Once authorized, the app displays the connected state and assigned NetBird IP address. The onboarding UI also updates to show that your first peer is connected.
|
||||
|
||||
### Add a Second Peer (Headless Linux Server)
|
||||
Next, let's add a second, headless peer, like a Linux server or a Raspberry Pi. For devices without a graphical interface, we use a [Setup Key](https://docs.netbird.io/manage/peers/register-machines-using-setup-keys).
|
||||
@@ -150,7 +150,7 @@ After running the second command, the terminal will confirm Connected. Your head
|
||||
Now, set up the device you will use to connect to your private network.
|
||||
1. Back in the web UI, the wizard will prompt you to "Time to add your client device." Click Install NetBird.
|
||||
2. Download and run the installer for your client machine's OS (e.g., macOS).
|
||||
3. Once installed, find the NetBird icon in your system tray or menu bar, click it, and select Connect.
|
||||
3. Once installed, launch the desktop app and click **Connect** in the main window or tray/menu-bar menu.
|
||||
4. Authorize this new device in the browser tab that opens.
|
||||
|
||||
### Test the Connection
|
||||
|
||||
@@ -27,12 +27,7 @@ The NetBird client (agent) allows a peer to join a pre-existing NetBird deployme
|
||||
|
||||
## Running NetBird with SSO Login
|
||||
### Desktop UI Application
|
||||
If you installed the Desktop UI client, you can launch it and click on Connect.
|
||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||
</p>
|
||||
Launch the desktop app and click **Connect** in the main window or tray/menu-bar menu. On first launch, choose NetBird Cloud or enter the URL of your self-hosted deployment. NetBird opens your browser to authenticate the device. See the [desktop app guide](/client/desktop-app) for the complete interface.
|
||||
|
||||
### CLI
|
||||
Alternatively, you could use command line. Simply run
|
||||
|
||||
@@ -6,19 +6,25 @@ The NetBird client (agent) allows a peer to join a pre-existing NetBird deployme
|
||||
|
||||
## Desktop App Dependencies
|
||||
|
||||
<Note>
|
||||
This applies to the redesigned NetBird desktop app, currently available as a **release candidate** (download the latest from [pkgs.netbird.io](https://pkgs.netbird.io/releases/rc)). The current stable GUI does not require these packages.
|
||||
</Note>
|
||||
The desktop app introduced in NetBird v0.75.0 renders its interface in a GTK 4 WebKit webview. Supported packages normally install these dependencies automatically. For manual or unsupported deployments, install the corresponding packages before launching the GUI.
|
||||
|
||||
The redesigned desktop app renders its interface in a GTK 4 WebKit webview. Linux distributions package these libraries under inconsistent names, so install them manually before launching the GUI.
|
||||
|
||||
**Debian / Ubuntu**
|
||||
**Debian 12+ / Ubuntu 22.04+**
|
||||
|
||||
```bash
|
||||
sudo apt-get install libgtk-4-1 libwebkitgtk-6.0-4 xdg-utils
|
||||
```
|
||||
|
||||
On other distributions, install the equivalent **GTK 4**, **WebKitGTK 6.0**, and **xdg-utils** packages from your package manager.
|
||||
**Fedora / RHEL 10+**
|
||||
|
||||
```bash
|
||||
sudo dnf install gtk4 webkitgtk6.0 xdg-utils
|
||||
```
|
||||
|
||||
<Note>
|
||||
RHEL 9 includes GTK 4 but does not provide WebKitGTK 6.0, which the desktop app requires. RHEL 10 is supported after enabling [EPEL](https://docs.fedoraproject.org/en-US/epel/getting-started/), which provides the `webkitgtk6.0` package.
|
||||
</Note>
|
||||
|
||||
On other distributions, install the equivalent **GTK 4**, **WebKitGTK 6.0**, and **xdg-utils** packages from your package manager, many systems may already include some of all of these packages.
|
||||
|
||||
## Linux Install Script
|
||||
|
||||
@@ -302,12 +308,7 @@ netbird up
|
||||
|
||||
## Running NetBird with SSO Login
|
||||
### Desktop UI Application
|
||||
If you installed the Desktop UI client, you can launch it and click on Connect.
|
||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||
</p>
|
||||
Launch the desktop app and click **Connect** in the main window or system-tray menu. On first launch, choose NetBird Cloud or enter the URL of your self-hosted deployment. NetBird opens your browser to authenticate the device. See the [desktop app guide](/client/desktop-app) for the complete interface.
|
||||
|
||||
### CLI
|
||||
Alternatively, you could use command line. Simply run
|
||||
|
||||
@@ -111,12 +111,7 @@ This creates a launchd daemon at `/Library/LaunchDaemons/netbird.plist` that run
|
||||
|
||||
## Running NetBird with SSO Login
|
||||
### Desktop UI Application
|
||||
If you installed the Desktop UI client, you can launch it and click on Connect.
|
||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||
</p>
|
||||
Launch the desktop app and click **Connect** in the main window or menu-bar menu. On first launch, choose NetBird Cloud or enter the URL of your self-hosted deployment. NetBird opens your browser to authenticate the device. See the [desktop app guide](/client/desktop-app) for the complete interface.
|
||||
|
||||
### CLI
|
||||
Alternatively, you could use command line. Simply run
|
||||
|
||||
@@ -16,7 +16,7 @@ The NetBird client (agent) allows a peer to join a pre-existing NetBird deployme
|
||||
|
||||
## 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.
|
||||
Both installers support silent (unattended) installation for use with RMM tools, MDM platforms, and scripted deployments.
|
||||
|
||||
### EXE Installer (NSIS)
|
||||
|
||||
@@ -26,7 +26,7 @@ Run the EXE installer with the `/S` flag for a silent installation:
|
||||
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.
|
||||
The installer no longer writes a machine-wide `HKLM\Software\Microsoft\Windows\CurrentVersion\Run` entry. Starting with v0.75.0, the desktop app manages launch at login as a per-user preference.
|
||||
|
||||
### MSI Installer
|
||||
|
||||
@@ -36,16 +36,10 @@ Run the MSI installer with `msiexec` for a silent installation:
|
||||
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
|
||||
```
|
||||
The MSI does not expose an `AUTOSTART` property. On a fresh desktop installation, the app enables **Launch NetBird UI at Login** for the current user the first time the UI runs. Upgrades preserve the user's existing preference. Users can change it under **Settings → General**, and administrators can suppress or remove the per-user registration with the [`disableAutostart` MDM setting](/client/mdm-integration#disableAutostart).
|
||||
|
||||
<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.
|
||||
**Launch NetBird UI at Login** affects only the graphical interface. The NetBird background service starts independently and can maintain connectivity even when the UI does not launch.
|
||||
</Note>
|
||||
|
||||
### Combining with a Setup Key
|
||||
@@ -70,12 +64,7 @@ netbird up --setup-key <SETUP KEY>
|
||||
|
||||
## Running NetBird with SSO Login
|
||||
### Desktop UI Application
|
||||
If you installed the Desktop UI client, you can launch it and click on Connect.
|
||||
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
||||
|
||||
<p>
|
||||
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
||||
</p>
|
||||
Launch the desktop app and click **Connect** in the main window or system-tray menu. On first launch, choose NetBird Cloud or enter the URL of your self-hosted deployment. NetBird opens your browser to authenticate the device. See the [desktop app guide](/client/desktop-app) for the complete interface.
|
||||
|
||||
### CLI
|
||||
Alternatively, you could use command line. Simply run
|
||||
|
||||
Reference in New Issue
Block a user