Commit Graph

825 Commits

Author SHA1 Message Date
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
Eduard Gert
4701c0f954 Update announcement (#579) 2026-01-27 11:56:23 +01:00
Misha Bragin
2ccf05149a Reference DUO (#575) 2026-01-24 18:24:15 +01:00
Brandon Hopkins
6db8d0e162 Quick Fixes and Docker Rootless (#572) 2026-01-23 14:00:30 -08:00
Maycon Santos
f12b83dabe Add new endpoints to navigation menu (#574) 2026-01-23 20:33:44 +01:00
Maycon Santos
4d5843df12 Update api.tsx to handle content type (#573)
* Update api.tsx to handle content type

* Update API pages with v0.64.1

---------

Co-authored-by: netbirddev <dev@netbird.io>
2026-01-23 20:05:08 +01:00
Misha Bragin
906e6c88bd Move configuration files up the menu (#571) 2026-01-23 00:17:45 +01:00
Jack Carter
ac7b74a467 docs: add Zero Trust implementation guide (#526)
* docs: add Zero Trust implementation guide

* minor text and formatting fixes

* various improvements to the zero trust guide

* Added links to other relevant docs pages

* docs: improve Zero Trust implementation guide

- Add guide to navigation menu
- Rewrite section 5.2 on routing peer traffic direction for clarity
- Add documentation links throughout (Networks, Access Control, DNS,
  Control Center, Setup Keys, IdP sync, Traffic Events, Event Streaming)
- Add internal section and appendix cross-references
- Remove "Subject" terminology, replace with "source groups" and
  clearer user/peer terminology
- Expand acronyms on first use (IdP, SSO, MFA, SIEM, CIDR, VPC, etc.)
- Add explanations for technical concepts (masquerading, overlay networks,
  NAT traversal, protocols, ports)
- Enhance firewall rules section with service explanations and FAQ link
- Improve worked examples with port and protocol context
- Add command-line tool explanations for troubleshooting
- Make guide more accessible for junior network admins and students

* Minor changes and adjustments.

* Add various diagrams

* Add dashboard settings best practices section

* Improve zero trust guide with MDX components, examples, and clarity

  - Add Note/Warning MDX components replacing markdown blockquotes
  - Add TURN service rules to firewall configuration section
  - Add JSON API example for policy creation
  - Improve three-tier app diagram with box-drawing characters
  - Add Networks vs legacy Network Routes warning for Zero Trust
  - Add CIDR posture check limitation note (iOS/Android unsupported)
  - Add DNS forwarder port change note (v0.59.0+)
  - Add lazy connections feature limitations and version requirements
  - Add Users view to Control Center documentation
  - Convert verification checklists to Note components
  - Fix grammar throughout (serial commas, hyphenation consistency)
  - Improve term definitions and service descriptions

* Update zero trust guide to enhance clarity and provide outbound port references

- Replace detailed outbound allowlist rules with links to FAQ and self-hosted guide for port requirements
- Minor adjustments to lazy connections feature description for consistency

---------

Co-authored-by: Brandon Hopkins <76761586+TechHutTV@users.noreply.github.com>
Co-authored-by: Ashley Mensah <ashleyamo982@gmail.com>
2026-01-22 20:16:22 +01:00
shuuri-labs
52329993be Remove environment variables navigation entry (#570) 2026-01-22 17:42:46 +01:00
shuuri-labs
4b5f9b58dc Config file breakdown (#565) 2026-01-22 16:38:32 +01:00
Zoltan Papp
b5ce088750 Remote debug (#564)
* Extend the trouble shooting with remote debug
2026-01-22 11:01:21 +01:00
Misha Bragin
38eb2925c8 Fix STUN migration links (#567) 2026-01-22 10:49:44 +01:00
Misha Bragin
14827a38d5 Add Coturn to Embedded STUN migration (#566) 2026-01-21 14:51:57 +01:00
shuuri-labs
410bfe325c Feat/add apple tv installation docs (#520)
* - Added docs page for installing on tvOS
- Split Android & Android TV installations into seperate pages

---------

Co-authored-by: Ashley Mensah <ashley@netbird.io>
Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
2026-01-20 21:54:15 +01:00
shuuri-labs
c7e6c9850c update idp local user docs with instructions on how to remove default… (#562) 2026-01-20 16:52:24 +01:00
Misha Bragin
32611fae25 Add password change doc (#563) 2026-01-20 16:50:16 +01:00
shuuri-labs
8b04229096 Add environment variables documentation for self-hosted deployments (#553)
Adds a comprehensive reference page for all environment variables used
when self-hosting NetBird, covering Management Server, Signal Server,
Relay Server, Dashboard, and Coturn services. Focuses on the new
embedded identity provider approach, removing deprecated external IDP
configuration variables.
2026-01-19 09:20:52 -08:00
Brandon Hopkins
c6f347fea2 Duo IdP (#558) 2026-01-19 17:16:22 +01:00
shuuri-labs
6e9932b679 Add clarification to jwt group sync docs that groups with same name in netbird will not be synced (#561) 2026-01-19 16:55:09 +01:00
Misha Bragin
775ba4b08e Fix autoupdate docs (#560) 2026-01-19 15:43:23 +01:00
Jack Carter
ee131d9d38 Add quickstart for private DNS behind routing peers, and consolidate DNS documentation. (#554) 2026-01-19 15:33:51 +01:00
Eduard Gert
513dc3bc2c Redirect dns/zones to dns/custom-zones (#559) 2026-01-19 11:08:10 +01:00
Maycon Santos
7af0ef443c Update slack url (#557) 2026-01-17 16:19:00 +01:00