Reword modules documentation to reflect the usage of local configuration files

mod_cron/README.md

@@ -17,7 +17,7 @@ ejabberd log file.
 Basic Configuration
 -------------------
 
-Add the module to your `ejabberd.yml`, on the `modules` section:
+Add the module to the `modules` section on the configuration file:
 ```yaml
 modules:
   mod_cron: {}

mod_default_contacts/README.md

@@ -22,7 +22,6 @@ following:
 
 ```yaml
 modules:
-  # [...]
   mod_default_contacts:
     contacts:
       -

mod_filter/README.md

@@ -39,7 +39,6 @@ index d13c05601..c2a72fd9f 100644
 Configuration
 -------------
 
-To use this module, follow the general build instructions.
 You can modify the default module configuration file like this:
 
 To enable the module:

mod_isolation/README.md

@@ -8,17 +8,13 @@ The module blocks communication of users between different virtual hosts.
 The module doesn't have any options, so the simpliest way to configure is:
 ```yaml
 modules:
-  ...
   mod_isolation: {}
-  ...
 ```
 
 Hint: if you also want to block whole s2s, use built-in ejabberd's `s2s_access` option:
 ```yaml
 s2s_access: none
-...
+
 modules:
-  ...
   mod_isolation: {}
-  ...
 ```

mod_logxml/README.md

@@ -11,8 +11,8 @@ Description
 
 This module sniffs all the XMPP traffic send and received by ejabberd,
 both internally and externally transmitted. It logs the XMPP packets
-to a XML formatted file. It's posible to filter transmitted packets 
-by orientation, stanza and direction. It's possible to configure the 
+to a XML formatted file. It's posible to filter transmitted packets
+by orientation, stanza and direction. It's possible to configure the
 file rotation rules and intervals.
 
 This module reuses code from `mod_log_forensic`, `mod_stats2file`, `mod_muc_log`.
@@ -57,8 +57,6 @@ Configuration
 Example Configuration
 ---------------------
 
-In `ejabberd.yml`, in the modules section, add the module. For example:
-
 ```yaml
 modules:
   mod_logxml:

mod_message_log/README.md

@@ -27,15 +27,19 @@ ejabberdctl reopen_log
 Configuration
 -------------
 
-In order to use this module, add the following lines to the modules section
-of your ejabberd.yml file:
+- `filename`
 
-```
+  Define the filename and path to store the log.
+  If the filename option is set to `auto`, it will be set to
+  the default ejabberd log path, with the file name `"message.log"`.
+  The filename option takes as default value `auto`.
+
+
+Example Configuration
+---------------------
+
+```yaml
 modules:
   mod_message_log:
     filename: "/path/to/ejabberd-message.log"
 ```
-
-If the filename option is set to `auto`, it will be set to
-the default ejabberd log path, with the file name `"message.log"`.
-The filename option takes as default value `auto`.

mod_muc_log_http/README.md

@@ -18,8 +18,13 @@ of `mod_http_fileserver`, customized for log serving.
 Configuration
 -------------
 
-Sample ejabberd.yml options. The directory to serve is already defined
-on `mod_muc_log`.
+This module has no configurable options, simply enable it.
+
+
+Example Configuration
+---------------------
+
+The directory to serve is already defined on `mod_muc_log`.
 
 ```yaml
 listen:

mod_post_log/README.md

@@ -10,16 +10,41 @@ This module implements logging of all messages sent (chat and groupchat) via an
 Configuration
 -------------
 
-Add the module to your `ejabberd.yml`, in the modules section:
+- `url`:
+  URL where the HTTP POSTs are to be sent.
+
+- `ts_header`:
+  Default value: `"X-Message-Timestamp"`
+
+- `from_header`:
+  Default value: `"X-Message-From"`
+
+- `to_header`:
+  Default value: `"X-Message-To"`
+
+- `headers`:
+  Default value: `[]`
+
+- `content_type`:
+  Default value: `"text/xml"`
+
+- `http_options`:
+  Default value: `[]`
+
+- `req_options`:
+  Default value: `[]`
+
+
+Example Configuration
+---------------------
 
 ```yaml
 modules:
-  ...
   mod_post_log:
     url: "http://foo.bar.com/messages"
-  ...
 ```
 
+
 API Example
 -----------
 

mod_rest/README.md

@@ -17,6 +17,28 @@ This module can also be used as a frontend to execute ejabberd commands.
 Configuration
 -------------
 
+Configurable options:
+
+- `allowed_ips`: IP addresses that can use the rest service.
+  Notice that the IP address is checked after the connection is established.
+  If you want to restrict the IP address that listens connections, and
+  only allow a certain IP to be able to connect to the port, then the
+  option `allowed_ips` is not useful to you: you better define the
+  listening IP address in the ejabberd listeners (see the ejabberd Guide).
+
+- `allowed_destinations`: Allowed destination Jabber ID addresses in the stanza.
+
+- `allowed_stanza_types`: Allowed stanza types of the posted stanza.
+
+- `access_commands`: Access restrictions to execute ejabberd commands.
+  This option is similar to the option `ejabberdctl_access_commands` that 
+  is documented in the ejabberd Guide.
+  There is more information about AccessCommands in the ejabberd Guide.
+
+
+Example Configuration
+---------------------
+
 You can modify the default module configuration file like this:
 
 To enable the module:
@@ -40,27 +62,9 @@ listen:
 With that configuration, you can send HTTP POST requests to the URL:
 `http://localhost:5285/rest`
 
-Configurable options:
 
