view mod_http_debug/README.md @ 5766:b8a2b3ebe792

mod_http_oauth2: Return validation output added in trunk rev 72d7830505f0 It's not fun at all to try to register a client and only get back "failed schema validation", this should help with that.
author Kim Alvefur <zash@zash.se>
date Sun, 03 Dec 2023 23:44:18 +0100
parents 91564b57e595
children
line wrap: on
line source

---
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"
   }
}
```

# Configuration

HTTP Methods handled can be configured via the `http_debug_methods`
setting. By default, the most common methods are already enabled.

```lua
http_debug_methods = { "GET"; "HEAD"; "DELETE"; "OPTIONS"; "PATCH"; "POST"; "PUT" };
```