Skip to content

OPNsense checkbox "Show community plugins"#765

Open
Tiranajunge wants to merge 1 commit into
netbirdio:mainfrom
Tiranajunge:main
Open

OPNsense checkbox "Show community plugins"#765
Tiranajunge wants to merge 1 commit into
netbirdio:mainfrom
Tiranajunge:main

Conversation

@Tiranajunge
Copy link
Copy Markdown

@Tiranajunge Tiranajunge commented May 23, 2026

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

Summary by CodeRabbit

  • Documentation
    • Updated OPNsense installation instructions to explicitly clarify the requirement to enable "Show community plugins" before searching for and installing the NetBird plugin.

Review Change Stack

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
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 23, 2026

📝 Walkthrough

Walkthrough

Updated OPNsense NetBird plugin installation documentation to explicitly instruct users to enable "Show community plugins" in the Plugins page before searching for and installing the os-netbird package. Single-line documentation clarification in the installation guide.

Changes

OPNsense Plugin Installation Guide

Layer / File(s) Summary
Installation instructions clarification
src/pages/get-started/install/opnsense.mdx
Updated step to explicitly require enabling "Show community plugins" in the OPNsense Plugins page before locating and installing the os-netbird package.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tiny tweak, so small yet bright,
Shows NetBird plugins in plain sight,
"Enable community," we now declare,
The path is clear, the way is fair! 🔌

🚥 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 identifies the specific checkbox setting that must be enabled in OPNsense, which matches the main change documented in the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 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/pages/get-started/install/opnsense.mdx

Oops! Something went wrong! :(

ESLint: 9.39.4

TypeError: Converting circular structure to JSON
--> starting at object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'flat' -> object with constructor 'Object'
| ...
| property 'plugins' -> object with constructor 'Object'
--- property 'react' closes the circle
Referenced from:
at JSON.stringify ()
at file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:308:45
at Array.map ()
at ConfigValidator.formatErrors (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:299:23)
at ConfigValidator.validateConfigSchema (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/shared/config-validator.js:330:84)
at ConfigArrayFactory._normalizeConfigData (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:676:19)
at ConfigArrayFactory._loadConfigData (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:641:21)
at ConfigArrayFactory._loadExtendedShareableConfig (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:946:21)
at ConfigArrayFactory._loadExtends (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:814:25)
at ConfigArrayFactory._normalizeObjectConfigDataBody (file:///node_modules/.pnpm/@eslint+eslintrc@3.3.5/node_modules/@eslint/eslintrc/lib/config-array-factory.js:752:25)


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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/pages/get-started/install/opnsense.mdx (1)

1-1: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Add missing imports for custom components.

The file uses custom components (YouTube, Note, Button) without importing them. As per coding guidelines, MDX files must import these components from their specified paths.

📦 Proposed fix to add imports
+import { Note } from '`@/components/mdx`'
+import { YouTube } from '`@/components/YouTube`'
+import { Button } from '`@/components/Button`'
+
 # OPNsense Installation

As per coding guidelines: Import custom components from @/components/mdx (Note, Warning, Success), @/components/Tiles, @/components/YouTube, @/components/Button, or @/components/mdx as needed for alerts, layout, media, and UI

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/get-started/install/opnsense.mdx` at line 1, This MDX uses custom
components YouTube, Note, and Button but lacks imports; add import statements at
the top of src/pages/get-started/install/opnsense.mdx to import YouTube, Note,
and Button from the project's MDX/component modules (the canonical component
exports used across MDX files), then update any existing usages to rely on those
imports (symbols: YouTube, Note, Button) so the components render correctly.
🧹 Nitpick comments (1)
src/pages/get-started/install/opnsense.mdx (1)

26-26: ⚡ Quick win

Fix comma splice and improve sentence structure.

The instruction contains a comma splice: "...Plugins, Make sure..." should be separated into distinct sentences or use proper punctuation for better readability.

✍️ Proposed fix for grammar and clarity
-    In the OPNsense Web UI, navigate to `System` > `Firmware` > `Plugins`, Make sure `Show community plugins` is checked and search for the `os-netbird` package. Click the install button next to it.
+    In the OPNsense Web UI, navigate to `System` > `Firmware` > `Plugins`. Make sure `Show community plugins` is checked, then search for the `os-netbird` package and click the install button next to it.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/get-started/install/opnsense.mdx` at line 26, Split the comma
splice by replacing the comma after the backticked `Plugins` with a period and
start a new sentence (or use a semicolon and lowercase the following word);
update the fragment "`System` > `Firmware` > `Plugins`, Make sure `Show
community plugins` is checked..." to read either "`System` > `Firmware` >
`Plugins`. Make sure `Show community plugins` is checked..." or "`System` >
`Firmware` > `Plugins`; make sure `Show community plugins` is checked..." and
keep the rest of the instruction referencing the `os-netbird` package unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@src/pages/get-started/install/opnsense.mdx`:
- Line 1: This MDX uses custom components YouTube, Note, and Button but lacks
imports; add import statements at the top of
src/pages/get-started/install/opnsense.mdx to import YouTube, Note, and Button
from the project's MDX/component modules (the canonical component exports used
across MDX files), then update any existing usages to rely on those imports
(symbols: YouTube, Note, Button) so the components render correctly.

---

Nitpick comments:
In `@src/pages/get-started/install/opnsense.mdx`:
- Line 26: Split the comma splice by replacing the comma after the backticked
`Plugins` with a period and start a new sentence (or use a semicolon and
lowercase the following word); update the fragment "`System` > `Firmware` >
`Plugins`, Make sure `Show community plugins` is checked..." to read either
"`System` > `Firmware` > `Plugins`. Make sure `Show community plugins` is
checked..." or "`System` > `Firmware` > `Plugins`; make sure `Show community
plugins` is checked..." and keep the rest of the instruction referencing the
`os-netbird` package unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2959613a-f897-438d-89b2-a598a06991ac

📥 Commits

Reviewing files that changed from the base of the PR and between a28e476 and cdb55ab.

📒 Files selected for processing (1)
  • src/pages/get-started/install/opnsense.mdx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant