Commit Graph
85 Commits
Author SHA1 Message Date
Jack Carter 2ba7990c9a docs(api): document MSP cross-tenant access via ?account= parameter (#723)
Adds a new API guide covering the cross-tenant `?account=<tenant_id>`
query parameter that scopes calls to a specific tenant under an MSP
account. Includes setup steps for picking a user and generating a PAT,
how to retrieve tenant IDs via the MSP listing endpoint, read/write
examples, and auditing/security guidance.

Cross-references added from the Authentication guide, the MSP Portal
page, and the public-api token-creation page so the new guide is
discoverable from each entry point an MSP user is likely to hit.
2026-05-04 10:11:12 -07:00
shuuri-labs a293b8a17b docs(macos): add CLI-only binary install and MDM deployment guide (#713)
* docs(macos): add CLI-only binary install and MDM deployment guide

Document the previously undocumented binary-only install path for macOS
using USE_BIN_INSTALL and SKIP_UI_APP flags. Add a new guide for
building custom CLI-only .pkg packages for MDM fleet deployment,
covering pkgbuild workflow, pre/postinstall scripts, setup key
enrollment, and update strategies.

* docs(macos): add warnings about unsigned binaries in tarballs

The darwin tarballs from GitHub releases contain unsigned binaries —
only the official .pkg goes through the sign pipeline. Add warnings
to both the install page and MDM guide, and document the full signing
workflow: codesign for the binary, pkgbuild --sign for the package,
and optional notarization via notarytool.
2026-05-04 10:07:39 +02:00
Misha Bragin a4888e5bdd Add public ipv4 and ipv6 posture check (#718)
* Add public ipv4 and ipv6 posture check

* Further clarifications
2026-05-03 13:51:09 +02:00
Bethuel Mmbaga d36c932b86 Add AWS Cognito SSO (#717) 2026-04-30 11:05:40 +03:00
shuuri-labs 10114fc7d7 docs: document Windows installer UI autostart behavior (#715)
Add silent installation section to the Windows install page covering
the AUTOSTART MSI property and the fixed EXE silent install default.
Update Intune and Acronis deployment guides to mention autostart.
2026-04-29 13:14:36 +02:00
Brandon Hopkins 9859e7d468 Improve self-hosted Traefik docs and CrowdSec observe-mode notes (#710)
* Crowdsec Updates

* Improve Traefik docs
2026-04-28 20:14:55 -07:00
Maycon SantosandAshley Mensah 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
Bruno Mercier CostaandAshley Mensah 357c431103 Update Reverse Proxy Main (#659)
* Update Reverse Proxy Main

- Adapted Availability to only mention Beta access
- Adapted support of pre-shared keys, and only mention Rosenpass not being supported

* re-add reverse proxy beta note

---------

Co-authored-by: Ashley Mensah <ashleyamo982@gmail.com>
2026-04-21 14:48:45 +02:00
Bethuel MmbagaandJack Carter 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
Pascal Fischer fc88effba3 add proxy access log retention section (#693) 2026-04-20 18:45:02 +02:00
shuuri-labs 79c99b23ab Added mention of peer disconnection notification feature to networks docs (#706) 2026-04-20 17:13:43 +02:00
Viktor Liu b2602add87 Add CrowdSec IP reputation documentation (#698) 2026-04-16 18:06:43 +02:00
Bruno Mercier Costa 6f88f3fea8 Update index.mdx (#703)
Remove isolated comma `,`
2026-04-16 10:22:27 +02:00
Jack Carter 17e4f340e3 docs: add minimum access policy note for exit nodes (#702) 2026-04-15 13:55:36 +02:00
Eduard Gert a4db2c6100 Add slack notifications docs (#697) 2026-04-14 14:21:30 +02:00
Bethuel Mmbaga 9b4c75421d Mark Step 1 Optional in Zitadel SSO Doc (#692) 2026-04-09 17:58:59 +03: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
Maycon Santos a8b7150ec4 Document managing access to routing peer in networks guide (#689) 2026-04-08 16:20:45 +02:00
Viktor Liu 1d942ae531 Add extra DNS labels documentation page (#661) 2026-04-08 14:54:52 +02:00
Brandon Hopkins 5835e7a0c7 Geo-restrictions block internal traffic from the management server (#682) 2026-04-07 11:52:55 +02: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
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
Maycon SantosandJack Carter 303307d791 Add FleetDM integration to EDR documentation (#673)
* Add FleetDM integration to EDR documentation

* docs: Improve FleetDM API token note wording

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
2026-03-31 19:08:02 +02:00
Brandon Hopkins 85e12be9ff Add Reverse Proxy Troubleshooting Page & Clean Up Availability Notes (#672)
* Add troubleshoot page and remove availability notes

* Added Debugging with the Proxy Debug Endpoint

* localhost is unreachable and packet capture
2026-03-30 09:50:01 -07:00
Thomas Bray dd72c79999 Fix formatting in public API documentation (#671) 2026-03-28 10:30:44 -07:00
Abdul Latif 6db1481f1b Add section to disable Netbird SSH server (#670)
Added instructions to disable the Netbird SSH server.
2026-03-28 10:29:05 -07:00
Nicolas Frati dda8cd1b45 add documentation for k8s operator gateway api beta (#668) 2026-03-24 09:09:23 +01:00
Brandon Hopkins 515c809bbf Edit Availability Note (#662) 2026-03-19 14:25:15 +01:00
Jack Carter ab4dea94db docs: Add WireGuard port conflict troubleshooting for Domain Controllers (#660)
Document the issue where Windows DNS Server claims UDP port 51820,
preventing WireGuard from starting on Domain Controllers. Covers
symptoms, diagnosis steps, and the dnscmd fix.
2026-03-18 10:23:45 +01:00
Bruno Mercier Costa 875d7bc497 Update connecting-from-the-office.mdx (#657)
fixing a typo from "agaom" to "again"
2026-03-17 13:25:28 +01:00
shuuri-labs 8680e5e822 Document TLS-ALPN-01 challenge requirements for reverse proxy (#656) 2026-03-16 15:26:52 +01:00
Bethuel Mmbaga 31a1eb5642 Update keycloak initial sync steps (#654) 2026-03-16 14:28:45 +03:00
Zoltan Papp e0f5fbf445 Extend the auto update feature with force flag (#653) 2026-03-13 21:40:32 +01: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-labsandBrandon Hopkins 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
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