Commit Graph
300 Commits
Author SHA1 Message Date
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
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
Brandon Hopkins 14c3112fc6 Add TrueNAS install documentation (#587) 2026-02-06 15:53:13 +01:00
Misha Bragin 858d7e7c9d Disable local authentication (#583) 2026-01-31 20:00:00 +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
Maycon Santos f12b83dabe Add new endpoints to navigation menu (#574) 2026-01-23 20:33:44 +01:00
Misha Bragin 906e6c88bd Move configuration files up the menu (#571) 2026-01-23 00:17:45 +01:00
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
Misha Bragin 14827a38d5 Add Coturn to Embedded STUN migration (#566) 2026-01-21 14:51:57 +01:00
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
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
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 80f49501d4 Update nextjs (#550) 2026-01-14 16:20:02 +01:00
shuuri-labs ca6aa9fcc3 Add NAT and connectivity concepts documentation (#532) 2026-01-13 18:52:26 +01:00
Brandon Hopkins 105e6774db Self Hosted Quickstart and Other Changes (#543) 2026-01-13 10:59:05 +01:00
Brandon Hopkins 1bc91042c0 General Docs Improvements (#542) 2026-01-12 23:01:42 +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
Brandon Hopkins 027d9f077a Updating Self-Hosted Managed Idp Guides (#538) 2026-01-08 23:05:28 -05:00
Brandon Hopkinsandbraginini de7571f552 Embedded DEX and IdP Docs (#533)
* DEX Docs Overall Updates

* No IdP required, Multiple IdPs supported, Onboarding flow

* File Name Change

* Add Announcement

* Specify that Embedded IdP is Recommended

* Condense Pages to index.mdx and Extra Remove Idp Info Quickstart

* Fix Links

* Remove API Reference

* Remove Gap

* Remove API Changes

* Update Quickstart

* New Local Page and Fixes

* Fixing Gaps

* Update idp doc

* Update quickstart

* Minor changes and banner

* Fix Broken Links

* Remove Password Reset

---------

Co-authored-by: braginini <bangvalo@gmail.com>
2026-01-07 19:26:54 +01: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
Misha Bragin 3d21a987a8 add-image-zoom (#512) 2025-12-05 17:01:11 +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
Brandon Hopkins c309000266 Add Platforms to Navigation and Pages for Proxmox and RaspberryPi (#506)
* Refactor installation documentation and navigation structure

- Updated the NavigationDocs component to reorganize installation links for NetBird, separating platforms into distinct sections for better clarity.
- Added new installation options for Raspberry Pi and Proxmox VE, enhancing the documentation for additional platforms.
- Improved the installation index page to include a dedicated section for additional platforms, ensuring users can easily find relevant installation instructions.

* Moved info from KH

* Enhance Proxmox VE installation documentation

- Added an introduction to Proxmox VE, explaining its features and suitability for running NetBird.
- Included detailed steps for downloading a container template, emphasizing popular Linux distributions.
- Added a video tutorial section and links to additional resources for setting up Proxmox with NetBird.

* Update NavigationDocscs

* Added <div className="videowrapper">

* Update TUN passthrough instructions for clarity

Clarify instructions for enabling /dev/tun passthrough in Proxmox VE.
2025-12-03 10:17:48 -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
shuuri-labs 11867aa4b8 Added install page from Android TV/tvOS (#495)
* - Seperated Android and iOS install pages
- Added detailed setup guide for Android, Android TV

* updated image alt tags

* removed dead links, tv.mdx

* redirect old mobile page to install index page

---------

Authored-by: Ashley Mensah <ashley@netbird.io>
2025-11-27 09:59:52 -08:00
Brandon Hopkins e45bb7ce11 Final Doc Restructure (#497) 2025-11-27 09:50:03 -08:00
Krzysztof Nazarewski (kdn)andAshley Mensah 846cae1fb0 A new Site-to-Site setup guide (#480)
* wip: new Site-to-Site guide

* wip: Site-to-Site guide with access controlls

* wip: Site-to-Site without masquerading

* feat: Site-to-Site setup guide

* amended wording/grammar, moved to new 'use cases' directory

* fix: missing some bold terms

* fix: revert headings changes

* Added styling for h4 headers, removed site-to-site doc from how-to directory

* moved images to correct directory

---------

Co-authored-by: Ashley Mensah <ashley@netbird.io>
2025-11-27 14:50:01 +01:00
Brandon Hopkins cc0b4cd01b Refactor layout and navigation components to remove unused motion props (#494)
- Replaced motion.header with a standard header in Layout component.
- Removed layout props from motion elements in NavigationAPI and NavigationDocs components for improved performance and clarity.
- Updated AnnouncementBannerProvider to make the banner always visible, removing scroll-based hiding logic.
2025-11-25 20:03:25 +01: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 c40c132caa Fix .videowrapper and update button and search components for consistency in text labels (#491)
* Update button and search components for consistency in text labels

- Changed button class to prevent text overflow by adding 'whitespace-nowrap'.
- Updated placeholder and button text from 'Find something...' to 'Search...' for clarity and uniformity across the search components.
- Adjusted aria-labels to match the updated button text for improved accessibility.

* Fix videowrapper
2025-11-22 10:09:46 +01:00
Brandon Hopkins 227e5cbb89 Reorganize Get Started Documentation Structure (#490) 2025-11-21 17:17:10 -08:00
Kairav Roshan Sanghvi 0878851d41 fixed link (#489) 2025-11-21 14:37:34 +01:00
Kairav Roshan Sanghvi 86bb8897ed Website banner (#487)
* added banner

* Update announcement link to a relative path

* Update link text for announcement banner
2025-11-21 11:47:13 +01:00
Kairav Roshan Sanghvi 36b8eb060a added banner (#484) 2025-11-21 11:24:17 +01: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
Bethuel MmbagaandEduard Gert 155671a8ac Add Keycloak SCIM (#463)
* wip: add keycloak scim doc

Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>

* Add generic scim info

* update steps

Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>

---------

Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>
Co-authored-by: Eduard Gert <kontakt@eduardgert.de>
2025-11-12 14:21:31 -05:00
Brandon Hopkins f12647b4da Adding new AI use case doc and images (#470)
* Ading new docs and images

* Update title from NetBid to NetBird

typo fix

* Update link for 'Distributed AI on Kubernetes'

distributed-multi-cloud-ai-argocd-microk8s-vllm

* Rename file url scheme

distributed-multi-cloud-ai-argocd-microk8s-vllm
2025-11-12 12:23:32 +01:00
Bethuel Mmbaga 77eba5286e Add JumpCloud integration doc (#455)
Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>
2025-10-30 11:14:53 +01:00