| CODENOTIFIER | HelpYou are not signed inSign in |
Project: ejabberd
Revision: 1532
Author: badlop
Date: 21 Aug 2008 11:13:25
Changes: * doc/guide.tex: Fix names of chatroom to room, user to occupant
* doc/guide.html: Likewise
| ... | ...@@ -2563,31 +2563,28 @@ | |
| 2563 | 2563 | \makesubsection{modmuc}{\modmuc{}} |
| 2564 | 2564 | \ind{modules!\modmuc{}}\ind{protocols!XEP-0045: Multi-User Chat}\ind{conferencing} |
| 2565 | 2565 | |
| 2566 | With this module enabled, your server will support Multi-User Chat | |
| 2567 | (\xepref{0045}). End users will be able to join text conferences. | |
| 2566 | This module provides a Multi-User Chat (\xepref{0045}) service. | |
| 2567 | Users can discover existing rooms, join or create them. | |
| 2568 | Occupants of a room can chat in public or have private chats. | |
| 2568 | 2569 | |
| 2569 | 2570 | Some of the features of Multi-User Chat: |
| 2570 | 2571 | \begin{itemize} |
| 2571 | \item Sending private messages to room participants. | |
| 2572 | \item Inviting users. | |
| 2573 | \item Setting a conference topic. | |
| 2572 | \item Sending public and private messages to room occupants. | |
| 2573 | \item Inviting other users to a room. | |
| 2574 | \item Setting a room subject. | |
| 2574 | 2575 | \item Creating password protected rooms. |
| 2575 | \item Kicking and banning participants. | |
| 2576 | \item Kicking and banning occupants. | |
| 2576 | 2577 | \end{itemize} |
| 2577 | 2578 | |
| 2578 | 2579 | The MUC service allows any Jabber ID to register a nickname, |
| 2579 | 2580 | so nobody else can use that nickname in any room in the MUC service. |
| 2580 | 2581 | To register a nickname, open the Service Discovery in your |
| 2581 | Jabber client and Register in the MUC service. | |
| 2582 | ||
| 2583 | The MUC service allows the service administrator to send a message | |
| 2584 | to all existing chatrooms. | |
| 2585 | To do so, send the message to the Jabber ID of the MUC service. | |
| 2582 | Jabber client and register in the MUC service. | |
| 2586 | 2583 | |
| 2587 | 2584 | This module supports clustering and load |
| 2588 | 2585 | balancing. One module can be started per cluster node. Rooms are |
| 2589 | 2586 | distributed at creation time on all available MUC module |
| 2590 | instances. The multi-user chat module is clustered but the room | |
| 2587 | instances. The multi-user chat module is clustered but the rooms | |
| 2591 | 2588 | themselves are not clustered nor fault-tolerant: if the node managing a |
| 2592 | 2589 | set of rooms goes down, the rooms disappear and they will be recreated |
| 2593 | 2590 | on an available node on first connection attempt. |
| ... | ...@@ -2596,19 +2593,19 @@ | |
| 2596 | 2593 | \begin{description} |
| 2597 | 2594 | \hostitem{conference} |
| 2598 | 2595 | \titem{access} \ind{options!access}You can specify who is allowed to use |
| 2599 | the Multi-User Chat service (by default, everyone is allowed to use it). | |
| 2596 | the Multi-User Chat service. By default everyone is allowed to use it. | |
| 2600 | 2597 | \titem{access\_create} \ind{options!access\_create}To configure who is |
| 2601 | 2598 | allowed to create new rooms at the Multi-User Chat service, this option |
| 2602 | can be used (by default, everybody is allowed to create rooms). | |
| 2599 | can be used. By default everybody is allowed to create rooms. | |
| 2603 | 2600 | \titem{access\_persistent} \ind{options!access\_persistent}To configure who is |
| 2604 | allowed to modify the 'persistent' chatroom option | |
| 2605 | (by default, everybody is allowed to modify that option). | |
| 2601 | allowed to modify the 'persistent' room option. | |
| 2602 | By default everybody is allowed to modify that option. | |
| 2606 | 2603 | \titem{access\_admin} \ind{options!access\_admin}This option specifies |
| 2607 | who is allowed to administrate the Multi-User Chat service (the default | |
| 2604 | who is allowed to administrate the Multi-User Chat service. The default | |
| 2608 | 2605 | value is \term{none}, which means that only the room creator can |
| 2609 | administer his room). | |
| 2606 | administer his room. | |
| 2610 | 2607 | The administrators can send a normal message to the service JID, |
| 2611 | and it will be shown in every active room as a service message. | |
| 2608 | and it will be shown in all active rooms as a service message. | |
| 2612 | 2609 | The administrators can send a groupchat message to the JID of an active room, |
| 2613 | 2610 | and the message will be shown in the room as a service message. |
| 2614 | 2611 | \titem{history\_size} \ind{options!history\_size}A small history of |
| ... | ...@@ -2618,44 +2615,43 @@ | |
| 2618 | 2615 | integer. Setting the value to \term{0} disables the history feature |
| 2619 | 2616 | and, as a result, nothing is kept in memory. The default value is |
| 2620 | 2617 | \term{20}. This value is global and thus affects all rooms on the |
| 2621 | server. | |
| 2618 | service. | |
| 2622 | 2619 | \titem{max\_users} \ind{options!max\_users} This option defines at |
| 2623 | the server level, the maximum number of users allowed per MUC | |
| 2620 | the service level, the maximum number of users allowed per | |
| 2624 | 2621 | room. It can be lowered in each room configuration but cannot be |
| 2625 | increased in individual MUC room configuration. The default value is | |
| 2622 | increased in individual room configuration. The default value is | |
| 2626 | 2623 | 200. |
| 2627 | 2624 | \titem{max\_users\_admin\_threshold} |
| 2628 | 2625 | \ind{options!max\_users\_admin\_threshold} This option defines the |
| 2629 | number of MUC admins or owners to allow to enter the room even if | |
| 2630 | the maximum number of allowed users is reached. The default limits | |
| 2631 | is 5. In most cases this default value is the best setting. | |
| 2626 | number of service admins or room owners allowed to enter the room when | |
| 2627 | the maximum number of allowed occupants was reached. The default limit | |
| 2628 | is 5. | |
| 2632 | 2629 | \titem{max\_user\_conferences} |
| 2633 | \ind{options!max\_user\_conferences} This option define the maximum | |
| 2634 | number of chat room any given user will be able to join. The default | |
| 2630 | \ind{options!max\_user\_conferences} This option defines the maximum | |
| 2631 | number of rooms that any given user can join. The default value | |
| 2635 | 2632 | is 10. This option is used to prevent possible abuses. Note that |
| 2636 | this is a soft limits: Some users can sometime join more conferences | |
| 2633 | this is a soft limit: some users can sometimes join more conferences | |
| 2637 | 2634 | in cluster configurations. |
| 2638 | 2635 | \titem{min\_message\_interval} \ind{options!min\_message\_interval} |
| 2639 | 2636 | This option defines the minimum interval between two messages send |
| 2640 | by a user in seconds. This option is global and valid for all chat | |
| 2637 | by an occupant in seconds. This option is global and valid for all | |
| 2641 | 2638 | rooms. A decimal value can be used. When this option is not defined, |
| 2642 | 2639 | message rate is not limited. This feature can be used to protect a |
| 2643 | MUC service from users abuses and limit number of messages that will | |
| 2640 | MUC service from occupant abuses and limit number of messages that will | |
| 2644 | 2641 | be broadcasted by the service. A good value for this minimum message |
| 2645 | interval is 0.4 second. If a user tries to send messages faster, an | |
| 2646 | error is send back explaining that the message have been discarded | |
| 2642 | interval is 0.4 second. If an occupant tries to send messages faster, an | |
| 2643 | error is send back explaining that the message has been discarded | |
| 2647 | 2644 | and describing the reason why the message is not acceptable. |
| 2648 | 2645 | \titem{min\_presence\_interval} |
| 2649 | 2646 | \ind{options!min\_presence\_interval} This option defines the |
| 2650 | minimum of time between presence changes coming from a given user in | |
| 2651 | seconds. This option is global and valid for all chat rooms. A | |
| 2647 | minimum of time between presence changes coming from a given occupant in | |
| 2648 | seconds. This option is global and valid for all rooms. A | |
| 2652 | 2649 | decimal value can be used. When this option is not defined, no |
| 2653 | 2650 | restriction is applied. This option can be used to protect a MUC |
| 2654 | service for users abuses, as fastly changing a user presence will | |
| 2655 | result in possible large presence packet broadcast. If a user tries | |
| 2651 | service for occupants abuses. If an occupant tries | |
| 2656 | 2652 | to change its presence more often than the specified interval, the |
| 2657 | 2653 | presence is cached by \ejabberd{} and only the last presence is |
| 2658 | broadcasted to all users in the room after expiration of the | |
| 2654 | broadcasted to all occupants in the room after expiration of the | |
| 2659 | 2655 | interval delay. Intermediate presence packets are silently |
| 2660 | 2656 | discarded. A good value for this option is 4 seconds. |
| 2661 | 2657 | \titem{default\_room\_options} \ind{options!default\_room\_options} |
| ... | ...@@ -2750,8 +2746,8 @@ | |
| 2750 | 2746 | ]}. |
| 2751 | 2747 | \end{verbatim} |
| 2752 | 2748 | |
| 2753 | \item In the following example, MUC anti abuse options are used. A | |
| 2754 | user cannot send more than one message every 0.4 seconds and cannot | |
| 2749 | \item In the following example, MUC anti abuse options are used. An | |
| 2750 | occupant cannot send more than one message every 0.4 seconds and cannot | |
| 2755 | 2751 | change its presence more than once every 4 seconds. No ACLs are |
| 2756 | 2752 | defined, but some user restriction could be added as well: |
| 2757 | 2753 | |
| ... | ...@@ -2766,7 +2762,7 @@ | |
| 2766 | 2762 | \end{verbatim} |
| 2767 | 2763 | |
| 2768 | 2764 | \item This example shows how to use \option{default\_room\_options} to make sure |
| 2769 | newly created chatrooms have by default those options. | |
| 2765 | the newly created rooms have by default those options. | |
| 2770 | 2766 | \begin{verbatim} |
| 2771 | 2767 | {modules, |
| 2772 | 2768 | [ |
| ... | ...@@ -2791,19 +2787,19 @@ | |
| 2791 | 2787 | \makesubsection{modmuclog}{\modmuclog{}} |
| 2792 | 2788 | \ind{modules!\modmuclog{}} |
| 2793 | 2789 | |
| 2794 | This module enables optional logging of Multi-User Chat (MUC) conversations to | |
| 2795 | HTML. Once you enable this module, users can join a chatroom using a MUC capable | |
| 2790 | This module enables optional logging of Multi-User Chat (MUC) public conversations to | |
| 2791 | HTML. Once you enable this module, users can join a room using a MUC capable | |
| 2796 | 2792 | Jabber client, and if they have enough privileges, they can request the |
| 2797 | configuration form in which they can set the option to enable chatroom logging. | |
| 2793 | configuration form in which they can set the option to enable room logging. | |
| 2798 | 2794 | |
| 2799 | 2795 | Features: |
| 2800 | 2796 | \begin{itemize} |
| 2801 | \item Chatroom details are added on top of each page: room title, JID, | |
| 2797 | \item Room details are added on top of each page: room title, JID, | |
| 2802 | 2798 | author, subject and configuration. |
| 2803 | 2799 | \item \ind{protocols!RFC 5122: Internationalized Resource Identifiers (IRIs) and Uniform Resource Identifiers (URIs) for the Extensible Messaging and Presence Protocol (XMPP)} |
| 2804 | The room JID in the generated HTML is a link to join the chatroom (using | |
| 2800 | The room JID in the generated HTML is a link to join the room (using | |
| 2805 | 2801 | \footahref{http://www.xmpp.org/rfcs/rfc5122.html}{XMPP URI}). |
| 2806 | \item Subject and chatroom configuration changes are tracked and displayed. | |
| 2802 | \item Subject and room configuration changes are tracked and displayed. | |
| 2807 | 2803 | \item Joins, leaves, nick changes, kicks, bans and `/me' are tracked and |
| 2808 | 2804 | displayed, including the reason if available. |
| 2809 | 2805 | \item Generated HTML files are XHTML 1.0 Transitional and CSS compliant. |
| ... | ...@@ -2818,7 +2814,7 @@ | |
| 2818 | 2814 | Options: |
| 2819 | 2815 | \begin{description} |
| 2820 | 2816 | \titem{access\_log}\ind{options!access\_log} |
| 2821 | This option restricts which users are allowed to enable or disable chatroom | |
| 2817 | This option restricts which occupants are allowed to enable or disable room | |
| 2822 | 2818 | logging. The default value is \term{muc\_admin}. Note for this default setting |
| 2823 | 2819 | you need to have an access rule for \term{muc\_admin} in order to take effect. |
| 2824 | 2820 | \titem{cssfile}\ind{options!cssfile} |
| ... | ...@@ -2868,8 +2864,8 @@ | |
| 2868 | 2864 | |
| 2869 | 2865 | Examples: |
| 2870 | 2866 | \begin{itemize} |
| 2871 | \item In the first example any chatroom owner can enable logging, and a | |
| 2872 | custom CSS file will be used (http://example.com/my.css). Further, the names | |
| 2867 | \item In the first example any room owner can enable logging, and a | |
| 2868 | custom CSS file will be used (http://example.com/my.css). The names | |
| 2873 | 2869 | of the log files will contain the full date, and there will be no |
| 2874 | 2870 | subdirectories. The log files will be stored in /var/www/muclogs, and the |
| 2875 | 2871 | time zone will be GMT/UTC. Finally, the top link will be |
| ... | ...@@ -2895,7 +2891,7 @@ | |
| 2895 | 2891 | \end{verbatim} |
| 2896 | 2892 | \item In the second example only \jid{admin1@example.org} and |
| 2897 | 2893 | \jid{admin2@example.net} can enable logging, and the embedded CSS file will be |
| 2898 | used. Further, the names of the log files will only contain the day (number), | |
| 2894 | used. The names of the log files will only contain the day (number), | |
| 2899 | 2895 | and there will be subdirectories for each year and month. The log files will |
| 2900 | 2896 | be stored in /var/www/muclogs, and the local time will be used. Finally, the |
| 2901 | 2897 | top link will be the default \verb|<a href="/">Home</a>|. |
| ... | ...@@ -1945,23 +1945,22 @@ | |
| 1945 | 1945 | the processing discipline for Last activity (<TT>jabber:iq:last</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>). |
| 1946 | 1946 | </DD></DL><P> <A NAME="modmuc"></A> </P><!--TOC subsection <TT>mod_muc</TT>--> |
| 1947 | 1947 | <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc44">3.3.8</A>  <A HREF="#modmuc"><TT>mod_muc</TT></A></H3><!--SEC END --><P> <A NAME="modmuc"></A> |
| 1948 | </P><P>With this module enabled, your server will support Multi-User Chat | |
| 1949 | (<A HREF="http://www.xmpp.org/extensions/xep-0045.html">XEP-0045</A>). End users will be able to join text conferences.</P><P>Some of the features of Multi-User Chat: | |
| 1948 | </P><P>This module provides a Multi-User Chat (<A HREF="http://www.xmpp.org/extensions/xep-0045.html">XEP-0045</A>) service. | |
| 1949 | Users can discover existing rooms, join or create them. | |
| 1950 | Occupants of a room can chat in public or have private chats.</P><P>Some of the features of Multi-User Chat: | |
| 1950 | 1951 | </P><UL CLASS="itemize"><LI CLASS="li-itemize"> |
| 1951 | Sending private messages to room participants. | |
| 1952 | </LI><LI CLASS="li-itemize">Inviting users. | |
| 1953 | </LI><LI CLASS="li-itemize">Setting a conference topic. | |
| 1952 | Sending public and private messages to room occupants. | |
| 1953 | </LI><LI CLASS="li-itemize">Inviting other users to a room. | |
| 1954 | </LI><LI CLASS="li-itemize">Setting a room subject. | |
| 1954 | 1955 | </LI><LI CLASS="li-itemize">Creating password protected rooms. |
| 1955 | </LI><LI CLASS="li-itemize">Kicking and banning participants. | |
| 1956 | </LI><LI CLASS="li-itemize">Kicking and banning occupants. | |
| 1956 | 1957 | </LI></UL><P>The MUC service allows any Jabber ID to register a nickname, |
| 1957 | 1958 | so nobody else can use that nickname in any room in the MUC service. |
| 1958 | 1959 | To register a nickname, open the Service Discovery in your |
| 1959 | Jabber client and Register in the MUC service.</P><P>The MUC service allows the service administrator to send a message | |
| 1960 | to all existing chatrooms. | |
| 1961 | To do so, send the message to the Jabber ID of the MUC service.</P><P>This module supports clustering and load | |
| 1960 | Jabber client and register in the MUC service.</P><P>This module supports clustering and load | |
| 1962 | 1961 | balancing. One module can be started per cluster node. Rooms are |
| 1963 | 1962 | distributed at creation time on all available MUC module |
| 1964 | instances. The multi-user chat module is clustered but the room | |
| 1963 | instances. The multi-user chat module is clustered but the rooms | |
| 1965 | 1964 | themselves are not clustered nor fault-tolerant: if the node managing a |
| 1966 | 1965 | set of rooms goes down, the rooms disappear and they will be recreated |
| 1967 | 1966 | on an available node on first connection attempt.</P><P>Module options: |
| ... | ...@@ -1973,19 +1972,19 @@ | |
| 1973 | 1972 | is replaced at start time with the real virtual host name. |
| 1974 | 1973 | |
| 1975 | 1974 | </DD><DT CLASS="dt-description"><B><TT>access</TT></B></DT><DD CLASS="dd-description"> You can specify who is allowed to use |
| 1976 | the Multi-User Chat service (by default, everyone is allowed to use it). | |
| 1975 | the Multi-User Chat service. By default everyone is allowed to use it. | |
| 1977 | 1976 | </DD><DT CLASS="dt-description"><B><TT>access_create</TT></B></DT><DD CLASS="dd-description"> To configure who is |
| 1978 | 1977 | allowed to create new rooms at the Multi-User Chat service, this option |
| 1979 | can be used (by default, everybody is allowed to create rooms). | |
| 1978 | can be used. By default everybody is allowed to create rooms. | |
| 1980 | 1979 | </DD><DT CLASS="dt-description"><B><TT>access_persistent</TT></B></DT><DD CLASS="dd-description"> To configure who is |
| 1981 | allowed to modify the ’persistent’ chatroom option | |
| 1982 | (by default, everybody is allowed to modify that option). | |
| 1980 | allowed to modify the ’persistent’ room option. | |
| 1981 | By default everybody is allowed to modify that option. | |
| 1983 | 1982 | </DD><DT CLASS="dt-description"><B><TT>access_admin</TT></B></DT><DD CLASS="dd-description"> This option specifies |
| 1984 | who is allowed to administrate the Multi-User Chat service (the default | |
| 1983 | who is allowed to administrate the Multi-User Chat service. The default | |
| 1985 | 1984 | value is <TT>none</TT>, which means that only the room creator can |
| 1986 | administer his room). | |
| 1985 | administer his room. | |
| 1987 | 1986 | The administrators can send a normal message to the service JID, |
| 1988 | and it will be shown in every active room as a service message. | |
| 1987 | and it will be shown in all active rooms as a service message. | |
| 1989 | 1988 | The administrators can send a groupchat message to the JID of an active room, |
| 1990 | 1989 | and the message will be shown in the room as a service message. |
| 1991 | 1990 | </DD><DT CLASS="dt-description"><B><TT>history_size</TT></B></DT><DD CLASS="dd-description"> A small history of |
| ... | ...@@ -1995,44 +1994,43 @@ | |
| 1995 | 1994 | integer. Setting the value to <TT>0</TT> disables the history feature |
| 1996 | 1995 | and, as a result, nothing is kept in memory. The default value is |
| 1997 | 1996 | <TT>20</TT>. This value is global and thus affects all rooms on the |
| 1998 | server. | |
| 1997 | service. | |
| 1999 | 1998 | </DD><DT CLASS="dt-description"><B><TT>max_users</TT></B></DT><DD CLASS="dd-description"> This option defines at |
| 2000 | the server level, the maximum number of users allowed per MUC | |
| 1999 | the service level, the maximum number of users allowed per | |
| 2001 | 2000 | room. It can be lowered in each room configuration but cannot be |
| 2002 | increased in individual MUC room configuration. The default value is | |
| 2001 | increased in individual room configuration. The default value is | |
| 2003 | 2002 | 200. |
| 2004 | 2003 | </DD><DT CLASS="dt-description"><B><TT>max_users_admin_threshold</TT></B></DT><DD CLASS="dd-description"> |
| 2005 | 2004 | This option defines the |
| 2006 | number of MUC admins or owners to allow to enter the room even if | |
| 2007 | the maximum number of allowed users is reached. The default limits | |
| 2008 | is 5. In most cases this default value is the best setting. | |
| 2005 | number of service admins or room owners allowed to enter the room when | |
| 2006 | the maximum number of allowed occupants was reached. The default limit | |
| 2007 | is 5. | |
| 2009 | 2008 | </DD><DT CLASS="dt-description"><B><TT>max_user_conferences</TT></B></DT><DD CLASS="dd-description"> |
| 2010 | This option define the maximum | |
| 2011 | number of chat room any given user will be able to join. The default | |
| 2009 | This option defines the maximum | |
| 2010 | number of rooms that any given user can join. The default value | |
| 2012 | 2011 | is 10. This option is used to prevent possible abuses. Note that |
| 2013 | this is a soft limits: Some users can sometime join more conferences | |
| 2012 | this is a soft limit: some users can sometimes join more conferences | |
| 2014 | 2013 | in cluster configurations. |
| 2015 | 2014 | </DD><DT CLASS="dt-description"><B><TT>min_message_interval</TT></B></DT><DD CLASS="dd-description"> |
| 2016 | 2015 | This option defines the minimum interval between two messages send |
| 2017 | by a user in seconds. This option is global and valid for all chat | |
| 2016 | by an occupant in seconds. This option is global and valid for all | |
| 2018 | 2017 | rooms. A decimal value can be used. When this option is not defined, |
| 2019 | 2018 | message rate is not limited. This feature can be used to protect a |
| 2020 | MUC service from users abuses and limit number of messages that will | |
| 2019 | MUC service from occupant abuses and limit number of messages that will | |
| 2021 | 2020 | be broadcasted by the service. A good value for this minimum message |
| 2022 | interval is 0.4 second. If a user tries to send messages faster, an | |
| 2023 | error is send back explaining that the message have been discarded | |
| 2021 | interval is 0.4 second. If an occupant tries to send messages faster, an | |
| 2022 | error is send back explaining that the message has been discarded | |
| 2024 | 2023 | and describing the reason why the message is not acceptable. |
| 2025 | 2024 | </DD><DT CLASS="dt-description"><B><TT>min_presence_interval</TT></B></DT><DD CLASS="dd-description"> |
| 2026 | 2025 | This option defines the |
| 2027 | minimum of time between presence changes coming from a given user in | |
| 2028 | seconds. This option is global and valid for all chat rooms. A | |
| 2026 | minimum of time between presence changes coming from a given occupant in | |
| 2027 | seconds. This option is global and valid for all rooms. A | |
| 2029 | 2028 | decimal value can be used. When this option is not defined, no |
| 2030 | 2029 | restriction is applied. This option can be used to protect a MUC |
| 2031 | service for users abuses, as fastly changing a user presence will | |
| 2032 | result in possible large presence packet broadcast. If a user tries | |
| 2030 | service for occupants abuses. If an occupant tries | |
| 2033 | 2031 | to change its presence more often than the specified interval, the |
| 2034 | 2032 | presence is cached by <TT>ejabberd</TT> and only the last presence is |
| 2035 | broadcasted to all users in the room after expiration of the | |
| 2033 | broadcasted to all occupants in the room after expiration of the | |
| 2036 | 2034 | interval delay. Intermediate presence packets are silently |
| 2037 | 2035 | discarded. A good value for this option is 4 seconds. |
| 2038 | 2036 | </DD><DT CLASS="dt-description"><B><TT>default_room_options</TT></B></DT><DD CLASS="dd-description"> |
| ... | ...@@ -2120,8 +2118,8 @@ | |
| 2120 | 2118 | {access_admin, muc_admins}]}, |
| 2121 | 2119 | ... |
| 2122 | 2120 | ]}. |
| 2123 | </PRE></LI><LI CLASS="li-itemize">In the following example, MUC anti abuse options are used. A | |
| 2124 | user cannot send more than one message every 0.4 seconds and cannot | |
| 2121 | </PRE></LI><LI CLASS="li-itemize">In the following example, MUC anti abuse options are used. An | |
| 2122 | occupant cannot send more than one message every 0.4 seconds and cannot | |
| 2125 | 2123 | change its presence more than once every 4 seconds. No ACLs are |
| 2126 | 2124 | defined, but some user restriction could be added as well:<PRE CLASS="verbatim">{modules, |
| 2127 | 2125 | [ |
| ... | ...@@ -2131,7 +2129,7 @@ | |
| 2131 | 2129 | ... |
| 2132 | 2130 | ]}. |
| 2133 | 2131 | </PRE></LI><LI CLASS="li-itemize">This example shows how to use <TT>default_room_options</TT> to make sure |
| 2134 | newly created chatrooms have by default those options. | |
| 2132 | the newly created rooms have by default those options. | |
| 2135 | 2133 | <PRE CLASS="verbatim">{modules, |
| 2136 | 2134 | [ |
| 2137 | 2135 | ... |
| ... | ...@@ -2151,17 +2149,17 @@ | |
| 2151 | 2149 | ]}. |
| 2152 | 2150 | </PRE></LI></UL><P> <A NAME="modmuclog"></A> </P><!--TOC subsection <TT>mod_muc_log</TT>--> |
| 2153 | 2151 | <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc45">3.3.9</A>  <A HREF="#modmuclog"><TT>mod_muc_log</TT></A></H3><!--SEC END --><P> <A NAME="modmuclog"></A> |
| 2154 | </P><P>This module enables optional logging of Multi-User Chat (MUC) conversations to | |
| 2155 | HTML. Once you enable this module, users can join a chatroom using a MUC capable | |
| 2152 | </P><P>This module enables optional logging of Multi-User Chat (MUC) public conversations to | |
| 2153 | HTML. Once you enable this module, users can join a room using a MUC capable | |
| 2156 | 2154 | Jabber client, and if they have enough privileges, they can request the |
| 2157 | configuration form in which they can set the option to enable chatroom logging.</P><P>Features: | |
| 2155 | configuration form in which they can set the option to enable room logging.</P><P>Features: | |
| 2158 | 2156 | </P><UL CLASS="itemize"><LI CLASS="li-itemize"> |
| 2159 | Chatroom details are added on top of each page: room title, JID, | |
| 2157 | Room details are added on top of each page: room title, JID, | |
| 2160 | 2158 | author, subject and configuration. |
| 2161 | 2159 | </LI><LI CLASS="li-itemize"> |
| 2162 | The room JID in the generated HTML is a link to join the chatroom (using | |
| 2160 | The room JID in the generated HTML is a link to join the room (using | |
| 2163 | 2161 | <A HREF="http://www.xmpp.org/rfcs/rfc5122.html">XMPP URI</A>). |
| 2164 | </LI><LI CLASS="li-itemize">Subject and chatroom configuration changes are tracked and displayed. | |
| 2162 | </LI><LI CLASS="li-itemize">Subject and room configuration changes are tracked and displayed. | |
| 2165 | 2163 | </LI><LI CLASS="li-itemize">Joins, leaves, nick changes, kicks, bans and ‘/me’ are tracked and |
| 2166 | 2164 | displayed, including the reason if available. |
| 2167 | 2165 | </LI><LI CLASS="li-itemize">Generated HTML files are XHTML 1.0 Transitional and CSS compliant. |
| ... | ...@@ -2174,7 +2172,7 @@ | |
| 2174 | 2172 | </LI></UL><P>Options: |
| 2175 | 2173 | </P><DL CLASS="description"><DT CLASS="dt-description"> |
| 2176 | 2174 | <B><TT>access_log</TT></B></DT><DD CLASS="dd-description"> |
| 2177 | This option restricts which users are allowed to enable or disable chatroom | |
| 2175 | This option restricts which occupants are allowed to enable or disable room | |
| 2178 | 2176 | logging. The default value is <TT>muc_admin</TT>. Note for this default setting |
| 2179 | 2177 | you need to have an access rule for <TT>muc_admin</TT> in order to take effect. |
| 2180 | 2178 | </DD><DT CLASS="dt-description"><B><TT>cssfile</TT></B></DT><DD CLASS="dd-description"> |
| ... | ...@@ -2222,8 +2220,8 @@ | |
| 2222 | 2220 | value is <TT>{"/", "Home"}</TT>. |
| 2223 | 2221 | </DD></DL><P>Examples: |
| 2224 | 2222 | </P><UL CLASS="itemize"><LI CLASS="li-itemize"> |
| 2225 | In the first example any chatroom owner can enable logging, and a | |
| 2226 | custom CSS file will be used (http://example.com/my.css). Further, the names | |
| 2223 | In the first example any room owner can enable logging, and a | |
| 2224 | custom CSS file will be used (http://example.com/my.css). The names | |
| 2227 | 2225 | of the log files will contain the full date, and there will be no |
| 2228 | 2226 | subdirectories. The log files will be stored in /var/www/muclogs, and the |
| 2229 | 2227 | time zone will be GMT/UTC. Finally, the top link will be |
| ... | ...@@ -2247,7 +2245,7 @@ | |
| 2247 | 2245 | ]}. |
| 2248 | 2246 | </PRE></LI><LI CLASS="li-itemize">In the second example only <TT>admin1@example.org</TT> and |
| 2249 | 2247 | <TT>admin2@example.net</TT> can enable logging, and the embedded CSS file will be |
| 2250 | used. Further, the names of the log files will only contain the day (number), | |
| 2248 | used. The names of the log files will only contain the day (number), | |
| 2251 | 2249 | and there will be subdirectories for each year and month. The log files will |
| 2252 | 2250 | be stored in /var/www/muclogs, and the local time will be used. Finally, the |
| 2253 | 2251 | top link will be the default <CODE><a href="/">Home</a></CODE>. |
| ... | ...@@ -1,3 +1,8 @@ | |
| 1 | 2008-08-21 Badlop <badlop@process-one.net> | |
| 2 | ||
| 3 | * doc/guide.tex: Fix names of chatroom to room, user to occupant | |
| 4 | * doc/guide.html: Likewise | |
| 5 | ||
| 1 | 6 | 2008-08-18 Badlop <badlop@process-one.net> |
| 2 | 7 | |
| 3 | 8 | * src/mod_muc/mod_muc_log.erl: MUC log files options: plaintext |