Commit Graph

127 Commits

Author SHA1 Message Date
infiniteduck
5a899c55c4 fix: use H1 for page title in backup, remove and upgrade docs (#621)
* Change header from H2 to H1 in backup.mdx

With H2 header, the browser tab name was "undefined" instead of the proper name

* Change H2 header to H1 in remove.mdx

With H2 header, the browser tab name was "undefined" instead of the proper name

* Change H2 header to H1 in upgrade.mdx

With H2 header, the browser tab name was "undefined" instead of the proper name

* Promote h3 sub-headings to h2 in upgrade.mdx to fix TOC error

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-18 09:31:46 +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
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
Brandon Hopkins
417b08cf1a Quick Fix to getting-started (#606) 2026-02-15 23:59:02 -08:00
Brandon Hopkins
62b39cf8a1 NetBird Proxy Service Edits (#603)
* NetBird Proxy Service Edits

* Self-hosted setup clarification
2026-02-15 12:26:55 +01:00
Misha Bragin
e3603aa4ee Fix reverse proxy wording (#599) 2026-02-14 16:33:11 +01:00
shuuri-labs
98120d51f6 Align proxy docs with getting-started.sh: fix image name, Traefik labels, add proxy domain warning and quickstart flow (#597) 2026-02-13 19:53:45 +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
Misha Bragin
858d7e7c9d Disable local authentication (#583) 2026-01-31 20:00:00 +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
Misha Bragin
2ccf05149a Reference DUO (#575) 2026-01-24 18:24:15 +01:00
shuuri-labs
4b5f9b58dc Config file breakdown (#565) 2026-01-22 16:38:32 +01:00
Misha Bragin
38eb2925c8 Fix STUN migration links (#567) 2026-01-22 10:49:44 +01:00
Misha Bragin
14827a38d5 Add Coturn to Embedded STUN migration (#566) 2026-01-21 14:51:57 +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
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
shuuri-labs
6e9932b679 Add clarification to jwt group sync docs that groups with same name in netbird will not be synced (#561) 2026-01-19 16:55:09 +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
yujinqiu
9794dd8398 Fix selfhosted docs (#549)
Co-authored-by: yujinqiu <yujinqiu@qfei.cn>
2026-01-14 08:36:27 +01: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
Brandon Hopkins
881fbfcb49 Separation of Advanced Steps and Self-Hosted Updates (#540)
* Seperatate Avanced Steps

* Remove Nessesary Note

* Self-Hosted Idp Separation

* Updated Pocket ID Steps and Screenshots

* Athentik

* Keycloak
2026-01-10 11:28:09 +01:00
Brandon Hopkins
027d9f077a Updating Self-Hosted Managed Idp Guides (#538) 2026-01-08 23:05:28 -05:00
Brandon Hopkins
b0d218484a v0.62 Quick Fixes and Edits (#537) 2026-01-07 21:02:45 -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
shuuri-labs
87e17964bd Clarified port requirements in self-hosted install guide (#523)
* Clarified port requirements in self-hosted install guide

* fixed typo

---------

Co-authored-by: Ashley Mensah <ashley@netbird.io>
2025-12-22 10:38:32 +01:00
Misha Bragin
47a1881325 Update self-hosted ports (#508) 2025-12-05 11:54:26 +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
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
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
Krzysztof Nazarewski (kdn)
bd3103a442 fix the docs link (#462)
branding `Netbird` as `NetBird` added a `-` to the link form for `net-bird`
2025-11-04 15:19:15 +01:00
John Conley
3154f5b603 Add documentation for self-hosted pocketid integration (#432) 2025-10-17 19:42:57 +02:00
YapWC
57b5e859ad Update Backup Section (#395)
Added the backup for openid-configuration.json

Without backing up this file maintainer would have to generate it again manually, which would be time & effort consuming.
2025-10-15 20:45:26 +02:00
RPuettmann
94b0e73516 Add selfhosted instructions for activity on mysql (#446) 2025-10-15 20:44:56 +02:00
Maycon Santos
eb031239d5 Update signal port info for caddy (#441) 2025-10-06 19:51:40 +02:00
Viktor Liu
ddc690886a Add websocket paths (#439) 2025-10-02 13:49:06 +02:00
Maycon Santos
95ea694b96 Add browser client support info (#437) 2025-10-02 00:53:19 +02:00
Krzysztof Nazarewski (kdn)
9630c856e3 selfhosted-guide: make it clear when to run configure.sh (#419) 2025-08-27 16:54:17 +02:00
Krzysztof Nazarewski (kdn)
1402bcdb31 self-hosted Keycloak: add missing NETBIRD_AUTH_DEVICE_AUTH_AUDIENCE? (#413) 2025-08-18 12:10:47 +02:00
Bethuel Mmbaga
e77a233390 Update redirect URI settings for Authentik integration (#406) 2025-08-13 10:48:32 +03: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
602a4b03a6 Updated identity-providers.mdx to correct information regarding Authentik service account passwords (#359)
After 11h of troubleshooting yesterday (https://github.com/netbirdio/netbird/issues/2142#issuecomment-2915471588), I found this out for myself.

There's a non-zero chance my solution was wrong, but perhaps someone with more insight can verify this for me. :- )
2025-05-29 12:01:59 +02:00
Hammy Havoc
5433a0bdb0 Fixed non-functioning Step 3 hyperlink on Update selfhosted-guide.mdx (#356)
I might be wrong in understanding the issue and doing this from my phone, but https://github.com/netbirdio/docs/issues/295 mentioned the broken link.

I couldn't see braces-related issue mentioned by the user, but I did see that the non-functioning `Step 3` link was pointing at `#step-3-configure-identity-provider` instead of `#step-3-configure-identity-provider-idp`.

Could well be wrong—it wouldn't be the first time. :- )
2025-05-29 11:58:56 +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