Add Unraid installation guide

[TechHutTV]

Description

Add a dedicated guide for installing the native NetBird plugin on Unraid and accessing the server remotely. The page covers installation through the Apps catalog or a direct plugin URL, setup-key registration, connection verification, and access to the Unraid web interface.

Instructions and settings were checked against the netbird-unraid source. The guide supports NetBird Cloud and self-hosted deployments, with an optional hostname that defaults to the Unraid server's name.

Changes

• Add /get-started/install/unraid with prerequisites and both installation methods.
• Document plugin settings and defaults, including DNS, SSH, Rosenpass, pre-shared keys, and logging.
• Explain profiles, connection controls, startup behavior, updates, and troubleshooting.
• Add the connection-status screenshot from the plugin README as a local docs asset.
• Link the guide from the Platforms sidebar and installation overview.

Summary by CodeRabbit

• Documentation
  • Added a detailed Unraid installation guide with setup, configuration, service management, updates, and troubleshooting information.
  • Added Unraid to the installation options and platform navigation.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
docs	Ready	Preview	Oct 8, 2026 5:27am UTC

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: 6424a7e0-7511-4bad-b096-1487001b4dda

📥 Commits

Reviewing files that changed from the base of the PR and between 71bb0e4 and 4ab9510.

⛔ Files ignored due to path filters (1)

• public/docs-static/img/get-started/unraid/netbird-connected.png is excluded by !**/*.png

📒 Files selected for processing (3)

• src/components/NavigationDocs.jsx
• src/pages/get-started/install/index.mdx
• src/pages/get-started/install/unraid.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The pull request adds an Unraid installation guide. It links the guide from the installation page and Platforms navigation, and documents setup, configuration, access, profiles, service controls, updates, and troubleshooting.

Changes

Unraid installation documentation

Layer / File(s)	Summary
Installation and registration src/components/NavigationDocs.jsx, src/pages/get-started/install/index.mdx, src/pages/get-started/install/unraid.mdx	Adds navigation and installation-page links. The guide covers plugin installation, prerequisites, registration, and connection checks.
Access and plugin configuration src/pages/get-started/install/unraid.mdx	Documents access to the Unraid web interface, plugin settings, profiles, and service controls.
Persistence and troubleshooting src/pages/get-started/install/unraid.mdx	Documents startup behavior, storage paths, updates, and troubleshooting steps.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: sunsetdrifter

Merge Risk: ⚪ Minimal · up to 4ab95

This change adds an Unraid installation guide and links to it from the install overview and the navigation. It is documentation only, and no merge-blocking issues were found.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: adding an Unraid installation guide and related documentation links.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/components/NavigationDocs.jsx

typescript-eslint does not support TS 7.0.
Please see https://devblogs.microsoft.com/typescript/announcing-typescript-7-0/#running-side-by-side-with-typescript-6.0 to run typescript-eslint using the TS 6 API.
See also typescript-eslint/typescript-eslint#10940 for tracking typescript-eslint's support for TS >=7.1

Oops! Something went wrong! :(

ESLint: 9.39.5

Error: typescript-eslint does not support TS 7.0.
at Object. (/.eslint-tmp/node_modules/typescript-eslint/dist/index.js:52:11)
at Module._compile (node:internal/modules/cjs/loader:1830:14)
at Object..js (node:internal/modules/cjs/loader:1961:10)
at Module.load (node:internal/modules/cjs/loader:1553:32)
at Module._load (node:internal/modules/cjs/loader:1355:12)
at wrapModuleLoad (node:internal/modules/cjs/loader:255:19)
at Module.require (node:internal/modules/cjs/loader:1576:12)
at require (node:internal/modules/helpers:153:16)
at Object. (/.eslint-tmp/node_modules/eslint-config-next/dist/index.js:5:64)
at Module._compile (node:internal/modules/cjs/loader:1830:14)

src/pages/get-started/install/index.mdx

ESLint skipped: the matched ESLint configuration already failed (config-incompatibility).

src/pages/get-started/install/unraid.mdx

ESLint skipped: the matched ESLint configuration already failed (config-incompatibility).

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{A rabbit finds the Unraid guide,
With setup steps and links beside.
Profiles hop from one to two,
DNS and service notes come through.
The guide is ready for the burrow crew.}

_{Comment @coderabbitai help to get the list of available commands.}