-- `allowed_ips`: IP addresses that can use the rest service.
-  Notice that the IP address is checked after the connection is established.
-  If you want to restrict the IP address that listens connections, and
-  only allow a certain IP to be able to connect to the port, then the
-  option `allowed_ips` is not useful to you: you better define the
-  listening IP address in the ejabberd listeners (see the ejabberd Guide).
-
-- `allowed_destinations`: Allowed destination Jabber ID addresses in the stanza.
-
-- `allowed_stanza_types`: Allowed stanza types of the posted stanza.
-
-- `access_commands`: Access restrictions to execute ejabberd commands.
-  This option is similar to the option `ejabberdctl_access_commands` that 
-  is documented in the ejabberd Guide.
-  There is more information about AccessCommands in the ejabberd Guide.
-
-
-Example Configuration
----------------------
+Example Access Configuration
+----------------------------
 
 ```yaml
 acl:

mod_s2s_log/README.md

@@ -5,7 +5,7 @@ mod_s2s_log - Log all s2s connections in a file
 This module can be used to keep track of other XMPP servers your server has
 been connected with.
 
-You can use it by adding the following lines `ejabberd.yml`:
+Example configuration:
 ```yaml
 modules:
   mod_s2s_log:

mod_shcommands/README.md

@@ -59,10 +59,10 @@ so this module is only recommended for experienced ejabberd and Erlang/OTP
 administrators.
 
 
-Basic Configuration
--------------------
+Configuration
+-------------
 
-Add the module to your `ejabberd.yml`, on the modules section:
+This module has no configurable options, simply enable it:
 ```
 modules:
   mod_shcommands: {}

mod_spam_filter/README.md

@@ -18,12 +18,10 @@ to control which recipients are subject to spam filtering.
 Configuration
 -------------
 
-In order to use this module, add a configuration snippet such as the
-following:
+To enable this module, configure it like this:
 
 ```yaml
 modules:
-  # [...]
   mod_spam_filter:
     spam_jids_file: "/etc/ejabberd/spam-filter/jids.txt"
     spam_urls_file: "/etc/ejabberd/spam-filter/urls.txt"

mod_statsdx/README.md

@@ -13,14 +13,9 @@ Web Admin and two ejabberd commands to view the information.
 Configuration
 -------------
 
-Enable the module in ejabberd.yml for example with a basic configuration:
-```yaml
-modules:
-  mod_statsdx: {}
-```
-
 Configurable options:
-- `hooks`:
+
+- `hooks`
 
   Set to `true` to enable hooks and related statistics.
   This option by default `false` because it is expected to
@@ -31,6 +26,14 @@ Configurable options:
 Example Configuration
 ---------------------
 
+To start using the module, simply enable it:
+```yaml
+modules:
+  mod_statsdx: {}
+```
+
+To enable the `hooks` option:
+
 ```yaml
 modules:
   mod_statsdx:
@@ -64,12 +67,6 @@ Configuration
 
 This module requires `mod_statsdx`.
 
-Enable the module in `ejabberd.yml` for example with a basic configuration:
-```yaml
-modules:
-  mod_stats2file: {}
-```
-
 Configurable options:
 - `interval`: Time between updates, in minutes (default: `5`)
 - `type`: Type of output. Allowed values: `html`, `txt`, `dat` (default: `html`)
@@ -81,6 +78,13 @@ Configurable options:
 Example Configuration
 ---------------------
 
+The module can be simply enabled, accepting the default options configuration:
+```yaml
+modules:
+  mod_stats2file: {}
+```
+
+Or set some options:
 ```yaml
 modules:
   mod_stats2file:

mod_webadmin_config/README.md

@@ -16,10 +16,8 @@ It also displays a diff of last changes detected in the configuration.
 
 # Configuration
 
-The module has no options to configure, simply enable it:
+The module has no options to configure, it's simply enabled with:
 ```yaml
 modules:
-  ...
   mod_webadmin_config: {}
-  ...
 ```

mod_webpresence/README.md

@@ -22,38 +22,6 @@ Allowed output methods are
 No web server, database, additional libraries or programs are required.
 
 
-Install
--------
-
-1. Compile the module
- * On Windows: `build.bat`
- * On other systems: `./build.sh`
-
-2. Copy `ebin/mod_webpresence.beam` to your ejabberd `ebin` directory.
-
-3. Copy the directory `data/pixmaps` to a directory you prefer.
-
-4. Edit `ejabberd.yml` and add the HTTP and module definitions:
-
-```yaml
-listen:
-  -
-    port: 5280
-    module: ejabberd_http
-    [...]
-    request_handlers:
-      "/presence": mod_webpresence
-
-modules:
-  mod_webpresence:
-    pixmaps_path: "/path/to/pixmaps"
-```
-
-5. Restart ejabberd.
-If problems appear, remember to always look first the ejabberd log files
-`ejabberd.log` and `sasl.log` since they may provide some valuable information.
-
-
 Configuration
 -------------
 
@@ -87,6 +55,26 @@ Configuration
     If the option is not specified, it takes as default value: `http://host:52080/presence/`
 
 
+Example Configuration
+---------------------
+
+```yaml
+listen:
+  -
+    port: 5280
+    module: ejabberd_http
+    request_handlers:
+      "/presence": mod_webpresence
+
+modules:
+  mod_webpresence:
+    pixmaps_path: "/path/to/pixmaps"
+```
+
+If problems appear, remember to always look first the ejabberd log files
+`ejabberd.log` and `sasl.log` since they may provide some valuable information.
+
+
 Automatic Enable
 ----------------