sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-10-06 13:49:03 +02:00
Code Issues Packages Projects Releases Wiki Activity
1,168 Commits 87 Branches 0 Tags
d5f4dbfa8a2ec0d41d2df6569a833a6267249751
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Maycon Santos 47b53bdb7d Document the remote-jobs opt-in and MDM keys (#914) 
Remote jobs are now an explicit opt-in on the peer (default off), enabled
with --allow-remote-jobs or the allowRemoteJobs MDM policy, and a new
debugBundleUploadURL MDM policy overrides the debug-bundle upload service.
Document both MDM keys in the MDM integration reference, and note the
opt-in requirement plus the new anonymization-level and upload-URL bundle
parameters on the Remote Jobs page.
 2026-09-22 16:50:46 +02:00
Maycon SantosandClaude Opus 5 ee9e5d9f03 docs: document CAA records for custom domains (#974) 
Domains that already have CAA records refuse certificate issuance unless
the certificate authority is authorized, leaving reverse proxy services
unreachable over HTTPS after the domain verifies successfully.

Document the sectigo.com value used by ZeroSSL on NetBird Cloud's managed
proxy clusters, the issue/issuewild records to add, CAA inheritance from
parent domains, and how to check existing records. Add a troubleshooting
entry for certificates that are not issued after verification.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
 2026-09-12 22:54:39 +02:00
Maycon Santos b046b65d4e [doc] Explain custom domain verification expiry (#969) 
* [doc] Explain custom domain verification expiry

Describe the 48-hour verification deadline, hourly cleanup, and activity event
so administrators know why a pending domain disappears and how to register it
again. Include the upgrade window and the exception for legacy service use.

* [doc] Explain custom domain name normalization

Describe how new custom domain registrations normalize case, internationalized
names, and a trailing dot, and reject malformed or wildcard names.
 2026-09-11 18:11:29 +02:00
Maycon Santos c53c0831a5 Correct Linux desktop app requirements and drop libappindicator (#888) 
The Wails 3 desktop app links GTK 4.10+ (GtkFileDialog) and WebKitGTK 6.0,
verified against the shipped v0.75.0 netbird-ui binary. The previously
documented floor of Debian 12 / Ubuntu 22.04 is below that: both ship
WebKitGTK 6.0 but only GTK 4.8 and 4.6, where the app starts and then
crashes on the first file dialog.

- Document the real floor per distribution and mark RHEL 9, Amazon Linux 2
  and Amazon Linux 2023 as CLI only.
- Name the GTK 4 and WebKitGTK 6.0 packages in the install commands, since
  netbird-ui does not declare them as dependencies.
- Note that EPEL provides webkitgtk6.0 on RHEL/AlmaLinux/Rocky 10.
- Remove libappindicator from the RPM install lines. The tray is a D-Bus
  StatusNotifierItem and does not link libappindicator; keep the GNOME
  extension step, which is still required for the tray to appear.
- Note that Linux netbird-ui packages are x86_64 only.
 2026-07-28 11:34:37 +02:00
Maycon Santosandbraginini 8c862e1f91 Document Agent Network prompt-cache token and cost accounting (#886) 
Co-authored-by: braginini <bangvalo@gmail.com>
 2026-07-26 21:44:09 +02:00
Maycon Santos 50660d5f32 agent-network: identity metadata setting and Bedrock cost allocation (#857) 2026-07-20 14:46:49 +02:00
Maycon Santos 5ab0207a27 update slack url (#846) 2026-07-10 21:31:28 +02:00
Maycon Santos 3fadeda2fa Add "Agent Network" link to NavigationAPI and update API generator script (#825) 2026-07-02 10:18:00 +02:00
Maycon SantosandTechHutTV 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
Maycon Santosandcoderabbitai[bot] 109140a77a Add observability documentation for self-hosted deployments (#772) 
* Add observability documentation for self-hosted deployments

* Update src/pages/selfhosted/observability/index.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update src/pages/selfhosted/observability/index.mdx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Document metric naming conventions and updates across self-hosted observability pages

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
 2026-05-29 16:04:04 +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
Maycon Santos 6dc4724fa2 Add short flags for CLI command options (#754) 2026-05-19 15:57:01 +02:00
Maycon SantosandJack Carter bc573143ae Add script to generate sitemap.xml and update related configurations (#742) 
* Add script to generate sitemap.xml and update related configurations

* chore: add robots.txt referencing sitemap.xml

---------

Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
 2026-05-12 10:13:30 +02:00
Maycon Santos a215b0358a Update slack url (#721) 2026-05-02 19:39:26 +02:00
Maycon Santos e1b55db10d Add new relay endpoints for streamline-de-fra1 (#712) 2026-04-28 01:31:24 +02: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
Maycon Santos 38119d2982 Update next.config.mjs (#695) 2026-04-09 09:43:13 -07:00
Maycon Santos a275571e46 update slack url (#694) 2026-04-09 09:05:39 -07:00
Maycon Santos a8b7150ec4 Document managing access to routing peer in networks guide (#689) 2026-04-08 16:20:45 +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
Maycon Santos 27e4500def add force push for docs workflow 2026-03-11 19:55:32 +01:00
Maycon Santosandshuuri-labs c413b2d00c Update reverse proxy documentation for domain and DNS record changes (#648) 
* Update reverse proxy documentation for domain and DNS record changes

* Clarify reverse proxy domain description in migration guide

* Update domain requirement clarification in migration guide

Clarified the domain requirement for the proxy + added missing charactr afer example domain

---------

Co-authored-by: shuuri-labs <61762328+shuuri-labs@users.noreply.github.com>
 2026-03-11 19:27:45 +01:00
Maycon Santos 9d443e23a4 update slack url (#645) 2026-03-08 16:44:14 +01:00
Maycon Santosandnetbirddev b35de5b477 Escape MDX-specific characters in API templates and refine Navigation… (#638) 
* Escape MDX-specific characters in API templates and refine NavigationAPI links

* Update API pages with v0.66.0

---------

Co-authored-by: netbirddev <dev@netbird.io>
 2026-02-26 16:28:00 +01:00
Maycon Santos c63c1fec29 Expand FAQ metrics section with detailed data points (#634) 2026-02-24 15:34:11 +01: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
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
Maycon Santos f12b83dabe Add new endpoints to navigation menu (#574) 2026-01-23 20:33:44 +01:00
Maycon Santosandnetbirddev 4d5843df12 Update api.tsx to handle content type (#573) 
* Update api.tsx to handle content type

* Update API pages with v0.64.1

---------

Co-authored-by: netbirddev <dev@netbird.io>
 2026-01-23 20:05:08 +01:00
Maycon Santos 7af0ef443c Update slack url (#557) 2026-01-17 16:19:00 +01:00
Maycon Santosandnetbirddev aef978f63d Handle merge api component conflicts (#539) 
* Handle merge api component conflicts

Added a fixConflictingEnumAllOf() function in generator/api.ts that pre-processes the spec before merging

* Update API pages with v0.62.2

---------

Co-authored-by: netbirddev <dev@netbird.io>
 2026-01-10 12:16:22 +01:00
Maycon Santos ec76ca2524 Update checkout and setup-go actions (#531) 2025-12-30 10:37:30 +01:00
Maycon Santos aa627eff0f Remove old relay and streamline regions (#529) 2025-12-26 11:29:56 +01:00
Maycon Santos e4ec49796d Add new nodes for various regions (#528) 2025-12-24 10:35:47 +01:00
Maycon Santos 1b73ce2855 Add new streamline-au-syd1 relay endpoints to netbird-cloud-endpoints.json (#503) 2025-12-01 09:38:08 +01:00
Maycon Santos abf5a83fb7 Add new streamline relay endpoints (#500) 
across multiple regions to netbird-cloud-endpoints.json
 2025-11-28 11:27:17 +01:00
Maycon Santos f37ab18ab2 Expand IPv4 and IPv6 address ranges for management, signal, and P2P services in the FAQ page. (#496) 2025-11-26 17:21:16 +01:00
Maycon Santos 95daa3f40d Update report-bug-issues.mdx (#474) 2025-11-14 15:45:36 +01:00
Maycon Santos 7ce07c1464 Add duplicate attributes node (#473) 2025-11-14 14:29:51 +01:00
Maycon Santos 601306243c Update slack invite url (#467) 2025-11-08 21:17:40 +01:00
Maycon Santos eb031239d5 Update signal port info for caddy (#441) 2025-10-06 19:51:40 +02:00
Maycon Santos 95ea694b96 Add browser client support info (#437) 2025-10-02 00:53:19 +02:00
Maycon Santos 29b2752980 Refactor netbirdAPI key configuration (#425) 
Updated netbirdAPI configuration to specify key name and key.
 2025-09-09 11:57:41 +02:00
Maycon Santos 108e8ad912 Update NetBird package versions in pfSense installation guide (#420) 2025-08-27 20:37:20 +02:00
Maycon Santos c810a0a9da Update Slack URL in redirects configuration (#418) 2025-08-24 17:51:12 +02:00
Maycon Santos fb8cdf8ad4 update URL and rename file 
added navigation link
 2025-06-24 16:47:48 +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
Maycon Santos 2a3e25ec94 update debug bundle text (#322) 
* update debug bundle text

* update
 2025-05-27 15:20:54 +02:00
Maycon Santos 09537916e4 Update Authentik doc with disable login var (#307) 
* Update Authentik doc with disable login var

* fix linter
 2025-04-11 13:54:00 +02:00
Maycon Santos ee1a757165 Update kubernetes-operator.mdx 2025-04-08 23:53:43 +02:00
Maycon Santos 2846a2a4a6 fix upgrade command 2025-04-08 23:38:46 +02:00
Maycon Santos 1a2acac12e Add Kubernetes operator docs (#302) 2025-04-01 21:33:09 +02:00
Maycon Santos 956a948b99 Update slack invite (#285) 2025-03-10 17:07:57 +01:00
Maycon Santos 5f68230137 fix slack URL 2025-01-06 20:58:32 +01:00
Maycon Santos bf2c616dce add tittle to the nav link 2024-12-23 16:52:19 +01:00
Maycon Santos 8ef3f4a37c Add networks documentation (#264) 2024-12-23 15:52:50 +01:00
Maycon Santos a19076b13a Update slack invite link (#253) 
* Update slack invite link

* fix spelling
 2024-11-22 18:33:47 +01:00
Maycon Santos 17fb9602d3 Update docker creds (#239) 2024-09-30 20:07:10 +02:00
Maycon Santos 6fe81c9fc9 Update advanced guide with new relay port requirement (#228) 2024-09-10 16:39:24 +02:00
Maycon Santos 92954fbaf1 Update diagram created with chartdb (#225) 2024-09-09 14:58:58 +02:00
Maycon Santos c30d01d184 update slack invite url 2024-08-18 13:28:31 +02:00
Maycon Santos d3cf24a6e4 adjust wording 2024-08-18 13:26:48 +02:00
Maycon Santos 2808b4d1de make Synology a header 2024-08-07 11:34:34 +02:00
Maycon SantosandMisha Bragin 9b2eb25d3c Update metrics faq (#201) 
* Update metrics faq

* Update src/pages/about-netbird/faq.mdx

Co-authored-by: Misha Bragin <bangvalo@gmail.com>

---------

Co-authored-by: Misha Bragin <bangvalo@gmail.com>
 2024-07-04 19:15:38 +02:00
Maycon Santos f84f95d95a Remove rules navigation link (#197) 2024-06-13 12:19:18 +02:00
Maycon Santos 0c9bc84fc1 Update windows installation (#192) 
* Update windows installation

* adjust links and use note box

* remove extra word
 2024-05-23 16:14:13 +02:00
Maycon Santos b79afb777e Update report-bug-issues.mdx (#160) 2024-03-01 15:09:41 +01:00
Maycon Santos 7b1b68ff68 Add HA step to the Kubernetes doc (#152) 2024-02-25 09:04:01 +00:00
Maycon Santos 6d9367af6b Add Deploy routing peers to a Kubernetes cluster guide (#151) 
* Add Deploy routing peers to a Kubernetes cluster guide

* adjust images width
 2024-02-23 17:33:24 +01:00
Maycon Santos c0a58196f1 Update CLI flags and reorder pages 2024-02-23 14:13:34 +01:00
Maycon Santos b9525bfc58 Remove old IP addresses (#147) 2024-02-20 15:25:14 +01:00
Maycon Santos 89891998d1 add NETBIRD_MGMT_IDP_SIGNKEY_REFRESH to zitadel (#142) 2024-02-12 10:58:21 +01:00
Maycon Santos 1a2fa325e6 add cloud note 2024-01-26 17:53:25 +01:00
Maycon Santos 0e1f56c5b4 fix a typo 2024-01-26 17:49:53 +01:00
Maycon Santos 51d27ef1fa Add report bug issues page (#137) 
adding a copy of our report template
 2024-01-26 17:48:05 +01:00
Maycon Santos f0873a255b Add user roles documentation (#120) 2024-01-04 18:34:08 +01:00
Maycon Santos bf0285623c Add delete account documentation (#121) 2024-01-04 18:30:15 +01:00
Maycon Santos 46ae38249c Update getting started path to use artifacts (#116) 
Adjust docs to PR https://github.com/netbirdio/netbird/pull/1235
 2023-12-17 18:00:00 +01:00
Maycon Santos ceddc4b1fc Use bot token on checkout step (#113) 2023-12-07 18:02:58 +01:00
Maycon Santos dfc764aaf0 Update DNS docs with new layout and add search domains concept (#108) 2023-10-20 18:14:09 +02:00
Maycon Santosandbraginini 8046beee03 Update SQLite docs (#107) 
---------

Co-authored-by: braginini <bangvalo@gmail.com>
 2023-10-19 21:09:46 +02:00
Maycon Santosandbraginini 53da0fe16f Add backup and upgrade guides for self-hosted deployments (#105) 
Co-authored-by: braginini <bangvalo@gmail.com>
 2023-10-16 13:53:51 +02:00
Maycon Santosandnetbirddev b54abbfa79 Update API pages with v0.23.3 (#91) 
* Update API pages with v0.23.3

* update user delete api description

---------

Co-authored-by: netbirddev <dev@netbird.io>
 2023-09-23 11:22:19 +02:00
Maycon Santos 971d6c7aba Update FAQ with new management endpoint addresses (#90) 2023-09-22 10:35:15 +02:00
Maycon Santos c3e0e657cd Update FAQ with new signal endpoint addresses (#89) 
* Update FAQ with new signal endpoint addresses

* Update FAQ with new signal endpoint addresses

* Update FAQ with new signal endpoint addresses
 2023-09-18 15:15:49 +02:00
Maycon Santos 308c8ba397 Update faq.mdx (#85) 2023-09-07 11:26:53 +02:00
Maycon Santosandnetbirddev 0d50068de9 Update API docs (#84) 
* Update API docs

* Update API pages with v0.23.0

---------

Co-authored-by: netbirddev <dev@netbird.io>
 2023-09-06 11:55:51 +02:00
Maycon Santos af5479f041 Update build_n_push.yml with workflow_dispatch 2023-08-14 12:02:38 +02:00
Maycon Santos 36496e81a6 Update generate_api_pages.yml 2023-08-11 14:57:13 +02:00
Maycon Santos ceb5ba0342 Update generate_api_pages.yml 2023-08-10 16:22:15 +02:00
Maycon SantosandDevBot NetBird 734cc3dfb2 Check for diff and force push (#78) 
check for diff before trying to commit

force push to protected branch

---------

Co-authored-by: DevBot NetBird <dev@netbird.io>
 2023-08-05 00:26:09 +02:00
Maycon Santos ff0d3e3cd6 Add getting started script guide with Zitadel (#76) 
Add getting started script guide with Zitadel

group and update order of IDPs
 2023-08-03 20:28:05 +02:00
Maycon Santos 98b2da2593 fix amazon 2023 name 2023-07-28 15:34:50 +02:00
Maycon Santos 37df8fcb2b add amazon linux 2023-07-28 15:27:55 +02:00
Maycon Santos f45200a234 Update packages domain (#75) 
* Update packages domain

* update committer info

* replace wiretrustee
 2023-07-28 15:16:06 +02:00
Maycon Santos a4c19dca53 update zitadel docs 2023-06-25 16:06:42 +02:00
Maycon Santos a5a764b788 configure IDP message 2023-06-25 14:31:21 +02:00
Maycon Santos 00c1f99530 self-hosted 2023-06-25 12:35:58 +02:00
Maycon Santos 480a9813c5 azure step 2023-06-25 10:50:34 +02:00
Maycon Santos 2950799770 Docs review 
Fix broken and missing links

Update docs with Scope support, removing manual changes

Added last step: Continue with the NetBird Self-hosting Guide
 2023-06-25 10:44:03 +02:00