Chapril/xmpp.chapril.org-ejabberd
24
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-06-02 21:17:12 +02:00
Code Releases Activity

* doc/guide.tex: Table of listener modules converted to

Browse Source 
description. Table of modules overview simplified, and module
names link to their sections.
* doc/guide.html: Regenerated with all the latest changes

SVN Revision: 1352
This commit is contained in:
Badlop 2008-06-12 23:52:13 +00:00
parent aaae1339e1
commit f59c0c9eb2
5 changed files with 975 additions and 1056 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ChangeLog
View File

@ -1,3 +1,10 @@
2008-06-13 Badlop <badlop@process-one.net>
* doc/guide.tex: Table of listener modules converted to
description. Table of modules overview simplified, and module
names link to their sections.
* doc/guide.html: Regenerated with all the latest changes
2008-06-12 Badlop <badlop@process-one.net> 2008-06-12 Badlop <badlop@process-one.net>
* doc/guide.tex: Permanent reference URL for sections (EJAB-651). * doc/guide.tex: Permanent reference URL for sections (EJAB-651).

2
doc/dev.html
View File

@ -139,7 +139,7 @@ Support for virtual hosting.
</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>). </LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>).
</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections. </LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections.
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-00163.html">Personal Eventing via Pubsub</A>. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services. </LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
</LI><LI CLASS="li-itemize">IRC transport. </LI><LI CLASS="li-itemize">IRC transport.
</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. </LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.

2
doc/features.html
View File

@ -118,7 +118,7 @@ Support for virtual hosting.
</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>). </LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>).
</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections. </LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections.
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-00163.html">Personal Eventing via Pubsub</A>. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services. </LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
</LI><LI CLASS="li-itemize">IRC transport. </LI><LI CLASS="li-itemize">IRC transport.
</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. </LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.

1102
doc/guide.html
View File

File diff suppressed because it is too large Load Diff

112
doc/guide.tex
View File

