From fc554dcbcbf63f4da547134cacf35e370dda7035 Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sat, 23 Mar 2024 12:31:53 +1100 Subject: [PATCH] =?UTF-8?q?Cleanup=20=F0=9F=A7=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- back/pialert.conf | 27 ++++++++++----------------- docs/SMTP.md | 10 +++++----- pialert/initialise.py | 5 ++--- 3 files changed, 17 insertions(+), 25 deletions(-) diff --git a/back/pialert.conf b/back/pialert.conf index abf33dbe..35220bdb 100755 --- a/back/pialert.conf +++ b/back/pialert.conf @@ -7,6 +7,8 @@ # # #-----------------AUTOGENERATED FILE-----------------# +# 🔺 Use the Settings UI - only edit when necessary 🔺 + # General #--------------------------- @@ -28,11 +30,11 @@ REPORT_DASHBOARD_URL='http://pi.alert' # Email #--------------------------- -REPORT_MAIL=False +SMTP_RUN='disabled' # use 'on_notification' to enable SMTP_SERVER='smtp.gmail.com' SMTP_PORT=587 -REPORT_TO='user@gmail.com' -REPORT_FROM='Pi.Alert ' +SMTP_REPORT_TO='user@gmail.com' +SMTP_REPORT_FROM='Pi.Alert ' SMTP_SKIP_LOGIN=False SMTP_USER='user@gmail.com' SMTP_PASS='password' @@ -41,7 +43,7 @@ SMTP_SKIP_TLS=False # Webhooks #--------------------------- -REPORT_WEBHOOK=False +WEBHOOK_RUN='disabled' # use 'on_notification' to enable 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 @@ -52,14 +54,14 @@ WEBHOOK_REQUEST_METHOD='GET' # Apprise #--------------------------- -REPORT_APPRISE=False +APPRISE_RUN='disabled' # use 'on_notification' to enable 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_RUN='disabled' # use 'on_notification' to enable NTFY_HOST='https://ntfy.sh' NTFY_TOPIC='replace_my_secure_topicname_91h889f28' NTFY_USER='user' @@ -68,13 +70,13 @@ NTFY_PASSWORD='passw0rd' # PUSHSAFER #--------------------------- -REPORT_PUSHSAFER=False +PUSHSAFER_RUN='disabled' # use 'on_notification' to enable PUSHSAFER_TOKEN='ApiKey' # MQTT #--------------------------- -REPORT_MQTT=False +MQTT_RUN='disabled' # use 'on_notification' to enable MQTT_BROKER='192.168.1.2' MQTT_PORT=1883 MQTT_USER='mqtt' @@ -83,15 +85,6 @@ 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?' - - #-------------------IMPORTANT INFO-------------------# # This file is ingested by a python script, so if # # modified it needs to use python syntax # diff --git a/docs/SMTP.md b/docs/SMTP.md index e1b052dc..1faa53fc 100755 --- a/docs/SMTP.md +++ b/docs/SMTP.md @@ -9,7 +9,7 @@ 5. In PiAlert specify these settings: ```python - REPORT_MAIL=True + SMTP_RUN='on_notification' SMTP_SERVER='mail.gmx.com' SMTP_PORT=465 SMTP_USER='gmx_email@gmx.com' @@ -17,8 +17,8 @@ SMTP_SKIP_TLS=True SMTP_FORCE_SSL=True SMTP_SKIP_LOGIN=False - REPORT_FROM='gmx_email@gmx.com' # this has to be the same email as in SMTP_USER - REPORT_TO='some_target_email@gmail.com' + SMTP_REPORT_FROM='gmx_email@gmx.com' # this has to be the same email as in SMTP_USER + SMTP_REPORT_TO='some_target_email@gmail.com' ``` @@ -30,12 +30,12 @@ 2. Specify the following settings: ```python - REPORT_MAIL=True + SMTP_RUN='on_notification' SMTP_SKIP_TLS=True SMTP_FORCE_SSL=True SMTP_PORT=465 SMTP_SERVER='smtp.gmail.com' SMTP_PASS='16-digit passcode from google' - REPORT_TO='some_target_email@gmail.com' + SMTP_REPORT_TO='some_target_email@gmail.com' ``` diff --git a/pialert/initialise.py b/pialert/initialise.py index 10babe28..171ee403 100755 --- a/pialert/initialise.py +++ b/pialert/initialise.py @@ -203,7 +203,7 @@ def importConfigs (db): # bulk-import language strings sql.executemany ("""INSERT INTO Plugins_Language_Strings ("Language_Code", "String_Key", "String_Value", "Extra") VALUES (?, ?, ?, ?)""", stringSqlParams ) - db.commitDB() + # db.commitDB() @@ -217,7 +217,6 @@ def importConfigs (db): sql.executemany ("""INSERT INTO Settings ("Code_Name", "Display_Name", "Description", "Type", "Options", "RegEx", "Value", "Group", "Events" ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)""", conf.mySettingsSQLsafe) - #commitDB(sql_connection) db.commitDB() # update only the settings datasource @@ -249,7 +248,7 @@ def read_config_file(filename): #------------------------------------------------------------------------------- -# DEPERECATED soonest after 3/3/2024 +# DEPERECATED soonest after 10/10/2024 # 🤔Idea/TODO: Check and compare versions/timestamps amd only perform a replacement if config/version older than... replacements = { r'\bREPORT_TO\b': 'SMTP_REPORT_TO',