Mercurial > prosody-modules
view mod_http_debug/README.md @ 5907:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
author | Ben Smith <bens@effortlessis.com> |
---|---|
date | Mon, 13 May 2024 13:25:13 -0700 |
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" }; ```