Merge pull request #536 from leiweibau/next_update

Next update

Author: leiweibau

back/pialert.py

@@ -201,6 +201,7 @@ PFSENSE_ACTIVE            = False
 PFSENSE_IP                = '192.168.1.1'
 PFSENSE_APIKEY            = ''
 PFSENSE_SSL               = False
+PFSENSE_EXCLUDE_INT       = ['WAN']
 
 # Satellite Configuration
 # -----------------------

config/pialert.conf

@@ -1,3 +1,3 @@
 VERSION           = ''
 VERSION_YEAR      = '2025'
-VERSION_DATE      = '2025-10-18'
+VERSION_DATE      = '2025-10-31'

config/version.conf

@@ -44,7 +44,7 @@ sends the results to a previously configured Pi.Alert instance. These satellites
 The "**4**" (🟪) is a link to the “docs” path in this repository
 
 
-[Next - Discreet buttons and menus](./guide/001.md)
+[Next (2) - Discreet buttons and menus](./guide/001.md)
 
 [Back to Readme](https://github.com/leiweibau/Pi.Alert)
 

docs/FIRST_START_GUIDE.md

@@ -247,7 +247,7 @@ I would like to give a short explanation to the individual points.
 | OPENWRT_PASS   | Password                                                                                                                                                                                          |
 
 
-#### :eight_spoked_asterisk: Asus Router Configuration
+#### :eight_spoked_asterisk: Asus Configuration
 
 | Option         | Description |
 |----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -258,6 +258,16 @@ I would like to give a short explanation to the individual points.
 | ASUSWRT_SSL    | Is https is True or False?                                                                                                                                                                        |
 
 
+#### :eight_spoked_asterisk: pfsense Configuration
+
+| Option              | Description |
+|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| PFSENSE_ACTIVE      | Enables the import of pfSense. To do this, the REST API must be installed in pfSense. You can find more details here: [pfSense REST API](https://pfrest.org/). The API is used to import the DHCP leases and the ARP table from pfSense. |
+| PFSENSE_IP          | IP address of the pfSense Firewall.                                                                                                                                                                                                      |
+| PFSENSE_APIKEY      | The API key that was created after installing the API in pfSense under ‘System’ -> ‘REST API’ -> 'Keys'                                                                                                                                  |
+| PFSENSE_SSL         | Is https is True or False?                                                                                                                                                                                                               |
+| PFSENSE_EXCLUDE_INT | Interfaces that should be ignored during import                                                                                                                                                                                          |
+
 #### :eight_spoked_asterisk: Satellite Configuration
 
 | Option               | Description |

docs/PIALERT_CONF.md

@@ -46,9 +46,9 @@ In addition to the individual "Delete" button, each report also has a button to
 the report (System Event, Device Scan, Web Service Monitoring, ICMP Monitoring)
 
 
-[Next - Settings](./002.md)
+[Next (3) - Settings](./002.md)
 
-[Back - Guide for the first start](../FIRST_START_GUIDE.md)
+[Back (1) - Guide for the first start](../FIRST_START_GUIDE.md)
 
 [Guide_002]:             https://raw.githubusercontent.com/leiweibau/Pi.Alert/assets/guide_002.png         "Guide_002"
 [Guide_003]:             https://raw.githubusercontent.com/leiweibau/Pi.Alert/assets/guide_003.png         "Guide_003"

docs/guide/001.md

@@ -45,9 +45,9 @@ In addition to section 4, this section contains the actual settings. This area i
 
 Here you can edit the pialert.conf file. You can look up an overview of the parameters on the "Help / FAQ" page (*Explanations for the file "pialert.conf"*) in Pi.Alert.
 
-[Next - Additional documents](./003.md)
+[Next (4) - Additional information about imports](./003.md)
 
-[Back - Discreet buttons and menus](./001.md)
+[Back (2) - Discreet buttons and menus](./001.md)
 
 [Guide_005]:             https://raw.githubusercontent.com/leiweibau/Pi.Alert/assets/guide_005.png         "Guide_005"
 

docs/guide/002.md

@@ -1,17 +1,71 @@
-# Additional documents
+# Additional information about imports
 <!--- --------------------------------------------------------------------- --->
 
-[Bulk Editor](../BULKEDITOR.md)
-  
-[Network Relationship](../NETWORK_RELATIONSHIP.md)
-  
-[Web service monitoring](../WEBSERVICES.md)
-  
-[Satellite Config](../SATELLITES.md)
+### Pi-hole DNS (v5 or v6) ###
 
+To use this feature, Pi.Alert requires the password for Pi-hole. During this import, an active host is recognized by 
+the fact that it has sent a DNS query to Pi-hole within the last 5 minutes. If the time of the last query was longer ago, 
+the host is marked as inactive or added to the device list as an inactive new host. In isolated cases, 
+Pi.Alert may repeatedly recognize a host despite it having been deleted, even though the host has long since ceased to exist. When using this importer, 
+the problem may also lie with Pi-hole. The maximum number of clients to be imported can also be specified in the configuration. 
+By default, this value is set to “100” and must be adjusted if necessary.
 
+### Pi-hole DHCP. (v5 or v6) ###
 
-[Back - Settings](./002.md)
+To use this feature, Pi.Alert requires the password for Pi-hole. This list is primarily used for name resolution.
+
+### Fritzbox ###
+
+To use this feature, the Fritzbox must be configured to use a username and password. 
+Since multiple users can be created on the Fritzbox, you can also create a separate account for Pi-Alert. The import queries all active hosts. 
+These can be located in the guest Wi-Fi or in the standard Wi-Fi. IP-less devices such as the Fritz Powerline adapters are also detected here.
+
+### Mikrotik ###
+
+Pi.Alert requires a user name and password for this function. During import, the active hosts are collected from the DCHP server.
+
+### UniFi ###
+
+Pi.Alert requires a user name and password for this function. Active hosts are collected during import.
+
+### OpenWRT ###
+
+Pi.Alert requires a user name and password for this function. In addition, the “JSON-RPC” package ([link](https://github.com/openwrt/luci/wiki/JsonRpcHowTo)) must be installed on the OpenWRT device.
+The active hosts are recorded during import.
+
+### AsusWRT ###
+
+Pi.Alert requires a user name and password for this function. Active hosts are collected during import.
+
+### pfSense ###
+
+Pi.Alert requires an API key for this function. This can be generated after installing the “pfSense REST API” ([link](https://pfrest.org/)) on the pfSense firewall.
+To increase the speed at which inactive hosts are detected, I changed another setting within pfSense:
+
+```
+System → Advanced → System Tunables
+
+Click on "Add"
+
+Insert:
+    Tunable: net.link.ether.inet.max_age
+    Value: e.g. 600
+```
+
+The background here is how long an entry in the pfSense ARP table is valid, i.e., how long a host is flagged as “active” by pfSense. This also affects the marking of active hosts in the DHCP leases.
+When importing from pfSense, all DHCP leases are imported and the active hosts are also marked as active by Pi.Alert. In addition, the hosts from the pfSense ARP table are also imported, which can include all interfaces,
+even those that are not managed by a DHCP server. This means that hosts may also be detected on the “WAN” interface. For this reason, this interface is excluded by default in the Pi.Alert configuration.
+
+
+## Satellite Scan ## 
+
+arp-scan, Pi-hole DNS, Pi-hole DHCP, Mikrotik, UniFi, OpenWRT, AsusWRT
+
+
+
+[Next (5) - Additional documents](./004.md)
+
+[Back (3) - Settings](./002.md)
 
 [Guide_005]:             https://raw.githubusercontent.com/leiweibau/Pi.Alert/assets/guide_005.png         "Guide_005"
 

docs/guide/003.md

@@ -0,0 +1,20 @@
+# Additional documents
+<!--- --------------------------------------------------------------------- --->
+
+[Bulk Editor](../BULKEDITOR.md)
+  
+[Network Relationship](../NETWORK_RELATIONSHIP.md)
+  
+[Web service monitoring](../WEBSERVICES.md)
+  
+[Satellite Config](../SATELLITES.md)
+
+
+
+[Back (4) - Additional information about imports](./002.md)
+
+[Guide_005]:             https://raw.githubusercontent.com/leiweibau/Pi.Alert/assets/guide_005.png         "Guide_005"
+
+
+
+