From 0ad45b1a93dd102b53ebcd95fca9bdfcf3d724d5 Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 6 Aug 2009 21:06:20 +0000 Subject: [PATCH] Document options for Roster Versioning (EJAB-964) SVN Revision: 2430 --- doc/guide.html | 24 ++++++++++++++++++++++-- doc/guide.tex | 25 ++++++++++++++++++++++++- 2 files changed, 46 insertions(+), 3 deletions(-) diff --git a/doc/guide.html b/doc/guide.html index 4bfe5e61c..74132c136 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -2852,11 +2852,31 @@ Also define a registration timeout of one hour: ]}.

3.3.19  mod_roster

-

This module implements roster management as defined in RFC 3921: XMPP IM.

Options: +

This module implements roster management as defined in +RFC 3921: XMPP IM. +It also supports Roster Versioning (XEP-0237).

Options:

iqdisc
This specifies the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section 3.3.2). -

+
{versioning, false | true}
Enables +Roster Versioning. +This option is disabled by default. +
{store_current_id, false | true}
+If this option is enabled, the current version number is stored on the database. +If disabled, the version number is calculated on the fly each time. +Enabling this option reduces the load for both ejabberd and the database. +This option does not affect the client in any way. +This option is only useful if Roster Versioning is enabled. +This option is disabled by default. +Important: if you use mod_shared_roster, you must disable this option. +

This example configuration enables Roster Versioning with storage of current id: +

{modules,
+ [
+  ...
+  {mod_roster, [{versioning, true}, {store_current_id, true}]},
+  ...
+ ]}.
+

3.3.20  mod_service_log

This module adds support for logging end user packets via a Jabber message auditing service such as diff --git a/doc/guide.tex b/doc/guide.tex index 4141d23ea..adca0a96f 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -3643,13 +3643,36 @@ Also define a registration timeout of one hour: \makesubsection{modroster}{\modroster{}} \ind{modules!\modroster{}}\ind{roster management}\ind{protocols!RFC 3921: XMPP IM} -This module implements roster management as defined in \footahref{http://www.xmpp.org/specs/rfc3921.html\#roster}{RFC 3921: XMPP IM}. +This module implements roster management as defined in +\footahref{http://www.xmpp.org/specs/rfc3921.html\#roster}{RFC 3921: XMPP IM}. +It also supports Roster Versioning (\xepref{0237}). Options: \begin{description} \iqdiscitem{Roster Management (\ns{jabber:iq:roster})} + \titem{\{versioning, false | true\}} \ind{options!versioning}Enables + Roster Versioning. + This option is disabled by default. + \titem{\{store\_current\_id, false | true\}} \ind{options!storecurrentid} + If this option is enabled, the current version number is stored on the database. + If disabled, the version number is calculated on the fly each time. + Enabling this option reduces the load for both ejabberd and the database. + This option does not affect the client in any way. + This option is only useful if Roster Versioning is enabled. + This option is disabled by default. + Important: if you use \modsharedroster, you must disable this option. \end{description} +This example configuration enables Roster Versioning with storage of current id: +\begin{verbatim} +{modules, + [ + ... + {mod_roster, [{versioning, true}, {store_current_id, true}]}, + ... + ]}. +\end{verbatim} + \makesubsection{modservicelog}{\modservicelog{}} \ind{modules!\modservicelog{}}\ind{message auditing}\ind{Bandersnatch}