Update README and example env file

README.md

@@ -51,14 +51,14 @@ This is based on the [daruzero/cloudflare-dns-auto-updater](https://github.com/D
 
 | Variable    | Example value                                 | Description                                                                                                               |
 |-------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
-| `EMAIL`     | [email protected]                           | Email address associated with your CloudFlare account                                                                     |
-| `AUTH_KEY`  | c2547eb745079dac9320b638f5e225cf483cc5cfdda41 | Your CloudFlare Global API Key                                                                                            |
-| `ZONE_NAME` | example.com                                   | The domain name that you want to change the record of. You can update multiple domains separating them with a `,` (comma) |
-| `ZONE_ID`   | 372e67954025e0ba6aaa6d586b9e0b59              | The ID of the zone you want to change a record of. You can update multiple domains separating them with a `,` (comma)     |
+| `EMAIL`     | <[email protected]>                           | Email address of your CloudFlare account                                                                     |
+| `AUTH_KEY`  | c2547eb745079dac9320b638f5e225cf483cc5cfdda41 | CloudFlare Global API Key                                                                                            |
+| `ZONE_NAME` | example.com                                   | Comma separated list of domains to update. |
+| `ZONE_ID`   | 372e67954025e0ba6aaa6d586b9e0b59              | Comma separated list of domain IDs to update     |
 
 > **Note:**
 >
-> - You only need to specify either `ZONE_ID` or `ZONE_NAME`. If you specify both, `ZONE_ID` will be used.
+> - You can set either `ZONE_ID` or `ZONE_NAME`. If you specify both, the value of `ZONE_ID` takes precedence.
 >
 
 #### Optional
@@ -67,23 +67,13 @@ This is based on the [daruzero/cloudflare-dns-auto-updater](https://github.com/D
 |--------------------|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|---------|
 | `RECORD_ID`        | 372e67954025e0ba6aaa6d586b9e0b59 | The ID of the record you want to change. Leave blank to update all records of the zone.                                                    | -       |
 | `CHECK_INTERVAL`   | 86400                            | The amount of seconds the script should wait between checks                                                                                | `86400` |
-| `SENDER_ADDRESS`   | [email protected]              | The address of the email sender. Must use Gmail SMTP server                                                                                | -       |
-| `SENDER_PASSWORD`  | supersecret                      | The password to authenticate the sender. Use an application password ([tutorial](https://support.google.com/accounts/answer/185833?hl=en)) | -       |
-| `RECEIVER_ADDRESS` | [email protected]              | The address of the email receiver. Must use Gmail SMTP server                                                                              | -       |
-
-> **Note:**
->
-> - `SENDER_ADDRESS` and `RECEIVER_ADDRESS` can be the same.
+| `NOTIFICATION_URLS` | smtp://username:password@host:587/?fromAddress=<[email protected]>&toAddresses=<[email protected]>              | Comma separated list of URLs as consumed by [`shoutrrr`](https://containrrr.dev/shoutrrr/v0.8/services/overview/)  | -       |
 
 ---
 
 ## Future implementation
 
 - [x] Possibility to update multiple domains
-- [ ] Support for other SMTP servers other than Google's
-- [ ] Support for other notification systems
-  - [ ] SMS
-  - [ ] Telegram
-  - [ ] Discord
-  - [ ] Slack
+- [x] Support for other SMTP servers other than Google's
+- [x] Support for other notification systems
 - [ ] Support for other DNS services

build/.env.example

@@ -1,21 +1,33 @@
-### REQUIRED ###
+########### CLOUDFLARE AUTHENTICATION
 
 # Email address of your CloudFlare account
 EMAIL=
-# API key of your CloudFlare account
+# CloudFlare Global API Key
 AUTH_KEY=
-# Domain that you want to update
+# The zone to update. Can be a comma separated list of domain names or zone IDs
+# Values from ZONE_ID have precedence
 ZONE_NAME=
+ZONE_ID=
 
 ### OPTIONAL ###
 
-# If you want to update only a specific record, set RECORD_ID to the ID of the record. Leave it empty to update all records.
+# Specific record to update. Leave empty to update all the records
 RECORD_ID=
 
-# If you want to change the time interval between checks, set INTERVAL to the number of seconds. Default is 86400 (24h).
+# Interval in seconds between checks. Defaults to 86400 (24h) if left empty
 CHECK_INTERVAL=
 
-# If you want to receive an email when the IP address changes, set these variables.
-SENDER_ADDRESS=
-SENDER_PASSWORD=
-RECEIVER_ADDRESS=
+########### NOTIFICATIONS
+
+# Notifications can be sent out when the public IP address changes.
+# Configuration is provided as a comma-separated list of URLs as consumed
+# by `shoutrrr`: https://containrrr.dev/shoutrrr/v0.8/services/overview/
+# The content of such notifications can be customized. Dedicated documentation
+# on how to do this can be found in the README. When providing multiple URLs or
+# an URL that contains a comma, the values can be URL encoded to avoid ambiguities.
+
+# The below URL demonstrates how to send an email using the provided SMTP
+# configuration and credentials.
+
+# NOTIFICATION_URLS=smtp://username:password@host:587/[email protected]&[email protected]
+