Software / code / prosody-modules
Annotate
mod_http_debug/README.md @ 6305:1c62edeb9147
mod_pastebin: Update Readme
diff --git a/mod_pastebin/README.md b/mod_pastebin/README.md
--- a/mod_pastebin/README.md
+++ b/mod_pastebin/README.md
@@ -37,12 +37,14 @@ For example:
Pastes will be available by default at
`http://<your-prosody>:5280/pastebin/` by default.
-In Prosody 0.9 and later this can be changed with [HTTP
-settings](https://prosody.im/doc/http).
+Ports and path can be changed with [HTTP
+settings](https://prosody.im/doc/http), for example like:
-In 0.8 and older this can be changed with `pastebin_ports` (see below),
-or you can forward another external URL from your web server to Prosody,
-use `pastebin_url` to set that URL.
+``` {.lua}
+ http_paths = {
+ pastebin = "/$host-paste";
+ }
+```
# Discovery
@@ -82,27 +84,16 @@ The line and character tresholds are adv
pastebin_line_threshold The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)
pastebin_trigger A string of characters (e.g. "!paste ") which if detected at the start of a message, always sends the message to the pastebin, regardless of length. (default: not set)
pastebin_expire_after Number of hours after which to expire (remove) a paste, defaults to 24. Set to 0 to store pastes permanently on disk.
- pastebin_ports List of ports to run the HTTP server on, same format as mod_httpserver's http_ports[^1]
- pastebin_url Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server[^2]
# Compatibility
- ------ -------
- trunk Works
+ ------ ---------------------
+ trunk Works as of 25-06-13
+ 13 Works
0.12 Works
- 0.11 Works
- 0.10 Works
- 0.9 Works
- 0.8 Works
- ------ -------
+ ------ ---------------------
# Todo
- Maximum paste length
- Web interface to submit pastes?
-
-[^1]: As of Prosody 0.9, `pastebin_ports` is replaced by `http_ports`,
- see [Prosody HTTP server documentation](https://prosody.im/doc/http)
-
-[^2]: See also
- [http_external_url](https://prosody.im/doc/http#external_url)
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 11:39:58 +0200 |
| parent | 5490:91564b57e595 |
| rev | line source |
|---|---|
| 5489 | 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 ``` | |
|
5490
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
32 |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
33 # Configuration |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
34 |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
35 HTTP Methods handled can be configured via the `http_debug_methods` |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
36 setting. By default, the most common methods are already enabled. |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
37 |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
38 ```lua |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
39 http_debug_methods = { "GET"; "HEAD"; "DELETE"; "OPTIONS"; "PATCH"; "POST"; "PUT" }; |
|
91564b57e595
mod_http_debug: Handle more HTTP methods
Kim Alvefur <zash@zash.se>
parents:
5489
diff
changeset
|
40 ``` |