Skip to content

Extend the auto update feature with force flag #653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pappz merged 1 commit into from
Mar 13, 2026
Merged

Extend the auto update feature with force flag #653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions src/pages/manage/peers/auto-update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>.
Expand Down Expand Up @@ -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:
Expand Down
Loading