| PARAMETER | DESCRIPTION |
|---|---|
| SATELLITE_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 |
| QUERY_MYIP_SERVER | The satellite uses this URL to check the current public IP |
| QUERY_MYIP_SERVER_FALLBACK | Fallback URL used when the primary public IP service is not reachable or returns an invalid response. The fallback service must return JSON with an ip field. |
| INTERNET_DETECTION | Activates or deactivates the public IP check (the parameter currently has no function) |
| SATELLITE_TOKEN | This token (48 alphanumeric characters long) is generated by Pi.Alert and must be entered here. It uniquely identifies this satellite within the Pi.Alert instance |
| SATELLITE_PASSWORD | The password (96 alphanumeric characters long) is generated by Pi.Alert individually for each satellite and must be entered here. |
| SATELLITE_MASTER_URL | This is the URL of the API to which the satellite sends its scan results. This can either be Pi.Alert directly or an external web server on which the API for proxy mode has been installed. It is important to note that the URL must be specified in full, including the endpoint, even when submitted directly (e.g., http://YOUR_IP_OR_HOSTNAME/pialert/api/satellite.php) |
| PROXY_MODE | Activates the proxy mode in the satellite. If the satellite informs the API that it is working in proxy mode, the API does not attempt to unpack the received data. |
| SATELLITE_ERROR_REPORT | This can be used to activate notification of satellite transmission errors. |
| NETWORK_DNS_SERVER | For host name resolving |
| 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 |
| SMTP_PASS | Password |
| 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. |
| FRIENDLY_NAME | Friendly display name used for notification mails. |
| MAIL_FROM | Sender address used for notification mails. By default it is built from FRIENDLY_NAME and SMTP_USER. |
| MAIL_TO | Destination e-mail address for notifications. |
| COLLECT_REPORTS_FOR_MAIL | This parameter defines the threshold at which notification of transmission errors takes place. The saved logs are attached to the mail. After this mail, further error notifications are stopped until a successful transmission has taken place. |
| 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 of the Fritzbox. |
| FRITZBOX_USER | This assumes that the Fritzbox is configured for a login with username and password, instead of password only. A login with password only is not supported. |
| FRITZBOX_PASS | Password |
| 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 of the Mikrotik router. |
| MIKROTIK_USER | Username |
| MIKROTIK_PASS | Password |
| 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 of the Unifi system. |
| UNIFI_API | Possible UNIFI APIs are v4, v5, unifiOS, UDMP-unifiOS, default |
| UNIFI_USER | Username |
| UNIFI_PASS | Password |
| Option | Description |
|---|---|
| OPENWRT_ACTIVE | The package luci-mod-rpcneed to be installed, on your OpenWrt router. If a OpenWRT 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 of the OpenWRT router. |
| OPENWRT_USER | Username |
| OPENWRT_PASS | Password |
| 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. |
| ASUSWRT_IP | IP address of the router. |
| ASUSWRT_USER | Username |
| ASUSWRT_PASS | Password |
| ASUSWRT_SSL | Whether SSL is used or not |
| Option | Description |
|---|---|
| PIHOLE_ACTIVE | This variable is set during installation. |
| PIHOLE_DHCP_ACTIVE | This variable is valid for the DHCP server of Pihole 5.x as well as for 6.x |
| 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 |
| Option | Description |
|---|---|
| PFSENSE_ACTIVE | Enables or disables pfSense as a data source for the satellite scan. |
| PFSENSE_IP | IP address or host name of the pfSense system. |
| PFSENSE_PORT | API port of the pfSense system. |
| PFSENSE_APIKEY | API key used for pfSense API access. |
| PFSENSE_SSL | Enables HTTPS for the pfSense API connection when set to True. |
| PFSENSE_EXCLUDE_INT | List of interface names that should be ignored when processing ARP data. |
| Option | Description |
|---|---|
| OPNSENSE_ACTIVE | Enables or disables OPNsense as a data source for the satellite scan. |
| OPNSENSE_IP | IP address or host name of the OPNsense system. |
| OPNSENSE_PORT | API port of the OPNsense system. |
| OPNSENSE_APIKEY | API key used for OPNsense API access. |
| OPNSENSE_APISECRET | API secret used together with the API key for OPNsense authentication. |
| OPNSENSE_SSL | Enables HTTPS for the OPNsense API connection when set to True. |
| OPNSENSE_EXCLUDE_INT | List of interface names that should be ignored when processing ARP data. |
| Option | Description |
|---|---|
| ADGUARD_ACTIVE | Enables or disables AdGuard as a data source for the satellite scan. |
| ADGUARD_IP | IP address or host name of the AdGuard server. |
| ADGUARD_PORT | Port of the AdGuard web/API interface. |
| ADGUARD_USER | User name for the AdGuard login. |
| ADGUARD_PASSWORD | Password for the AdGuard login. |
| ADGUARD_SSL | Enables HTTPS for the AdGuard connection when set to True. |
| ADGUARD_QUERY_LIMIT | Maximum number of DNS query log entries requested per scan to determine the current client activity state. |