Skip to content

Commit ec2fad7

Browse files
committed
Update Documentation
1 parent 684a85e commit ec2fad7

File tree

2 files changed

+34
-16
lines changed

2 files changed

+34
-16
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,17 @@
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.
15+
`hass-opnsense` uses the OPNsense [REST API](https://docs.opnsense.org/development/api.html) to integrate OPNsense with Home Assistant.
16+
17+
**With OPNsense Firmware 26.1.1+, a plugin is no longer needed on the OPNsense Router.**
1618

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.__
1819

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

2122
## Table of Contents
2223

2324
* [Installation](#installation)
24-
* [OPNsense Plugin](#opnsense-plugin)
25+
* [OPNsense Plugin (deprecated)](#opnsense-plugin)
2526
* [Home Assistant Integration](#homeassistant-integration)
2627
* [HACS Installation](#hacs-installation)
2728
* [Manual Installation](#manual-installation)
@@ -48,9 +49,12 @@ A Discord server to discuss the integration is available, please click the Disco
4849

4950
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.
5051

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

53-
### OPNsense Plugin
56+
<details>
57+
<summary><h4>OPNsense Firmware < 26.1.1</h4></summary>
5458

5559
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.
5660

@@ -73,6 +77,8 @@ OR
7377

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

80+
</details>
81+
7682
### HomeAssistant Integration
7783

7884
In Home Assistant, add this repository to the HACS installation or clone the directory manually.
@@ -116,20 +122,18 @@ In <ins>OPNsense</ins>, create a new admin role user (or choose an existing admi
116122

117123
### Granular Sync Options
118124

119-
Either at the time of install or in the integration options, Granular Sync Options can be enabled. There, choose the categories to sync with HA as desired. If enabled:
125+
Either at the time of install or in the integration options, Granular Sync Options can be enabled. There, choose the categories to sync with HA as desired. If enabled, the <ins>OPNsense</ins> user can have more narrow permissions.
120126

121-
* The <ins>OPNsense</ins> user can have more narrow permissions
122-
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-
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)
127+
At minimum, the following permissions are required:
126128

127129
* Lobby: Dashboard
128130

129131
* Status: Interfaces
130132

131133
* System: Firmware
132134

135+
[The list of what other permissions are needed for the Granular Sync Options and for the Actions can be reviewed here.](granular_permissions.md)
136+
133137
### Basic Configuration
134138

135139
| Option | Required | Default | Description |
@@ -192,11 +196,9 @@ Many entities are created by `hass-opnsense` for statistics etc. Due to the volu
192196

193197
All of the switches are disabled by default
194198

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

199-
* NAT Outbound Rules - enable/disable rules
201+
* NAT Rules - enable/disable rules
200202

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

granular_permissions.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,29 @@
5454
| Interfaces: Virtual IPs: Status | /api/diagnostics/interface/get_vip_status |
5555
| Interfaces: Virtual IPs: Settings | /api/interfaces/vip_settings/get |
5656

57-
## Firewall filter and NAT switches
57+
## Firewall rules and NAT rules switches
58+
59+
### OPNsense Firmware 26.1.1+
60+
61+
| OPNsense Permission | API Endpoints |
62+
| ----- | ----- |
63+
| Firewall: Rules [New] | /api/firewall/filter/search_rule<br>/api/firewall/filter/toggle_rule |
64+
| Firewall: NAT: Destination NAT | /api/firewall/d_nat/search_rule<br>/api/firewall/d_nat/toggle_rule |
65+
| Firewall: NAT: 1:1 | /api/firewall/one_to_one/search_rule<br>/api/firewall/one_to_one/toggle_rule |
66+
| Firewall: NAT: Source NAT | /api/firewall/source_nat/search_rule<br>/api/firewall/source_nat/toggle_rule |
67+
| Firewall: NAT: NPTv6 | /api/firewall/npt/search_rule<br>/api/firewall/npt/toggle_rule |
68+
69+
<details>
70+
<summary><h3>OPNsense Firmware < 26.1.1</h3></summary>
71+
5872
> **\*\*OPNsense plugin required\*\***
5973
6074
| OPNsense Permission | API Endpoints |
6175
| ----- | ----- |
6276
| XMLRPC Library | _N/A – Operations are executed using the XMLRPC interface and OPNsense plugin_ |
6377

78+
</details>
79+
6480
## Service switches
6581

6682
| OPNsense Permission | API Endpoints |

0 commit comments

Comments
 (0)