@ -660,31 +660,26 @@ tuple with the following elements:
\ind{modules!ejabberd\_c2s}\ind{modules!ejabberd\_s2s\_in}\ind{modules!ejabberd\_service}\ind{modules!ejabberd\_http}\ind{protocols!XEP-0114: Jabber Component Protocol} \ind{modules!ejabberd\_c2s}\ind{modules!ejabberd\_s2s\_in}\ind{modules!ejabberd\_service}\ind{modules!ejabberd\_http}\ind{protocols!XEP-0114: Jabber Component Protocol}
The available modules, their purpose and the options allowed by each one are: The available modules, their purpose and the options allowed by each one are:
\begin{table}[H] \begin{description}
\centering \titem{\texttt{ejabberd\_c2s}}
\def\arraystretch{1.4} Handles c2s connections.\\
\begin{tabular}{|l|l|p{87mm}|} Options: \texttt{access}, \texttt{certfile}, \texttt{inet6},
\hline \texttt{ejabberd\_c2s}& Description& Handles c2s connections.\\
\cline{2-3} & Options& \texttt{access}, \texttt{certfile}, \texttt{inet6},
\texttt{ip}, \texttt{max\_stanza\_size}, \texttt{shaper}, \texttt{ip}, \texttt{max\_stanza\_size}, \texttt{shaper},
\texttt{starttls}, \texttt{starttls\_required}, \texttt{tls}, \texttt{starttls}, \texttt{starttls\_required}, \texttt{tls},
\texttt{zlib}\\ \texttt{zlib}
\hline \texttt{ejabberd\_s2s\_in}& Description& Handles incoming s2s \titem{\texttt{ejabberd\_s2s\_in}}
connections.\\ Handles incoming s2s connections.\\
\cline{2-3} & Options& \texttt{inet6}, \texttt{ip}, Options: \texttt{inet6}, \texttt{ip}, \texttt{max\_stanza\_size}
\texttt{max\_stanza\_size}\\ \titem{\texttt{ejabberd\_service}}
\hline \texttt{ejabberd\_service}& Description& Interacts with Interacts with \footahref{http://www.ejabberd.im/tutorials-transports}{external components}
\footahref{http://www.ejabberd.im/tutorials-transports}{external components}
(as defined in the Jabber Component Protocol (\xepref{0114}).\\ (as defined in the Jabber Component Protocol (\xepref{0114}).\\
\cline{2-3} & Options& \texttt{access}, \texttt{hosts}, \texttt{inet6}, Options: \texttt{access}, \texttt{hosts}, \texttt{inet6},
\texttt{ip}, \texttt{shaper}, \texttt{service\_check\_from}\\ \texttt{ip}, \texttt{shaper}, \texttt{service\_check\_from}
\hline \texttt{ejabberd\_http}& Description& Handles incoming HTTP \titem{\texttt{ejabberd\_http}}
connections.\\ Handles incoming HTTP connections.\\
\cline{2-3} & Options& \texttt{certfile}, \texttt{http\_bind}, \texttt{http\_poll}, Options: \texttt{certfile}, \texttt{http\_bind}, \texttt{http\_poll},
\texttt{inet6}, \texttt{ip}, \texttt{request\_handlers}, \texttt{tls}, \texttt{web\_admin}\\ \texttt{inet6}, \texttt{ip}, \texttt{request\_handlers}, \texttt{tls}, \texttt{web\_admin}\\
\hline \end{description}
\end{tabular}
\end{table}
This is a detailed description of each option allowed by the listening modules: This is a detailed description of each option allowed by the listening modules:
\begin{description} \begin{description}
@ -1910,54 +1905,53 @@ Examples:
\end{verbatim} \end{verbatim}
\end{itemize} \end{itemize}
\makesubsection{modoverview}{Overview} \makesubsection{modoverview}{Modules Overview}
\ind{modules!overview}\ind{XMPP compliancy} \ind{modules!overview}\ind{XMPP compliancy}
The following table lists all modules included in \ejabberd{}. The following table lists all modules included in \ejabberd{}.
\begin{table}[H] \begin{table}[H]
\centering \centering
\begin{tabular}{|l|l|l|l|} \begin{tabular}{|l|l|l|}
\hline Module & Feature & Dependencies & Needed for XMPP? \\ \hline {\bf Module} & {\bf Feature} & {\bf Dependencies} \\
\hline \hline \modadhoc{} & Ad-Hoc Commands (\xepref{0050}) & & No \\ \hline
\hline \modannounce{} & Manage announcements & recommends \modadhoc{} & No \\ \hline \modadhoc{} & Ad-Hoc Commands (\xepref{0050}) & \\
\hline \modcaps{} & Request and cache Entity Capabilities (\xepref{0115}) & & No \\ \hline \ahrefloc{modannounce}{\modannounce{}} & Manage announcements & recommends \modadhoc{} \\
\hline \modconfigure{} & Server configuration using Ad-Hoc & \modadhoc{} & No \\ \hline \modcaps{} & Entity Capabilities (\xepref{0115}) & \\
\hline \moddisco{} & Service Discovery (\xepref{0030}) & & No \\ \hline \modconfigure{} & Server configuration using Ad-Hoc & \modadhoc{} \\
\hline \modecho{} & Echoes Jabber packets & & No \\ \hline \ahrefloc{moddisco}{\moddisco{}} & Service Discovery (\xepref{0030}) & \\
\hline \modirc{} & IRC transport & & No \\ \hline \ahrefloc{modecho}{\modecho{}} & Echoes Jabber packets & \\
\hline \modlast{} & Last Activity (\xepref{0012}) & & No \\ \hline \ahrefloc{modirc}{\modirc{}} & IRC transport & \\
\hline \modlastodbc{} & Last Activity (\xepref{0012}) & supported database (*) & No \\ \hline \ahrefloc{modlast}{\modlast{}} & Last Activity (\xepref{0012}) & \\
\hline \modmuc{} & Multi-User Chat (\xepref{0045}) & & No \\ \hline \ahrefloc{modlast}{\modlastodbc{}} & Last Activity (\xepref{0012}) & supported DB (*) \\
\hline \modmuclog{} & Multi-User Chat room logging & \modmuc{} & No \\ \hline \ahrefloc{modmuc}{\modmuc{}} & Multi-User Chat (\xepref{0045}) & \\
\hline \modoffline{} & Offline message storage & & No \\ \hline \ahrefloc{modmuclog}{\modmuclog{}} & Multi-User Chat room logging & \modmuc{} \\
\hline \modofflineodbc{} & Offline message storage & supported database (*) & No \\ \hline \ahrefloc{modoffline}{\modoffline{}} & Offline message storage (\xepref{0160}) & \\
\hline \modprivacy{} & Blocking Communications & & Yes \\ \hline \ahrefloc{modoffline}{\modofflineodbc{}} & Offline message storage (\xepref{0160}) & supported DB (*) \\
\hline \modprivacyodbc{} & Blocking Communications & supported database (*) & Yes \\ \hline \ahrefloc{modprivacy}{\modprivacy{}} & Blocking Communication (XMPP IM) & \\
\hline \modprivate{} & Private XML Storage (\xepref{0049}) & & No \\ \hline \ahrefloc{modprivacy}{\modprivacyodbc{}} & Blocking Communication (XMPP IM) & supported DB (*) \\
\hline \modprivateodbc{} & Private XML Storage (\xepref{0049}) & supported database (*) & No \\ \hline \ahrefloc{modprivate}{\modprivate{}} & Private XML Storage (\xepref{0049}) & \\
\hline \modproxy{} & SOCKS5 Bytestreams (\xepref{0065}) & & No\\ \hline \ahrefloc{modprivate}{\modprivateodbc{}} & Private XML Storage (\xepref{0049}) & supported DB (*) \\
\hline \modpubsub{} & Publish-Subscribe (\xepref{0060}) and PEP (\xepref{0163}) & \modcaps{} & No \\ \hline \ahrefloc{modproxy}{\modproxy{}} & SOCKS5 Bytestreams (\xepref{0065}) & \\
\hline \modregister{} & In-Band Registration (\xepref{0077}) & & No \\ \hline \ahrefloc{modpubsub}{\modpubsub{}} & Pub-Sub (\xepref{0060}), PEP (\xepref{0163}) & \modcaps{} \\
\hline \modroster{} & Roster management & & Yes (**) \\ \hline \ahrefloc{modregister}{\modregister{}} & In-Band Registration (\xepref{0077}) & \\
\hline \modrosterodbc{} & Roster management & supported database (*) & Yes (**) \\ \hline \ahrefloc{modroster}{\modroster{}} & Roster management (XMPP IM) & \\
\hline \modservicelog{} & Copy user messages to logger service & & No \\ \hline \ahrefloc{modroster}{\modrosterodbc{}} & Roster management (XMPP IM) & supported DB (*) \\
\hline \modsharedroster{} & Shared roster management & \modroster{} or & No \\ \hline \ahrefloc{modservicelog}{\modservicelog{}} & Copy user messages to logger service & \\
& & \modrosterodbc{} & \\ \hline \ahrefloc{modsharedroster}{\modsharedroster{}} & Shared roster management & \modroster{} or \\
\hline \modstats{} & Statistics Gathering (\xepref{0039}) & & No \\ & & \modrosterodbc\\
\hline \modtime{} & Entity Time (\xepref{0090}) & & No \\ \hline \ahrefloc{modstats}{\modstats{}} & Statistics Gathering (\xepref{0039}) & \\
\hline \modvcard{} & vcard-temp (\xepref{0054}) & & No \\ \hline \ahrefloc{modtime}{\modtime{}} & Entity Time (\xepref{0090}) & \\
\hline \modvcardldap{} & vcard-temp (\xepref{0054}) & LDAP server & No \\ \hline \ahrefloc{modvcard}{\modvcard{}} & vcard-temp (\xepref{0054}) & \\
\hline \modvcardodbc{} & vcard-temp (\xepref{0054}) & supported database (*) & No \\ \hline \ahrefloc{modvcardldap}{\modvcardldap{}} & vcard-temp (\xepref{0054}) & LDAP server \\
\hline \modversion{} & Software Version (\xepref{0092}) & & No\\ \hline \ahrefloc{modvcard}{\modvcardodbc{}} & vcard-temp (\xepref{0054}) & supported DB (*) \\
\hline \ahrefloc{modversion}{\modversion{}} & Software Version (\xepref{0092}) & \\
\hline \hline
\end{tabular} \end{tabular}
\end{table} \end{table}
\begin{itemize} \begin{itemize}
\item (*) For a list of supported databases, see section~\ref{database}. \item (*) This module requires a supported database. For a list of supported databases, see section~\ref{database}.
\item (**) This module or a similar one with another database backend is needed for
XMPP compliancy.
\end{itemize} \end{itemize}
You can see which database backend each module needs by looking at the suffix: You can see which database backend each module needs by looking at the suffix:
@ -3637,7 +3631,7 @@ You need to take the following TCP ports in mind when configuring your firewall:
\begin{table}[H] \begin{table}[H]
\centering \centering
\begin{tabular}{|l|l|} \begin{tabular}{|l|l|}
\hline Port& Description\\ \hline {\bf Port} & {\bf Description} \\
\hline \hline 5222& Standard port for Jabber/XMPP client connections, plain or STARTTLS.\\ \hline \hline 5222& Standard port for Jabber/XMPP client connections, plain or STARTTLS.\\
\hline 5223& Standard port for Jabber client connections using the old SSL method.\\ \hline 5223& Standard port for Jabber client connections using the old SSL method.\\
\hline 5269& Standard port for Jabber/XMPP server connections.\\ \hline 5269& Standard port for Jabber/XMPP server connections.\\