# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1685107204 -7200
# Node ID a7188eb4ded4dac921ae464197ccfa328e7c609a
# Parent  9a4556a13cc74745099dd848e7d68908298d82ca
mod_http_debug: Add a brief README

diff -r 9a4556a13cc7 -r a7188eb4ded4 mod_http_debug/README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_debug/README.md	Fri May 26 15:20:04 2023 +0200
@@ -0,0 +1,31 @@
+---
+summary: HTTP module returning info about requests for debugging
+---
+
+This module returns some info about HTTP requests as Prosody sees them
+from an endpoint like `http://xmpp.example.net:5281/debug`.  This can be
+used to validate [reverse-proxy configuration][doc:http] and similar use
+cases.
+
+# Example
+
+```
+$ curl -sSf  https://xmpp.example.net:5281/debug | json_pp
+{
+   "body" : "",
+   "headers" : {
+      "accept" : "*/*",
+      "host" : "xmpp.example.net:5281",
+      "user_agent" : "curl/7.74.0"
+   },
+   "httpversion" : "1.1",
+   "id" : "jmFROQKoduU3",
+   "ip" : "127.0.0.1",
+   "method" : "GET",
+   "path" : "/debug",
+   "secure" : true,
+   "url" : {
+      "path" : "/debug"
+   }
+}
+```