Skip to content

Commit c8dcd72

Browse files
committed
Update README.md
1 parent 684a85e commit c8dcd72

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@
1212

1313
Join `OPNsense` with `Home Assistant`!
1414

15-
`hass-opnsense` uses the OPNsense [REST API](https://docs.opnsense.org/development/api.html) and built-in `xmlrpc` service to integrate OPNsense with Home Assistant.
16-
17-
__In most cases, a [plugin](#opnsense-plugin) is currently required to be installed on the <ins>OPNsense</ins> router for this to work properly.__
15+
`hass-opnsense` uses the OPNsense [REST API](https://docs.opnsense.org/development/api.html) to integrate OPNsense with Home Assistant.
1816

1917
A Discord server to discuss the integration is available, please click the Discord badge at the beginning of the page for the invite link.
2018

@@ -48,9 +46,12 @@ A Discord server to discuss the integration is available, please click the Disco
4846

4947
This integration **replaces** the built-in OPNsense integration which only provides `device_tracker` functionality. Be sure to remove any associated configuration for the built-in integration **before** installing this replacement.
5048

51-
In most cases, use of the integration requires a plugin installed on <ins>OPNsense</ins>.
49+
### OPNsense Plugin *(deprecated)*
50+
51+
With OPNsense Firmware of 26.1.1+, a plugin is no longer needed on the OPNsense Router.
5252

53-
### OPNsense Plugin
53+
<details>
54+
<summary><h4>OPNsense Firmware < 26.1.1</h4></summary>
5455

5556
In most cases, use of the integration requires an <ins>OPNsense</ins> plugin made available on mimugmail repository: `https://www.routerperformance.net/opnsense-repo/`. See [Granular Sync Options](#granular-sync-options) below for more details.
5657

@@ -73,6 +74,8 @@ OR
7374

7475
2. In an <ins>OPNsense</ins> SSH session: `pkg install os-homeassistant-maxit`
7576

77+
</details>
78+
7679
### HomeAssistant Integration
7780

7881
In Home Assistant, add this repository to the HACS installation or clone the directory manually.
@@ -120,8 +123,6 @@ Either at the time of install or in the integration options, Granular Sync Optio
120123

121124
* The <ins>OPNsense</ins> user can have more narrow permissions
122125

123-
* If a category that requires the <ins>OPNsense</ins> plugin isn't selected, the plugin on the <ins>OPNsense</ins> router isn't needed
124-
125126
At minimum, the following permissions are required. [The list of what other permissions are needed for the Granular Sync Options and for the Actions can be reviewed here.](granular_permissions.md)
126127

127128
* Lobby: Dashboard
@@ -192,11 +193,9 @@ Many entities are created by `hass-opnsense` for statistics etc. Due to the volu
192193

193194
All of the switches are disabled by default
194195

195-
* Filter Rules - enable/disable rules
196-
197-
* NAT Port Forward Rules - enable/disable rules
196+
* Firewall Rules - enable/disable rules
198197

199-
* NAT Outbound Rules - enable/disable rules
198+
* NAT Rules - enable/disable rules
200199

201200
* Services - start/stop services (services must be enabled before they can be started)
202201

0 commit comments

Comments
 (0)