Commit Graph
45 Commits
Author SHA1 Message Date
Maycon SantosandBrandon Hopkins 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 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
Jack CarterandClaude Opus 4.6 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
Brandon Hopkins 8da42f59ff Add Temp Diagram and Fix Sidebar Nav (#613) 2026-02-17 21:31:10 +01:00
Jack CarterandClaude Opus 4.6 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 CarterandClaude Opus 4.6 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
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
Arsolitt 8ebe477d54 Add --disable-default-route CLI flag documentation (#595) 2026-02-13 19:54:40 +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
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
Azim Azizov 2f25ea085a Fix instruction on Auto Apply option for exit nodes (#581) 2026-01-27 15:42:06 +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 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
shuuri-labs 2900964bd6 Updated references to 'service discovery' in dns docs (now dns aliases) (#556)
* Updated references to 'service discovery' in dns docs (now dns aliases)

* add entry to side bar menu & update references within page to match title
2026-01-16 19:13:30 +01:00
shuuri-labsandBrandon Hopkins 6079b88f71 Add Reverse Proxy Templates + Wizard Instructions to Docs (#551)
* 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>
2026-01-16 09:22:09 -08:00
Bethuel Mmbaga 157f390c6c Add custom DNS zones (#518) 2026-01-16 18:43:33 +03:00
Eduard Gert 2901b505ba Add users view (#544) 2026-01-13 10:58:40 +01:00
Brandon Hopkinsandbraginini becf4bd6e4 Style Consistency Changes and Element Improvements (#541)
Co-authored-by: braginini <bangvalo@gmail.com>
2026-01-11 09:27:56 +01:00
Omar Atef c75d0884e8 docs: fix --disable-dns flag in DNS management examples (#534) 2026-01-07 10:59:45 +08:00
Omar Atef ff94f58a39 Add DNS management re-enablement instructions (#535) 2026-01-07 10:58:35 +08:00
shuuri-labsandAshley Mensah 0443471387 update SSH docs for v0.61.0 fine-grained access control (#530)
* update SSH docs for v0.61.0 fine-grained access control

---------

Co-authored-by: Ashley Mensah <ashley@netbird.io>
2025-12-29 13:36:52 +00:00
M. EssamandZoltán Papp 697d71db6a Add Automatic Updates Documentation (#443)
* Add Automatic Updates Documentation

* Add more information and version notes

* Update

* Set version

---------

Co-authored-by: Zoltán Papp <zoltan.pmail@gmail.com>
2025-12-29 13:07:15 +01:00
shuuri-labsandAshley Mensah fe2f159f74 Remove wildcard syntax (*.domain.com) from match domain examples as (#524)
the UI does not support wildcards - adding a domain automatically
  matches all subdomains
- Add note about disabling Android Private DNS for custom DNS resolution
- Re-add DNS API documentation

Co-authored-by: Ashley Mensah <ashley@netbird.io>
2025-12-19 10:20:58 +01:00
Jack Carter a9dfece4db Documents that the Peer Network Range posture check is not supported on iOS and Android clients due to OS-level restrictions on accessing local IP information. (#522) 2025-12-19 10:00:31 +01:00
Jack Carter b817c6abbd Update Team Plan pricing from $5 to $6 per user (#519) 2025-12-16 20:00:40 +01:00
Jack CarterandAshley Mensah 607f4af66e docs: consolidate and refine DNS troubleshooting guide (#516)
* docs: consolidate DNS troubleshooting links and remove redundancies

* rewrote to improve readability

* Update recommended version for fleet upgrade

---------

Co-authored-by: Ashley Mensah <ashley@netbird.io>
2025-12-15 11:37:31 +01:00
Bethuel Mmbaga a2f787134f Add duo security idp sso (#511) 2025-12-12 18:53:43 +03:00
Pascal Fischer 3e972e816c add PAT rate limiting info (#514) 2025-12-10 19:46:48 +01:00
shuuri-labsandAshley Mensah 4db6796ef9 docs: Restructure and improve DNS documentation (#504)
* docs: Restructure and improve DNS documentation

Reorganizes DNS docs into overview, configuration, settings, and troubleshooting
guides with clearer explanations and UI-aligned terminology

* amendments from Vik's feedback

* clarified IP assignment range

* remove incorrect common mistake note

* - added diagrams
- renamed dns overview.mdx to index.mdx
- updated references/redirects
- created new spacer div class

---------

Co-authored-by: Ashley Mensah <ashley@netbird.io>
2025-12-04 11:16:57 -08:00
Bethuel Mmbaga e1dd6fffde Add huntress edr (#478) 2025-12-01 21:49:19 +01:00
Brandon Hopkinsandbraginini 67d2b0fa94 Improve Identity Providers Documentation and Navigation under Self-Hosted (#501)
* Refactor NavigationDocs component and update documentation structure

- Improved formatting and organization of the NavigationDocs component for better readability.
- Updated the docsNavigation structure to include detailed sections for managing peers, access control, networks, and integrations.
- Removed the identity providers documentation file as part of the restructuring effort.
- Enhanced the overall navigation experience by ensuring all links are properly formatted and accessible.

* Update NavigationDocs to include new SSO links and remove outdated documentation

- Added links for Authentik, Keycloak, Auth0, and JumpCloud under the Single Sign-On section in NavigationDocs.
- Removed the single-sign-on.mdx file as part of the documentation cleanup effort.

* Add more info about self-hosted IdP support

* Update Single Sign-On documentation and NavigationDocs

- Updated titles and added introductory text for Auth0, Authentik, JumpCloud, and Keycloak pages to clarify their use as Identity Providers with NetBird.
- Commented out the links section in NavigationDocs for Single Sign-On to reflect the current documentation state. Didn't make sense to have those and didn't want to confuse people thinking those are the only supported providers.
- Enhanced the index page to include detailed descriptions and setup buttons for Okta ans each OIDC Identity Provider.

* Update paths in structure and documentation for Auth0, Authentik, Keycloak, Microsoft Entra ID, Google Workspace, and JumpCloud. This cleanup enhances clarity and ensures all references point to the correct resources.

---------

Co-authored-by: braginini <bangvalo@gmail.com>
2025-12-01 20:39:31 +01:00
Brandon Hopkins 2bdb0a1fe1 Enhance resource access management documentation (#499)
Updated the section on managing access to resources to clarify the assignment of resources to groups and the creation of access control policies. Added details on how peers access resources based on group policies and included a note about resources not being part of the built-in 'All' group by default.
2025-11-28 07:24:33 -08:00
Brandon Hopkins e45bb7ce11 Final Doc Restructure (#497) 2025-11-27 09:50:03 -08:00
Bethuel Mmbaga 969fd8afaf Add Entra ID SCIM (#468) 2025-11-25 11:35:48 +03:00
Brandon Hopkins 0080ae97df Restructuring Phase 3 (#492) 2025-11-24 18:25:44 +01:00
Brandon Hopkins 227e5cbb89 Reorganize Get Started Documentation Structure (#490) 2025-11-21 17:17:10 -08:00
Brandon Hopkins a8f91c38b1 New Group and Access Policies Document and Initial Reorganization of Access Control Structure (#477)
* New Access Control and ReOrg

* Enhance Access Control Documentation and Add New Resources

- Updated `next.config.mjs` to include new redirects for access control documentation.
- Added multiple images related to access control and endpoint detection and response.
- Refactored links in various documentation files to point to the new access control structure.
- Removed outdated documentation files and created new ones for managing access control and endpoint detection.
- Introduced a new section for understanding posture checks and their implementation in access control.

This commit aims to improve the organization and clarity of access control resources, aligning with the recent restructuring of documentation.

* Remove outdated Intune MDM documentation and update links in access control resources. This commit enhances the organization of the documentation by eliminating obsolete files and ensuring all references to Microsoft Intune are correctly aligned with the new structure.

* Fix typos in access control documentation for clarity and accuracy. Updated "Understnading" to "Understanding" and corrected "NerBird" to "NetBird" in relevant sections.
* Fix typo in Access Control section
* Fix formatting in posture checks documentation
* Added a space in the Posture Checks reference for clarity.
2025-11-18 10:30:45 -08:00