From 74ba402d5daa555099b5d51827c0265df29c3dcf Mon Sep 17 00:00:00 2001 From: jokob-sk <96159884+jokob-sk@users.noreply.github.com> Date: Sat, 31 Dec 2022 00:23:36 +1100 Subject: [PATCH] Clean-up of pialert.conf --- config/pialert.conf | 214 ++++++++++++++++++++++---------------------- 1 file changed, 109 insertions(+), 105 deletions(-) diff --git a/config/pialert.conf b/config/pialert.conf index 76bed8a2..bf30ff3d 100755 --- a/config/pialert.conf +++ b/config/pialert.conf @@ -1,113 +1,117 @@ -#------------------------------------------------------------------------------- -# Pi.Alert -# Open Source Network Guard / WIFI & LAN intrusion detector -# -# pialert.conf - Back module. Configuration file -#------------------------------------------------------------------------------- -# Puche 2021 pi.alert.application@gmail.com GNU GPLv3 -#------------------------------------------------------------------------------- +#-----------------AUTOGENERATED FILE-----------------# +# # +# Generated: 2022-12-30_22-19-40 # +# # +# Config file for the LAN intruder detection app: # +# https://github.com/jokob-sk/Pi.Alert # +# # +#-----------------AUTOGENERATED FILE-----------------# -# GENERAL settings -# ---------------------- -PRINT_LOG = False -TIMEZONE = 'Europe/Berlin' -PIALERT_WEB_PROTECTION = False -PIALERT_WEB_PASSWORD = '8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92' - -INCLUDED_SECTIONS = ['internet', 'new_devices', 'down_devices', 'events'] # Specifies which events trigger notifications. - # Remove the event type(s) you don't want to get notified on - # Overrides device-specific settings in the UI. -SCAN_CYCLE_MINUTES = 5 # delay between scans - -# EMAIL settings -# ---------------------- -SMTP_SERVER = 'smtp.gmail.com' -SMTP_PORT = 587 -SMTP_USER = 'user@gmail.com' -SMTP_PASS = 'password' -SMTP_SKIP_TLS = False -SMTP_SKIP_LOGIN = False - -REPORT_MAIL = False -REPORT_FROM = 'Pi.Alert <' + SMTP_USER +'>' -REPORT_TO = 'user@gmail.com' -REPORT_DEVICE_URL = 'http://pi.alert/deviceDetails.php?mac=' -REPORT_DASHBOARD_URL = 'http://pi.alert/' - -# Webhook settings -# ---------------------- -REPORT_WEBHOOK = False -WEBHOOK_URL = 'http://n8n.local:5555/webhook-test/aaaaaaaa-aaaa-aaaa-aaaaa-aaaaaaaaaaaa' -WEBHOOK_PAYLOAD = 'json' # webhook payload data format for the "body > attachements > text" attribute - # in https://github.com/jokob-sk/Pi.Alert/blob/main/docs/webhook_json_sample.json - # supported values: 'json', 'html' or 'text' - # e.g.: for discord use 'html' -WEBHOOK_REQUEST_METHOD = 'GET' # POST, GET... - -# Apprise settings -#----------------------- -REPORT_APPRISE = False -APPRISE_HOST = 'http://localhost:8000/notify' -APPRISE_URL = 'mailto://smtp-relay.sendinblue.com:587?from=user@gmail.com&name=apprise&user=user@gmail.com&pass=password&to=user@gmail.com' - -# NTFY (https://ntfy.sh/) settings -# ---------------------- -REPORT_NTFY = False -NTFY_HOST = 'https://ntfy.sh' -NTFY_TOPIC = 'replace_my_secure_topicname_91h889f28' -NTFY_USER = 'user' # set username... -NTFY_PASSWORD = 'passw0rd' # ...and password if authentication is used https://docs.ntfy.sh/config/#users-and-roles - -# PUSHSAFER (https://www.pushsafer.com/) settings -# ---------------------- -REPORT_PUSHSAFER = False -PUSHSAFER_TOKEN = 'ApiKey' - -# MQTT settings -# ---------------------- -REPORT_MQTT = False -MQTT_BROKER = '192.168.1.2' -MQTT_PORT = 1883 -MQTT_USER = 'mqtt' -MQTT_PASSWORD = 'passw0rd' -MQTT_QOS = 0 -MQTT_DELAY_SEC = 2 # delay in seconds, increase if not all devices are created in Home Assistant - -# DynDNS -# ---------------------- -# QUERY_MYIP_SERVER = 'https://diagnostic.opendns.com/myip' -QUERY_MYIP_SERVER = 'http://ipv4.icanhazip.com' -DDNS_ACTIVE = False -DDNS_DOMAIN = 'your_domain.freeddns.org' -DDNS_USER = 'dynu_user' -DDNS_PASSWORD = 'A0000000B0000000C0000000D0000000' -DDNS_UPDATE_URL = 'https://api.dynu.com/nic/update?' - -# PIHOLE settings -# ---------------------- -PIHOLE_ACTIVE = False # if enabled you need to map '/etc/pihole/pihole-FTL.db' in docker-compose.yml -PIHOLE_DB = '/etc/pihole/pihole-FTL.db' -DHCP_ACTIVE = False # if enabled you need to map '/etc/pihole/dhcp.leases' in docker-compose.yml -DHCP_LEASES = '/etc/pihole/dhcp.leases' - -# arp-scan options & samples -# ---------------------- -# -# Scan local network (default) -# SCAN_SUBNETS = '--localnet' -# -# Scan two subnets -# SCAN_SUBNETS = '192.168.11.0/24 192.168.144.0/24' -# +# General +#--------------------------- # Scan using interface eth0 -# SCAN_SUBNETS = '--localnet --interface=eth0' +# SCAN_SUBNETS = ['192.168.1.0/24 --interface=eth0'] # # Scan multiple interfaces (eth1 and eth0): # SCAN_SUBNETS = [ '192.168.1.0/24 --interface=eth1', '192.168.1.0/24 --interface=eth0' ] +SCAN_SUBNETS=['192.168.1.0/24 --interface=eth1'] +PRINT_LOG=False +TIMEZONE='Europe/Berlin' +PIALERT_WEB_PROTECTION=False +PIALERT_WEB_PASSWORD='8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92' +INCLUDED_SECTIONS=['internet','new_devices','down_devices','events'] +SCAN_CYCLE_MINUTES=5 +DAYS_TO_KEEP_EVENTS=90 +REPORT_DASHBOARD_URL='http://pi.alert/' -SCAN_SUBNETS = '--localnet' -# Maintenance Task Settings -# ---------------------- -DAYS_TO_KEEP_EVENTS = 90 +# Email +#--------------------------- +REPORT_MAIL=False +SMTP_SERVER='smtp.gmail.com' +SMTP_PORT=587 +REPORT_TO='user@gmail.com' +REPORT_FROM='Pi.Alert ' +SMTP_SKIP_LOGIN=False +SMTP_USER='user@gmail.com' +SMTP_PASS='password' +SMTP_SKIP_TLS=False + + +# Webhooks +#--------------------------- +REPORT_WEBHOOK=False +WEBHOOK_URL='http://n8n.local:5555/webhook-test/aaaaaaaa-aaaa-aaaa-aaaaa-aaaaaaaaaaaa' +WEBHOOK_PAYLOAD='json' # webhook payload data format for the "body > attachements > text" attribute + # in https://github.com/jokob-sk/Pi.Alert/blob/main/docs/webhook_json_sample.json + # supported values: 'json', 'html' or 'text' + # e.g.: for discord use 'html' +WEBHOOK_REQUEST_METHOD='GET' + + +# Apprise +#--------------------------- +REPORT_APPRISE=False +APPRISE_HOST='http://localhost:8000/notify' +APPRISE_URL='mailto://smtp-relay.sendinblue.com:587?from=user@gmail.com&name=apprise&user=user@gmail.com&pass=password&to=user@gmail.com' + + +# NTFY +#--------------------------- +REPORT_NTFY=False +NTFY_HOST='https://ntfy.sh' +NTFY_TOPIC='replace_my_secure_topicname_91h889f28' +NTFY_USER='user' +NTFY_PASSWORD='passw0rd' + + +# PUSHSAFER +#--------------------------- +REPORT_PUSHSAFER=False +PUSHSAFER_TOKEN='ApiKey' + + +# MQTT +#--------------------------- +REPORT_MQTT=False +MQTT_BROKER='192.168.1.2' +MQTT_PORT=1883 +MQTT_USER='mqtt' +MQTT_PASSWORD='passw0rd' +MQTT_QOS=0 +MQTT_DELAY_SEC=2 + + +# DynDNS +#--------------------------- +DDNS_ACTIVE=False +DDNS_DOMAIN='your_domain.freeddns.org' +DDNS_USER='dynu_user' +DDNS_PASSWORD='A0000000B0000000C0000000D0000000' +DDNS_UPDATE_URL='https://api.dynu.com/nic/update?' + + +# PiHole +#--------------------------- +# if enabled you need to map '/etc/pihole/pihole-FTL.db' in docker-compose.yml +PIHOLE_ACTIVE=False +# if enabled you need to map '/etc/pihole/dhcp.leases' in docker-compose.yml +DHCP_ACTIVE=False + + +# Pholus +#--------------------------- +PHOLUS_ACTIVE=False +PHOLUS_TIMEOUT=20 +PHOLUS_FORCE=False +PHOLUS_DAYS_DATA=7 +PHOLUS_RUN='once' +PHOLUS_RUN_TIMEOUT=300 +PHOLUS_RUN_SCHD='0 4 * * *' + + +#-------------------IMPORTANT INFO-------------------# +# This file is ingested by a python script, so if # +# modified it needs to use python syntax # +#-------------------IMPORTANT INFO-------------------#