Diff

--- a/mod_unified_push/README.md	Wed Nov 20 05:07:11 2024 +0100
+++ b/mod_unified_push/README.md	Sun Jan 05 17:50:02 2025 +0100
@@ -1,7 +1,7 @@
 ---
 labels:
 - Stage-Alpha
-summary: "Unified Push provider"
+summary: Unified Push provider
 ---
 
 This module implements a [Unified Push](https://unifiedpush.org/) Provider
@@ -72,28 +72,29 @@
 `openssl rand -base64 32`. Changing the secret will invalidate all existing
 push registrations.
 
-### HTTP configuration
+## HTTP configuration
 
-This module exposes a HTTP endpoint (to receive push notifications from app
-servers). For more information on configuring HTTP services in Prosody, see
+This module exposes a HTTP endpoint, by default at the path `/push` (to receive push notifications from app
+servers). **If you use a reverse proxy, make sure you proxy this path too.**
+For more information on configuring HTTP services and reverse proxying in Prosody, see
 [Prosody HTTP documentation](https://prosody.im/doc/http).
 
-#### Example configuration
+## Example configuration
 
-##### Normal method
+### Recommended: load on Virtualhost(s)
 
 Just add just add `"unified_push"` to your `modules_enabled` option.
 This is the easiest and **recommended** configuration.
 
-``` {.lua}
+``` lua
   modules_enabled = {
-    ---
+    -- ...
     "unified_push";
-    ---
+    -- ...
   }
 ```
 
-##### Component method
+#### Component method
 
 This is an example of how to configure the module as an internal component,
 e.g. on a subdomain or other non-user domain.
@@ -105,7 +106,7 @@
 on the 'example.com' host, which avoids needing to create/update DNS records
 and HTTPS certificates if example.com is already set up.
 
-``` {.lua}
+``` lua
 Component "notify.example.com" "unified_push"
     unified_push_secret = "<secret string here>"
     http_host = "example.com"
@@ -113,5 +114,7 @@
 
 ## Compatibility
 
-| trunk | Works |
-| 0.12  | Works |
+  Prosody-Version   Status
+  ----------------- ----------------------
+  trunk             Works as of 24-12-08
+  0.12              Works