Commit Graph

213 Commits

Author SHA1 Message Date
Brandon Hopkins
3ef558be01 Document the redesigned NetBird desktop app (release candidate) (#802)
* Add RC notes and documentation

* Add download links

* Updates lang and daemon
2026-06-19 23:21:23 +02:00
Brandon Hopkins
b70301ee4d Image Audit: Unreferenced Images (#787) 2026-06-11 19:22:11 -07:00
Jack Carter
6a31154b96 Add dedicated User Roles page (#789)
Create a standalone User Roles reference covering all six roles (Owner,
Admin, Network Admin, Billing Admin, Auditor, User) with a permission
matrix aligned to the current dashboard, per-role sections, API/token
notes, and role-assignment steps.

Reduce the role section on the Add Users page to a pointer (keeping the
existing anchor), repoint inbound links from delete-account,
control-center, and msp-portal, add the page to the Team sidebar, and
refresh the role screenshots.
2026-06-11 16:19:08 +02:00
Brandon Hopkins
39303d1c48 Align docs with the new dashboard UI (Phase 1) (#778)
* bulk text edit to fit new flows

* Updated screenshots, some minor docs fix. (#782)

* Update Settings on site-to-site.mdx

* fix image names and embedded links

* Update high level dia

* general dashboard images and auto-update stucture fix

* remove temp audit file

---------

Co-authored-by: PizzaLovingNerd <cameron@stillhq.io>
2026-06-10 09:24:36 -07:00
Bruno Mercier Costa
6107943b50 Update Entra Provisioning Screenshot (#785) 2026-06-10 09:59:16 +02:00
Jack Carter
7fb329aba7 docs: rewrite Networks page as a teaching guide (#779)
* docs: rewrite Networks page as a teaching guide

Rework /manage/networks from a reference-style concept page into a
structured teaching guide: mental model, the four building blocks
(Network, Resource, Access policy, Routing peer), how a packet reaches
a resource, and an end-to-end walkthrough for reaching two internal
apps with Zero Trust access by default.

- Add a production checklist (HA, monitoring, masquerade, internal DNS,
  routing-peer access) and a clear "Networks or Network Routes?" split:
  Networks now covers every remote-access scenario except exit nodes.
- Add worked-example and resource-list screenshots.
- how-routing-peers-work: point site-to-site at Networks, describe
  Routing Peer DNS Resolution as on by default, and restore the
  0.59.x domain-resolution compatibility note.
- Rename the sidebar entry from "Concept" to "Overview".

* image organization into /networks dir

* fix embedded images in networks/index.mdx

* docs: note no inbound ports and Linux-only masquerade on Networks page

---------

Co-authored-by: TechHutTV <brandon@techhut.tv>
2026-06-09 17:06:22 +02:00
Bethuel Mmbaga
a8c86c48e0 Add Zoho Directory SSO (#780) 2026-06-08 18:12:40 +03:00
Maycon Santos
c2ccdf43e0 Documented NetBird-Only Access and Proxy Cluster features in reverse … (#767)
* Documented NetBird-Only Access and Proxy Cluster features in reverse proxy settings. Updated authentication methods, backend configuration guides, and cluster capability requirements.

* Expanded documentation for NetBird-Only services, updated Access Control baseline behavior, added details on Direct Upstream and Proxy Cluster features, and refined cluster capability descriptions.

* add private services diagrams and update auth screenshot

* Document ProxyService gRPC routes and expand reverse proxy configuration details

---------

Co-authored-by: TechHutTV <brandon@techhut.tv>
2026-06-05 08:16:03 -07:00
Misha Bragin
14efe3f46a User Servers ref when relevant instead of User Devices (#770) 2026-05-27 16:38:39 +02:00
Maycon Santos
30cb1bff3b Update BYOP documentation to reflect "Clusters" terminology (#762)
* Update BYOP documentation to reflect "Clusters" terminology and add shared vs account cluster details.

* Update BYOP DNS documentation and replace modal images
2026-05-20 12:07:28 +02:00
Brandon Hopkins
8ab98eff17 Add Cloud Marketplaces section, reorganize self-hosted docs, clean up redirects (#760)
* Add marketplace section with Vultr

* Add Images and Self-Hosted Restructure

* Organize self-hosted pages

* Clean up redirects
2026-05-19 07:55:43 -07:00
Eduard Gert
eb752fd70b Add distributor portal docs (#729)
* add distributor portal

* update wordings

* update docs
2026-05-15 12:47:38 +02:00
Nicolas Frati
a2cd5f41d5 Add docs for MFA totp (#704)
Co-authored-by: Brandon Hopkins <76761586+TechHutTV@users.noreply.github.com>
2026-05-14 11:39:45 -07:00
Jack Carter
442116bb8f docs: prune redundant Networks and Network Routes use cases (#749)
The Networks and Network Routes "By Scenario" / "By Resource Type" /
"By Configuration" subgroups had grown into reskinned walkthroughs of
flows already on the concept pages. Collapse to what's actually
distinct, flatten the survivors up one level, fold unique nuggets
into the concept pages.

Networks:
- Delete the "By Resource Type" trio (Multiple IP Resources, Domain
  Resources, Wildcard Domains) and Remote Worker Access — all rehashes
  of /manage/networks. Fold the wildcard-vs-base-domain gotcha and the
  shared-policy pattern into the concept page.
- Delete the Use Cases overview; fold the VPN-to-Site framing into the
  concept page.
- Flatten access-home-devices and cloud-to-on-premise up out of
  /by-scenario/.

Network Routes:
- Consolidate site-to-site-{home,office,cloud} into one
  /manage/network-routes/use-cases/site-to-site page covering the
  shared walkthrough plus AWS/GCP/Azure routing-peer requirements.
- Move exit-nodes, access-control, overlapping-routes, and
  advanced-configuration up out of /by-{scenario,configuration}/.
- Trim advanced-configuration (301 → 144 lines), dropping masquerade
  basics, ACL setup, site-to-site flow, and HA repetition duplicated
  elsewhere. Keep the masquerade trade-off matrix, Networks-vs-Routes
  comparison, troubleshooting, and debug commands.
- Delete the Use Cases overview.

Permanent redirects added for every removed URL. Inbound references
updated across introduction, ipv6, homelab, cloud, security,
site-to-site overview, android-tv/tvOS install pages, and the concept
pages.
2026-05-13 14:17:43 +02:00
Jack Carter
6d0ad7d60d docs(event-streaming): add Wazuh integration guide (#734)
* docs(event-streaming): add Wazuh integration guide

Documents how to wire NetBird's Generic HTTP event-streaming integration
to a self-hosted Wazuh manager: NetBird-side configuration, KQL queries
for audit and traffic events in the Wazuh dashboard, and a schema
reference for both event shapes via the receiver wrapper.

Adds the page to the Stream Activity Events sidebar and the
event-streaming index.

* docs(event-streaming): replace Wazuh Generic HTTP screenshot
2026-05-12 15:52:25 +02:00
Viktor Liu
93f1fb265c Add IPv6 overlay addressing documentation (#667) 2026-05-11 17:48:31 +02:00
Vlad
694e009a08 bring your own proxy docs (#733) 2026-05-11 15:14:25 +02:00
Bruno Mercier Costa
58f1e94ec4 SSO Screenshot Update (#732)
SSO Screenshot Update
2026-05-07 16:15:23 +02:00
Bethuel Mmbaga
d36c932b86 Add AWS Cognito SSO (#717) 2026-04-30 11:05:40 +03:00
Brandon Hopkins
5c13dd3a49 Update Crowdsec doc with context and images (#709) 2026-04-21 09:00:57 -07:00
Maycon Santos
a02fe74b0d Add bypass docs (#577)
* Add force approval docs

* add force approval

* add filter and batch operation

* Rename force approval docs to bypass compliance

- Rename force-approval.mdx to bypass-compliance.mdx
- Update navigation title from "Force Approval" to "Bypass Compliance"
- Update all internal links to use new path
- Update image paths to /bypass-compliance/
- Update terminology in EDR integration docs

* add images

---------

Co-authored-by: Ashley Mensah <ashleyamo982@gmail.com>
2026-04-21 16:39:33 +02:00
Bethuel Mmbaga
e0076457c8 Add IdP sync docs for embedded IdP (#696)
* Add embedded IdP sync docs

* Link idp sync to embedded idp sync docs

* fix: Add missing Note imports and fix NerBird typo in idp-sync docs

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
2026-04-21 14:23:55 +02:00
Eduard Gert
a4db2c6100 Add slack notifications docs (#697) 2026-04-14 14:21:30 +02:00
Bethuel Mmbaga
a95036e9ee Add Zitadel SSO docs (#691) 2026-04-09 17:19:26 +03:00
Eduard Gert
918b8579c2 Add notification docs and fix search autofocus (#647) 2026-04-09 13:15:45 +03:00
Jack Carter
679ad7b3ad docs: add Entra ID enterprise application enablement guide (#677)
Add documentation for enabling the NetBird enterprise application in
Microsoft Entra ID, including finding the app by Application ID and
granting admin consent for the directory.
2026-04-01 16:37:56 +02:00
Misha Bragin
e17482abaa Improve screenshot quality and add access restrictions screenshot (#675) 2026-04-01 12:25:57 +02:00
Viktor Liu
f169522dde Document L4 service modes, header authentication, and access restrictions (#666)
---------

Co-authored-by: Brandon Hopkins <brandon@techhut.tv>
Co-authored-by: Ashley Mensah <ashleyamo982@gmail.com>
2026-04-01 11:22:04 +02:00
Bethuel Mmbaga
31a1eb5642 Update keycloak initial sync steps (#654) 2026-03-16 14:28:45 +03:00
shuuri-labs
4b5fa2b2f4 Update networks docs to reflect new state of 'add resource' modal (#651) 2026-03-13 15:17:30 +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
Brandon Hopkins
8da42f59ff Add Temp Diagram and Fix Sidebar Nav (#613) 2026-02-17 21:31:10 +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
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
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
Brandon Hopkins
14c3112fc6 Add TrueNAS install documentation (#587) 2026-02-06 15:53:13 +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
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
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
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
Bethuel Mmbaga
157f390c6c Add custom DNS zones (#518) 2026-01-16 18:43:33 +03:00
shuuri-labs
c31143ab83 Added JWT group sync instructions for each IdP (#545)
* Added JWT group sync instructions for each IdP
2026-01-13 19:52:57 +01:00
Brandon Hopkins
105e6774db Self Hosted Quickstart and Other Changes (#543) 2026-01-13 10:59:05 +01:00