From 99cd07658e5f76df3c5649187143cbbc661d8586 Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Thu, 14 Sep 2023 22:23:59 +1000 Subject: [PATCH] SMTP docs --- docs/README.md | 2 +- docs/SMTP.md | 39 +++++++++++++++++++++++++ docs/SMTP_GMAIL.md | 15 ---------- front/php/templates/language/en_us.json | 2 +- front/php/templates/language/es_es.json | 2 +- front/plugins/pihole_scan/config.json | 4 +-- 6 files changed, 44 insertions(+), 20 deletions(-) create mode 100755 docs/SMTP.md delete mode 100755 docs/SMTP_GMAIL.md diff --git a/docs/README.md b/docs/README.md index 201abb2b..b61d3f42 100755 --- a/docs/README.md +++ b/docs/README.md @@ -22,7 +22,7 @@ There is also an in-app Help / FAQ section that should be answering frequently a #### 馃敐 Popular/Suggested - [Network treemap configuration](/docs/NETWORK_TREE.md) -- [Gmail as SMTP server for sending emails](/docs/SMTP_GMAIL.md) +- [SMTP server config](/docs/SMTP.md) - [Subnets and VLANs configuration for arp-scan](/docs/SUBNETS.md) - [Home Assistant](/docs/HOME_ASSISTANT.md) diff --git a/docs/SMTP.md b/docs/SMTP.md new file mode 100755 index 00000000..8a0a8187 --- /dev/null +++ b/docs/SMTP.md @@ -0,0 +1,39 @@ + + +## Use the GMX SMTP server + +1. Go to your GMX account https://account.gmx.com +2. Under Security Options enable 2FA (Two-factor authentication) +3. Under Security Options generate an Application-specific password +4. Home -> Email Settings -> POP3 & IMAP -> Enable access to this account via POP3 and IMAP +5. In PiAlert specify these settings: + +```python +REPORT_MAIL=True +SMTP_SERVER='mail.gmx.com' +SMTP_PORT=465 +SMTP_USER='gmx_email@gmx.com' +SMTP_PASS='' +SMTP_SKIP_TLS=True +SMTP_FORCE_SSL=True +SMTP_SKIP_LOGIN=False +REPORT_FROM='gmx_email@gmx.com' +REPORT_TO='some_target_email@gmail.com' +``` + + +## Use the Gmail SMTP server + +1. Create an app password by following the instructions from Google, you need to Enable 2FA for this to work. +[https://support.google.com/accounts/answer/185833](https://support.google.com/accounts/answer/185833) + +2. Specify the following settings: + +```python + SMTP_SKIP_TLS=True + SMTP_FORCE_SSL=True + SMTP_PORT=465 + SMTP_SERVER='smtp.gmail.com' + SMTP_PASS='16-digit passcode from google' +``` + diff --git a/docs/SMTP_GMAIL.md b/docs/SMTP_GMAIL.md deleted file mode 100755 index 3aef0fd4..00000000 --- a/docs/SMTP_GMAIL.md +++ /dev/null @@ -1,15 +0,0 @@ -## Use the Gmail SMTP server - -1) Create an app password by following the instructions from Google, you need to Enable 2FA for this to work. -[https://support.google.com/accounts/answer/185833](https://support.google.com/accounts/answer/185833) - -2) Specify the following settings: - -```python - SMTP_SKIP_TLS=True - SMTP_FORCE_SSL=True - SMTP_PORT=465 - SMTP_SERVER='smtp.gmail.com' - SMTP_PASS='16-digit passcode from google' -``` - diff --git a/front/php/templates/language/en_us.json b/front/php/templates/language/en_us.json index 5a02de49..7197819e 100755 --- a/front/php/templates/language/en_us.json +++ b/front/php/templates/language/en_us.json @@ -498,7 +498,7 @@ "REPORT_MAIL_name" : "Enable email", "REPORT_MAIL_description" : "If enabled an email is sent out with a list of changes you nove 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.", "SMTP_SERVER_name" : "SMTP server URL", - "SMTP_SERVER_description" : "The SMTP server host URL. For example smtp-relay.sendinblue.com. To use Gmail as an SMTP server follow this guide", + "SMTP_SERVER_description" : "The SMTP server host URL. For example smtp-relay.sendinblue.com. To use Gmail as an SMTP server follow this guide", "SMTP_PORT_name" : "SMTP server PORT", "SMTP_PORT_description" : "Port number used for the SMTP connection. Set to 0 if you do not want to use a port when connecting to the SMTP server.", "SMTP_SKIP_LOGIN_name" : "Skip authentication", diff --git a/front/php/templates/language/es_es.json b/front/php/templates/language/es_es.json index 5ed8fe6d..6dbdb503 100755 --- a/front/php/templates/language/es_es.json +++ b/front/php/templates/language/es_es.json @@ -489,7 +489,7 @@ "REPORT_MAIL_name" : "Habilitar email", "REPORT_MAIL_description" : "Si est谩 habilitado, se env铆a un correo electr贸nico con una lista de cambios a los que se ha suscrito. Complete tambi茅n todas las configuraciones restantes relacionadas con la configuraci贸n de SMTP a continuaci贸n", "SMTP_SERVER_name" : "URL del servidor SMTP", - "SMTP_SERVER_description" : "La URL del host del servidor SMTP. Por ejemplo, smtp-relay.sendinblue.com. Para utilizar Gmail como servidor SMTP siga esta gu铆a", + "SMTP_SERVER_description" : "La URL del host del servidor SMTP. Por ejemplo, smtp-relay.sendinblue.com. Para utilizar Gmail como servidor SMTP siga esta gu铆a", "SMTP_PORT_name" : "Puerto del servidor SMTP", "SMTP_PORT_description" : "N煤mero de puerto utilizado para la conexi贸n SMTP. Establ茅zcalo en 0 si no desea utilizar un puerto al conectarse al servidor SMTP.", "SMTP_SKIP_LOGIN_name" : "Omitir autenticaci贸n", diff --git a/front/plugins/pihole_scan/config.json b/front/plugins/pihole_scan/config.json index eaa60d1b..f75f285d 100755 --- a/front/plugins/pihole_scan/config.json +++ b/front/plugins/pihole_scan/config.json @@ -243,11 +243,11 @@ "localized": ["name"], "name":[{ "language_code":"en_us", - "string" : "IP" + "string" : "Link to device" }, { "language_code":"es_es", - "string" : "IP" + "string" : "N/A" }] }, {