In this configuration file many functions of Pi.Alert can be set according to the personal wishes. Since the possibilities are various,
I would like to give a short explanation to the individual points.
| Option | Description |
|---|
| PIALERT_PATH | This variable is set during installation and should not be changed. |
| DB_PATH | This variable is set during installation and should not be changed. |
| LOG_PATH | This variable is set during installation and should not be changed. |
| PRINT_LOG | If this entry is set to True, additional timestamps for the individual sub-functions are added to the scan log. By default this entry is set to False |
| VENDORS_DB | This variable is set during installation and should not be changed. |
| PIALERT_APIKEY | With the API key it is possible to make queries to the database without using the web page. The API key is a random string that can be set via the settings or via pialert-cli |
| PIALERT_WEB_PROTECTION | Enables or disables the password protection of the Pi.Alert web interface. |
| PIALERT_WEB_PASSWORD | This field contains the hashed password for the web interface. The password cannot be entered here in plain text, but must be set with pialert-cli |
| NETWORK_DNS_SERVER | IP address of the DNS server in the network. This entry is required to attempt to resolve a hostname in the network. |
| AUTO_UPDATE_CHECK | Enables or disables automatic search for Pi.Alert updates. |
| AUTO_DB_BACKUP | Enables or disables automatic creation of database and configuration backups. |
| AUTO_DB_BACKUP_KEEP | This specifies how many automatic backups should be retained, including the current backup. This includes both configuration backups and database backup. This value is not relevant during manual cleanup, where the last 3 backups are retained. |
| REPORT_NEW_CONTINUOUS | Enables or disables the recurring notification for devices marked as "New". |
| NEW_DEVICE_PRESET_EVENTS | Enables or disables the notification for all events on new devices. |
| NEW_DEVICE_PRESET_DOWN | Enables or disables the notification for "Down" events on new devices. |
| SYSTEM_TIMEZONE | If a time zone has already been set in php.ini, this will of course be used. If no time zone is set, i.e. PHP uses "UTC", then the time zone stored in pialert.conf is applied. PHP Timezones |
| OFFLINE_MODE | After the installation and the initial test of all script components, the offline mode can be configured to prevent any communication with the Internet |
| Option | Description |
|---|
| SCAN_WEBSERVICES | Here the function for monitoring web services can be switched on (True) or off (False) |
| ICMPSCAN_ACTIVE | ICMP Monitoring on/off |
| SATELLITES_ACTIVE | Enable the Satellite management and import function. One or more companion scripts can perform remote scans and send them to the central Pi.Alert instance. |
| Option | Description |
|---|
| SCAN_ROGUE_DHCP | Activates the search for foreign, also called "rogue", DHCP servers. This function is used to detect whether there is a foreign DHCP server in the network that could take control of IP management. |
| DHCP_SERVER_ADDRESS | The IP of the known DHCP server is stored here. A list of DHCP servers is also supported |
| Option | Description |
|---|
| AUTO_UPDATE_CHECK_CRON | Interval, in crontab syntax, at which to search for new updates from Pi.Alert. The shortest interval is 3 minutes. All larger intervals must be an integer multiples of 3 minutes (15, 30, 36, etc). |
| AUTO_DB_BACKUP_CRON | Interval, in crontab syntax, at which the automatic backups should be created. The shortest interval is 3 minutes. All larger intervals must be aninteger multiples of 3 minutes (15, 30, 36, etc). |
| REPORT_NEW_CONTINUOUS_CRON | Interval, in Crontab syntax, at which notifications should be sent repeatedly. The shortest interval is 3 minutes. All larger intervals must be an integer multiple of 3 minutes (15, 30, 36, etc.). |
| SPEEDTEST_TASK_CRON | Full hour, or comma-separated hours, at which the speed test is to be started. The shortest interval is 3 minutes. All larger intervals must be integer multiples of 3 minutes (15, 30, 36, etc). |
| Option | Description |
|---|
| SMTP_SERVER | Address of the e-mail server (e.g. smtp.gmail.com) |
| SMTP_PORT | The port of the SMTP server. The port may vary depending on the server configuration. |
| SMTP_USER | User name used to authenticate with the SMTP server. |
| SMTP_PASS | Password used to authenticate with the SMTP server. |
| SMTP_SKIP_TLS | If this entry is set to True, transport encryption of the e-mail is enabled. If the server does not support this, the entry must be set to False. |
| SMTP_SKIP_LOGIN | There are SMTP servers which do not require a login. In such a case, this value can be set to True. |
| Option | Description |
|---|
| REPORT_WEBGUI | Enables/disables the notifications about changes in the network in the web interface. |
| REPORT_WEBGUI_WEBMON | Enables/disables the notifications about changes in the monitored web services in the web interface. |
| REPORT_TO_ARCHIVE | Number of hours after which a report is moved to the archive. The value 0 disables the feature |
| Option | Description |
|---|
| REPORT_TO_MQTT | General activation/deactivation of the MQTT function. |
| REPORT_MQTT_BROKER | The IP or host name of the MQTT server/broker. The URL scheme "mqtt://" is not supported as input and must be removed. |
| REPORT_MQTT_PORT | The port under which the MQTT server can be accessed. The standard MQTT port is 1883. If SSL/TLS is used, 8883 is usually used. |
| REPORT_MQTT_USERNAME | Username for logging in to the MQTT server. If no authentication is used, leave this field blank. |
| REPORT_MQTT_PASSWORD | Password for logging in to the MQTT server. If no authentication is used, leave this field blank. |
| REPORT_MQTT_TLS | Enable or disable SSL/TLS. |
| PUBLISH_MQTT_STATUS | Activation or deactivation of general information about the Pi.Alert installation. The following sensors are created: “Pi.Alert Status”, “Pi.Alert local”, “Pi.Alert <Satellite Name>” |
| Option | Description |
|---|
| REPORT_MAIL | Enables/disables the notifications about changes in the network via e-mail. |
| REPORT_MAIL_WEBMON | Enables/disables the notification of changes in the monitored web services by e-mail. |
| REPORT_FROM | Name or identifier of the sender. |
| REPORT_TO | E-mail address to which the notification should be sent. |
| REPORT_DEVICE_URL | URL of the Pi.Alert installation to create a clickable link in the e-mail to the detected device. |
| REPORT_DASHBOARD_URL | URL of the Pi.Alert installation, to be able to create a clickable link in the e-mail. |
| Option | Description |
|---|
| REPORT_PUSHSAFER | Enables/disables notifications about changes in the network via Pushsafer. |
| REPORT_PUSHSAFER_WEBMON | Enables/disables notifications about changes in the monitored web services via Pushsafer. |
| PUSHSAFER_TOKEN | This is the private key that can be viewed on the pushsafer page. |
| PUSHSAFER_DEVICE | The device ID to which the message will be sent. ‘a’ means the message will be sent to all configuring devices and will consume a corresponding number of API calls. |
| PUSHSAFER_PRIO | Priority level of the message. |
| PUSHSAFER_SOUND | Notification sound (integer). |
| Option | Description |
|---|
| REPORT_PUSHOVER | Enables/disables notifications about changes in the network via Pushover. |
| REPORT_PUSHOVER_WEBMON | Enables/disables the notifications about changes in the monitored web services via Pushover. |
| PUSHOVER_TOKEN | Also called "APP TOKEN" or "API TOKEN". This token can be queried on the pushover page. |
| PUSHOVER_USER | Also called "USER KEY". This key is displayed right after login on the start page. |
| PUSHOVER_PRIO | Priority level of the message. |
| PUSHOVER_SOUND | Notification sound. |
| Option | Description |
|---|
| REPORT_NTFY | Enables/Disables notifications about changes in the network via NTFY |
| REPORT_NTFY_WEBMON | Enables/Disables notifications about changes in monitored web services via NTFY |
| NTFY_HOST | The hostname or IP address of the NTFY server. |
| NTFY_TOPIC | The subject of notifications sent via NTFY. |
| NTFY_USER | The username used for authentication with the NTFY server. |
| NTFY_PASSWORD | The password used for authentication with the NTFY server. |
| NTFY_PRIORITY | Priority of notifications sent via NTFY |
| NTFY_CLICKABLE | Enables or disables the click action for the notification. |
:exclamation: If you want to use a token instead of username and password, leave the username blank and use the token as the password.
| Option | Description |
|---|
| SHOUTRRR_BINARY | Here you have to configure which binary of shoutrrr has to be used. This depends on the hardware Pi.Alert was installed on. |
| Option | Description |
|---|
| REPORT_TELEGRAM | Enables/disables the notifications about changes in the network via Telegram |
| REPORT_TELEGRAM_WEBMON | Enables/disables the notifications about changes in the monitored web services via Telegram |
| TELEGRAM_BOT_TOKEN_URL | Here the URL created by the shoutrrr setup wizard is entered. |
| Option | Description |
|---|
| REPORT_DISCORD | Enables/disables notifications about network changes via Discord. |
| REPORT_DISCORD_WEBMON | Enables/disables notifications about monitored web service changes via Discord. |
| DISCORD_BOT_TOKEN_URL | The Discord webhook URL used to send the notification. |
| Option | Description |
|---|
| QUERY_MYIP_SERVER | Server URL that determines and returns the current public IP. |
| QUERY_MYIP_SERVER_FALLBACK | Fallback server URL used when the primary public IP lookup fails. |
| DDNS_ACTIVE | Enables/Disables the configured DDNS service in Pi.Alert. DDNS, also known as DynDNS, allows a domain name to be updated with a regularly changing IP address. This service is provided by various providers. |
| DDNS_DOMAIN | Domain name or host name that should be updated by the configured DDNS provider. |
| DDNS_USER | User name used to authenticate with the DDNS provider. |
| DDNS_PASSWORD | Password used to authenticate with the DDNS provider. |
| DDNS_UPDATE_URL | Provider-specific update URL used to send the current public IP to the DDNS service. |
| Option | Description |
|---|
| SPEEDTEST_TASK_ACTIVE | Activate/deactivate the automatic speed test. This requires the installation of the Ookla speed test in the "Tools" tab of the "Internet" device. Follow the instructions during installation. |
| Option | Description |
|---|
| MAC_IGNORE_LIST | ['MAC-Address 1', 'MAC-Address 2']
This MAC address(es) (save with small letters) will be filtered out from the scan results. It is also possible to specify only the beginning of a MAC address. All addresses with the same prefix will also be filtered out |
| IP_IGNORE_LIST | ['IP-Address 1', 'IP-Address 2']
This IP address(es) will be filtered out from the scan results. It is also possible to specify only the beginning of a IP address. All addresses with the same prefix will also be filtered out. A syntax such as “172.17.0.0/24” does not lead to success. In this case, use an entry such as “172.17.” |
| HOSTNAME_IGNORE_LIST | ['Hostname', 'Host*', '*stna*', '*stname']
If no “*” is specified, the exact host name is searched for. “*”, however, serves as a wildcard. No distinction is made between upper and lower case letters. |
| SCAN_SUBNETS | ‘--localnet’
Normally this option is already the correct settings. This setting is selected when Pi.Alert is installed on a device with a network card and no other networks are configured.
‘--localnet --interface=eth0’
This configuration is selected if Pi.Alert is installed on a system with at least 2 network cards and a configured network. However, the interface designation may differ and must be adapted to the conditions of the system.
['192.168.1.0/24 --interface=eth0','192.168.2.0/24 --interface=eth1']
The last configuration is necessary if several networks are to be monitored. For each network to be monitored, a corresponding network card must be configured. This is necessary because the "arp-scan" used is not routed, i.e. it only works within its own subnet. Each interface is entered here with the corresponding network. The interface designation must be adapted to the conditions of the system.
|
| Option | Description |
|---|
| ICMP_ONLINE_TEST | Number of attempts to determine if a device is online (Default 1). |
| ICMP_GET_AVG_RTT | Number of "ping's" to calculate the average response time (Default 2). |
| Option | Description |
|---|
| PIHOLE_ACTIVE | This variable is set during installation. |
| PIHOLE_VERSION | The version information is necessary because access to the Pi-hole data has fundamentally changed from version 5 to 6. Default is 6 after the official realease of Pihole 6 |
| PIHOLE_DB | This variable is set during installation and should not be changed. |
| PIHOLE6_URL | If you want to access the Pi-hole data of version 6, enter the URL to the web interface (without the "/admin" suffix) here. |
| PIHOLE6_PASSWORD | Enter the password for the Pi-hole web interface here. |
| PIHOLE6_API_MAXCLIENTS | Specifies the maximum number of clients that are returned as a response from the API |
| DHCP_ACTIVE | This variable is valid for the DHCP server of Pihole 5.x as well as for 6.x |
| DHCP_LEASES | This path is only relevant for version 5.x of Pihole and should not be changed. |
| DHCP_INCL_SELF_TO_LEASES | Adds the Mac addresses of Pi-hole itself to the DHCP leases to import Pi-hole itself into the database if it is not in the local network of Pi.Alert |
| Option | Description |
|---|
| FRITZBOX_ACTIVE | If a Fritzbox is used in the network, it can be used as a data source. This can be activated or deactivated at this point. |
| FRITZBOX_IP | IP address or host name of the Fritzbox. |
| FRITZBOX_USER | User name for Fritzbox authentication. Password-only logins are not supported. |
| FRITZBOX_PASS | Password for the configured Fritzbox user. |
| Option | Description |
|---|
| MIKROTIK_ACTIVE | If a Mikrotik router is used in the network, it can be used as a data source. This can be enabled or disabled at this point. |
| MIKROTIK_IP | IP address or host name of the Mikrotik router. |
| MIKROTIK_USER | User name used to authenticate with the Mikrotik router. |
| MIKROTIK_PASS | Password used to authenticate with the Mikrotik router. |
| Option | Description |
|---|
| UNIFI_ACTIVE | If a UniFi system is used in the network, it can be used as a data source. This can be enabled or disabled at this point. |
| UNIFI_IP | IP address or host name of the UniFi controller or UniFi OS device. |
| UNIFI_API | Possible UNIFI APIs are v4, v5, unifiOS, UDMP-unifiOS, default |
| UNIFI_USER | User name used to authenticate with the UniFi controller. |
| UNIFI_PASS | Password used to authenticate with the UniFi controller. |
| Option | Description |
|---|
| OPENWRT_ACTIVE | The package luci-mod-rpcneed to be installed, on your OpenWrt router. If a OpenWRT router is used in the network, it can be used as a data source. This can be activated or deactivated at this point. |
| OPENWRT_IP | IP address or host name of the OpenWRT router. |
| OPENWRT_USER | User name used to authenticate with the OpenWRT router. |
| OPENWRT_PASS | Password used to authenticate with the OpenWRT router. |
| Option | Description |
|---|
| ASUSWRT_ACTIVE | If a Asus router is used in the network, it can be used as a data source. This can be activated or deactivated at this point. The Python package “asusrouter” is used for communication with the router, which supports a large number of devices. You can check whether your router is supported at “https://pypi.org/project/asusrouter/”. |
| ASUSWRT_IP | IP address or host name of the AsusWRT router. |
| ASUSWRT_USER | User name used to authenticate with the AsusWRT router. |
| ASUSWRT_PASS | Password used to authenticate with the AsusWRT router. |
| ASUSWRT_SSL | Set to True for https or False for http when connecting to the router. |
| 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. The API is used to import the DHCP leases and the ARP table from pfSense. |
| PFSENSE_IP | IP address or domain name of the pfSense firewall. |
| PFSENSE_PORT | The port through which the web interface can be accessed. This is usually 443 for https (PFSENSE_SSL = True) and 80 for http (PFSENSE_SSL = False). |
| PFSENSE_APIKEY | The API key that was created after installing the API in pfSense under ‘System’ -> ‘REST API’ -> 'Keys' |
| PFSENSE_SSL | Set to True for https or False for http. |
| PFSENSE_EXCLUDE_INT | Interfaces that should be ignored during import |
| Option | Description |
|---|
| OPNSENSE_ACTIVE | Enables the import of OPNsense data. Pi.Alert uses the OPNsense API to read DHCP lease and ARP information. |
| OPNSENSE_IP | IP address or domain name of the OPNsense firewall. |
| OPNSENSE_PORT | The port used by the OPNsense web interface and API. This is usually 443 for https and 80 for http. |
| OPNSENSE_APIKEY | API key created for the OPNsense API user. |
| OPNSENSE_APISECRET | API secret that belongs to the configured API key. |
| OPNSENSE_SSL | Set to True for https or False for http. |
| OPNSENSE_EXCLUDE_INT | Interfaces that should be ignored during import. |
| Option | Description |
|---|
| ADGUARD_ACTIVE | Enables or disables the AdGuard import. |
| ADGUARD_IP | IP address or host name of the AdGuard Home instance. |
| ADGUARD_PORT | Port used by the AdGuard web interface and API. |
| ADGUARD_USER | User name used to authenticate with the AdGuard web interface. |
| ADGUARD_PASSWORD | Password for the AdGuard web interface. If you enter a password with \ in the GUI, pialert.conf may show \\. This is expected and preserves the correct value. |
| ADGUARD_SSL | Set to True for https or False for http. |
| ADGUARD_QUERY_MINUTES | Query time window, in minutes, that is used to mark AdGuard lease entries as active. |
| ADGUARD_ACTIVITY_MINUTES | Retention time, in minutes, for entries in the AdGuard activity table before they are removed as inactive. |
| ADGUARD_QUERY_LIMIT | Maximum number of query log entries requested from AdGuard per run. |
| Option | Description |
|---|
| SATELLITE_PROXY_MODE | Activates/deactivates the support of an external API to which the satellites send their data. If this function is deactivated, Pi.Alert only uses scan events that were sent directly to this instance. |
| SATELLITE_PROXY_URL | URL of the Pi.Alert Satellite Proxy API that receives scan data from satellite instances. |
| Option | Description |
|---|
| DAYS_TO_KEEP_ONLINEHISTORY | Number of days for which the online history (activity graph) is to be stored in the database. One day generates 288 such records. |
| DAYS_TO_KEEP_EVENTS | Number of days for which the events of the individual devices are to be stored. |
Back