Mercurial > prosody-modules
annotate mod_invite/README.md @ 6261: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 |
| parents | fe081789f7b5 |
| children |
| rev | line source |
|---|---|
| 2059 | 1 --- |
| 2 labels: | |
|
4099
78b7879a04f7
mod_invite: Add deprecation note and tag
Matthew Wild <mwild1@gmail.com>
parents:
2059
diff
changeset
|
3 - 'Stage-Deprecated' |
| 2059 | 4 summary: 'Allows users to invite new users' |
| 5 ... | |
| 6 | |
|
4099
78b7879a04f7
mod_invite: Add deprecation note and tag
Matthew Wild <mwild1@gmail.com>
parents:
2059
diff
changeset
|
7 **NOTE:** This module has been deprecated. Its functionality has been |
|
78b7879a04f7
mod_invite: Add deprecation note and tag
Matthew Wild <mwild1@gmail.com>
parents:
2059
diff
changeset
|
8 moved to other modules, see the mod_invites documentation for details. |
|
78b7879a04f7
mod_invite: Add deprecation note and tag
Matthew Wild <mwild1@gmail.com>
parents:
2059
diff
changeset
|
9 |
| 2059 | 10 Introduction |
| 11 ============ | |
| 12 | |
| 13 This module allows users with an account to generate single-use invite URLs | |
| 14 using an ad-hoc command. The invite URLs allow new users to create an account | |
| 15 even if public registration is disabled. | |
| 16 | |
| 17 After the account is created, the inviter and the invitee are automatically | |
| 18 added to the other's roster. The inviter of a user is stored, so can be used | |
| 19 later (for example, for detecting spammers). | |
| 20 | |
| 21 This module depends on Prosody's internal webserver. | |
| 22 | |
| 23 Compatibility | |
| 24 ============= | |
| 25 | |
| 26 ----- ------- | |
| 27 0.9 Works | |
| 28 ----- ------- |
