|
1 | | -import {Note} from "@/components/mdx"; |
| 1 | +import {Note, Warning} from "@/components/mdx"; |
2 | 2 |
|
3 | 3 | # Client Automatic Updates |
4 | 4 |
|
5 | | -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. |
| 5 | +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. |
6 | 6 |
|
7 | 7 | <Note> |
8 | 8 | Minimum supported agent version: <strong>v0.61.0</strong>. |
@@ -30,19 +30,29 @@ You can either: |
30 | 30 | * Update to a specific version. |
31 | 31 |
|
32 | 32 | <Note> |
33 | | - 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. |
| 33 | + 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. |
34 | 34 | </Note> |
35 | 35 |
|
| 36 | +### Force Automatic Updates |
| 37 | + |
| 38 | +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. |
| 39 | + |
| 40 | +<Warning> |
| 41 | + Enabling Force Automatic Updates will restart the NetBird client during updates, which can temporarily disrupt active connections. Use with caution in production environments. |
| 42 | +</Warning> |
| 43 | + |
36 | 44 |
|
37 | 45 | ## How it works |
38 | 46 |
|
39 | 47 | 1. **User-Initiated Connection**: When a Peer connects to Management, it will receive the current Automatic Updates settings. |
40 | 48 | 2. **Version Check**: The Peer will compare its current version with the version specified in the Automatic Updates settings. |
41 | 49 | 3. **Update Process**: |
42 | | - 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. |
| 50 | + 1. If the Peer is running an older version than specified, it will prompt the user to install the update. |
43 | 51 | 2. Client will then download the update package from the official NetBird repository. |
44 | 52 | 3. The Peer will then install the update and restart itself to apply the changes. |
45 | 53 |
|
| 54 | +When **Force Automatic Updates** is enabled, step 3.1 is skipped, the update is installed automatically in the background without user interaction. |
| 55 | + |
46 | 56 | ## Supported Platforms |
47 | 57 |
|
48 | 58 | Automatic Updates are supported on the following platforms only: |
|
0 commit comments