Commit Graph

45 Commits

Author SHA1 Message Date
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
Jack Carter
d1936d99ec fix: replace invalid <p> wrapping Button with <div> (#768)
* fix: replace invalid <p> wrapping Button with <div>

The Button component renders a <div> in its primary variant. HTML
disallows block elements inside <p>, so browsers auto-close the <p>
during parsing and React 19 reports a hydration mismatch. The
float="center" attribute was non-functional, so rendering is unchanged.

* chore: gitignore .playwright-mcp run artifacts
2026-05-27 13:51:03 -07:00
Misha Bragin
14efe3f46a User Servers ref when relevant instead of User Devices (#770) 2026-05-27 16:38:39 +02:00
Tiranajunge
090eff7117 OPNsense checkbox "Show community plugins" (#765)
* OPNsense checkbox "Show community plugins"

OPNsense requires a new checkbox "Show community plugins" to be checked, before you can find the netbird plugin.

Tested on OPNsense 26.1.8_5

* docs: tighten OPNsense community plugins instruction

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
2026-05-26 16:14:50 +02:00
Misha Bragin
3bac72719b Align docs with the simplified layout changes (#766) 2026-05-26 10:35:24 +02:00
PizzaLovingNerd
4e1f5669c9 Added Homebrew for Linux as instructions for atomic, updated DistroBox docs. (#756)
* Update Linux installation instructions for NetBird on Fedora Silverblue and Universal Blue. Added Homebrew and Distrobox installation methods, including necessary commands and SELinux configuration notes. Updated Distrobox container image version from Debian 12 to 13.

* Some adjustments to homebrew docs

* removed leading space on the \``bash` opening fence

---------

Co-authored-by: TechHutTV <brandon@techhut.tv>
2026-05-19 14:20:53 -07:00
Maycon Santos
6dc4724fa2 Add short flags for CLI command options (#754) 2026-05-19 15:57:01 +02: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
Philipp Gillé
6b15feed76 Fix group & policy link in Android install docs (#736) 2026-05-11 18:22:25 +02:00
Viktor Liu
93f1fb265c Add IPv6 overlay addressing documentation (#667) 2026-05-11 17:48:31 +02:00
Jack Carter
b6bc6579d5 docs: unhyphenate "Zero Trust" across the docs (#740)
House style writes "Zero Trust" / "zero trust" without a hyphen
in prose. Sweep all hyphenated prose occurrences under `src/pages/`
to match.

URL slugs (e.g. `/use-cases/security/implement-zero-trust`) and
external links (CrowdStrike press release / blog URLs that include
`zero-trust` as a path segment) are intentionally preserved.
2026-05-11 12:25:00 +02:00
Brandon Hopkins
28b7c13bd3 Added auto-generated "Updated..." line under H1 (#719) 2026-05-04 09:37:57 -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
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
shuuri-labs
c0fa9329be docs(pfsense): remove hardcoded version from install instructions (#711)
Replace hardcoded v0.1.2/netbird-0.55.1 URLs with placeholders that
direct users to the latest GitHub release page. Adds architecture
guidance (x86_64 vs aarch64) and a concrete example showing how to
map release page values into the download commands. Also fixes step
numbering and removes version-specific package names from uninstall.
2026-04-27 16:38:51 +02:00
Viktor Liu
5a575acdee Document missing CLI flags and client environment variables (#687) 2026-04-08 16:19:49 +02:00
Viktor Liu
1d942ae531 Add extra DNS labels documentation page (#661) 2026-04-08 14:54:52 +02:00
Jack Carter
1e8ff9525e docs: Add new CLI flags to up command (#686) 2026-04-08 11:25:39 +02:00
Pierre Timmermans
cf7d8a9737 Enable gpgcheck for netbird repository (#669)
Updated gpgcheck setting from 0 to 1 for netbird repository configuration.
2026-04-03 10:22:00 +02:00
Eirik Rolland Enger
2f6e844019 fix(CLI): typo netbirt to netbird (#646) 2026-03-09 13:10:14 -07:00
Maycon Santos
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
Misha Bragin
5c059fa7b8 Refer to the new config.yaml file (#628) 2026-02-19 12:03:32 +01:00
Jack Carter
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
Brandon Hopkins
5fe0de4379 Fix typo in rootless image section (#605) 2026-02-16 18:51:43 +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
Jack Carter
320e9fdcaf Fix 5 broken internal links across docs (#596)
- Fix case mismatch: /get-started/install/iOS → /ios (would 404 on Linux)
- Remove literal /index from /manage/dns/index → /manage/dns
- Add missing /by-scenario/ segment to 3 network-routes links

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-13 19:01:47 +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
heypete
2e1c05a655 Update references to outdated server addresses (#586)
The document has several outdated references to server addresses (e.g. api.wiretrustee.com, signal2.wiretrustee.com) and ports.

I've updated the document with the current addresses and ports according to https://docs.netbird.io/about-netbird/faq
2026-02-08 09:34:11 +01:00
Brandon Hopkins
b323333df5 Edits and add KH Ref (#591) 2026-02-06 16:38:44 +01:00
Brandon Hopkins
14c3112fc6 Add TrueNAS install documentation (#587) 2026-02-06 15:53:13 +01:00
Viktor Liu
1ef008c950 Add /dev/net/tun for container running in userspace (#589) 2026-02-05 11:58:19 +01:00
Brandon Hopkins
6db8d0e162 Quick Fixes and Docker Rootless (#572) 2026-01-23 14:00:30 -08: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
Brandon Hopkins
1bc91042c0 General Docs Improvements (#542) 2026-01-12 23:01:42 +01:00
Brandon Hopkins
becf4bd6e4 Style Consistency Changes and Element Improvements (#541)
Co-authored-by: braginini <bangvalo@gmail.com>
2026-01-11 09:27:56 +01:00
shuuri-labs
db480cbba4 Added new 'imagewrapper-medium' class, applied to images in android.mdx (#517)
Co-authored-by: Ashley Mensah <ashley@netbird.io>
2025-12-12 12:31:21 +01:00
Jack Carter
0749bbca4e docs: add firewall troubleshooting guide for pfSense and OPNsense (#515) 2025-12-12 12:30:57 +01:00
GodSpoon
71fa51a777 Update installation command for Synology NAS (#507)
Had to add sudo for it to run correctly
2025-12-05 16:24:43 +01: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
Brandon Hopkins
0bceba76c0 Mobile Pages Quick Fix (#498)
* Mobile Pages Quick Fix

* Rename iOS.mdx to ios.mdx
2025-11-27 11:09:53 -08: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
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