Commit Graph

131 Commits

Author SHA1 Message Date
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
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-labs
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
shuuri-labs
ca6aa9fcc3 Add NAT and connectivity concepts documentation (#532) 2026-01-13 18:52:26 +01:00
Brandon Hopkins
027d9f077a Updating Self-Hosted Managed Idp Guides (#538) 2026-01-08 23:05:28 -05:00
Brandon Hopkins
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. Essam
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-labs
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 Hopkins
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)
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
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
Bethuel Mmbaga
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
Jack Carter
351ad3a0c2 Add Control Center documentation (#450)
* Add Control Center documentation page

* Revert package.json changes

* Add Control Center Groups view screenshot

* Update control-center.mdx

* Update control-center.mdx

* Update src/pages/how-to/control-center.mdx

* Update src/pages/how-to/control-center.mdx

* Improve control center docs

---------

Co-authored-by: Misha Bragin <bangvalo@gmail.com>
2025-10-15 20:43:43 +02:00
Eduard Gert
13e9e98177 Update ssh docs (#442)
* Update ssh docs

* Add more ssh links

* Update src/pages/how-to/ssh.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Add cli command

* Apply suggestion from @mlsmaycon

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Maycon Santos <mlsmaycon@gmail.com>
2025-10-07 17:26:41 +02:00
Viktor Liu
81ed300b8c Add browser client docs (#435)
* Add browser client docs

* Address review
2025-10-01 15:53:57 +02:00
Bethuel Mmbaga
5cd895ae7f Add SentinelOne Data Lake integration guide (#423)
Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>
2025-09-15 17:40:42 +01:00
Bethuel Mmbaga
d0d24cb5ee Add SentinelOne EDR (#422)
* Add SentinelOne Singularity integration guide and update navigation

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

* update steps

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

* wip: refactor doc

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

* refactor

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

* fix grammar

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

* refactor

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

---------

Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>
2025-09-15 12:36:44 +02:00
Eduard Gert
d4b7cb313a Add approve user doc (#421) 2025-09-02 15:51:33 +02:00
Bethuel Mmbaga
28eb59221d Add OPNsense guide (#404)
* add opnsense docs

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

* Add configuration instructions for NetBird interface in OPNsense

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

* Clarify navigation steps

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

* refactor

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

---------

Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>
2025-08-26 19:25:30 +02:00
Jack Carter
acbce23c77 Add a Client section to docs, add Profiles section under Client (#405) 2025-08-05 12:41:04 +02:00
braginini
112982ac44 Improve plans and billing docs 2025-07-31 16:00:43 +02:00
Pedro Maia Costa
11489d200a Intune MDM integration (#394) 2025-07-25 14:29:09 +01:00
Jack Carter
9eb5da76c3 Access home network how-to guide (#385) 2025-07-23 15:00:23 +01:00
Bethuel Mmbaga
a7189313b4 Add pfSense guide (#381)
* Add pfSense installation guide

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

* Move pfSense guide to installation section

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

* update docs

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

---------

Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>
2025-07-11 02:13:30 +02:00
Brandon Hopkins
071e220ada Installation reorganization (#380) 2025-06-25 21:59:19 +02:00
Maycon Santos
fb8cdf8ad4 update URL and rename file
added navigation link
2025-06-24 16:47:48 +02:00
Vlad
9b0a9ddb3f added generic http event streaming docs (#365)
* added generic http event streaming docs

* minor fix

* rename to mdx

* minor fix
2025-06-20 15:13:03 +02:00
Bethuel Mmbaga
b19f46df3e add Activity Events Postgres store doc (#364)
Signed-off-by: bcmmbaga <bethuelmbaga12@gmail.com>
2025-06-11 11:46:04 +02:00
Hammy Havoc
b4811de4fb Moved Self-hosted vs. Cloud-hosted NetBird in navigation menu (#354)
It makes far more sense to have this under `Use Cases`, IMO.

It's the kind of information a user would like to have upfront and not as an afterthought. Furthermore, comparisons between the two options are typically made far sooner in other projects.

May also consider changing the dir that the `.md` file is in, which also change the URL to `/selfhosted/` from to possibly `how-to`, though that's probably beyond the scope of what I can pull off from my cellphone in bed. :- ) Edits of course welcome re that.
2025-05-29 10:45:38 +02:00
Maycon Santos
aa11529511 update slack url and twitter (#355)
* update slack url and twitter

use a dedicated url for slack, allowing update in a single place

rename Twitter references to X

* rollback Install NetBird title in navigation menu
2025-05-29 00:50:55 +02:00
Hammy Havoc
78838af530 Updated docs to be more clear about to diferentiate on installing the NetBird client versus self-hosted deployment (#352)
* Update NavigationDocs.jsx to be more clear about installing the NetBird client

I've seen several people get very confused about setting up NetBird in terms of self-hosting when this is the first thing they see on the docs. Reminds me of the problem with 'Plex Media Server' versus 'Plex' with a lot of people installing the server on their computer instead of the client software.

* Update installation.mdx

* Update getting-started.mdx
2025-05-29 00:35:38 +02:00
Pedro Maia Costa
7c3d0b6c7a single sign on Authentik and Keycloak instructions (#320)
* single sign on Authentik and Keycloak instructions

* feedback updates
2025-05-23 16:57:52 +02:00
Zoltan Papp
09b3a378f8 Explain lazy connection enable-disable logic (#321)
* Explain lazy connection enable-disable logic

* Change text

* Add line break

* Improve lazy connections doc

* Improve lazy connections doc

* Clarify lazy connections versioning

---------

Co-authored-by: braginini <bangvalo@gmail.com>
2025-05-23 14:12:03 +02:00
Zoltan Papp
ce4151c551 Add lazy connection page (#317)
* Add lazy connection page

* Update based on feedback

* Add note about future developments

* Fix URL

* Add to the navigation
2025-05-21 11:18:15 +02:00