diff options
| author | Alexey Shchepin <alexey@process-one.net> | 2004-08-13 02:34:19 +0400 |
|---|---|---|
| committer | Alexey Shchepin <alexey@process-one.net> | 2004-08-13 02:34:19 +0400 |
| commit | d77a936b322220a67e703525ff585660ea8da670 (patch) | |
| tree | 69c3cb1dfd199de6f78884f1e3db9a991958c42e /doc | |
| parent | 357554265e4c86c5cd0dc3b6ae2f69f20c85786b (diff) | |
* src/ejabberd_c2s.erl: Bugfix in resend_offline_messages/1
* src/mod_announce.erl: New module to manage announce messages
(thanks to Sergei Golovan)
* src/ejabberd_local.erl: Moved processing of announce messages to
mod_announce (thanks to Sergei Golovan)
* src/ejabberd_c2s.erl: Added several hooks
* src/ejabberd_hooks.erl: Fixed run_fold (thanks to Sergei
Golovan)
* src/ejabberd.cfg.example: Updated (thanks to Sergei Golovan)
* doc/guide.tex: Updated (thanks to Sergei Golovan)
SVN Revision: 256
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guide.html | 107 | ||||
| -rw-r--r-- | doc/guide.tex | 26 |
2 files changed, 92 insertions, 41 deletions
diff --git a/doc/guide.html b/doc/guide.html index 851bb0384..1d0927ac8 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -85,24 +85,25 @@ <A HREF="#htoc30">A.1.1 Option <TT>iqdisc</TT></A> <LI><A HREF="#htoc31">A.1.2 Option <TT>host</TT></A> </UL> -<LI><A HREF="#htoc32">A.2 <TT>mod_configure</TT></A> -<LI><A HREF="#htoc33">A.3 <TT>mod_disco</TT></A> -<LI><A HREF="#htoc34">A.4 <TT>mod_echo</TT></A> -<LI><A HREF="#htoc35">A.5 <TT>mod_irc</TT></A> -<LI><A HREF="#htoc36">A.6 <TT>mod_last</TT></A> -<LI><A HREF="#htoc37">A.7 <TT>mod_muc</TT></A> -<LI><A HREF="#htoc38">A.8 <TT>mod_offline</TT></A> -<LI><A HREF="#htoc39">A.9 <TT>mod_privacy</TT></A> -<LI><A HREF="#htoc40">A.10 <TT>mod_private</TT></A> -<LI><A HREF="#htoc41">A.11 <TT>mod_pubsub</TT></A> -<LI><A HREF="#htoc42">A.12 <TT>mod_register</TT></A> -<LI><A HREF="#htoc43">A.13 <TT>mod_roster</TT></A> -<LI><A HREF="#htoc44">A.14 <TT>mod_stats</TT></A> -<LI><A HREF="#htoc45">A.15 <TT>mod_time</TT></A> -<LI><A HREF="#htoc46">A.16 <TT>mod_vcard</TT></A> -<LI><A HREF="#htoc47">A.17 <TT>mod_version</TT></A> +<LI><A HREF="#htoc32">A.2 <TT>mod_announce</TT></A> +<LI><A HREF="#htoc33">A.3 <TT>mod_configure</TT></A> +<LI><A HREF="#htoc34">A.4 <TT>mod_disco</TT></A> +<LI><A HREF="#htoc35">A.5 <TT>mod_echo</TT></A> +<LI><A HREF="#htoc36">A.6 <TT>mod_irc</TT></A> +<LI><A HREF="#htoc37">A.7 <TT>mod_last</TT></A> +<LI><A HREF="#htoc38">A.8 <TT>mod_muc</TT></A> +<LI><A HREF="#htoc39">A.9 <TT>mod_offline</TT></A> +<LI><A HREF="#htoc40">A.10 <TT>mod_privacy</TT></A> +<LI><A HREF="#htoc41">A.11 <TT>mod_private</TT></A> +<LI><A HREF="#htoc42">A.12 <TT>mod_pubsub</TT></A> +<LI><A HREF="#htoc43">A.13 <TT>mod_register</TT></A> +<LI><A HREF="#htoc44">A.14 <TT>mod_roster</TT></A> +<LI><A HREF="#htoc45">A.15 <TT>mod_stats</TT></A> +<LI><A HREF="#htoc46">A.16 <TT>mod_time</TT></A> +<LI><A HREF="#htoc47">A.17 <TT>mod_vcard</TT></A> +<LI><A HREF="#htoc48">A.18 <TT>mod_version</TT></A> </UL> -<LI><A HREF="#htoc48">B I18n/L10n</A> +<LI><A HREF="#htoc49">B I18n/L10n</A> </UL> <!--TOC section Introduction--> @@ -474,15 +475,15 @@ The following options are defined: <DT><B><TT>{ip, IPAddress}</TT></B><DD> This option specifies which network interface to listen on. For example <CODE>{ip, {192, 168, 1, 1}}</CODE>. <DT><B><TT>inet6</TT></B><DD> Set up the socket for IPv6. - <DT><B><TT>tls</TT></B><DD> This option specifies that STARTTLS extension is available on - connections to this port. You should also set ``<CODE>certfile</CODE>'' option. - <DT><B><TT>tls_from_start</TT></B><DD> Among with <TT>tls</TT> this option specifies that - traffic on this port will be encrypted using SSL immediately after - connecting. + <DT><B><TT>starttls</TT></B><DD> This option specifies that STARTTLS extension is available + on connections to this port. You should also set ``<CODE>certfile</CODE>'' + option. + <DT><B><TT>tls</TT></B><DD> This option specifies that traffic on this port will be + encrypted using SSL immediately after connecting. You should also set + ``<CODE>certfile</CODE>'' option. <DT><B><TT>ssl</TT></B><DD> This option specifies that traffic on this port will be encrypted using SSL. You should also set ``<CODE>certfile</CODE>'' option. It - is recommended to use <TT>tls</TT> and <TT>tls_from_start</TT> options - instead. + is recommended to use <TT>tls</TT> option instead. <DT><B><TT>{certfile, Path}</TT></B><DD> Path to a file containing the SSL certificate. </DL> <DT><B><TT>ejabberd_s2s_in</TT></B><DD> This module serves incoming S2S connections. @@ -818,9 +819,33 @@ Example: ... ]}. </PRE> +<!--TOC subsection <TT>mod_announce</TT>--> + +<H3><A NAME="htoc32">A.2</A> <TT>mod_announce</TT></H3><!--SEC END --> + +<A NAME="sec:modannounce"></A> +This module adds support for broadcast announce messages and MOTD.<BR> +<BR> +Options: +<DL COMPACT=compact><DT> +<B><TT>access</TT></B><DD> Specifies who is allowed to send announce messages +and set MOTD (default value is <TT>none</TT>). +</DL> +Example: +<PRE> + % Only admins can send announcement messages: + {access, announce, [{allow, admin}]}. + + {modules, + [ + ... + {mod_announce, [{access, announce}]}, + ... + ]}. +</PRE> <!--TOC subsection <TT>mod_configure</TT>--> -<H3><A NAME="htoc32">A.2</A> <TT>mod_configure</TT></H3><!--SEC END --> +<H3><A NAME="htoc33">A.3</A> <TT>mod_configure</TT></H3><!--SEC END --> <A NAME="sec:modconfigure"></A> Options: @@ -830,7 +855,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_disco</TT>--> -<H3><A NAME="htoc33">A.3</A> <TT>mod_disco</TT></H3><!--SEC END --> +<H3><A NAME="htoc34">A.4</A> <TT>mod_disco</TT></H3><!--SEC END --> <A NAME="sec:moddisco"></A> This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0030.html">JEP-0030</A> (Service Discovery).<BR> @@ -855,7 +880,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_echo</TT>--> -<H3><A NAME="htoc34">A.4</A> <TT>mod_echo</TT></H3><!--SEC END --> +<H3><A NAME="htoc35">A.5</A> <TT>mod_echo</TT></H3><!--SEC END --> <A NAME="sec:modecho"></A> This module acts as a service and simply returns to sender any Jabber packet. Module may be @@ -869,7 +894,7 @@ then prefix <TT>echo.</TT> is added to main <TT>ejabberd</TT> hostname. </DL> <!--TOC subsection <TT>mod_irc</TT>--> -<H3><A NAME="htoc35">A.5</A> <TT>mod_irc</TT></H3><!--SEC END --> +<H3><A NAME="htoc36">A.6</A> <TT>mod_irc</TT></H3><!--SEC END --> <A NAME="sec:modirc"></A> This module implements IRC transport.<BR> @@ -892,7 +917,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_last</TT>--> -<H3><A NAME="htoc36">A.6</A> <TT>mod_last</TT></H3><!--SEC END --> +<H3><A NAME="htoc37">A.7</A> <TT>mod_last</TT></H3><!--SEC END --> <A NAME="sec:modlast"></A> This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0012.html">JEP-0012</A> (Last Activity)<BR> @@ -904,7 +929,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_muc</TT>--> -<H3><A NAME="htoc37">A.7</A> <TT>mod_muc</TT></H3><!--SEC END --> +<H3><A NAME="htoc38">A.8</A> <TT>mod_muc</TT></H3><!--SEC END --> <A NAME="sec:modmuc"></A> This module implements <A HREF="http://www.jabber.org/jeps/jep-0045.html">JEP-0045</A> (Multi-User Chat) service.<BR> @@ -939,14 +964,14 @@ Example: </PRE> <!--TOC subsection <TT>mod_offline</TT>--> -<H3><A NAME="htoc38">A.8</A> <TT>mod_offline</TT></H3><!--SEC END --> +<H3><A NAME="htoc39">A.9</A> <TT>mod_offline</TT></H3><!--SEC END --> <A NAME="sec:modoffline"></A> This module implements offline message storage.<BR> <BR> <!--TOC subsection <TT>mod_privacy</TT>--> -<H3><A NAME="htoc39">A.9</A> <TT>mod_privacy</TT></H3><!--SEC END --> +<H3><A NAME="htoc40">A.10</A> <TT>mod_privacy</TT></H3><!--SEC END --> <A NAME="sec:modprivacy"></A> This module implements Privacy Rules as defined in XMPP IM @@ -959,7 +984,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_private</TT>--> -<H3><A NAME="htoc40">A.10</A> <TT>mod_private</TT></H3><!--SEC END --> +<H3><A NAME="htoc41">A.11</A> <TT>mod_private</TT></H3><!--SEC END --> <A NAME="sec:modprivate"></A> This module adds support of <A HREF="http://www.jabber.org/jeps/jep-0049.html">JEP-0049</A> (Private XML Storage).<BR> @@ -971,7 +996,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_pubsub</TT>--> -<H3><A NAME="htoc41">A.11</A> <TT>mod_pubsub</TT></H3><!--SEC END --> +<H3><A NAME="htoc42">A.12</A> <TT>mod_pubsub</TT></H3><!--SEC END --> <A NAME="sec:modpubsub"></A> This module implements <A HREF="http://www.jabber.org/jeps/jep-0060.html">JEP-0060</A> (Publish-Subscribe Service).<BR> @@ -996,7 +1021,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_register</TT>--> -<H3><A NAME="htoc42">A.12</A> <TT>mod_register</TT></H3><!--SEC END --> +<H3><A NAME="htoc43">A.13</A> <TT>mod_register</TT></H3><!--SEC END --> <A NAME="sec:modregister"></A> This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</A> (In-Band Registration).<BR> @@ -1029,7 +1054,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_roster</TT>--> -<H3><A NAME="htoc43">A.13</A> <TT>mod_roster</TT></H3><!--SEC END --> +<H3><A NAME="htoc44">A.14</A> <TT>mod_roster</TT></H3><!--SEC END --> <A NAME="sec:modroster"></A> This module implements roster management.<BR> @@ -1041,7 +1066,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_stats</TT>--> -<H3><A NAME="htoc44">A.14</A> <TT>mod_stats</TT></H3><!--SEC END --> +<H3><A NAME="htoc45">A.15</A> <TT>mod_stats</TT></H3><!--SEC END --> <A NAME="sec:modstats"></A> This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A> (Statistics Gathering).<BR> @@ -1055,7 +1080,7 @@ TBD about access.<BR> <BR> <!--TOC subsection <TT>mod_time</TT>--> -<H3><A NAME="htoc45">A.15</A> <TT>mod_time</TT></H3><!--SEC END --> +<H3><A NAME="htoc46">A.16</A> <TT>mod_time</TT></H3><!--SEC END --> <A NAME="sec:modtime"></A> This module answers UTC time on <TT>jabber:iq:time</TT> queries.<BR> @@ -1067,7 +1092,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_vcard</TT>--> -<H3><A NAME="htoc46">A.16</A> <TT>mod_vcard</TT></H3><!--SEC END --> +<H3><A NAME="htoc47">A.17</A> <TT>mod_vcard</TT></H3><!--SEC END --> <A NAME="sec:modvcard"></A> This module implements simple Jabber User Directory (based on user vCards) @@ -1095,7 +1120,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_version</TT>--> -<H3><A NAME="htoc47">A.17</A> <TT>mod_version</TT></H3><!--SEC END --> +<H3><A NAME="htoc48">A.18</A> <TT>mod_version</TT></H3><!--SEC END --> <A NAME="sec:modversion"></A> This module answers <TT>ejabberd</TT> version on <TT>jabber:iq:version</TT> queries.<BR> @@ -1107,7 +1132,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC section I18n/L10n--> -<H2><A NAME="htoc48">B</A> I18n/L10n</H2><!--SEC END --> +<H2><A NAME="htoc49">B</A> I18n/L10n</H2><!--SEC END --> <A NAME="sec:i18nl10n"></A> All built-in modules support <TT>xml:lang</TT> attribute inside IQ queries. diff --git a/doc/guide.tex b/doc/guide.tex index dd78dbb98..5e12c70db 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -34,6 +34,7 @@ \newcommand{\Jabber}{Jabber} \newcommand{\module}[1]{\texttt{#1}} +\newcommand{\modannounce}{\module{mod\_announce}} \newcommand{\modconfigure}{\module{mod\_configure}} \newcommand{\moddisco}{\module{mod\_disco}} \newcommand{\modirc}{\module{mod\_irc}} @@ -812,6 +813,31 @@ Example: \end{verbatim} +\subsection{\modannounce{}} +\label{sec:modannounce} + +This module adds support for broadcast announce messages and MOTD. + +Options: +\begin{description} +\titem{access} Specifies who is allowed to send announce messages +and set MOTD (default value is \term{none}). +\end{description} + +Example: +\begin{verbatim} + % Only admins can send announcement messages: + {access, announce, [{allow, admin}]}. + + {modules, + [ + ... + {mod_announce, [{access, announce}]}, + ... + ]}. +\end{verbatim} + + \subsection{\modconfigure{}} \label{sec:modconfigure} |