search

leiweibau / Pi.Alert

Scan the devices connected to your WIFI / LAN and alert you the connection of unknown devices. It also warns if a "always connected" device disconnects. In addition, it is possible to check web services for availability. For this purpose HTTP status codes and the response time of the service are evaluated.
https://leiweibau.net
GNU General Public License v3.0
334 stars 25 forks source link

[Documentation] List of all settings? #301

Closed TheCableGuy99 closed 1 month ago

TheCableGuy99 commented 2 months ago

Hi,

I was going through the pi.alert config and just wondering what some of the settings were and what to put in some of the fields.

For example just one of them is pushover:

Pushover

----------------------

REPORT_PUSHOVER = False REPORT_PUSHOVER_WEBMON = False PUSHOVER_TOKEN = ''" PUSHOVER_USER = ''"

I know what some of the settings should be but no idea on others like "REPORT_PUSHOVER_WEBMON" or "PUSHOVER_USER" (should this be my email address?).

Another is:

Special Protocol Scanning

----------------------

SCAN_ROGUE_DHCP = True DHCP_SERVER_ADDRESS = ''

Does this only work with some DHCP servers or all?

I'm just wondering if there's a page with all settings explained and what to put in each field because I cannot find one and it would be helpful? Especially as new features are added?

Thanks.

leiweibau commented 2 months ago

Yes, this page exists: Help/FAQ. It is not quite complete, but most of it is there.

Does this only work with some DHCP servers or all?

At the moment, only one DHCP is supported

TheCableGuy99 commented 2 months ago

ahhh how silly of me, I was checking on here rather than on the website. I'll take a look but if in a future update it could be brought up to date I'd really appreciate it (as you said it's not all there). If there's any way I can help I'd be happy to.

By the way... I've just had an idea regarding my previous ticket: https://github.com/leiweibau/Pi.Alert/issues/297

I suggested this because I said there was no way of knowing which AP a device might be connected to. But would it be possible to identify which AP it's connected to and it show wireless devices connected to the relevant AP if using the Ubiquiti API feature? The console knows so i'm guessing there's a way to do this?

Thanks as always :)

leiweibau commented 1 month ago

Is marked here (https://github.com/leiweibau/Pi.Alert/issues/312) as a topic to be documented.