|
12 | 12 |
|
13 | 13 | Join `OPNsense` with `Home Assistant`! |
14 | 14 |
|
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. |
18 | 16 |
|
19 | 17 | A Discord server to discuss the integration is available, please click the Discord badge at the beginning of the page for the invite link. |
20 | 18 |
|
@@ -48,9 +46,12 @@ A Discord server to discuss the integration is available, please click the Disco |
48 | 46 |
|
49 | 47 | 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. |
50 | 48 |
|
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. |
52 | 52 |
|
53 | | -### OPNsense Plugin |
| 53 | +<details> |
| 54 | +<summary><h4>OPNsense Firmware < 26.1.1</h4></summary> |
54 | 55 |
|
55 | 56 | 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. |
56 | 57 |
|
|
73 | 74 |
|
74 | 75 | 2. In an <ins>OPNsense</ins> SSH session: `pkg install os-homeassistant-maxit` |
75 | 76 |
|
| 77 | +</details> |
| 78 | + |
76 | 79 | ### HomeAssistant Integration |
77 | 80 |
|
78 | 81 | 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 |
120 | 123 |
|
121 | 124 | * The <ins>OPNsense</ins> user can have more narrow permissions |
122 | 125 |
|
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 | | - |
125 | 126 | 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) |
126 | 127 |
|
127 | 128 | * Lobby: Dashboard |
@@ -192,11 +193,9 @@ Many entities are created by `hass-opnsense` for statistics etc. Due to the volu |
192 | 193 |
|
193 | 194 | All of the switches are disabled by default |
194 | 195 |
|
195 | | -* Filter Rules - enable/disable rules |
196 | | - |
197 | | -* NAT Port Forward Rules - enable/disable rules |
| 196 | +* Firewall Rules - enable/disable rules |
198 | 197 |
|
199 | | -* NAT Outbound Rules - enable/disable rules |
| 198 | +* NAT Rules - enable/disable rules |
200 | 199 |
|
201 | 200 | * Services - start/stop services (services must be enabled before they can be started) |
202 | 201 |
|
|
0 commit comments