Skip to content

Update Documentation for Deprecating Plugin#490

Merged
Snuffy2 merged 1 commit intotravisghansen:mainfrom
Snuffy2:Update-documentation-for-deprecating-plugin
Feb 8, 2026
Merged

Update Documentation for Deprecating Plugin#490
Snuffy2 merged 1 commit intotravisghansen:mainfrom
Snuffy2:Update-documentation-for-deprecating-plugin

Conversation

@Snuffy2
Copy link
Collaborator

@Snuffy2 Snuffy2 commented Feb 7, 2026

This pull request updates the documentation to clarify that, starting with OPNsense Firmware 26.1.1, the integration no longer requires a plugin on the OPNsense router. The README and granular permissions documentation have been revised to reflect this change, deprecate the plugin requirement, and improve clarity around permissions and switch functionality.

Documentation updates for plugin deprecation and permissions:

  • Updated README.md to state that as of OPNsense Firmware 26.1.1+, a plugin is no longer needed, and marked the plugin as deprecated. Added clear sectioning to distinguish requirements for older firmware versions. [1] [2] [3]
  • Clarified the minimum permissions required for granular sync options, and improved the explanation for when the plugin is still needed on older firmware.
  • Updated switch descriptions to use consistent terminology ("Firewall Rules" and "NAT Rules") and simplified the list of available switches.
  • Enhanced granular_permissions.md to document new permissions and API endpoints available with OPNsense Firmware 26.1.1+, and clarified the plugin requirement for older versions.

Partially addresses #488

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 7, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 7, 2026

Coverage report

This PR does not seem to contain any modification to coverable code.

@Snuffy2 Snuffy2 force-pushed the Update-documentation-for-deprecating-plugin branch from c8dcd72 to 77307bf Compare February 7, 2026 01:20
@travisghansen
Copy link
Owner

Congrats on getting the plugin requirement removed. That’s a huge milestone!

@Snuffy2 Snuffy2 force-pushed the Update-documentation-for-deprecating-plugin branch from e90cf64 to 17ddbc6 Compare February 7, 2026 01:26
@Snuffy2 Snuffy2 force-pushed the Update-documentation-for-deprecating-plugin branch from 17ddbc6 to ec2fad7 Compare February 7, 2026 01:32
@Snuffy2 Snuffy2 marked this pull request as ready for review February 7, 2026 03:25
@Snuffy2 Snuffy2 merged commit 6a38f2c into travisghansen:main Feb 8, 2026
6 checks passed
@Snuffy2 Snuffy2 deleted the Update-documentation-for-deprecating-plugin branch February 8, 2026 01:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants