Mercurial > prosody-modules

comparison mod_http_debug/README.md @ 5489:a7188eb4ded4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_debug: Add a brief README
author Kim Alvefur <zash@zash.se>
date Fri, 26 May 2023 15:20:04 +0200
parents
children 91564b57e595
comparison
equal deleted inserted replaced
5488:9a4556a13cc7 5489:a7188eb4ded4
1 ---
2 summary: HTTP module returning info about requests for debugging
3 ---
4
5 This module returns some info about HTTP requests as Prosody sees them
6 from an endpoint like `http://xmpp.example.net:5281/debug`. This can be
7 used to validate [reverse-proxy configuration][doc:http] and similar use
8 cases.
9
10 # Example
11
12 ```
13 $ curl -sSf https://xmpp.example.net:5281/debug | json_pp
14 {
15 "body" : "",
16 "headers" : {
17 "accept" : "*/*",
18 "host" : "xmpp.example.net:5281",
19 "user_agent" : "curl/7.74.0"
20 },
21 "httpversion" : "1.1",
22 "id" : "jmFROQKoduU3",
23 "ip" : "127.0.0.1",
24 "method" : "GET",
25 "path" : "/debug",
26 "secure" : true,
27 "url" : {
28 "path" : "/debug"
29 }
30 }
31 ```