sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-15 23:16:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Extend the auto update feature with force flag (#653)

Browse Source
This commit is contained in:
Zoltan Papp
2026-03-13 21:40:32 +01:00
committed by GitHub
parent 4b5fa2b2f4
commit e0f5fbf445
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/pages/manage/peers/auto-update.mdx
View File

@@ -1,8 +1,8 @@
import {Note} from "@/components/mdx";
import {Note, Warning} from "@/components/mdx";
# Client Automatic Updates
The Automatic Updates feature allows the NetBird client to automatically update itself when a new version is available. This ensures that users always have the latest features and security patches without needing to manually download and install updates.
The Automatic Updates feature allows the NetBird client to notify users when a new version is available and prompt them to install it. This ensures that users always have the latest features and security patches without needing to manually download and install updates.
<Note>
Minimum supported agent version: <strong>v0.61.0</strong>.
@@ -30,19 +30,29 @@ You can either:
* Update to a specific version.
<Note>
Once enabled, NetBird clients will automatically check for updates when connecting via the UI and install the specified version if the current version is older than the specified version.
Once enabled, NetBird clients will prompt the user to install the specified version when connecting via the UI, if the current version is older than the specified version.
</Note>
### Force Automatic Updates
When you need updates to be installed without user interaction, enable the **Force Automatic Updates** toggle. With this option, updates are installed automatically in the background without prompting the user.
<Warning>
Enabling Force Automatic Updates will restart the NetBird client during updates, which can temporarily disrupt active connections. Use with caution in production environments.
</Warning>
## How it works
1. **User-Initiated Connection**: When a Peer connects to Management, it will receive the current Automatic Updates settings.
2. **Version Check**: The Peer will compare its current version with the version specified in the Automatic Updates settings.
3. **Update Process**:
1. If the Peer is running an older version than specified, it will show a notification to the user indicating that an Automatic Update is under way.
1. If the Peer is running an older version than specified, it will prompt the user to install the update.
2. Client will then download the update package from the official NetBird repository.
3. The Peer will then install the update and restart itself to apply the changes.
When **Force Automatic Updates** is enabled, step 3.1 is skipped, the update is installed automatically in the background without user interaction.
## Supported Platforms
Automatic Updates are supported on the following platforms only: