From 819c896d400a78aff6834fc04b8bb6df93f9042c Mon Sep 17 00:00:00 2001
From: Hunter Kehoe <hunter.kehoe@gmail.com>
Date: Sat, 8 Oct 2022 21:02:55 -0600
Subject: [PATCH] docs for auth query param

---
 docs/publish.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/docs/publish.md b/docs/publish.md
index 491327d9..f757a629 100644
--- a/docs/publish.md
+++ b/docs/publish.md
@@ -2678,6 +2678,25 @@ Here's a simple example:
     ]));
     ```
 
+#### Auth Query Param
+In some instances, you may want to send auth credentials in the URL (e.g., a GET webhook or a JSON POST request). You
+can use the `auth` query parameter. Set the value to the base64 encoding of the value of the `Authorization` header and strip any trailing `=`. **Be sure to only send auth credentials over an HTTPS connection**
+
+Here is an example:
+
+1. base64(user:pass) -> base64(testuser:fakepassword) -> dGVzdHVzZXI6ZmFrZXBhc3N3b3Jk
+2. Authorization header -> Basic base64(testuser:fakepassword) -> Basic dGVzdHVzZXI6ZmFrZXBhc3N3b3Jk
+3. base64(Authorization header) -> base64(Basic dGVzdHVzZXI6ZmFrZXBhc3N3b3Jk) -> QmFzaWMgZEdWemRIVnpaWEk2Wm1GclpYQmhjM04zYjNKaw==
+4. remove trailing `=` (if any) -> QmFzaWMgZEdWemRIVnpaWEk2Wm1GclpYQmhjM04zYjNKaw== -> QmFzaWMgZEdWemRIVnpaWEk2Wm1GclpYQmhjM04zYjNKaw
+5. add query param to URL -> https://ntfy.sh/topic -> https://ntfy.sh/topic?auth=QmFzaWMgZEdWemRIVnpaWEk2Wm1GclpYQmhjM04zYjNKaw
+
+!!! note
+    Do NOT remove trailing `=` after step 2
+
+The following command will generate the appropriate value for you on *nix systems:
+
+```echo -n "Basic `echo -n 'testuser:fakepassword' | base64`" | base64 | tr -d '='```
+
 ### Message caching
 !!! info
     If `Cache: no` is used, messages will only be delivered to connected subscribers, and won't be re-delivered if a