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
+30-7Lines changed: 30 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,33 @@
1
+
import {Note} from"@/components/mdx";
2
+
1
3
# Client Automatic Updates
2
4
3
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.
This or higher version must also be installed on the peers you need to Automatically Update.
10
+
</Note>
11
+
12
+
<Note>
13
+
This feature also requires an upgraded NetBird Management server.
14
+
If you're self-hosting NetBird, ensure your server is updated to version <strong>TODO:</strong>, which adds support for Automatic Updates.
15
+
</Note>
16
+
17
+
<Note>
18
+
This feature is currently under active development and will continue to evolve. Future releases will add Linux support, and handling for long-running peers.
To enable client auto updates, navigate to [Settings » Clients](https://app.netbird.io/settings) and enable 'Automatic Updates'.
10
26
11
27
You can either:
12
-
a. Update to latest stable version.
13
-
b. Update to a specific version.
28
+
29
+
* Update to latest stable version.
30
+
* Update to a specific version.
14
31
15
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.
16
33
@@ -32,13 +49,19 @@ Automatic Updates are supported on the following platforms only:
32
49
33
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.
34
51
52
+
## Backward and Forward Compatibility
53
+
54
+
* If Management server version < (#TODO: Insert release version with Auto Updates here), clients will **not** automatically update.
55
+
* If Management server version >= TODO:, NetBird clients with version >= TODO: will automatically update according to the Automatic Updates settings.
56
+
35
57
## Notes
36
58
37
-
1. 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.
38
-
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.
39
-
3. For long-running Peers, a future release may include support for periodic update checks during runtime.
40
-
4. 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.
41
-
5. 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 "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.
0 commit comments