view mod_http_debug/README.md @ 6513:5fb466693e85

mod_storage_xmlarchive: Ensure list index files are removed using os.remove() on the list files leaves the new index files behind since util.datamanager does not know they are removed. Thanks Link Mauve
author Kim Alvefur <zash@zash.se>
date Tue, 07 Apr 2026 21:10:54 +0200
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" };
```