# HG changeset patch # User Kim Alvefur # Date 1440770700 -7200 # Node ID 0ab737feada662d651b47f338b556f640c56906d # Parent 5abf61915ab4eba8e29aec576761a2e62035e6c9 Delete wiki pages of deleted modules diff -r 5abf61915ab4 -r 0ab737feada6 mod_adhoc/README.wiki --- a/mod_adhoc/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,59 +0,0 @@ -#summary XEP-0050: Ad-Hoc Commands -#labels Stage-Beta, Deprecated - -= Introduction = - -implementation of [http://xmpp.org/extensions/xep-0050.html XEP-0050: Ad-Hoc Commands], which allows clients to execute commands on the Prosody server. This plugin adds no commands itself, see the other `mod_adhoc_*` plugins for those. - -This module along with the other adhoc modules in prosody-modules are included in Prosody as of 0.8, making this plugin unnecessary for users of this version and later. - -= Details = - -Will offer any adhoc command registered via 'module:add_item("adhoc", ....)'. - - - -= Usage = - -First copy (or symlink) the directory "adhoc" which contains mod_adhoc to your plugins directory. -Load mod_adhoc and then any module which provides an adhoc command, such as -mod_adhoc_cmd_ping. - -If you want to build your own adhoc command, just register your adhoc command module with -module:add_item and a descriptor for your command. - -A descriptor can be created like this: -{{{ -local adhoc_new = module:require "adhoc".new; -local descriptor = adhoc_new("Name", "node", handler); -module:add_item ("adhoc", descriptor) -}}} - -A handler gets 2 parameters. A data table and a state. - -The data table has 4 fields: -||to||The to attribute of the stanza to be handled|| -||from||The from attribute of the stanza to be handled|| -||action||The action to be performed as specified in the stanza to be handled|| -||form||If the to be handled stanza contains a form this will contain the form element|| - -The handler should return two items. A data table and a state. -The state will be saved and passed to the handler on invocation for any adhoc stanza with the same sessionid. If a session has ended the state returned should be nil. - -The returned table can have the following fields: -||*Name*||*Explanation*||*Required?*|| -||status||Status of the command (One of: "completed", "canceled", "error")||yes|| -||error||A table with the fields "type", "condition" and "message"||when status is "error"|| -||info||Informational text for display to the user||no|| -||warn||A warning for the user||no|| -||actions||The actions avaiable to the client||no|| -||form||A dataform to be filled out by the user||no|| -||result||A dataform of type result to be presented to the user||no|| -||other||Any other XML to be included in the response to the user||no|| - -For a simple module and details have a look at mod_adhoc_cmd_ping. - -= Compatibility = -||0.6||Most commands work|| -||0.7||Works|| -||0.8||Included in Prosody|| diff -r 5abf61915ab4 -r 0ab737feada6 mod_adhoc_cmd_admin/README.wiki --- a/mod_adhoc_cmd_admin/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,32 +0,0 @@ -#summary Administrative adhoc commands -#labels Stage-Beta, Deprecated - -= Introduction = - -This module contains administrative commands. - -Supported commands are: - * Add User - * Delete User - * End User Session - * Change User Password - * Get User Password - * Get User Roster - * Get User Statistics - * Get List of Online Users - * Send Announcement to Online Users - * Shut Down Service - -The goal is to implement many/all commands described in XEP-0133. - -= Usage = - -Load mod_adhoc_cmd_admin after [mod_adhoc], you can then use the provided adhoc commands from your XEP-0050 compliant client. - -= Compatibility = -||0.7||Works|| -||0.8||Included in Prosody (in mod_admin_adhoc)|| - -= TODO = - - * Add more commands diff -r 5abf61915ab4 -r 0ab737feada6 mod_adhoc_cmd_modules/README.wiki --- a/mod_adhoc_cmd_modules/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,14 +0,0 @@ -#summary Module management via ad-hoc commands -#labels Stage-Beta, Deprecated - -= Introduction = - -This module adds support for Loading, Reloading and Unloading of modules. - - -= Usage = -Load this module after [mod_adhoc]. It can then be used from any XEP-0050 compliant client. - -= Compatibility = -||0.7||Works|| -||0.8||Included in Prosody (in mod_admin_adhoc)|| diff -r 5abf61915ab4 -r 0ab737feada6 mod_adhoc_cmd_ping/README.wiki --- a/mod_adhoc_cmd_ping/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,13 +0,0 @@ -#summary Adhoc command ping -#labels Stage-Beta, Deprecated - -= Introduction = - -implements the adhoc command 'ping'. - -= Usage = -Just load it after [mod_adhoc] and you can execute the adhoc command 'ping' with any adhoc command aware jabber client. - -= Compatibility = -||0.7||Works|| -||0.8||Included in Prosody (in mod_ping)|| diff -r 5abf61915ab4 -r 0ab737feada6 mod_adhoc_cmd_uptime/README.wiki --- a/mod_adhoc_cmd_uptime/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -#summary Adhoc command to show the uptime -#labels Stage-Beta, Deprecated - -= Introduction = - -Implements an uptime adhoc command. - - -= Usage = - -Load this module after [mod_adhoc]. - -= Compatibility = -||0.7||Works|| -||0.8||Included in Prosody (in mod_uptime)|| diff -r 5abf61915ab4 -r 0ab737feada6 mod_archive/README.wiki --- a/mod_archive/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,52 +0,0 @@ -#summary XEP-0136: Message Archiving -#labels Stage-Unsupported - ----- -This page is held here for reference only. mod_archive is no longer supported. - -Similar modules: - - * [mod_mam] - * [mod_mam_sql] - * [http://prosody.im/files/mod_log_messages.lua mod_log_messages] (mainly useful as a template for people making their own logging module) - -*Note:* If you are an administrator looking for a module just for centrally logging messages passing to/from users on your server, this probably isn't the module you are looking for (mod_archive is for user-managed archives). We'd really like to hear about your requirements to make a module more tailored to this kind of use-case though (especially how/where you would like the messages stored)... drop us an email at developers@prosody.im to let us know. - ----- - -= Introduction = - -Currently many XMPP clients save the messages locally and it's not convenient or even possible to retrieve the historical messages, especially when one switches the clients a lot. - -= Details = - -This module keeps an archive of incoming and outgoing messages for each user on the server, and allows the user to query and manage this archive using the XMPP extension described in [http://xmpp.org/extensions/xep-0136.html XEP-0136: Message Archiving]. - -*Note:* If you are an administrator looking for a module just for centrally logging messages passing to/from users on your server, this probably isn't the module you are looking for (mod_archive is for user-managed archives). We'd really like to hear about your requirements to make a module more tailored to this kind of use-case though (especially how/where you would like the messages stored)... drop us an email at developers@prosody.im to let us know. - -= Usage = - -First copy the module to the prosody plugins directory. - -Then add "archive" to your modules_enabled list: -{{{ - modules_enabled = { - -- ... - "privacy", - "archive", - -- ... -}}} - -= Configuration = -|| *Name* || *Description* || *Type* || *Default value* || -|| default_max || the maximum number of items to return when requesting collection list or archived messages || integer || 100 || -|| force_archiving || archive every message automatically, and do NOT consider the preferences || boolean || false || -|| auto_archiving_enabled || applied when no any preferences available || boolean || true || - - -= Compatibility = -|| 0.7.0 || Works || - -= TODO = - * consider '`exactmatch`' attribute when do JID matching. - * return a `` error when the client set the value of the '`save`' attribute to '`stream`'. diff -r 5abf61915ab4 -r 0ab737feada6 mod_archive_muc/README.wiki --- a/mod_archive_muc/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,38 +0,0 @@ -#summary XEP-xxxx: Message Archive Management -#labels Stage-Alpha, Deprecated - -= Introduction = - -Implementation of [http://matthewwild.co.uk/uploads/message-archive-management.html XEP-xxxx: Message Archive Management]. Like [mod_archive] but much simpler. - -= Details = - -The server will have the ability to archive muc messages passing through. - -= Usage = - -First copy the module to the prosody plugins directory. - -Then add "archive_muc" to your modules_enabled list: -{{{ - modules_enabled = { - -- ... - "privacy", - "archive_muc", - -- ... -}}} - -= Configuration = - -|| *Name* || *Description* || *Type* || *Default value* || -|| auto_muc_archiving_enabled || applied when no any preferences available || boolean || true || - -= Compatibility = -|| 0.7.0 || Works || - -= TODO = -Test - - - - diff -r 5abf61915ab4 -r 0ab737feada6 mod_cleanup_http/README.wiki --- a/mod_cleanup_http/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -#summary http "spring cleans" module -#labels Stage-Beta, Deprecated - -= Details = - -Auto cleans handlers and open unused http ports (only on server_select) for BOSH/HTTP modules. - -= Usage = - -Copy both files into prosody's module directory and place 'em into your enabled modules into the configuration file's global section. - -Required parameters, example: -{{{ -local bosh_mod_name_ports_conf_var_reference = { { interface = { "127.0.0.1" }, port = 5280 } } -cleanup_http_modules = { ["bosh_mod_name"] = bosh_mod_name_ports_conf_var_reference, ["bosh_mod_name_unreferenced"] = { { interface = { "127.0.0.1" }, port = 5280 } } } -}}} - -You can either reference other local variables present in the configuration (see above, cleanup_http_modules needs to be placed after those in that case) or duplicate 'em (see bosh_mod_name_unreferenced). - -= Compatibility = - - * 0.9/trunk works - * 0.8 works diff -r 5abf61915ab4 -r 0ab737feada6 mod_ircd/README.wiki --- a/mod_ircd/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,45 +0,0 @@ -#summary IRC to XMPP interface to allow IRC clients to connect to chatrooms -#labels Stage-Alpha, Deprecated - -*NOTE: Consider this module currently more of a fun experiment than a serious project for use in production. Note the 'alpha' tag and have fun!* - -= Introduction = - -Whether you like it or not, XMPP is the future, but that pesky IRC just won't go away :) - -With this module you can set up a special host on your server to allow connections from IRC clients and bots. They are able to join XMPP chatrooms on a specified conference server. - -= Usage = -In your config file put something similar to the following: - -{{{ -Component "irc2muc.example.com" "ircd" - conference_server = "conference.example.com" -- required - listener_port = 7000 -}}} - -If you don't want your IRC users to have connectivity outside your server then there is no need for the hostnames you specify to be valid DNS entries. - -= Warning = - -The plugin stability, and/or serving compatibility with most of the IRC clients is yet to be determined. - -= Install = - -This release requires the [http://code.matthewwild.co.uk/verse/ Verse client library] as dependancy and [http://code.matthewwild.co.uk/squish/ Squish] to meld it with the plugin. - -Instructions (temporarily changed): - * Clone the Squish repo and/or download the latest tip from it (in that case you'll have to decompress the tip zip/tarball) - * In your Squish directory type make install - * Back into your mod_ircd directory call squish with --verse=./verse/verse.lua - * Move the mod_ircd.lua file to your prosody's plugins directory - -= Compatibility = -||0.8||Works|| -||0.7||Uncertain|| -||0.6||Doesn't work|| - -= Todo = - * Authentication - * SSL - * Many improvements to handling of IRC and XMPP diff -r 5abf61915ab4 -r 0ab737feada6 mod_proxy65/README.wiki --- a/mod_proxy65/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,31 +0,0 @@ -#summary XEP-0065: SOCKS5 Bytestreams file transfer proxy -#labels Stage-Beta, Deprecated - -= Introduction = - -mod_proxy65 implements XEP-0065: SOCKS5 Bytestreams as a component. It allows the server to proxy file transfers between 2 clients that are behind NAT routers or firewalls, and otherwise wouldn't be able to transfer files. - -= Details = -Once set up, depending on which client you are using the proxy may be automatically used, or the client may have to be configured. Consult your client's friendly documentation for more information :) - -= Usage = -{{{ -Component "proxy.example.com" "proxy65" -}}} - -= Configuration = -Although none are required, under the Component section mod_proxy65 understands several configuration options: - -||proxy65_interface||The server's interface (IP address) to bind (listen) on (default is "`*`", meaning all interfaces)|| -||proxy65_address||The advertised address of the proxy, which clients use to connect to (default is the same as the hostname of the component)|| -||proxy65_port||The port on the server to which clients should connect (default is port 5000)|| -||proxy65_acl||Access Control List, when specified all users will be denied access unless in the list. The list can contain domains, bare jids (normal) or full jids (including a resource). e.g. proxy65_acl = {"example.com", "theadmin@anotherdomain.com", "only@fromwork.de/AtWork"}|| - -= Compatibility = -||0.7 and above||Officially included in Prosody|| -||0.6||Works|| -||0.5||Should work|| - -= Todo = - * Optional support for UDP connections - * Statistics, bandwidth limits/monitoring diff -r 5abf61915ab4 -r 0ab737feada6 mod_s2s_blackwhitelist/README.wiki --- a/mod_s2s_blackwhitelist/README.wiki Fri Aug 28 00:40:53 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,45 +0,0 @@ -#summary Module for setting blacklist and whitelist on new server to server connections -#labels Deprecated - -= Introduction = - -This module adds the functionality of blacklist and whitelist for new server to server connections (federation). - - -= Details = - -If the configuration is changed then you can use console to issue "config:reload()" and this plugin will automatically reload the black/whitelists. - -You can either choose whitelist or blacklist functionality (both can't co-exist). - -Note: If a host with existing connections is blacklisted then this module will not tear down existing connection since that was created when the connection agreement was valid. You will need to use "s2s:close" command on console to manually close those connections. - -= Configuration = - -First define whether you need blacklist or whitelist, - -{{{ -s2s_enable_blackwhitelist = "whitelist" -- enable whitelist. use blacklist to use blacklists -}}} - -Now create populate an array of domains in those lists - -For whitelist, - -{{{ -s2s_whitelist = { "abc.net", "gmail.com", "xyz.net" } -}}} - -For blacklist, - -{{{ -s2s_blacklist = { "gmail.com", "xyz.com" } -}}} - -You can change configuration at runtime but need to use console plugin to reload configuration via "config:reload" command. - -= Compatibility = - -|| 0.9 || Doesn't work || -|| 0.8 || Unknown || -|| 0.7 || tested to work with dialbacks ||