Skip to content

Update lazy connection description #388

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update lazy connection description #388

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee9c73a
Update lazy connection description
pappz Jul 6, 2025
0e93308
Add Signal server too
pappz Jul 6, 2025
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
15 changes: 6 additions & 9 deletions src/pages/how-to/lazy-connection.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ NetBird now includes an experimental lazy connection feature designed to improve
This guide walks you through enabling and configuring this feature in your NetBird client.

<Note>
Minimum supported agent version: <strong>v0.45.0</strong>.
Minimum supported agent version: <strong>v0.50.1</strong>.
This or higher version must also be installed on the peers you are trying to access for lazy connections to function.
</Note>

<Note>
This feature also requires an upgraded NetBird Management server.
If you're self-hosting NetBird, ensure your server is updated to version <strong>v0.45.0</strong>, which adds support for lazy connections.
This feature also requires an upgraded NetBird Management and Signal server.
If you're self-hosting NetBird, ensure your server is updated to version <strong>v0.50.1</strong>, which adds support for lazy connections.
</Note>

<Note>
Expand All @@ -25,7 +25,7 @@ When enabled, lazy connections allow the NetBird agent to:

- Establish peer-to-peer connections **only when needed** (e.g., when pinging a remote peer).
- Monitor peer activity and **automatically disconnect peers** that remain inactive **and unreachable** for a specified time.
- Keep critical peers (such as routers or excluded peers) **always connected** to ensure uninterrupted communication.
- Keep critical peers (such as excluded peers) **always connected** to ensure uninterrupted communication.

This feature is especially useful in **large-scale deployments** or **resource-constrained environments**, where maintaining full-mesh, permanent connections to all peers is unnecessary and inefficient.

Expand All @@ -36,15 +36,12 @@ This feature is especially useful in **large-scale deployments** or **resource-c

### How Automatic Disconnection Works

Once a connection between two peers is established, it will remain open **as long as the remote peer is reachable**. The connection is **not** closed just because there is no data transfer.

In other words, the inactivity timer only triggers a disconnect if the peer is both <em>inactive</em> and <em>unreachable</em> for the full duration of the threshold.
Once a connection between two peers is established, it will remain open only if there is ongoing traffic from the remote peer. If no traffic is received for 15 minutes, the connection will be closed — even if the remote peer is still reachable.

<Note>
The default inactivity threshold is <strong>60 minutes</strong>, and can be configured via the <code>NB_LAZY_CONN_INACTIVITY_THRESHOLD</code> environment variable.
The default inactivity threshold is <strong>15 minutes</strong>, and can be configured via the <code>NB_LAZY_CONN_INACTIVITY_THRESHOLD</code> environment variable.
</Note>

Additionally, the disconnection logic is being improved and will be enhanced in future releases to better support mobile devices—providing more intelligent reconnection behavior and improved handling of intermittent connectivity.

## Enabling Lazy Connections on agent

Expand Down