You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/how-to/auto-update.mdx
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,23 +29,23 @@ You can either:
29
29
* Update to latest stable version.
30
30
* Update to a specific version.
31
31
32
-
Once enabled, all NetBird clients will automatically check for updates on startup and install the specified version if the current version is older than the specified version.
32
+
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
+
33
34
34
35
## How it works
35
36
36
-
1.**Connection Start**: When a Peer connects to Management, it will receive the current Automatic Updates settings.
37
+
1.**User-Initiated Connection**: When a Peer connects to Management, it will receive the current Automatic Updates settings.
37
38
2.**Version Check**: The Peer will compare its current version with the version specified in the Automatic Updates settings.
38
39
3.**Update Process**:
39
40
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.
40
41
2. Client will then download the update package from the official NetBird repository.
41
42
3. The Peer will then install the update and restart itself to apply the changes.
42
-
4.**Notification**: After a successful update, the Peer will show a notification to the user indicating that the update was successful.
43
43
44
44
## Supported Platforms
45
45
46
46
Automatic Updates are supported on the following platforms only:
47
47
- Windows
48
-
- macOS
48
+
- macOS (with PKG installer)
49
49
50
50
Linux support is not available at this time due to the variety of distributions and package managers. A future release may include support for popular distributions.
51
51
@@ -56,12 +56,10 @@ Linux support is not available at this time due to the variety of distributions
56
56
57
57
## Notes
58
58
59
-
1. Automatic Updates will be set to "Latest" by default.
60
-
2. Automatic Updates currently only run within the first minute after the Peer starts. If the Peer is not restarted, it will not check for updates again until the next restart.
61
-
3. If the Peer is unable to download or install the update (e.g., due to network issues), it will show an error notification but will not retry until the next restart.
62
-
4. For long-running Peers, a future release may include support for periodic update checks during runtime.
63
-
5. On MacOS, NetBird clients installed using Homebrew will be automatically upgraded to the latest available version regardless of the version specified in the Automatic Updates settings.
64
-
6. All notifications related to Automatic Updates will be shown only if NetBird UI is running and Notifications are enabled.
59
+
1. Automatic Updates will be set to "disabled" by default.
60
+
2. If the Peer is unable to download or install the update (e.g., due to network issues), it will show an error notification but will not retry until the next restart.
61
+
3. For long-running Peers, a future release may include support for periodic update checks during runtime.
62
+
4. All notifications related to Automatic Updates will be shown only if NetBird UI is running and Notifications are enabled.
0 commit comments