Commit Graph

863 Commits

Author SHA1 Message Date
Viktor Liu
0ba4abd21d Add IPv6 overlay addressing documentation 2026-03-23 10:51:13 +01:00
Viktor Liu
fdff1eafed Add health probe configuration to Kubernetes deployment guide (#665) 2026-03-23 09:40:50 +01:00
Brandon Hopkins
515c809bbf Edit Availability Note (#662) 2026-03-19 14:25:15 +01:00
Jack Carter
ab4dea94db docs: Add WireGuard port conflict troubleshooting for Domain Controllers (#660)
Document the issue where Windows DNS Server claims UDP port 51820,
preventing WireGuard from starting on Domain Controllers. Covers
symptoms, diagnosis steps, and the dnscmd fix.
2026-03-18 10:23:45 +01:00
Bruno Mercier Costa
875d7bc497 Update connecting-from-the-office.mdx (#657)
fixing a typo from "agaom" to "again"
2026-03-17 13:25:28 +01:00
shuuri-labs
8680e5e822 Document TLS-ALPN-01 challenge requirements for reverse proxy (#656) 2026-03-16 15:26:52 +01:00
Bethuel Mmbaga
31a1eb5642 Update keycloak initial sync steps (#654) 2026-03-16 14:28:45 +03:00
Zoltan Papp
e0f5fbf445 Extend the auto update feature with force flag (#653) 2026-03-13 21:40:32 +01:00
shuuri-labs
4b5fa2b2f4 Update networks docs to reflect new state of 'add resource' modal (#651) 2026-03-13 15:17:30 +01:00
Nino Fischer
469864790b Update external-reverse-proxy.mdx (#649)
Repaired anchor for "Combined container"-Link
2026-03-13 00:47:57 -07:00
shuuri-labs
22556fc8d0 clarify port requirements for reverse proxy when using with old multi-container setup (#652) 2026-03-12 19:51:08 +01:00
shuuri-labs
d2c7216406 amend NB_PROXY_MANAGEMENT_ADDRESS port - instruction case should user docker internal port as opposed to external (#650) 2026-03-12 17:58:28 +01:00
netbirddev
2a99d1ee0e Update API pages with v0.66.4 2026-03-11 19:01:10 +00:00
Maycon Santos
27e4500def add force push for docs workflow 2026-03-11 19:55:32 +01:00
Maycon Santos
c413b2d00c Update reverse proxy documentation for domain and DNS record changes (#648)
* Update reverse proxy documentation for domain and DNS record changes

* Clarify reverse proxy domain description in migration guide

* Update domain requirement clarification in migration guide

Clarified the domain requirement for the proxy + added missing charactr afer example domain

---------

Co-authored-by: shuuri-labs <61762328+shuuri-labs@users.noreply.github.com>
2026-03-11 19:27:45 +01:00
Eirik Rolland Enger
2f6e844019 fix(CLI): typo netbirt to netbird (#646) 2026-03-09 13:10:14 -07:00
Maycon Santos
9d443e23a4 update slack url (#645) 2026-03-08 16:44:14 +01:00
Brandon Hopkins
b2cab09cdc Add Remote Jobs Page (#644) 2026-03-04 13:57:20 +01:00
Bethuel Mmbaga
cb44c913b7 Update Microsoft Entra SCIM docs (#642) 2026-03-03 20:44:41 +03:00
shuuri-labs
b35d3ce6c8 Add backend service configuration guide trusted proxies and fix images (#639)
* Add backend service configuration guide for reverse proxy trusted proxies

Many self-hosted services (Jellyfin, Home Assistant, Nextcloud, Plex)
require a "trusted proxies" or "known hosts" setting when behind a
reverse proxy. With NetBird, the proxy's IP is a dynamic NetBird IP
from 100.64.0.0/10 that can change on restart, so hardcoding it breaks.

This adds a new doc page with the recommended solution (trust the full
CGNAT range), per-service config examples, Docker bridge network
guidance, and a warning on the reverse proxy overview page.

* Update service-configuration.mdx and move/add images

* Fixing typos

---------

Co-authored-by: Brandon Hopkins <brandon@techhut.tv>
2026-02-27 20:27:30 +01:00
Bethuel Mmbaga
3c8736f8f6 Add cidaas idp sso (#641) 2026-02-27 11:57:21 +03:00
Misha Bragin
58625d69f6 Add auth store migration (#637) 2026-02-27 08:37:28 +02:00
Maycon Santos
b35de5b477 Escape MDX-specific characters in API templates and refine Navigation… (#638)
* Escape MDX-specific characters in API templates and refine NavigationAPI links

* Update API pages with v0.66.0

---------

Co-authored-by: netbirddev <dev@netbird.io>
2026-02-26 16:28:00 +01:00
Onoitsu2
8b7b458569 Update selfhosted-quickstart.mdx (#632)
Fixes incorrect instructions, for the proxy domain.
2026-02-24 07:34:59 -08:00
Maycon Santos
c63c1fec29 Expand FAQ metrics section with detailed data points (#634) 2026-02-24 15:34:11 +01:00
Maycon Santos
13ec8c817a add expose command (#633)
* add expose command

* Fix peer groups steo

* Update CLI documentation with examples and clarifications for flags

* update docs

---------

Co-authored-by: Brandon Hopkins <brandon@techhut.tv>
2026-02-24 10:02:39 +01:00
Jack Carter
a87e560602 docs: Reorganize DNS documentation (#635)
- Create Internal DNS Servers page consolidating nameserver configuration,
  private DNS routing, and Active Directory guidance
- Trim DNS Overview, DNS Settings removing duplicated and filler content
- Merge Configuring Nameservers page into Internal DNS Servers
- Replace Quickstart and Configuring Nameservers pages with redirects
- Update navigation sidebar and all internal links
2026-02-23 17:05:11 +01:00
shuuri-labs
e80b6b522a add disable local auth instructions for combined container setup (#631) 2026-02-20 15:15:04 +01:00
shuuri-labs
9c74c1b26e Update (external) reverse proxy docs (#624)
- update (external) reverse proxy docs, added 'external' terminology to avoid confusion with the new internal reverse proxy feature
- add templates for combined container setups
- clearer clarifications (3478 needs to be publicy accessible etc)
2026-02-19 19:08:08 +01:00
Jack Carter
1239aceafe docs: Add MSP tenant resource access guidance (#630)
Document two approaches for MSPs to access resources inside client
tenant networks: inviting an MSP user via email subaddressing
(recommended) or adding a network and routing peer.
2026-02-19 19:06:24 +01:00
Jack Carter
67fec9487f docs: Add DNS guidance for Domain Controllers (#629)
Add use case for running NetBird on Windows Domain Controllers,
recommending a dedicated group with DNS management disabled to
avoid conflicts with Active Directory DNS services.
2026-02-19 16:30:09 +01:00
shuuri-labs
d49f899db1 Reverse Proxy - Multiple Instances (#620) 2026-02-19 13:14:43 +01:00
Misha Bragin
5c059fa7b8 Refer to the new config.yaml file (#628) 2026-02-19 12:03:32 +01:00
shuuri-labs
243c1af0c1 Combined setup migration docs (#619) 2026-02-18 21:00:37 +01:00
Brandon Hopkins
31a994937c Fixing Edit on GitHub Links (#627) 2026-02-18 20:55:06 +01:00
Misha Bragin
4dacaaecfb Clarify geolocation issues (#625) 2026-02-18 17:18:44 +01:00
shuuri-labs
4110ffe05e Fix reverse proxy docs: add ProxyService gRPC route, fix container co… (#623)
* Fix reverse proxy docs: add ProxyService gRPC route, fix container commands, support both setups

- add missing /management.ProxyService/ gRPC route to all reverse proxy config templates (traefik, nginx, caddy, NPM) in reverse-proxy.mdx
- change default proxy -> management connection to use direct docker network instead of routing through traefik, avoiding hairpin NAT and missing gRPC route issues
- add "Connecting through Traefik" section for separatevhost deployments
- fix token CLI commands: use /go/bin/ prefix (not on container PATH), add --config flag for combined container
- ratify instructions for enabling reverse proxy both combined (netbird-server) and multi-container (management) setups

* remove unecessary proxy endpoints from reverse proxy templates other than traefik in reverse-proxy.mdx

* - standardize usage of 'docker exec' as opposed to 'docker compose exec + service name' in instructions
- added AuthClientID config instructions
- added traefik grpc rule to configuration file explanation page
- idletimeout for reverse proxy migration is now 0, matching getting-started.sh

* add clarification on grpc ProxyService path for traffic - only required if the proxy service is on a different docker network to traefik

* fix: correct step count in Traefik connection section from two to three

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-18 16:36:04 +01:00
Jack Carter
8936e9163f Add Client Settings documentation section (#612)
* Add Block Inbound Connections documentation to Client settings

Document the previously undocumented "Block Inbound Connections" client
setting (introduced in v0.46.0). Adds a dedicated feature page under
Client > Settings, updates the sidebar navigation, and adds the
--block-inbound flag to the CLI reference.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Move Post-Quantum Cryptography to Client settings and add systray notes

Move the Rosenpass/post-quantum cryptography page from manage/integrations/
to client/ under the new Settings section. Add redirects for the old URL.
Also add systray toggle instructions to both the Quantum-Resistance and
Lazy Connections pages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Rename post-quantum cryptography page and fix hydration error

Drop the "Enable" prefix from the page title and filename for a cleaner
topic name. Update redirects and navigation. Fix hydration mismatch
caused by a <div> (Button component) nested inside a <p> tag.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-18 12:53:51 +01:00
Bethuel Mmbaga
c8f1dbd027 Add init sidecar mode for k8s operator (#622) 2026-02-18 14:46:29 +03:00
infiniteduck
5a899c55c4 fix: use H1 for page title in backup, remove and upgrade docs (#621)
* Change header from H2 to H1 in backup.mdx

With H2 header, the browser tab name was "undefined" instead of the proper name

* Change H2 header to H1 in remove.mdx

With H2 header, the browser tab name was "undefined" instead of the proper name

* Change H2 header to H1 in upgrade.mdx

With H2 header, the browser tab name was "undefined" instead of the proper name

* Promote h3 sub-headings to h2 in upgrade.mdx to fix TOC error

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-18 09:31:46 +01:00
Brandon Hopkins
8da42f59ff Add Temp Diagram and Fix Sidebar Nav (#613) 2026-02-17 21:31:10 +01:00
Jack Carter
e88ca88f30 Fix routing peer platform support statement (#618)
Routing peers support Linux, Windows, macOS, and Docker, not just Linux.

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-17 19:01:11 +01:00
Jack Carter
05e024cec8 Point VPN-to-Site scenarios to Networks only (#617)
Remove Network Routes as an alternative for VPN-to-Site rows in the
"Which Scenario Do I Need?" table, directing users to the recommended
Networks feature instead.

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-17 19:00:49 +01:00
Jack Carter
8b0a549091 Clarify FAQ outgoing port requirements are for NetBird Cloud (#615)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-17 19:00:32 +01:00
Jack Carter
6ead42305a Document that routing peers require a separate policy for direct access (#611)
Users commonly run services (Pi-hole, Home Assistant, monitoring) on
routing peer machines but have no guidance that a network resource policy
only grants access to the network behind the peer, not the peer itself.
Add notes to Networks, Network Routes, Access Control, and the Zero
Trust guide clarifying that a peer-to-peer access policy is needed.

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-17 19:00:11 +01:00
shuuri-labs
bca8559980 Reverse proxy amendments 2 (#616)
* Reverse Proxy Doc Amendments

- update custom domains page to more closely reflect wording in the UI, added screenshots
- add warning to index page that reverse proxy feature does not currently work with pre-shared keys/rosenpass

* Update navigation order (move reverse proxy below network routes)

* update migration guide to mention the need for TWO cname records (proxy and proxy wildcard)
2026-02-17 14:37:37 +01:00
Brandon Hopkins
f007175574 Clearing Issues and General Fixes (#592)
* Upgrade link fix

* Fix on-page nav highlighting
2026-02-17 12:50:06 +01:00
Brandon Hopkins
5fe0de4379 Fix typo in rootless image section (#605) 2026-02-16 18:51:43 +01:00
Brandon Hopkins
417b08cf1a Quick Fix to getting-started (#606) 2026-02-15 23:59:02 -08:00
Brandon Hopkins
62b39cf8a1 NetBird Proxy Service Edits (#603)
* NetBird Proxy Service Edits

* Self-hosted setup clarification
2026-02-15 12:26:55 +01:00