Skip to content

Commit 8c15635

Browse files
committed
Add more information and version notes
1 parent d1ddda4 commit 8c15635

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

src/pages/how-to/auto-update.mdx

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
1+
import {Note} from "@/components/mdx";
2+
13
# Client Automatic Updates
24

35
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.
46

7+
<Note>
8+
Minimum supported agent version: <strong>TODO:</strong>.
9+
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.
19+
</Note>
20+
521
## Enable Automatic Updates
622

723
![Automatic Updates](/docs-static/img/how-to-guides/auto-update/dashboard.png)
824

925
To enable client auto updates, navigate to [Settings &raquo; Clients](https://app.netbird.io/settings) and enable 'Automatic Updates'.
1026

1127
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.
1431

1532
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.
1633

@@ -32,13 +49,19 @@ Automatic Updates are supported on the following platforms only:
3249

3350
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.
3451

52+
## Backward and Forward Compatibility
53+
54+
* If Management server version &lt; (#TODO: Insert release version with Auto Updates here), clients will **not** automatically update.
55+
* If Management server version &gt;= TODO:, NetBird clients with version &gt;= TODO: will automatically update according to the Automatic Updates settings.
56+
3557
## Notes
3658

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.
4265

4366
## Get started
4467
<p float="center" >

0 commit comments

Comments
 (0)