Einstellung

If enabled an email is sent out with a list of changes you've subscribed to. Please also fill out all remaining settings related to the SMTP setup below. If facing issues, set LOG_LEVEL to debug and check the error log.

The SMTP server host URL. For example smtp-relay.sendinblue.com. To use Gmail as an SMTP server follow this guide

Port number used for the SMTP connection. Set to 0 if you don't want to use a port when connecting to the SMTP server.

Email address to which the notification will be send to.

Notification email subject line. Some SMTP servers need this to be an email.

Don't use authentication when connecting to the SMTP server.

The user name used to login into the SMTP server (sometimes a full email address).

The SMTP server password.

Disable TLS when connecting to your SMTP server.

Force SSL when connecting to your SMTP server.

Enable webhooks for notifications. Webhooks help you to connect to a lot of 3rd party tools, such as IFTTT, Zapier or n8n to name a few. Check out this simple n8n guide here to get started. If enabled, configure related settings below.

Target URL starting with http:// or https://.

The Webhook payload data format for the body > attachments > text attribute in the payload json. See an example of the payload here. (e.g.: for discord use text)

The HTTP request method to be used for the webhook call.

The maximum size of the webhook payload as number of characters in the passed string. If above limit, it will be truncated and a (text was truncated) message is appended.

Enable sending notifications via Apprise.

Apprise host URL starting with http:// or https://. (don't forget to include /notify at the end)

Apprise notification target URL. For example for Telegram it would be tgram://{bot_token}/{chat_id}.

Select the payoad type sent to Apprise. For example html works well with emails, text with chat apps, such as Telegram.

Enable sending notifications via NTFY.

NTFY host URL starting with http:// or https://. You can use the hosted instance on https://ntfy.sh by simply entering https://ntfy.sh.

Your secret topic.

Enter user if you need (host) an instance with enabled authetication.

Enter password if you need (host) an instance with enabled authetication.

Enable sending notifications via Pushsafer.

Your secret Pushsafer API key (token).

Enable sending notifications via MQTT to your Home Assistance instance.

MQTT host URL (don't include http:// or https://).

Port number where the broker is listening. Usually 1883.

User name used to login into your MQTT broker instance.

Password used to login into your MQTT broker instance.

Quality of service setting for MQTT message sending. 0 - Low quality to 2 - High quality. The higher the quality the longer the delay.

A little hack - delay adding to the queue in case the process is restarted and previous publish processes aborted (it takes ~2s to update a sensor config on the broker). Tested with 2-3 seconds of delay. This delay is only applied when devices are created (during the first notification loop). It doesn't affect subsequent scans or notifications.

Update URL starting with http:// or https://.

You need to map:/etc/pihole/pihole-FTL.db in the docker-compose.yml file if you enable this setting.

You need to map :/etc/pihole/dhcp.leases in the docker-compose.yml file if you enable this setting.

Pholus is a sniffing tool to discover additional information about the devices on the network, including the device name. If enabled this will execute the scan before every network scan cycle until there are no (unknown) or (name not found) devices. Please be aware it can spam the network with unnecessary traffic. Depends on the SCAN_SUBNETS setting. For a scheduled or one-off scan, check the PHOLUS_RUN setting.

How long in seconds should Pholus be sniffing on each interface if above condition is fulfilled. The longer you leave it on, the more likely devices would broadcast more info. This timeout adds to the time it takes to perform an arp-scan on your network.

Force scan every network scan, even if there are no (unknown) or (name not found) devices. Be careful enabling this as the sniffing can easily flood your network.

Enable a regular Pholus scan / sniff on your network. The scheduling settings can be found below. If you select once Pholus is run only once on start for the time specified in PHOLUS_RUN_TIMEOUT setting.

The timeout in seconds for the scheduled Pholus scan. Same notes regarding the duration apply as on the PHOLUS_TIMEOUT setting. A scheduled scan doesn't check if there are (unknown) or (name not found) devices, the scan is executed either way.

Only enabled if you select schedule in the PHOLUS_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes.

How many days of Pholus scan entries should be kept (globally, not device specific!) Enter 0 to disable.

If enabled this will execute a scan on a newly found device. For a scheduled or one-off scan, check the NMAP_RUN setting.

Maximum time in seconds to wait for an Nmap scan to finish on any device.

Enable a regular Nmap scan on your network on all devices. The scheduling settings can be found below. If you select once Nmap is run only once on start for the time specified in NMAP_TIMEOUT setting.

Only enabled if you select schedule in the NMAP_RUN setting. Make sure you enter the schedule in the correct cron-like format.

Arguments used to run the Nmap scan. Be careful to specify the arguments correctly. For example -p -10000 scans ports from 1 to 10000.

You can specify a custom SQL query which will generate a JSON file and then expose it via the table_custom_endpoint.json file endpoint.

When enabled, ONCE is the preferred option. It runs at startup and after every save of the config here.
Changes will only show in the devices after the next scan!

Command to run. This can not be changed

Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted.

Undiscoverable Devices can not change their status, no watch is enabled.

No notifications will be sent.

Devices to be added to the devices list.

Specify when the SQL query is executed.

This SQL query is used to populate the coresponding UI tables under the Plugins section.

Only enabled if you select schedule in the NMAPSRV_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes.

Send a notification if selected values change. Use CTRL + Click to select/deselect.

• Watched_Value1 is service type (e.g.: http, ssh)
• Watched_Value2 is Status (open or closed)
• Watched_Value3 unused
• Watched_Value4 unused

Send a notification only on these statuses. new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. watched-changed means that selected Watched_ValueN columns changed.

Enable import of devices from dhcp.leases files. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) or after you update your settings.

