mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 01:26:11 -08:00
46 lines
2.4 KiB
Markdown
Executable File
46 lines
2.4 KiB
Markdown
Executable File
# Integration with PiHole
|
|
|
|
NetAlertX comes with 2 plugins suitable for integarting with your existing PiHole instace. One plugin is using a direct SQLite DB connection, the other leverages the DHCP.leases file generated by PiHole. You can combine both approaches and also supplement it with other [plugins](/docs/PLUGINS.md).
|
|
|
|
## Approach 1: `DHCPLSS` Plugin - Import devices from the PiHole DHCP leases file
|
|
|
|
|
|
|
|
### Settings
|
|
|
|
| Setting | Description | Recommended value |
|
|
| :------------- | :------------- | :-------------|
|
|
| `DHCPLSS_RUN` | When the plugin should run. | `schedule` |
|
|
| `DHCPLSS_RUN_SCHD` | If you run multiple device scanner plugins, align the schedules of all plugins to the same value. | `*/5 * * * *` |
|
|
| `DHCPLSS_paths_to_check` | You need to map the value in this setting in the `docker-compose.yml` file. The in-container path must contain `pihole` so it's parsed correctly. | `['/etc/pihole/dhcp.leases']` |
|
|
|
|
Check the [DHCPLSS plugin readme](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/dhcp_leases#overview) for details
|
|
|
|
### docker-compose changes
|
|
|
|
| Path | Description |
|
|
| :------------- | :------------- |
|
|
| `:/etc/pihole/dhcp.leases` | PiHole's `dhcp.leases` file. Required if you want to use PiHole `dhcp.leases` file. This has to be matched with a corresponding `DHCPLSS_paths_to_check` setting entry (the path in the container must contain `pihole`) |
|
|
|
|
|
|
## Approach 2: `PIHOLE` Plugin - Import devices directly from the PiHole database
|
|
|
|
|
|
|
|
| Setting | Description | Recommended value |
|
|
| :------------- | :------------- | :-------------|
|
|
| `PIHOLE_RUN` | When the plugin should run. | `schedule` |
|
|
| `PIHOLE_RUN_SCHD` | If you run multiple device scanner plugins, align the schedules of all plugins to the same value. | `*/5 * * * *` |
|
|
| `PIHOLE_DB_PATH` | You need to map the value in this setting in the `docker-compose.yml` file. | `/etc/pihole/pihole-FTL.db` |
|
|
|
|
Check the [PiHole plugin readme](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/pihole_scan) for details
|
|
|
|
### docker-compose changes
|
|
|
|
| Path | Description |
|
|
| :------------- | :------------- |
|
|
| `:/etc/pihole/pihole-FTL.db` | PiHole's `pihole-FTL.db` database file. |
|
|
|
|
|
|
Check out other [plugins](/docs/PLUGINS.md) that can help you discover more about your network or check how to scan [Remote networks](./REMOTE_NETWORKS.md).
|