Software / code / prosody-modules
Annotate
mod_http_dir_listing/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 | 6003:fe081789f7b5 |
| rev | line source |
|---|---|
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
1 --- |
|
5144
606f6c6535bb
mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents:
1820
diff
changeset
|
2 rockspec: |
|
606f6c6535bb
mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents:
1820
diff
changeset
|
3 build: |
|
606f6c6535bb
mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents:
1820
diff
changeset
|
4 copy_directories: |
|
5523
a0a4413e55b8
mod_http_dir_listing: Strip path to using plugin installer
Kim Alvefur <zash@zash.se>
parents:
5145
diff
changeset
|
5 - http_dir_listing/resources |
|
5144
606f6c6535bb
mod_http_dir_listing: Add metadata to fix plugin package build
Kim Alvefur <zash@zash.se>
parents:
1820
diff
changeset
|
6 modules: |
|
5523
a0a4413e55b8
mod_http_dir_listing: Strip path to using plugin installer
Kim Alvefur <zash@zash.se>
parents:
5145
diff
changeset
|
7 mod_http_dir_listing: http_dir_listing/mod_http_dir_listing.lua |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
8 summary: HTTP directory listing |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
9 ... |
| 1782 | 10 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
11 Introduction |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
12 ============ |
| 1782 | 13 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
14 This module generates directory listings when invoked by |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
15 `mod_http_files`. See [documentation on |
|
1820
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1803
diff
changeset
|
16 `mod_http_files`](http://prosody.im/doc/modules/mod_http_files). |
| 1782 | 17 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
18 Configuration |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
19 ============= |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
20 |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
21 The module itself doesn't have any configuration of its own, just enable |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
22 the it along with `mod_http_files`. |
| 1782 | 23 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
24 modules_enabled = { |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
25 ... |
| 1782 | 26 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
27 "http_files"; |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
28 "http_dir_listing"; |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
29 } |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
30 |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
31 http_dir_listing = true; |
| 1782 | 32 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
33 The layout, CSS and icons in the `resources/` directory can be |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
34 customized or replaced. All resources are cached in memory when the |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
35 module is loaded and the images are inlined in the CSS. |
| 1782 | 36 |
|
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
37 Compatibility |
|
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
38 ============= |
| 1782 | 39 |
|
5145
885d696473d2
mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents:
5144
diff
changeset
|
40 version status |
|
885d696473d2
mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents:
5144
diff
changeset
|
41 --------- -------- |
|
885d696473d2
mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents:
5144
diff
changeset
|
42 trunk Works |
|
885d696473d2
mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents:
5144
diff
changeset
|
43 0.12 Works |
|
885d696473d2
mod_http_dir_listing: Update Compatibility section
Kim Alvefur <zash@zash.se>
parents:
5144
diff
changeset
|
44 0.11 Works |