Commit Graph

847 Commits

Author SHA1 Message Date
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
Maycon Santos
024ce42bfa Revert "Add --disable-default-route CLI flag documentation (#595)" (#601)
This reverts commit 8ebe477d54.
2026-02-14 16:33:25 +01:00
Misha Bragin
e3603aa4ee Fix reverse proxy wording (#599) 2026-02-14 16:33:11 +01:00
Arsolitt
8ebe477d54 Add --disable-default-route CLI flag documentation (#595) 2026-02-13 19:54:40 +01:00
shuuri-labs
98120d51f6 Align proxy docs with getting-started.sh: fix image name, Traefik labels, add proxy domain warning and quickstart flow (#597) 2026-02-13 19:53:45 +01:00
shuuri-labs
432602e35e Add Reverse Proxy documentation and update self-hosted quickstart (#594)
- Add Reverse Proxy docs: overview, custom domains, authentication, access logs
- Add Reverse Proxy section to sidebar navigation
- Update self-hosted quickstart for new getting-started.sh (Traefik default, combined server)
2026-02-13 19:07:01 +01:00
Jack Carter
320e9fdcaf Fix 5 broken internal links across docs (#596)
- Fix case mismatch: /get-started/install/iOS → /ios (would 404 on Linux)
- Remove literal /index from /manage/dns/index → /manage/dns
- Add missing /by-scenario/ segment to 3 network-routes links

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-13 19:01:47 +01:00
shuuri-labs
f69c55b9c2 Streamlined site-to-site docs in new dedicated section. Removed old u… (#585)
* Streamlined site-to-site docs in new dedicated section. Removed old use-case guide and added redirects

* restructure use-cases, move network use cases to network sections

* Reorganize network routes and networks documentation structure

- Restructure use cases into by-scenario and by-configuration folders
- Reorganize images to match new doc structure (concepts, by-scenario, by-resource-type)
- Add screenshots for site-to-site guides (home, office, cloud)
- Add policy screenshots for networks use cases
- Update site-to-site docs to use two separate policies instead of bidirectional
- Fix Access Control Groups to use correct destination groups
- Move "Self-Hosted vs Cloud" page to about section
- Update navigation and add redirects for moved pages
- Add CLAUDE.md for Claude Code guidance

* cleaned up network docs/image folder structure

* Align site-to-site use case links and redirects

Co-authored-by: Cursor <cursoragent@cursor.com>

* Update CLAUDE.md with accurate project details

Fix Next.js version (14 → 16), add React 19/Tailwind/Pages Router
details, document MDX page conventions, image paths, and note
absence of test suite.

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

* Fix broken images and hydration error on networks page

- Restore 6 network index images accidentally deleted in 4116092
- Fix keycloak image filename typo (keycloack -> keycloak)
- Fix hydration mismatch by replacing invalid <p><div> nesting with <div>

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

* Fix 4 broken internal links found in PR review

- Fix missing by-scenario/ segment in site-to-site-home and
  site-to-site-office Tile hrefs (network-routes use-cases index)
- Fix lazy-connections typo to lazy-connection (implement-zero-trust)
- Update stale redirect link to direct path for access-control

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

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-13 15:35:44 +01:00
heypete
2e1c05a655 Update references to outdated server addresses (#586)
The document has several outdated references to server addresses (e.g. api.wiretrustee.com, signal2.wiretrustee.com) and ports.

I've updated the document with the current addresses and ports according to https://docs.netbird.io/about-netbird/faq
2026-02-08 09:34:11 +01:00
Brandon Hopkins
b323333df5 Edits and add KH Ref (#591) 2026-02-06 16:38:44 +01:00
Brandon Hopkins
14c3112fc6 Add TrueNAS install documentation (#587) 2026-02-06 15:53:13 +01:00
Viktor Liu
1ef008c950 Add /dev/net/tun for container running in userspace (#589) 2026-02-05 11:58:19 +01:00
Eduard Gert
766b03cc40 Update NextJS (#584)
* Update nextjs

* Add eslint config
2026-02-02 17:33:09 +01:00
Misha Bragin
858d7e7c9d Disable local authentication (#583) 2026-01-31 20:00:00 +01:00
Azim Azizov
2f25ea085a Fix instruction on Auto Apply option for exit nodes (#581) 2026-01-27 15:42:06 +01:00
Misha Bragin
562252d1fc Add user invite docs (#576) 2026-01-27 15:16:50 +01:00
Misha Bragin
75164d3aef Add a Maintenance Section (#580)
* Add a Maintenance section

* Move the self-host section higher

* Add references to backup and upgrade
2026-01-27 12:29:05 +01:00