Documentation for notifications

README.md

@@ -22,6 +22,8 @@ The recommended and supported installation method is using [Docker](https://www.
 | HTTP_HOST | The protocol, hostname, and port (if necessary) for clients to connect to your server | | `http://192.168.0.2:8000` or `https://pinpoint.example.com` |
 | MQTT_HOST | The hostname for clients to connect to the MQTT server. If set, client configuration links will use MQTT instead of HTTP settings. | | `pinpointmqtt.example.com` |
 | ADMIN_PASSWORD | The password for the admin account | `pinpointadmin` | `mysupersecretpassword` |
+| APPRISE_HOST | Either `cli` to use the [Apprise CLI](https://github.com/caronc/apprise) to send notifications or the protocol, hostname, and port of an [Apprise API](https://github.com/caronc/apprise-api) server | `cli` | `http://127.0.0.1:8000` |
+| APPRISE_EMAIL_URL | [Apprise URI](https://github.com/caronc/apprise/wiki) for sending emails to users. The user's email address will be appended to this to build the final URI. If not set, notifications will be disabled. |  | `mailgun://admin@example.com/my-mailgun-token/` |
 | JWT_SECRET | A random string | `pleasechangeme` | `eWF6vUCKXAgB2DK2bzWrJ4RJsALxE6eacKKQarKx` |
 | CLEAR_CARD_CACHE | A cron expression (with seconds) to clear card cache and force devices to re-download card data | `0 0 0 * * *` aka midnight daily | `0 0 0 * * 0` aka midnight weekly on Sunday |
 
@@ -69,6 +71,7 @@ services:
       - HTTP_HOST=pinpoint.${DOMAIN_NAME}
       - ADMIN_PASSWORD=${PINPOINT_ADMIN_PASSWORD}
       - JWT_SECRET=${PINPOINT_JWT_SECRET}
+      - APPRISE_EMAIL_URL=${APPRISE_EMAIL_URL}
     labels:
       caddy: pinpoint.${DOMAIN_NAME}
       caddy.reverse_proxy: "{{upstreams 8000}}"
@@ -132,6 +135,7 @@ services:
       - MQTT_HOST=pinpointmqtt.${DOMAIN_NAME}
       - ADMIN_PASSWORD=${PINPOINT_ADMIN_PASSWORD}
       - JWT_SECRET=${PINPOINT_JWT_SECRET}
+      - APPRISE_EMAIL_URL=${APPRISE_EMAIL_URL}
     labels:
       caddy_0: pinpoint.${DOMAIN_NAME}
       caddy_0.reverse_proxy: "{{upstreams 8000}}"