Command to run

Add all dhcp.leases mapped paths to watch. Enter full path within the container, e.g. /mnt/dhcp2.leases. You must map these files accordingly in your docker-compose.yml file.

Only enabled if you select schedule in the DHCPLSS_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes.

Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted.

Send a notification if selected values change. Use CTRL + Click to select/deselect.

• Watched_Value1 is Active
• Watched_Value2 is Hostname
• Watched_Value3 is hardware
• Watched_Value4 is State

Send a notification only on these statuses. new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. watched-changed means that selected Watched_ValueN columns changed.

Enable a regular scan of your services. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) for the time specified in WEBMON_RUN_TIMEOUT setting.

Command to run

Only enabled if you select schedule in the WEBMON_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes.

You can specify a custom SQL query which will generate a JSON file and then expose it via the plugin_website_monitor.json file endpoint.

Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted.

Send a notification if selected values change. Use CTRL + Click to select/deselect.

• Watched_Value1 is response status code (e.g.: 200, 404)
• Watched_Value2 is Latency (not recommended)
• Watched_Value3 unused
• Watched_Value4 unused

Send a notification only on these statuses. new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. watched-changed means that selected Watched_ValueN columns changed.

Services to watch. Enter full URL, e.g. https://google.com. The values from this setting will be used to replace the {urls} wildcard in the WEBMON_CMD setting.

Unused setting - for demonstration only. Getting the IP address of the Router / Internet.

Enable import of devices from a SNMP enabled device. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) or after you update your settings.

Command to run. Not recommended to change.

A list of snmpwalk commands to execute against IP addresses of roputers/switches with SNMP turned on.

Example with the router on the IP 192.168.1.1:
snmpwalk -v 2c -c public -OXsq 192.168.1.1 .1.3.6.1.2.1.3.1.1.2

Only IPv4 supported. Authentication is not supported. More info on the plugin here.

Only enabled if you select schedule in the SNMPDSC_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes.

Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted.

Send a notification if selected values change. Use CTRL + Click to select/deselect.

• Watched_Value1 is Hostname (not discoverable)
• Watched_Value2 is Router IP
• Watched_Value3 is not used
• Watched_Value4 is not used

Send a notification only on these statuses. new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. watched-changed means that selected Watched_ValueN columns changed.

Enable a regular scan of rogue DHCP servers. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) or after you update your settings.

Command to run

Only enabled if you select schedule in the DHCPSRVS_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes.

Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted.

Send a notification if selected values change. Use CTRL + Click to select/deselect.

• Watched_Value1 is Domain Name Server
• Watched_Value2 is IP Offered
• Watched_Value3 is Interface
• Watched_Value4 is Router

Send a notification only on these statuses. new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. watched-changed means that selected Watched_ValueN columns changed.

Enable import of devices from a UNIFI controller. If you select schedule the scheduling settings from below are applied. If you select once the scan is run only once on start of the application (container) or after you update your settings.

Command to run. Not recommended to change.

The username used to login into your UNIFI controller. It is recommended to create a read-only user account.

The password used to login into your UNIFI controller.

The protocol to use to access the controller.

The host (IP) where the UNIFI controller is runnig. Do NOT include the protocol (e.g. https://)

The port number where the UNIFI controller is runnig. Usually it is 8443.

The base version of the Unify controller API. Supported values as of time of writing are v4|v5|unifiOS|UDMP-unifiOS.

The sites you want to connect to. Usually it is only one and the name is default. Check the URL in your UniFi controller UI if unsure.

Only enabled if you select schedule in the UNFIMP_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering 0 4 * * * will run the scan after 4 am in the TIMEZONE you set above. Will be run NEXT time the time passes.

Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted.

Send a notification if selected values change. Use CTRL + Click to select/deselect.

• Watched_Value1 is Hostname
• Watched_Value2 is Vendor
• Watched_Value3 is Type
• Watched_Value4 is Network

Send a notification only on these statuses. new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered. watched-changed means that selected Watched_ValueN columns changed.

The MAC address of the device. Uneditable - Autodetected.

The name of the device. Uneditable as internal functionality is dependent on specific new device names.

The owner of the device.

The type of the device.

The vendor of the device. Uneditable - Autodetected.

Indicates whether the device is marked as a favorite.

The group to which the device belongs.

Additional comments or notes about the device.

The date and time of the first connection with the device. Uneditable - Autodetected.

The date and time of the last connection with the device. Uneditable - Autodetected.

The last known IP address of the device. Uneditable - Autodetected.

Indicates whether the device has a static IP address.

The default value of the Scan device dropdown. Enable if newly discovered devices should be scanned.

Indicates whether events related to the device shouldbe logged.

Indicates whether events related to the device should trigger alerts. The default value of the Alert All Events checkbox.

Indicates whether an alert should be triggered when the device goes down. The default value of the Alert Down checkbox.

The default value of the Skip repeated notifications for dropdown. Enter number of hours for which repeated notifications should be ignored for. If you enter 0 then you get notified on all events.

The date and time of the last notification sent for the device. Uneditable - Autodetected.

Indicates whether the device should be marked as present after detected in a scan.

Indicates whether the device is considered a new device. The default value of the New Device checkbox.

The location of the device.

Indicates whether the device is archived. The default value of the Archived checkbox.

The MAC address of the network node.

The port number of the network node. Uneditable.

The icon associated with the device. Check the documentation on icons for more details.