# HG changeset patch # User Kim Alvefur # Date 1441207833 -7200 # Node ID 8de50be756e544f428c59ed5ef875096ff0c5743 # Parent 1b08597b5e6f677f21e9a30864e1a71fc7989f9a Various README files: Correct indentation levels, fix syntax and other small fixes diff -r 1b08597b5e6f -r 8de50be756e5 mod_admin_message/README.markdown --- a/mod_admin_message/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_admin_message/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -21,7 +21,7 @@ modules](http://prosody.im/doc/installing_modules)) and set up a component: - Component "console@example.com" "admin_message" + Component "console@example.com" "admin_message" "console@example.com" is the identifier of the XMPP console. diff -r 1b08597b5e6f -r 8de50be756e5 mod_auth_dovecot/README.markdown --- a/mod_auth_dovecot/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_auth_dovecot/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -18,7 +18,7 @@ modules\_enabled. Simply add in the global section, or for the relevant hosts: - authentication = "dovecot" + authentication = "dovecot" These options are used by mod\_auth\_dovecot: diff -r 1b08597b5e6f -r 8de50be756e5 mod_auth_external/README.markdown --- a/mod_auth_external/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_auth_external/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -17,7 +17,7 @@ [lpty](http://www.tset.de/lpty/). You can install it on many platforms using [LuaRocks](http://luarocks.org/), for example: - sudo luarocks install lpty + sudo luarocks install lpty Note: Earlier versions of the module did not depend on lpty. While using the newer version is strongly recommended, you can find the [older @@ -32,7 +32,7 @@ modules\_enabled. Simply add in the global section, or for the relevant hosts: - authentication = "external" + authentication = "external" These options are specific to mod\_auth\_external: diff -r 1b08597b5e6f -r 8de50be756e5 mod_captcha_registration/README.markdown --- a/mod_captcha_registration/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_captcha_registration/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -19,11 +19,11 @@ Then clone repsository lua-captcha: -**`$ git clone https://github.com/mrDoctorWho/lua-captcha`** + $ git clone https://github.com/mrDoctorWho/lua-captcha install it: -**`$ make install`** + $ make install Configuration ============= diff -r 1b08597b5e6f -r 8de50be756e5 mod_cloud_notify/README.markdown --- a/mod_cloud_notify/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_cloud_notify/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -8,7 +8,7 @@ ============ This is an implementation of the server bits of [XEP-357: -Push](http://xmpp.org/extensions/xep-357.html). It allows clients to +Push](http://xmpp.org/extensions/xep-0357.html). It allows clients to register an "app server" which is notified about new messages while the user is offline or disconnected. Implementation of the "app server", which is expected to forward notifications to something like Google diff -r 1b08597b5e6f -r 8de50be756e5 mod_group_bookmarks/README.markdown --- a/mod_group_bookmarks/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_group_bookmarks/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -39,11 +39,11 @@ Add "group\_bookmarks" to your modules\_enabled list: - modules_enabled = { - -- ...other modules here... -- - "group_bookmarks"; - -- ...maybe some more here... -- - } + modules_enabled = { + -- ...other modules here... -- + "group_bookmarks"; + -- ...maybe some more here... -- + } Configuration ============= diff -r 1b08597b5e6f -r 8de50be756e5 mod_http_dir_listing/README.markdown --- a/mod_http_dir_listing/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_http_dir_listing/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -1,5 +1,4 @@ --- -labels: summary: HTTP directory listing ... @@ -8,7 +7,7 @@ This module generates directory listings when invoked by `mod_http_files`. See [documentation on -`mod\_http\_files`](http://prosody.im/doc/modules/mod_http_files). +`mod_http_files`](http://prosody.im/doc/modules/mod_http_files). Configuration ============= diff -r 1b08597b5e6f -r 8de50be756e5 mod_incidents_handling/README.markdown --- a/mod_incidents_handling/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_incidents_handling/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -38,7 +38,6 @@ Optional configuration directives: ``` {.lua} - incidents_expire_time = 86400 -- Expiral of "closed" incidents in seconds. ``` diff -r 1b08597b5e6f -r 8de50be756e5 mod_isolate_host/README.markdown --- a/mod_isolate_host/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_isolate_host/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -26,17 +26,21 @@ To isolate all hosts by default, add the module to your global modules\_enabled: - modules_enabled = { - ... - "isolate_host"; - ... - } +``` {.lua} +modules_enabled = { + ... + "isolate_host"; + ... +} +``` Alternatively you can isolate a single host by putting a modules\_enabled line under the VirtualHost directive: - VirtualHost "example.com" - modules_enabled = { "isolate_host" } +``` {.lua} +VirtualHost "example.com" +modules_enabled = { "isolate_host" } +``` After enabling the module, you can add further options to add exceptions for the isolation: diff -r 1b08597b5e6f -r 8de50be756e5 mod_limits/README.markdown --- a/mod_limits/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_limits/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -34,16 +34,18 @@ The limits are specified like so in the **global** section of your config (they cannot be per-host): - limits = { - c2s = { - rate = "3kb/s"; - burst = "2s"; - }; - s2sin = { - rate = "10kb/s"; - burst = "5s"; - }; - } +``` {.lua} +limits = { + c2s = { + rate = "3kb/s"; + burst = "2s"; + }; + s2sin = { + rate = "10kb/s"; + burst = "5s"; + }; +} +``` All units are in terms of *bytes*, not *bits*, so that "kb/s" is interpreted as "kilobytes per second", where a kilobyte is 1000 bytes. @@ -53,10 +55,10 @@ ----- ------------------- 0.9 Works - 0.8 Doesn't work(`*`) + 0.8 Doesn't work(\*) ----- ------------------- -(`*`) This module can be made to work in 0.8 if you do two things: +(\*) This module can be made to work in 0.8 if you do two things: 1. Install [util.throttle](http://hg.prosody.im/0.9/raw-file/d46948d3018a/util/throttle.lua) diff -r 1b08597b5e6f -r 8de50be756e5 mod_log_rate/README.markdown --- a/mod_log_rate/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_log_rate/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -1,5 +1,4 @@ --- -labels: summary: Collect statistics on rate of log messages ... @@ -16,11 +15,14 @@ and adding it to modules\_enabled as most other modules, you also need to add it to your logging config: - log = { - -- your other log sinks - info = "/var/log/prosody/prosody.log" - -- add this: - { to = "measure" } +``` {.lua} +log = { + -- your other log sinks + info = "/var/log/prosody/prosody.log" + -- add this: + { to = "measure" }; +} +``` Then log messages will be counted by [statsmanager](https://prosody.im/doc/developers/core/statsmanager). diff -r 1b08597b5e6f -r 8de50be756e5 mod_mam/README.markdown --- a/mod_mam/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_mam/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -23,11 +23,13 @@ Then add "mam" to your modules\_enabled list: - modules_enabled = { - -- ... - "mam", - -- ... - } +``` {.lua} +modules_enabled = { + -- ... + "mam", + -- ... +} +``` Storage backend =============== @@ -38,9 +40,11 @@ For example, to use mod\_storage\_sql2: - storage = { - archive2 = "sql2"; - } +``` {.lua} +storage = { + archive2 = "sql2"; +} +``` Configuration ============= @@ -51,7 +55,9 @@ will log no messages by default, for privacy concerns. If you decide to change this, you should inform your users. - default_archive_policy = false -- other options are true or "roster"; +``` {.lua} +default_archive_policy = false -- other options are true or "roster"; +``` This controls what messages are archived if the user hasn't set a matching rule, or another personal default. diff -r 1b08597b5e6f -r 8de50be756e5 mod_mam_adhoc/README.markdown --- a/mod_mam_adhoc/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_mam_adhoc/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -24,9 +24,11 @@ Then add "mam\_adhoc" to your modules\_enabled list: - modules_enabled = { - -- ... - "mam", - "mam_adhoc", - -- ... - } +``` {.lua} +modules_enabled = { + -- ... + "mam", + "mam_adhoc", + -- ... +} +``` diff -r 1b08597b5e6f -r 8de50be756e5 mod_mam_muc/README.markdown --- a/mod_mam_muc/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_mam_muc/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -20,15 +20,17 @@ Then add "mam\_muc" to your modules\_enabled list: - Component "conference.example.org" "muc" - modules_enabled = { - "mam_muc", - } - storage = { - -- This makes mod_mam_muc use the sql2 storage backend (others will use internal) - -- which at the time of this writing is the only one supporting stanza archives - muc_log = "sql2"; - } +``` {.lua} +Component "conference.example.org" "muc" +modules_enabled = { + "mam_muc", +} +storage = { + -- This makes mod_mam_muc use the sql2 storage backend (others will use internal) + -- which at the time of this writing is the only one supporting stanza archives + muc_log = "sql2"; +} +``` See [Prosodys data storage documentation](https://prosody.im/doc/storage) for more info on how to @@ -40,15 +42,17 @@ Logging needs to be enabled for each room in the room configuration dialog. - muc_log_by_default = true; -- Enable logging by default (can be disabled in room config) +``` {.lua} +muc_log_by_default = true; -- Enable logging by default (can be disabled in room config) - muc_log_all_rooms = false; -- set to true to force logging of all rooms +muc_log_all_rooms = false; -- set to true to force logging of all rooms - -- This is the largest number of messages that are allowed to be retrieved in one MAM request. - max_archive_query_results = 20; +-- This is the largest number of messages that are allowed to be retrieved in one MAM request. +max_archive_query_results = 20; - -- This is the largest number of messages that are allowed to be retrieved when joining a room. - max_history_messages = 1000; +-- This is the largest number of messages that are allowed to be retrieved when joining a room. +max_history_messages = 1000; +``` Compatibility ============= diff -r 1b08597b5e6f -r 8de50be756e5 mod_mam_sql/README.markdown --- a/mod_mam_sql/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_mam_sql/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -32,44 +32,50 @@ Then add "mam\_sql" to your modules\_enabled list: - modules_enabled = { - -- ... - "mam_sql", - -- ... - } +``` lua +modules_enabled = { + -- ... + "mam_sql", + -- ... +} +``` You should probably run the SQL to create the archive table/indexes: - CREATE TABLE `prosodyarchive` ( - `host` TEXT, - `user` TEXT, - `store` TEXT, - `id` INTEGER PRIMARY KEY AUTOINCREMENT, - `when` INTEGER, - `with` TEXT, - `resource` TEXT, - `stanza` TEXT +``` sql +CREATE TABLE `prosodyarchive` ( + `host` TEXT, + `user` TEXT, + `store` TEXT, + `id` INTEGER PRIMARY KEY AUTOINCREMENT, + `when` INTEGER, + `with` TEXT, + `resource` TEXT, + `stanza` TEXT ); - CREATE INDEX `hus` ON `prosodyarchive` (`host`, `user`, `store`); - CREATE INDEX `with` ON `prosodyarchive` (`with`); - CREATE INDEX `thetime` ON `prosodyarchive` (`when`); +CREATE INDEX `hus` ON `prosodyarchive` (`host`, `user`, `store`); +CREATE INDEX `with` ON `prosodyarchive` (`with`); +CREATE INDEX `thetime` ON `prosodyarchive` (`when`); +``` (**NOTE**: I ran the following SQL to initialize the table/indexes on MySQL): - CREATE TABLE prosodyarchive ( - `host` VARCHAR(1023) NOT NULL, - `user` VARCHAR(1023) NOT NULL, - `store` VARCHAR(1023) NOT NULL, - `id` INTEGER PRIMARY KEY AUTO_INCREMENT, - `when` INTEGER NOT NULL, - `with` VARCHAR(2047) NOT NULL, - `resource` VARCHAR(1023), - `stanza` TEXT NOT NULL - ); - CREATE INDEX hus ON prosodyarchive (host, user, store); - CREATE INDEX `with` ON prosodyarchive (`with`); - CREATE INDEX thetime ON prosodyarchive (`when`); +``` sql +CREATE TABLE prosodyarchive ( + `host` VARCHAR(1023) NOT NULL, + `user` VARCHAR(1023) NOT NULL, + `store` VARCHAR(1023) NOT NULL, + `id` INTEGER PRIMARY KEY AUTO_INCREMENT, + `when` INTEGER NOT NULL, + `with` VARCHAR(2047) NOT NULL, + `resource` VARCHAR(1023), + `stanza` TEXT NOT NULL +); +CREATE INDEX hus ON prosodyarchive (host, user, store); +CREATE INDEX `with` ON prosodyarchive (`with`); +CREATE INDEX thetime ON prosodyarchive (`when`); +``` You may want to tweak the column sizes a bit; I did for my own purposes. diff -r 1b08597b5e6f -r 8de50be756e5 mod_manifesto/README.markdown --- a/mod_manifesto/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_manifesto/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -1,5 +1,4 @@ --- -labels: summary: Module for raising awareness about the Security Test Days ... @@ -13,10 +12,12 @@ Configuration ============= - manifesto_contact_encryption_warning = [[ - Your rant about security here - ]] - admin_contact_address = "mailto:xmpp@example.com" +``` lua +manifesto_contact_encryption_warning = [[ + Your rant about security here +]] +admin_contact_address = "mailto:xmpp@example.com" +``` `admin_contact_address` can be a JID or a `mailto:` URI. diff -r 1b08597b5e6f -r 8de50be756e5 mod_motd_sequential/README.markdown --- a/mod_motd_sequential/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_motd_sequential/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -16,13 +16,14 @@ Configuration ============= - - modules_enabled = { - -- other modules - "motd_sequential"; - } - motd_sequential_messages = { - "Hello and welcome to our service!", -- First login - "Lorem ipsum dolor sit amet", -- Second time they login - -- Add more messages here. - } +``` lua +modules_enabled = { + -- other modules + "motd_sequential"; +} +motd_sequential_messages = { + "Hello and welcome to our service!", -- First login + "Lorem ipsum dolor sit amet", -- Second time they login + -- Add more messages here. +} +``` diff -r 1b08597b5e6f -r 8de50be756e5 mod_muc_ban_ip/README.markdown --- a/mod_muc_ban_ip/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_muc_ban_ip/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -44,9 +44,11 @@ Remember... do not load it on the MUC host, simply add it to your global `modules_enabled` list, or under a specific host like: - VirtualHost "anon.example.com" - authentication = "anonymous" - modules_enabled = { "muc_ban_ip" } +``` lua +VirtualHost "anon.example.com" + authentication = "anonymous" + modules_enabled = { "muc_ban_ip" } +``` Compatibility ============= diff -r 1b08597b5e6f -r 8de50be756e5 mod_muc_config_restrict/README.markdown --- a/mod_muc_config_restrict/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_muc_config_restrict/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -44,12 +44,14 @@ Enable the plugin on a MUC host (do not put it in your global modules\_enabled list): - Component "conference.example.com" "muc" - modules_enabled = { "muc_config_restrict" } - muc_config_restricted = { - "muc#roomconfig_persistentroom"; -- Prevent non-admins from changing a room's persistence setting - "muc#roomconfig_membersonly"; -- Prevent non-admins from changing whether rooms are members-only - } +``` {.lua} +Component "conference.example.com" "muc" +modules_enabled = { "muc_config_restrict" } +muc_config_restricted = { + "muc#roomconfig_persistentroom"; -- Prevent non-admins from changing a room's persistence setting + "muc#roomconfig_membersonly"; -- Prevent non-admins from changing whether rooms are members-only +} +``` Compatibility ============= diff -r 1b08597b5e6f -r 8de50be756e5 mod_proxy65_whitelist/README.markdown --- a/mod_proxy65_whitelist/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_proxy65_whitelist/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -1,4 +1,4 @@ - --- +--- labels: 'Stage-Alpha' summary: Limit which file transfer users can use ... diff -r 1b08597b5e6f -r 8de50be756e5 mod_pubsub_feeds/README.markdown --- a/mod_pubsub_feeds/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_pubsub_feeds/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -19,13 +19,15 @@ This module must be loaded on a Prosody pubsub component. Add it to `modules_enabled` and configure like so: - Component "pubsub.example.com" "pubsub" - modules_enabled = { "pubsub_feeds" } +``` lua +Component "pubsub.example.com" "pubsub" +modules_enabled = { "pubsub_feeds" } - feeds = { - planet_jabber = "http://planet.jabber.org/atom.xml"; - prosody_blog = "http://blog.prosody.im/feed/atom.xml"; - } +feeds = { + planet_jabber = "http://planet.jabber.org/atom.xml"; + prosody_blog = "http://blog.prosody.im/feed/atom.xml"; +} +``` This example creates two nodes, 'planet\_jabber' and 'prosody\_blog' that clients can subscribe to using diff -r 1b08597b5e6f -r 8de50be756e5 mod_roster_command/README.markdown --- a/mod_roster_command/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_roster_command/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -16,7 +16,7 @@ After putting this module in your modules directory you can use it via prosodyctl like this: - prosodyctl mod_roster_command COMMAND [OPTIONS...] + prosodyctl mod_roster_command COMMAND [OPTIONS...] **Note:** Do not add mod\_roster\_command to your Prosody config file. This is unnecessary because it will automatically be loaded by @@ -24,27 +24,27 @@ ### Commands - subscribe user@host contact@host + subscribe user@host contact@host Subscribes the user to the contact's presence. That is, the user will see when the contact is online (but the contact won't see the user). - subscribe_both user@host contact@host + subscribe_both user@host contact@host The same as the 'subscribe' command, but performs the subscription in both directions, so that both the contact and user will always see each other online. - unsubscribe user@host contact@host + unsubscribe user@host contact@host Removes a subscription to the contact's presence. - unsubscribe_both user@host contact@host + unsubscribe_both user@host contact@host Same as unsubscribe, but also revokes a contact's subscription to the user's presence. - rename user@host contact@host [name] [group] + rename user@host contact@host [name] [group] Sets or updates a name for a contact in the user's roster, and moves the contact to the given group, if specified. diff -r 1b08597b5e6f -r 8de50be756e5 mod_s2s_auth_fingerprint/README.markdown --- a/mod_s2s_auth_fingerprint/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_s2s_auth_fingerprint/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -22,19 +22,21 @@ After installing and enabling this module, you can put fingerprints of remote servers in your config like this: - s2s_auth_fingerprint_digest = "sha1" -- This is the default. Other options are "sha256" and "sha512" - s2s_trusted_fingerprints = { - ["jabber.org"] = "11:C2:3D:87:3F:95:F8:13:F8:CA:81:33:71:36:A7:00:E0:01:95:ED"; - ["matthewwild.co.uk"] = { - "FD:7F:B2:B9:4C:C4:CB:E2:E7:48:FB:0D:98:11:C7:D8:4D:2A:62:AA"; - "CF:F3:EC:43:A9:D5:D1:4D:D4:57:09:55:52:BC:5D:73:06:1A:A1:A0"; - }; - } +``` {.lua} +s2s_auth_fingerprint_digest = "sha1" -- This is the default. Other options are "sha256" and "sha512" +s2s_trusted_fingerprints = { + ["jabber.org"] = "11:C2:3D:87:3F:95:F8:13:F8:CA:81:33:71:36:A7:00:E0:01:95:ED"; + ["matthewwild.co.uk"] = { + "FD:7F:B2:B9:4C:C4:CB:E2:E7:48:FB:0D:98:11:C7:D8:4D:2A:62:AA"; + "CF:F3:EC:43:A9:D5:D1:4D:D4:57:09:55:52:BC:5D:73:06:1A:A1:A0"; + }; +} - -- If you don't want to fall back to dialback, you can list the domains s2s_secure_domains too - s2s_secure_domains = { - "jabber.org"; - } +-- If you don't want to fall back to dialback, you can list the domains s2s_secure_domains too +s2s_secure_domains = { + "jabber.org"; +} +``` Compatibility ============= diff -r 1b08597b5e6f -r 8de50be756e5 mod_seclabels/README.markdown --- a/mod_seclabels/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_seclabels/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -16,12 +16,6 @@ As with all modules, you enable it by adding it to the modules\_enabled list. - modules_enabled = { - ... - "seclabels"; - ... - } - These options exist: Name Description Default @@ -32,28 +26,30 @@ You can then add your labels in a table called security\_labels. They can be both orderd and unorderd, but ordered comes first. - security_labels = { - { -- This label will come first - name = "Public", - label = true, -- This is a label, but without the actual label. - default = true -- This is the default label. - }, - { - name = "Private", - label = "PRIVATE", - color = "white", - bgcolor = "blue" - }, - Sensitive = { -- A Sub-selector - SECRET = { -- The index is used as name - label = true - }, - TOPSECRET = { -- The order of this and the above is not guaranteed. - color = "red", - bgcolor = "black", - } - } - } +``` {.lua} +security_labels = { + { -- This label will come first + name = "Public", + label = true, -- This is a label, but without the actual label. + default = true -- This is the default label. + }, + { + name = "Private", + label = "PRIVATE", + color = "white", + bgcolor = "blue" + }, + Sensitive = { -- A Sub-selector + SECRET = { -- The index is used as name + label = true + }, + TOPSECRET = { -- The order of this and the above is not guaranteed. + color = "red", + bgcolor = "black", + } + } +} +``` Each label can have the following properties: diff -r 1b08597b5e6f -r 8de50be756e5 mod_server_contact_info/README.markdown --- a/mod_server_contact_info/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_server_contact_info/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -13,14 +13,16 @@ Configuration ============= - contact_info = { - abuse = { "mailto:abuse@shakespeare.lit", "xmpp:abuse@shakespeare.lit" }; - admin = { "mailto:admin@shakespeare.lit", "xmpp:admin@shakespeare.lit" }; - feedback = { "http://shakespeare.lit/feedback.php", "mailto:feedback@shakespeare.lit", "xmpp:feedback@shakespeare.lit" }; - sales = "xmpp:bard@shakespeare.lit"; - security = "xmpp:security@shakespeare.lit"; - support = { "http://shakespeare.lit/support.php", "xmpp:support@shakespeare.lit" }; - }; +``` lua +contact_info = { + abuse = { "mailto:abuse@shakespeare.lit", "xmpp:abuse@shakespeare.lit" }; + admin = { "mailto:admin@shakespeare.lit", "xmpp:admin@shakespeare.lit" }; + feedback = { "http://shakespeare.lit/feedback.php", "mailto:feedback@shakespeare.lit", "xmpp:feedback@shakespeare.lit" }; + sales = "xmpp:bard@shakespeare.lit"; + security = "xmpp:security@shakespeare.lit"; + support = { "http://shakespeare.lit/support.php", "xmpp:support@shakespeare.lit" }; +}; +``` The default is based on the `admins` config variable. diff -r 1b08597b5e6f -r 8de50be756e5 mod_storage_lmdb/README.markdown --- a/mod_storage_lmdb/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_storage_lmdb/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -26,6 +26,6 @@ Compatibility ============= - ---------- ------------- - '\>=0.9' Should work - ---------- ------------- + -------- ------------- + \>=0.9 Should work + -------- ------------- diff -r 1b08597b5e6f -r 8de50be756e5 mod_storage_mongodb/README.markdown --- a/mod_storage_mongodb/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_storage_mongodb/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -22,7 +22,7 @@ In Prosody's configuration file, set: - storage = "mongodb" + storage = "mongodb" MongoDB options are: diff -r 1b08597b5e6f -r 8de50be756e5 mod_storage_muc_log/README.markdown --- a/mod_storage_muc_log/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_storage_muc_log/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -19,17 +19,19 @@ Replace mod\_muc\_log (and mod\_muc\_log\_http) in your config with - Component "conference.example.org" "muc" - modules_enabled = { - -- "muc_log"; -- functionality replaced by mod_mam_muc + mod_storage_muc_log - "mam_muc"; -- Does logging to storage backend configured below +``` {.lua} +Component "conference.example.org" "muc" +modules_enabled = { + -- "muc_log"; -- functionality replaced by mod_mam_muc + mod_storage_muc_log + "mam_muc"; -- Does logging to storage backend configured below - -- "muc_log_http"; -- Replaced by the mod_http_muc_log - "http_muc_log"; - } - storage = { - muc_log = "muc_log"; - } + -- "muc_log_http"; -- Replaced by the mod_http_muc_log + "http_muc_log"; +} +storage = { + muc_log = "muc_log"; +} +``` Compatibility ============= diff -r 1b08597b5e6f -r 8de50be756e5 mod_tcpproxy/README.markdown --- a/mod_tcpproxy/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_tcpproxy/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -36,14 +36,16 @@ A new stream is opened like this: - - - +``` {.xml} + + + +``` The stanza attribute (currently) MUST be 'message', and a block-size, if given, is (currently) ignored. diff -r 1b08597b5e6f -r 8de50be756e5 mod_telnet_tlsinfo/README.markdown --- a/mod_telnet_tlsinfo/README.markdown Wed Sep 02 16:43:34 2015 +0200 +++ b/mod_telnet_tlsinfo/README.markdown Wed Sep 02 17:30:33 2015 +0200 @@ -15,10 +15,10 @@ Just add the module to the `modules_enabled` list. There is no other configuration. - modules_enabled = { - ... - "telnet_tlsinfo"; - } + modules_enabled = { + ... + "telnet_tlsinfo"; + } Usage =====