sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-10-20 20:49:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add Reverse Proxy Templates + Wizard Instructions to Docs (#551)

Browse Source 
* Add Reverse Proxy Templates + Wizard Instructions to Docs

- Updated quickstart guide to include instructions on new reverse proxy wizard in setup script
- Add new reverse proxy page including quickstart script instructions and templates
- Updated advanced guide to refer to new reverse proxy page

* Update lazy-connection documentation to clarify inactivity threshold configuration. from #452

* Added <Note>

* Update lazy connection documentation to reflect new minimum supported agent version and server requirements. From PR#338

* traefik ssl amendments + nginx fixes

* - add youtube video to self hosted quickstart guide page
- clarify quickstart script reverse proxy wizard behaviour in advanced guide

* added in-depth TLS instructions for nginx

* add individual proxy hyperlinks to self hosted advanced guide

---------

Co-authored-by: Brandon Hopkins <brandon@techhut.tv>
This commit is contained in:
shuuri-labs
2026-01-16 09:22:09 -08:00
committed by GitHub
co-authored by Brandon Hopkins
parent 1dd22c0a41
commit 6079b88f71
5 changed files with 1009 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/manage/peers/lazy-connection.mdx
+6 -10
View File
@@ -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>
@@ -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.
@@ -36,16 +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>60 minutes</strong>, and can be configured via the <code>NB_LAZY_CONN_INACTIVITY_THRESHOLD</code> environment variable (`60`).
</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
Lazy connections are disabled by default. You can enable Lazy Connections using the following environment variable: