aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2009-04-22 12:05:10 +0000
committerBadlop <badlop@process-one.net>2009-04-22 12:05:10 +0000
commitb59ecb83e8df04316ad8656444f7ded0fd610fee (patch)
treed82c10f84c6e703d1c772af6aeefdbe7c557bb36 /doc
parent* src/cyrsasl.erl: Change API of check_password: pass a function (diff)
* src/mod_muc/mod_muc.erl: Limit number of characters in Room ID,
Name and Description (EJAB-899) * src/mod_muc/mod_muc_room.erl: Likewise * doc/guide.tex: Likewise * doc/guide.html: Likewise SVN Revision: 2034
Diffstat (limited to 'doc')
-rw-r--r--doc/guide.html21
-rw-r--r--doc/guide.tex21
2 files changed, 38 insertions, 4 deletions
diff --git a/doc/guide.html b/doc/guide.html
index 8cf7310ec..98db96307 100644
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -2134,6 +2134,18 @@ number of rooms that any given user can join. The default value
is 10. This option is used to prevent possible abuses. Note that
this is a soft limit: some users can sometimes join more conferences
in cluster configurations.
+</DD><DT CLASS="dt-description"><B><TT>max_room_id</TT></B></DT><DD CLASS="dd-description">
+This option defines the maximum number of characters that Room ID
+can have when creating a new room.
+The default value is to not limit: infinite.
+</DD><DT CLASS="dt-description"><B><TT>max_room_name</TT></B></DT><DD CLASS="dd-description">
+This option defines the maximum number of characters that Room Name
+can have when configuring the room.
+The default value is to not limit: infinite.
+</DD><DT CLASS="dt-description"><B><TT>max_room_desc</TT></B></DT><DD CLASS="dd-description">
+This option defines the maximum number of characters that Room Description
+can have when configuring the room.
+The default value is to not limit: infinite.
</DD><DT CLASS="dt-description"><B><TT>min_message_interval</TT></B></DT><DD CLASS="dd-description">
This option defines the minimum interval between two messages send
by an occupant in seconds. This option is global and valid for all
@@ -2245,12 +2257,17 @@ and the default value of 20 history messages will be send to the users.
]}.
</PRE></LI><LI CLASS="li-itemize">In the following example, MUC anti abuse options are used. An
occupant cannot send more than one message every 0.4 seconds and cannot
-change its presence more than once every 4 seconds. No ACLs are
+change its presence more than once every 4 seconds.
+The length of Room IDs and Room Names are limited to 20 characters,
+and Room Description to 300 characters. No ACLs are
defined, but some user restriction could be added as well:<PRE CLASS="verbatim">{modules,
[
...
{mod_muc, [{min_message_interval, 0.4},
- {min_presence_interval, 4}]},
+ {min_presence_interval, 4},
+ {max_room_id, 20},
+ {max_room_name, 20},
+ {max_room_desc, 300}]},
...
]}.
</PRE></LI><LI CLASS="li-itemize">This example shows how to use <TT>default_room_options</TT> to make sure
diff --git a/doc/guide.tex b/doc/guide.tex
index ab9d11324..159ac6133 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -2811,6 +2811,18 @@ Module options:
is 10. This option is used to prevent possible abuses. Note that
this is a soft limit: some users can sometimes join more conferences
in cluster configurations.
+\titem{max\_room\_id} \ind{options!max\_room\_id}
+ This option defines the maximum number of characters that Room ID
+ can have when creating a new room.
+ The default value is to not limit: infinite.
+\titem{max\_room\_name} \ind{options!max\_room\_name}
+ This option defines the maximum number of characters that Room Name
+ can have when configuring the room.
+ The default value is to not limit: infinite.
+\titem{max\_room\_desc} \ind{options!max\_room\_desc}
+ This option defines the maximum number of characters that Room Description
+ can have when configuring the room.
+ The default value is to not limit: infinite.
\titem{min\_message\_interval} \ind{options!min\_message\_interval}
This option defines the minimum interval between two messages send
by an occupant in seconds. This option is global and valid for all
@@ -2929,7 +2941,9 @@ Examples:
\item In the following example, MUC anti abuse options are used. An
occupant cannot send more than one message every 0.4 seconds and cannot
-change its presence more than once every 4 seconds. No ACLs are
+change its presence more than once every 4 seconds.
+The length of Room IDs and Room Names are limited to 20 characters,
+and Room Description to 300 characters. No ACLs are
defined, but some user restriction could be added as well:
\begin{verbatim}
@@ -2937,7 +2951,10 @@ defined, but some user restriction could be added as well:
[
...
{mod_muc, [{min_message_interval, 0.4},
- {min_presence_interval, 4}]},
+ {min_presence_interval, 4},
+ {max_room_id, 20},
+ {max_room_name, 20},
+ {max_room_desc, 300}]},
...
]}.
\end{verbatim}