document Shoutrrr special characters in username & password -

fixes #532
2023-11-18 08:50:47 -08:00
parent c3a0fb7fb5
commit fb6c3d6a24
2 changed files with 20 additions and 1 deletions
@@ -24,8 +24,23 @@ SCRUTINY_MESSAGE - eg. "Scrutiny SMART error notification for device: %s\nFailur
 SCRUTINY_HOST_ID - (optional) eg. "my-custom-host-id"
 ```

+# Special Characters
+
+`Shoutrrr` supports special characters in the username and password fields, however you'll need to url-encode the
+username and the password separately.
+
+- if your username is: `myname@example.com`
+- if your password is `124@34$1`
+
+Then your `shoutrrr` url will look something like:
+
+- `smtp://myname%40example%2Ecom:124%4034%241@ms.my.domain.com:587`
+
 # Testing Notifications
-You can test that your notifications are configured correctly by posting an empty payload to the notifications health check API.
+
+You can test that your notifications are configured correctly by posting an empty payload to the notifications health
+check API.
+
 ```
 curl -X POST http://localhost:8080/api/health/notify
 ```