yetangitu/ejabberd
1
0
Fork 0
mirror of https://github.com/processone/ejabberd synced 2025-10-03 17:59:31 +02:00
Code Issues Releases Wiki Activity

* doc/guide.tex: Documentation rework started (EJAB-272)

Browse source 
* doc/introduction.tex: Likewise

SVN Revision: 803
This commit is contained in:
Mickaël Rémond 2007-06-28 09:16:21 +00:00
parent b7e16968b6
commit 12ab036236
7 changed files with 2184 additions and 3154 deletions
Download patch file Download diff file Expand all files Collapse all files

9
ChangeLog
View file

@ -1,7 +1,12 @@
2007-06-28 Mickael Remond <mickael.remond@process-one.net>
* doc/guide.tex: Documentation rework started (EJAB-272)
* doc/introduction.tex: Likewise
2007-06-28 Christophe Romain <christophe.romain@process-one.net> 2007-06-28 Christophe Romain <christophe.romain@process-one.net>
* src/web/ejabberd_web_admin.erl: corrects EJAB-273, * src/web/ejabberd_web_admin.erl: corrects (EJAB-273),
remove obsolete OnlineUsers calculation remove obsolete OnlineUsers calculation
2007-06-26 Alexey Shchepin <alexey@sevcom.net> 2007-06-26 Alexey Shchepin <alexey@sevcom.net>

466
doc/dev.html
View file

@ -1,15 +1,23 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd"> "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML> <HTML>
<HEAD> <HEAD>
<TITLE>Ejabberd 2.0.0beta1 Developers Guide
</TITLE>
<TITLE>Ejabberd 1.1.2 Developers Guide</TITLE> <META http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<META name="GENERATOR" content="hevea 1.09">
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<META name="GENERATOR" content="hevea 1.08">
<STYLE type="text/css"> <STYLE type="text/css">
.li-itemize{margin:1ex 0ex;}
.li-enumerate{margin:1ex 0ex;}
.dd-description{margin:0ex 0ex 1ex 4ex;}
.dt-description{margin:0ex;}
.toc{list-style:none;} .toc{list-style:none;}
.thefootnotes{text-align:left;margin:0ex;}
.dt-thefootnotes{margin:0em;}
.dd-thefootnotes{margin:0em 0em 0em 2em;}
.footnoterule{margin:1em auto 1em 0px;width:50%;}
.caption{padding-left:2ex; padding-right:2ex; margin-left:auto; margin-right:auto}
.title{margin:auto;text-align:center} .title{margin:auto;text-align:center}
.center{text-align:center;margin-left:auto;margin-right:auto;} .center{text-align:center;margin-left:auto;margin-right:auto;}
.flushleft{text-align:left;margin-left:0ex;margin-right:auto;} .flushleft{text-align:left;margin-left:0ex;margin-right:auto;}
@ -17,233 +25,163 @@
DIV TABLE{margin-left:inherit;margin-right:inherit;} DIV TABLE{margin-left:inherit;margin-right:inherit;}
PRE{text-align:left;margin-left:0ex;margin-right:auto;} PRE{text-align:left;margin-left:0ex;margin-right:auto;}
BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
TD P{margin:0px;}
.boxed{border:1px solid black}
.textboxed{border:1px solid black}
.vbar{border:none;width:2px;background-color:black;}
.hbar{border:none;height:2px;width:100%;background-color:black;}
.hfill{border:none;height:1px;width:200%;background-color:black;}
.vdisplay{border-collapse:separate;border-spacing:2px;width:auto; empty-cells:show; border:2px solid red;}
.vdcell{white-space:nowrap;padding:0px;width:auto; border:2px solid green;}
.display{border-collapse:separate;border-spacing:2px;width:auto; border:none;}
.dcell{white-space:nowrap;padding:0px;width:auto; border:none;}
.dcenter{margin:0ex auto;}
.vdcenter{border:solid #FF8000 2px; margin:0ex auto;}
.minipage{text-align:left; margin-left:0em; margin-right:auto;}
.marginpar{border:solid thin black; width:20%; text-align:left;}
.marginparleft{float:left; margin-left:0ex; margin-right:1ex;}
.marginparright{float:right; margin-left:1ex; margin-right:0ex;}
.theorem{text-align:left;margin:1ex auto 1ex 0ex;}
.part{margin:auto;text-align:center} .part{margin:auto;text-align:center}
</STYLE> </STYLE>
</HEAD> </HEAD>
<BODY > <BODY >
<!--HEVEA command line is: hevea -fix -noiso -pedantic dev.tex --> <!--HEVEA command line is: /usr/local/bin/hevea -fix -noiso -pedantic dev.tex -->
<!--HTMLHEAD--> <!--CUT DEF section 1 --><P><A NAME="titlepage"></A>
<!--ENDHTML-->
<!--PREFIX <ARG ></ARG>-->
<!--CUT DEF section 1 -->
<BR> </P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 2.0.0beta1 Developers Guide</H1><H3 CLASS="titlerest">Alexey Shchepin<BR>
<BR> <A HREF="mailto:alexey@sevcom.net"><TT>mailto:alexey@sevcom.net</TT></A><BR>
<A NAME="titlepage"></A> <A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A></H3></TD></TR>
</TABLE><DIV CLASS="center">
<TABLE CLASS="title"> <IMG SRC="logo.png" ALT="logo.png">
<TR><TD>
<H1 CLASS="titlemain">Ejabberd 1.1.2 Developers Guide</H1>
<H3 CLASS="titlerest">Alexey Shchepin<BR>
<A HREF="mailto:alexey@sevcom.net"><TT>mailto:alexey@sevcom.net</TT></A><BR>
<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A></H3></TD>
</TR></TABLE><BR>
<BR>
<DIV CLASS="center">
<IMG SRC="logo.png" ALT="logo.png">
<BR> </DIV><BLOCKQUOTE CLASS="quotation"><I>I can thoroughly recommend ejabberd for ease of setup &#X2013;
<BR> Kevin Smith, Current maintainer of the Psi project</I></BLOCKQUOTE><!--TOC section Contents-->
<H2 CLASS="section"><!--SEC ANCHOR -->Contents</H2><!--SEC END --><UL CLASS="toc"><LI CLASS="li-toc">
</DIV> <A HREF="#htoc1">1&#XA0;&#XA0;Key Features</A>
<BLOCKQUOTE CLASS="quotation"><I>I can thoroughly recommend ejabberd for ease of setup &ndash; </LI><LI CLASS="li-toc"><A HREF="#htoc2">2&#XA0;&#XA0;Additional Features</A>
Kevin Smith, Current maintainer of the Psi project</I></BLOCKQUOTE> </LI><LI CLASS="li-toc"><A HREF="#htoc3">3&#XA0;&#XA0;How it Works</A>
<!--TOC section Contents-->
<H2 CLASS="section">Contents</H2><!--SEC END -->
<UL CLASS="toc"><LI CLASS="li-toc"> <UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc1">1&nbsp;&nbsp;Introduction</A> <A HREF="#htoc4">3.1&#XA0;&#XA0;Router</A>
</LI><LI CLASS="li-toc"><A HREF="#htoc5">3.2&#XA0;&#XA0;Local Router</A>
</LI><LI CLASS="li-toc"><A HREF="#htoc6">3.3&#XA0;&#XA0;Session Manager</A>
</LI><LI CLASS="li-toc"><A HREF="#htoc7">3.4&#XA0;&#XA0;S2S Manager</A>
</LI></UL>
</LI><LI CLASS="li-toc"><A HREF="#htoc8">4&#XA0;&#XA0;XML Representation</A>
</LI><LI CLASS="li-toc"><A HREF="#htoc9">5&#XA0;&#XA0;Module <TT>xml</TT></A>
</LI><LI CLASS="li-toc"><A HREF="#htoc10">6&#XA0;&#XA0;Module <TT>xml_stream</TT></A>
</LI><LI CLASS="li-toc"><A HREF="#htoc11">7&#XA0;&#XA0;Modules</A>
<UL CLASS="toc"><LI CLASS="li-toc"> <UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc2">1.1&nbsp;&nbsp;Key Features</A> <A HREF="#htoc12">7.1&#XA0;&#XA0;Module gen_iq_handler</A>
<LI CLASS="li-toc"><A HREF="#htoc3">1.2&nbsp;&nbsp;Additional Features</A> </LI><LI CLASS="li-toc"><A HREF="#htoc13">7.2&#XA0;&#XA0;Services</A>
</UL> </LI></UL>
<LI CLASS="li-toc"><A HREF="#htoc4">2&nbsp;&nbsp;How it Works</A> </LI></UL><P>Introduction
<UL CLASS="toc"><LI CLASS="li-toc"> <A NAME="intro"></A></P><P><TT>ejabberd</TT> is a free and open source instant messaging server written in <A HREF="http://www.erlang.org/">Erlang</A>.</P><P><TT>ejabberd</TT> is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</P><P><TT>ejabberd</TT> is designed to be a rock-solid and feature rich XMPP server.</P><P><TT>ejabberd</TT> is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.</P><!--TOC section Key Features-->
<A HREF="#htoc5">2.1&nbsp;&nbsp;Router</A> <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc1">1</A>&#XA0;&#XA0;Key Features</H2><!--SEC END --><P>
<LI CLASS="li-toc"><A HREF="#htoc6">2.2&nbsp;&nbsp;Local Router</A>
<LI CLASS="li-toc"><A HREF="#htoc7">2.3&nbsp;&nbsp;Session Manager</A>
<LI CLASS="li-toc"><A HREF="#htoc8">2.4&nbsp;&nbsp;S2S Manager</A>
</UL>
<LI CLASS="li-toc"><A HREF="#htoc9">3&nbsp;&nbsp;XML Representation</A>
<LI CLASS="li-toc"><A HREF="#htoc10">4&nbsp;&nbsp;Module <TT>xml</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc11">5&nbsp;&nbsp;Module <TT>xml_stream</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc12">6&nbsp;&nbsp;Modules</A>
<UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc13">6.1&nbsp;&nbsp;Module gen_iq_handler</A>
<LI CLASS="li-toc"><A HREF="#htoc14">6.2&nbsp;&nbsp;Services</A>
</UL>
</UL>
<!--TOC section Introduction-->
<H2 CLASS="section"><A NAME="htoc1">1</A>&nbsp;&nbsp;Introduction</H2><!--SEC END -->
<A NAME="intro"></A>
<TT>ejabberd</TT> is a free and open source instant messaging server written in <A HREF="http://www.erlang.org/">Erlang</A>.<BR>
<BR>
<TT>ejabberd</TT> is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.<BR>
<BR>
<TT>ejabberd</TT> is designed to be a rock-solid and feature rich XMPP server.<BR>
<BR>
<TT>ejabberd</TT> is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.<BR>
<BR>
<!--TOC subsection Key Features-->
<H3 CLASS="subsection"><A NAME="htoc2">1.1</A>&nbsp;&nbsp;Key Features</H3><!--SEC END -->
<A NAME="keyfeatures"></A> <A NAME="keyfeatures"></A>
</P><P><TT>ejabberd</TT> is:
<TT>ejabberd</TT> is: </P><UL CLASS="itemize"><LI CLASS="li-itemize">
<UL CLASS="itemize"><LI CLASS="li-itemize"> Cross-platform: <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.</LI><LI CLASS="li-itemize">Distributed: You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.</LI><LI CLASS="li-itemize">Fault-tolerant: You can deploy an <TT>ejabberd</TT> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.</LI><LI CLASS="li-itemize">Administrator Friendly: <TT>ejabberd</TT> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
Cross-platform: <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.<BR>
<BR>
<LI CLASS="li-itemize">Distributed: You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.<BR>
<BR>
<LI CLASS="li-itemize">Fault-tolerant: You can deploy an <TT>ejabberd</TT> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.<BR>
<BR>
<LI CLASS="li-itemize">Administrator Friendly: <TT>ejabberd</TT> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Comprehensive documentation. Comprehensive documentation.
<LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows.
<LI CLASS="li-itemize">Web interface for administration tasks. </LI><LI CLASS="li-itemize">Web interface for administration tasks.
<LI CLASS="li-itemize">Shared Roster Groups. </LI><LI CLASS="li-itemize">Shared Roster Groups.
<LI CLASS="li-itemize">Command line administration tool. </LI><LI CLASS="li-itemize">Command line administration tool.
<LI CLASS="li-itemize">Can integrate with existing authentication mechanisms. </LI><LI CLASS="li-itemize">Can integrate with existing authentication mechanisms.
<LI CLASS="li-itemize">Capability to send announce messages. </LI><LI CLASS="li-itemize">Capability to send announce messages.
</UL><BR> </LI></UL></LI><LI CLASS="li-itemize">Internationalized: <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
<BR>
<LI CLASS="li-itemize">Internationalized: <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Translated in 12 languages. Translated in 12 languages.
<LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
</UL><BR> </LI></UL></LI><LI CLASS="li-itemize">Open Standards: <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
<BR>
<LI CLASS="li-itemize">Open Standards: <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Fully XMPP compliant. Fully XMPP compliant.
<LI CLASS="li-itemize">XML-based protocol. </LI><LI CLASS="li-itemize">XML-based protocol.
<LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many protocols supported</A>. </LI><LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many protocols supported</A>.
</UL></UL> </LI></UL></LI></UL><!--TOC section Additional Features-->
<!--TOC subsection Additional Features--> <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2">2</A>&#XA0;&#XA0;Additional Features</H2><!--SEC END --><P>
<H3 CLASS="subsection"><A NAME="htoc3">1.2</A>&nbsp;&nbsp;Additional Features</H3><!--SEC END -->
<A NAME="addfeatures"></A> <A NAME="addfeatures"></A>
</P><P>Moreover, <TT>ejabberd</TT> comes with a wide range of other state-of-the-art features:
Moreover, <TT>ejabberd</TT> comes with a wide range of other state-of-the-art features: </P><UL CLASS="itemize"><LI CLASS="li-itemize">
<UL CLASS="itemize"><LI CLASS="li-itemize">
Modular Modular
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Load only the modules you want. Load only the modules you want.
<LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules. </LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules.
</UL> </LI></UL>
<LI CLASS="li-itemize">Security </LI><LI CLASS="li-itemize">Security
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
SASL and STARTTLS for c2s and s2s connections. SASL and STARTTLS for c2s and s2s connections.
<LI CLASS="li-itemize">STARTTLS and Dialback s2s connections. </LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections.
<LI CLASS="li-itemize">Web interface accessible via HTTPS secure access. </LI><LI CLASS="li-itemize">Web interface accessible via HTTPS secure access.
</UL> </LI></UL>
<LI CLASS="li-itemize">Databases </LI><LI CLASS="li-itemize">Databases
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Native MySQL support. Native MySQL support.
<LI CLASS="li-itemize">Native PostgreSQL support. </LI><LI CLASS="li-itemize">Native PostgreSQL support.
<LI CLASS="li-itemize">Mnesia. </LI><LI CLASS="li-itemize">Mnesia.
<LI CLASS="li-itemize">ODBC data storage support. </LI><LI CLASS="li-itemize">ODBC data storage support.
<LI CLASS="li-itemize">Microsoft SQL Server support. </LI><LI CLASS="li-itemize">Microsoft SQL Server support.
</UL> </LI></UL>
<LI CLASS="li-itemize">Authentication </LI><LI CLASS="li-itemize">Authentication
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
LDAP and ODBC. LDAP and ODBC.
<LI CLASS="li-itemize">External Authentication script. </LI><LI CLASS="li-itemize">External Authentication script.
<LI CLASS="li-itemize">Internal Authentication. </LI><LI CLASS="li-itemize">Internal Authentication.
</UL> </LI></UL>
<LI CLASS="li-itemize">Others </LI><LI CLASS="li-itemize">Others
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
<LI CLASS="li-itemize">Interface with networks such as AIM, ICQ and MSN. </LI><LI CLASS="li-itemize">Interface with networks such as AIM, ICQ and MSN.
<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 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 CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with logging. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with logging.
<LI CLASS="li-itemize">Users Directory based on users vCards. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
<LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component.
<LI CLASS="li-itemize">Support for virtual hosting. </LI><LI CLASS="li-itemize">Support for virtual hosting.
<LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> service. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> service.
<LI CLASS="li-itemize">IRC transport. </LI><LI CLASS="li-itemize">IRC transport.
</UL> </LI></UL>
</UL> </LI></UL><!--TOC section How it Works-->
<!--TOC section How it Works--> <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc3">3</A>&#XA0;&#XA0;How it Works</H2><!--SEC END --><P>
<A NAME="howitworks"></A></P><P>A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
<H2 CLASS="section"><A NAME="htoc4">2</A>&nbsp;&nbsp;How it Works</H2><!--SEC END -->
<A NAME="howitworks"></A>
A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
be run on different machines that are connected via a network. They all must be run on different machines that are connected via a network. They all must
have the ability to connect to port 4369 of all another nodes, and must have have the ability to connect to port 4369 of all another nodes, and must have
the same magic cookie (see Erlang/OTP documentation, in other words the file the same magic cookie (see Erlang/OTP documentation, in other words the file
<TT>~ejabberd/.erlang.cookie</TT> must be the same on all nodes). This is <TT>~ejabberd/.erlang.cookie</TT> must be the same on all nodes). This is
needed because all nodes exchange information about connected users, S2S needed because all nodes exchange information about connected users, S2S
connections, registered services, etc...<BR> connections, registered services, etc&#X2026;</P><P>Each <TT>ejabberd</TT> node have following modules:
<BR> </P><UL CLASS="itemize"><LI CLASS="li-itemize">
Each <TT>ejabberd</TT> node have following modules:
<UL CLASS="itemize"><LI CLASS="li-itemize">
router; router;
<LI CLASS="li-itemize">local router. </LI><LI CLASS="li-itemize">local router.
<LI CLASS="li-itemize">session manager; </LI><LI CLASS="li-itemize">session manager;
<LI CLASS="li-itemize">S2S manager; </LI><LI CLASS="li-itemize">S2S manager;
</UL> </LI></UL><!--TOC subsection Router-->
<!--TOC subsection Router--> <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4">3.1</A>&#XA0;&#XA0;Router</H3><!--SEC END --><P>This module is the main router of Jabber packets on each node. It routes
<H3 CLASS="subsection"><A NAME="htoc5">2.1</A>&nbsp;&nbsp;Router</H3><!--SEC END -->
This module is the main router of Jabber packets on each node. It routes
them based on their destinations domains. It has two tables: local and global them based on their destinations domains. It has two tables: local and global
routes. First, domain of packet destination searched in local table, and if it routes. First, domain of packet destination searched in local table, and if it
found, then the packet is routed to appropriate process. If no, then it found, then the packet is routed to appropriate process. If no, then it
searches in global table, and is routed to the appropriate <TT>ejabberd</TT> node or searches in global table, and is routed to the appropriate <TT>ejabberd</TT> node or
process. If it does not exists in either tables, then it sent to the S2S process. If it does not exists in either tables, then it sent to the S2S
manager.<BR> manager.</P><!--TOC subsection Local Router-->
<BR> <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5">3.2</A>&#XA0;&#XA0;Local Router</H3><!--SEC END --><P>This module routes packets which have a destination domain equal to this server
<!--TOC subsection Local Router-->
<H3 CLASS="subsection"><A NAME="htoc6">2.2</A>&nbsp;&nbsp;Local Router</H3><!--SEC END -->
This module routes packets which have a destination domain equal to this server
name. If destination JID has a non-empty user part, then it routed to the name. If destination JID has a non-empty user part, then it routed to the
session manager, else it is processed depending on it's content.<BR> session manager, else it is processed depending on it's content.</P><!--TOC subsection Session Manager-->
<BR> <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc6">3.3</A>&#XA0;&#XA0;Session Manager</H3><!--SEC END --><P>This module routes packets to local users. It searches for what user resource
<!--TOC subsection Session Manager-->
<H3 CLASS="subsection"><A NAME="htoc7">2.3</A>&nbsp;&nbsp;Session Manager</H3><!--SEC END -->
This module routes packets to local users. It searches for what user resource
packet must be sended via presence table. If this resource is connected to packet must be sended via presence table. If this resource is connected to
this node, it is routed to C2S process, if it connected via another node, then this node, it is routed to C2S process, if it connected via another node, then
the packet is sent to session manager on that node.<BR> the packet is sent to session manager on that node.</P><!--TOC subsection S2S Manager-->
<BR> <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7">3.4</A>&#XA0;&#XA0;S2S Manager</H3><!--SEC END --><P>This module routes packets to other Jabber servers. First, it checks if an
<!--TOC subsection S2S Manager-->
<H3 CLASS="subsection"><A NAME="htoc8">2.4</A>&nbsp;&nbsp;S2S Manager</H3><!--SEC END -->
This module routes packets to other Jabber servers. First, it checks if an
open S2S connection from the domain of the packet source to the domain of open S2S connection from the domain of the packet source to the domain of
packet destination already exists. If it is open on another node, then it packet destination already exists. If it is open on another node, then it
routes the packet to S2S manager on that node, if it is open on this node, then routes the packet to S2S manager on that node, if it is open on this node, then
it is routed to the process that serves this connection, and if a connection it is routed to the process that serves this connection, and if a connection
does not exist, then it is opened and registered.<BR> does not exist, then it is opened and registered.</P><!--TOC section XML Representation-->
<BR> <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8">4</A>&#XA0;&#XA0;XML Representation</H2><!--SEC END --><P>
<!--TOC section XML Representation--> <A NAME="xmlrepr"></A></P><P>Each XML stanza is represented as the following tuple:
</P><PRE CLASS="verbatim">XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
<H2 CLASS="section"><A NAME="htoc9">3</A>&nbsp;&nbsp;XML Representation</H2><!--SEC END -->
<A NAME="xmlrepr"></A>
Each XML stanza is represented as the following tuple:
<PRE CLASS="verbatim">
XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
Name = string() Name = string()
Attrs = [Attr] Attrs = [Attr]
Attr = {Key, Val} Attr = {Key, Val}
@ -251,45 +189,30 @@ XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
Val = string() Val = string()
ElementOrCDATA = XMLElement | CDATA ElementOrCDATA = XMLElement | CDATA
CDATA = {xmlcdata, string()} CDATA = {xmlcdata, string()}
</PRE>E.&nbsp;g. this stanza: </PRE><P>E.&#XA0;g. this stanza:
<PRE CLASS="verbatim"> </P><PRE CLASS="verbatim">&lt;message to='test@conference.example.org' type='groupchat'&gt;
&lt;message to='test@conference.example.org' type='groupchat'&gt;
&lt;body&gt;test&lt;/body&gt; &lt;body&gt;test&lt;/body&gt;
&lt;/message&gt; &lt;/message&gt;
</PRE>is represented as the following structure: </PRE><P>is represented as the following structure:
<PRE CLASS="verbatim"> </P><PRE CLASS="verbatim">{xmlelement, "message",
{xmlelement, "message",
[{"to", "test@conference.example.org"}, [{"to", "test@conference.example.org"},
{"type", "groupchat"}], {"type", "groupchat"}],
[{xmlelement, "body", [{xmlelement, "body",
[], [],
[{xmlcdata, "test"}]}]}} [{xmlcdata, "test"}]}]}}
</PRE> </PRE><!--TOC section Module <TT>xml</TT>-->
<!--TOC section Module <TT>xml</TT>--> <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc9">5</A>&#XA0;&#XA0;Module <TT>xml</TT></H2><!--SEC END --><P>
<A NAME="xmlmod"></A></P><DL CLASS="description"><DT CLASS="dt-description">
<H2 CLASS="section"><A NAME="htoc10">4</A>&nbsp;&nbsp;Module <TT>xml</TT></H2><!--SEC END --> </DT><DD CLASS="dd-description"><CODE>element_to_string(El) -&gt; string()</CODE>
<PRE CLASS="verbatim">El = XMLElement
<A NAME="xmlmod"></A> </PRE>Returns string representation of XML stanza <TT>El</TT>.</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>crypt(S) -&gt; string()</CODE>
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>element_to_string(El) -&gt; string()</CODE> <PRE CLASS="verbatim">S = string()
<PRE CLASS="verbatim">
El = XMLElement
</PRE>Returns string representation of XML stanza <TT>El</TT>.<BR>
<BR>
<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>crypt(S) -&gt; string()</CODE>
<PRE CLASS="verbatim">
S = string()
</PRE>Returns string which correspond to <TT>S</TT> with encoded XML special </PRE>Returns string which correspond to <TT>S</TT> with encoded XML special
characters.<BR> characters.</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>remove_cdata(ECList) -&gt; EList</CODE>
<BR> <PRE CLASS="verbatim">ECList = [ElementOrCDATA]
<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>remove_cdata(ECList) -&gt; EList</CODE>
<PRE CLASS="verbatim">
ECList = [ElementOrCDATA]
EList = [XMLElement] EList = [XMLElement]
</PRE><TT>EList</TT> is a list of all non-CDATA elements of ECList.<BR> </PRE><TT>EList</TT> is a list of all non-CDATA elements of ECList.</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>get_path_s(El, Path) -&gt; Res</CODE>
<BR> <PRE CLASS="verbatim">El = XMLElement
<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>get_path_s(El, Path) -&gt; Res</CODE>
<PRE CLASS="verbatim">
El = XMLElement
Path = [PathItem] Path = [PathItem]
PathItem = PathElem | PathAttr | PathCDATA PathItem = PathElem | PathAttr | PathCDATA
PathElem = {elem, Name} PathElem = {elem, Name}
@ -298,74 +221,56 @@ PathCDATA = cdata
Name = string() Name = string()
Res = string() | XMLElement Res = string() | XMLElement
</PRE>If <TT>Path</TT> is empty, then returns <TT>El</TT>. Else sequentially </PRE>If <TT>Path</TT> is empty, then returns <TT>El</TT>. Else sequentially
consider elements of <TT>Path</TT>. Each element is one of: consider elements of <TT>Path</TT>. Each element is one of:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>{elem, Name}</CODE> <TT>Name</TT> is name of subelement of <DL CLASS="description"><DT CLASS="dt-description">
<TT>El</TT>, if such element exists, then this element considered in </DT><DD CLASS="dd-description"><CODE>{elem, Name}</CODE> <TT>Name</TT> is name of subelement of
following steps, else returns empty string. <TT>El</TT>, if such element exists, then this element considered in
<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>{attr, Name}</CODE> If <TT>El</TT> have attribute <TT>Name</TT>, then following steps, else returns empty string.
returns value of this attribute, else returns empty string. </DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>{attr, Name}</CODE> If <TT>El</TT> have attribute <TT>Name</TT>, then
<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>cdata</CODE> Returns CDATA of <TT>El</TT>. returns value of this attribute, else returns empty string.
</DL><BR> </DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>cdata</CODE> Returns CDATA of <TT>El</TT>.
<BR> </DD></DL></DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description">TODO:
<DT CLASS="dt-description"><DD CLASS="dd-description">TODO: <PRE CLASS="verbatim"> get_cdata/1, get_tag_cdata/1
<PRE CLASS="verbatim">
get_cdata/1, get_tag_cdata/1
get_attr/2, get_attr_s/2 get_attr/2, get_attr_s/2
get_tag_attr/2, get_tag_attr_s/2 get_tag_attr/2, get_tag_attr_s/2
get_subtag/2 get_subtag/2
</PRE></DL> </PRE></DD></DL><!--TOC section Module <TT>xml_stream</TT>-->
<!--TOC section Module <TT>xml_stream</TT>--> <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc10">6</A>&#XA0;&#XA0;Module <TT>xml_stream</TT></H2><!--SEC END --><P>
<A NAME="xmlstreammod"></A></P><DL CLASS="description"><DT CLASS="dt-description">
<H2 CLASS="section"><A NAME="htoc11">5</A>&nbsp;&nbsp;Module <TT>xml_stream</TT></H2><!--SEC END --> </DT><DD CLASS="dd-description"><CODE>parse_element(Str) -&gt; XMLElement | {error, Err}</CODE>
<PRE CLASS="verbatim">Str = string()
<A NAME="xmlstreammod"></A>
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>parse_element(Str) -&gt; XMLElement | {error, Err}</CODE>
<PRE CLASS="verbatim">
Str = string()
Err = term() Err = term()
</PRE>Parses <TT>Str</TT> using XML parser, returns either parsed element or error </PRE>Parses <TT>Str</TT> using XML parser, returns either parsed element or error
tuple. tuple.
</DL> </DD></DL><!--TOC section Modules-->
<!--TOC section Modules--> <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc11">7</A>&#XA0;&#XA0;Modules</H2><!--SEC END --><P>
<A NAME="emods"></A></P><!--TOC subsection Module gen_iq_handler-->
<H2 CLASS="section"><A NAME="htoc12">6</A>&nbsp;&nbsp;Modules</H2><!--SEC END --> <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc12">7.1</A>&#XA0;&#XA0;Module gen_iq_handler</H3><!--SEC END --><P>
<A NAME="geniqhandl"></A></P><P>The module <CODE>gen_iq_handler</CODE> allows to easily write handlers for IQ packets
<A NAME="emods"></A> of particular XML namespaces that addressed to server or to users bare JIDs.</P><P>In this module the following functions are defined:
<!--TOC subsection Module gen_iq_handler--> </P><DL CLASS="description"><DT CLASS="dt-description">
</DT><DD CLASS="dd-description"><CODE>add_iq_handler(Component, Host, NS, Module, Function, Type)</CODE>
<H3 CLASS="subsection"><A NAME="htoc13">6.1</A>&nbsp;&nbsp;Module gen_iq_handler</H3><!--SEC END --> <PRE CLASS="verbatim">Component = Module = Function = atom()
<A NAME="geniqhandl"></A>
The module <CODE>gen_iq_handler</CODE> allows to easily write handlers for IQ packets
of particular XML namespaces that addressed to server or to users bare JIDs.<BR>
<BR>
In this module the following functions are defined:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>add_iq_handler(Component, Host, NS, Module, Function, Type)</CODE>
<PRE CLASS="verbatim">
Component = Module = Function = atom()
Host = NS = string() Host = NS = string()
Type = no_queue | one_queue | parallel Type = no_queue | one_queue | parallel
</PRE>Registers function <CODE>Module:Function</CODE> as handler for IQ packets on </PRE>Registers function <CODE>Module:Function</CODE> as handler for IQ packets on
virtual host <CODE>Host</CODE> that contain child of namespace <CODE>NS</CODE> in virtual host <CODE>Host</CODE> that contain child of namespace <CODE>NS</CODE> in
<CODE>Component</CODE>. Queueing discipline is <CODE>Type</CODE>. There are at least <CODE>Component</CODE>. Queueing discipline is <CODE>Type</CODE>. There are at least
two components defined: two components defined:
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>ejabberd_local</CODE> Handles packets that addressed to server JID; <DL CLASS="description"><DT CLASS="dt-description">
<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>ejabberd_sm</CODE> Handles packets that addressed to users bare JIDs. </DT><DD CLASS="dd-description"><CODE>ejabberd_local</CODE> Handles packets that addressed to server JID;
</DL> </DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>ejabberd_sm</CODE> Handles packets that addressed to users bare JIDs.
<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>remove_iq_handler(Component, Host, NS)</CODE> </DD></DL>
<PRE CLASS="verbatim"> </DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>remove_iq_handler(Component, Host, NS)</CODE>
Component = atom() <PRE CLASS="verbatim">Component = atom()
Host = NS = string() Host = NS = string()
</PRE>Removes IQ handler on virtual host <CODE>Host</CODE> for namespace <CODE>NS</CODE> from </PRE>Removes IQ handler on virtual host <CODE>Host</CODE> for namespace <CODE>NS</CODE> from
<CODE>Component</CODE>. <CODE>Component</CODE>.
</DL> </DD></DL><P>Handler function must have the following type:
Handler function must have the following type: </P><DL CLASS="description"><DT CLASS="dt-description">
<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>Module:Function(From, To, IQ)</CODE> </DT><DD CLASS="dd-description"><CODE>Module:Function(From, To, IQ)</CODE>
<PRE CLASS="verbatim"> <PRE CLASS="verbatim">From = To = jid()
From = To = jid() </PRE></DD></DL><PRE CLASS="verbatim">-module(mod_cputime).
</PRE></DL>
<PRE CLASS="verbatim">
-module(mod_cputime).
-behaviour(gen_mod). -behaviour(gen_mod).
@ -399,14 +304,9 @@ process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) -&gt;
[{"xmlns", ?NS_CPUTIME}], [{"xmlns", ?NS_CPUTIME}],
[{xmlelement, "cputime", [], [{xmlcdata, SCPUTime}]}]}]} [{xmlelement, "cputime", [], [{xmlcdata, SCPUTime}]}]}]}
end. end.
</PRE> </PRE><!--TOC subsection Services-->
<!--TOC subsection Services--> <H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc13">7.2</A>&#XA0;&#XA0;Services</H3><!--SEC END --><P>
<A NAME="services"></A></P><PRE CLASS="verbatim">-module(mod_echo).
<H3 CLASS="subsection"><A NAME="htoc14">6.2</A>&nbsp;&nbsp;Services</H3><!--SEC END -->
<A NAME="services"></A>
<PRE CLASS="verbatim">
-module(mod_echo).
-behaviour(gen_mod). -behaviour(gen_mod).
@ -440,10 +340,10 @@ stop(Host) -&gt;
Proc = gen_mod:get_module_proc(Host, ?PROCNAME), Proc = gen_mod:get_module_proc(Host, ?PROCNAME),
Proc ! stop, Proc ! stop,
{wait, Proc}. {wait, Proc}.
</PRE> </PRE><!--CUT END -->
<!--HTMLFOOT--> <!--HTMLFOOT-->
<!--ENDHTML--> <!--ENDHTML-->
<!--FOOTER--> <!--FOOTER-->
<HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by <HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by
</EM><A HREF="http://pauillac.inria.fr/~maranget/hevea/index.html"><EM>H<FONT SIZE=2><sup>E</sup></FONT>V<FONT SIZE=2><sup>E</sup></FONT>A</EM></A><EM>.</EM></BLOCKQUOTE></BODY> </EM><A HREF="http://hevea.inria.fr/index.html"><EM>H</EM><EM><FONT SIZE=2><sup>E</sup></FONT></EM><EM>V</EM><EM><FONT SIZE=2><sup>E</sup></FONT></EM><EM>A</EM></A><EM>.</EM></BLOCKQUOTE></BODY>
</HTML> </HTML>

211
doc/features.html
View file

@ -1,15 +1,23 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd"> "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML> <HTML>
<HEAD> <HEAD>
<TITLE>Ejabberd 2.0.0beta1 Feature Sheet
</TITLE>
<TITLE>Ejabberd 1.1.2 Feature Sheet</TITLE> <META http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<META name="GENERATOR" content="hevea 1.09">
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<META name="GENERATOR" content="hevea 1.08">
<STYLE type="text/css"> <STYLE type="text/css">
.li-itemize{margin:1ex 0ex;}
.li-enumerate{margin:1ex 0ex;}
.dd-description{margin:0ex 0ex 1ex 4ex;}
.dt-description{margin:0ex;}
.toc{list-style:none;} .toc{list-style:none;}
.thefootnotes{text-align:left;margin:0ex;}
.dt-thefootnotes{margin:0em;}
.dd-thefootnotes{margin:0em 0em 0em 2em;}
.footnoterule{margin:1em auto 1em 0px;width:50%;}
.caption{padding-left:2ex; padding-right:2ex; margin-left:auto; margin-right:auto}
.title{margin:auto;text-align:center} .title{margin:auto;text-align:center}
.center{text-align:center;margin-left:auto;margin-right:auto;} .center{text-align:center;margin-left:auto;margin-right:auto;}
.flushleft{text-align:left;margin-left:0ex;margin-right:auto;} .flushleft{text-align:left;margin-left:0ex;margin-right:auto;}
@ -17,147 +25,114 @@
DIV TABLE{margin-left:inherit;margin-right:inherit;} DIV TABLE{margin-left:inherit;margin-right:inherit;}
PRE{text-align:left;margin-left:0ex;margin-right:auto;} PRE{text-align:left;margin-left:0ex;margin-right:auto;}
BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
TD P{margin:0px;}
.boxed{border:1px solid black}
.textboxed{border:1px solid black}
.vbar{border:none;width:2px;background-color:black;}
.hbar{border:none;height:2px;width:100%;background-color:black;}
.hfill{border:none;height:1px;width:200%;background-color:black;}
.vdisplay{border-collapse:separate;border-spacing:2px;width:auto; empty-cells:show; border:2px solid red;}
.vdcell{white-space:nowrap;padding:0px;width:auto; border:2px solid green;}
.display{border-collapse:separate;border-spacing:2px;width:auto; border:none;}
.dcell{white-space:nowrap;padding:0px;width:auto; border:none;}
.dcenter{margin:0ex auto;}
.vdcenter{border:solid #FF8000 2px; margin:0ex auto;}
.minipage{text-align:left; margin-left:0em; margin-right:auto;}
.marginpar{border:solid thin black; width:20%; text-align:left;}
.marginparleft{float:left; margin-left:0ex; margin-right:1ex;}
.marginparright{float:right; margin-left:1ex; margin-right:0ex;}
.theorem{text-align:left;margin:1ex auto 1ex 0ex;}
.part{margin:auto;text-align:center} .part{margin:auto;text-align:center}
SPAN{width:20%; float:right; text-align:left; margin-left:auto;} SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
</STYLE> </STYLE>
</HEAD> </HEAD>
<BODY > <BODY >
<!--HEVEA command line is: hevea -fix -noiso -pedantic features.tex --> <!--HEVEA command line is: /usr/local/bin/hevea -fix -noiso -pedantic features.tex -->
<!--HTMLHEAD--> <!--CUT DEF section 1 --><P><A NAME="titlepage"></A>
<!--ENDHTML-->
<!--PREFIX <ARG ></ARG>-->
<!--CUT DEF section 1 -->
<BR> </P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 2.0.0beta1 Feature Sheet</H1><H3 CLASS="titlerest">Sander Devrieze<BR>
<BR> <A HREF="mailto:s.devrieze@pandora.be"><TT>mailto:s.devrieze@pandora.be</TT></A><BR>
<A NAME="titlepage"></A> <A HREF="xmpp:sander@devrieze.dyndns.org"><TT>xmpp:sander@devrieze.dyndns.org</TT></A></H3></TD></TR>
</TABLE><DIV CLASS="center">
<TABLE CLASS="title"> <IMG SRC="logo.png" ALT="logo.png">
<TR><TD>
<H1 CLASS="titlemain">Ejabberd 1.1.2 Feature Sheet</H1>
<H3 CLASS="titlerest">Sander Devrieze<BR>
<A HREF="mailto:s.devrieze@pandora.be"><TT>mailto:s.devrieze@pandora.be</TT></A><BR>
<A HREF="xmpp:sander@devrieze.dyndns.org"><TT>xmpp:sander@devrieze.dyndns.org</TT></A></H3></TD>
</TR></TABLE><BR>
<BR>
<DIV CLASS="center">
<IMG SRC="logo.png" ALT="logo.png">
<BR> </DIV><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I can thoroughly recommend ejabberd for ease of setup &#X2013;
<BR> Kevin Smith, Current maintainer of the Psi project</I></FONT></BLOCKQUOTE><P>Introduction
<A NAME="intro"></A></P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. &#X2014;
</DIV> Joeri</I></FONT></BLOCKQUOTE><P><TT>ejabberd</TT> is a <B><FONT SIZE=4><FONT COLOR="#001376">free and open source</FONT></FONT></B> instant messaging server written in <A HREF="http://www.erlang.org/">Erlang</A>.</P><P><TT>ejabberd</TT> is <B><FONT SIZE=4><FONT COLOR="#001376">cross-platform</FONT></FONT></B>, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</P><P><TT>ejabberd</TT> is designed to be a <B><FONT SIZE=4><FONT COLOR="#001376">rock-solid and feature rich</FONT></FONT></B> XMPP server.</P><P><TT>ejabberd</TT> is suitable for small deployments, whether they need to be <B><FONT SIZE=4><FONT COLOR="#001376">scalable</FONT></FONT></B> or not, as well as extremely big deployments.</P><!--TOC section Key Features-->
<BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I can thoroughly recommend ejabberd for ease of setup &ndash; <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc1"></A>Key Features</H2><!--SEC END --><P>
Kevin Smith, Current maintainer of the Psi project</I></FONT></BLOCKQUOTE>
<!--TOC section Introduction-->
<H2 CLASS="section">Introduction</H2><!--SEC END -->
<A NAME="intro"></A>
<BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. &mdash;
Joeri</I></FONT></BLOCKQUOTE>
<TT>ejabberd</TT> is a <B><FONT SIZE=4><FONT COLOR="#001376">free and open source</FONT></FONT></B> instant messaging server written in <A HREF="http://www.erlang.org/">Erlang</A>.<BR>
<BR>
<TT>ejabberd</TT> is <B><FONT SIZE=4><FONT COLOR="#001376">cross-platform</FONT></FONT></B>, distributed, fault-tolerant, and based on open standards to achieve real-time communication.<BR>
<BR>
<TT>ejabberd</TT> is designed to be a <B><FONT SIZE=4><FONT COLOR="#001376">rock-solid and feature rich</FONT></FONT></B> XMPP server.<BR>
<BR>
<TT>ejabberd</TT> is suitable for small deployments, whether they need to be <B><FONT SIZE=4><FONT COLOR="#001376">scalable</FONT></FONT></B> or not, as well as extremely big deployments.<BR>
<BR>
<!--TOC subsection Key Features-->
<H3 CLASS="subsection">Key Features</H3><!--SEC END -->
<A NAME="keyfeatures"></A> <A NAME="keyfeatures"></A>
</P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>Erlang seems to be tailor-made for writing stable, robust servers. &#X2014;
<BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>Erlang seems to be tailor-made for writing stable, robust servers. &mdash; Peter Saint-Andr&#XE9;, Executive Director of the Jabber Software Foundation</I></FONT></BLOCKQUOTE><P><TT>ejabberd</TT> is:
Peter Saint-Andr&eacute;, Executive Director of the Jabber Software Foundation</I></FONT></BLOCKQUOTE> </P><UL CLASS="itemize"><LI CLASS="li-itemize">
<TT>ejabberd</TT> is: <B><FONT SIZE=4><FONT COLOR="#001376">Cross-platform:</FONT></FONT></B> <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.</LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Distributed:</FONT></FONT></B> You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.</LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Fault-tolerant:</FONT></FONT></B> You can deploy an <TT>ejabberd</TT> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.</LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Administrator Friendly:</FONT></FONT></B> <TT>ejabberd</TT> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
<UL CLASS="itemize"><LI CLASS="li-itemize">
<B><FONT SIZE=4><FONT COLOR="#001376">Cross-platform:</FONT></FONT></B> <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.<BR>
<BR>
<LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Distributed:</FONT></FONT></B> You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.<BR>
<BR>
<LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Fault-tolerant:</FONT></FONT></B> You can deploy an <TT>ejabberd</TT> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced `on the fly'.<BR>
<BR>
<LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Administrator Friendly:</FONT></FONT></B> <TT>ejabberd</TT> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Comprehensive documentation. Comprehensive documentation.
<LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows.<FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT> </LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows.<DIV CLASS="marginpar marginparright"><FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT></DIV>
<LI CLASS="li-itemize">Web interface for administration tasks. </LI><LI CLASS="li-itemize">Web interface for administration tasks.
<LI CLASS="li-itemize">Shared Roster Groups. </LI><LI CLASS="li-itemize">Shared Roster Groups.
<LI CLASS="li-itemize">Command line administration tool.<FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT> </LI><LI CLASS="li-itemize">Command line administration tool.<DIV CLASS="marginpar marginparright"><FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT></DIV>
<LI CLASS="li-itemize">Can integrate with existing authentication mechanisms. </LI><LI CLASS="li-itemize">Can integrate with existing authentication mechanisms.
<LI CLASS="li-itemize">Capability to send announce messages. </LI><LI CLASS="li-itemize">Capability to send announce messages.
</UL><BR> </LI></UL></LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Internationalized:</FONT></FONT></B> <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
<BR>
<LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Internationalized:</FONT></FONT></B> <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Translated in 12 languages.<FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT> Translated in 12 languages.<DIV CLASS="marginpar marginparright"><FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT></DIV>
<LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
</UL><BR> </LI></UL></LI><LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Open Standards:</FONT></FONT></B> <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
<BR>
<LI CLASS="li-itemize"><B><FONT SIZE=4><FONT COLOR="#001376">Open Standards:</FONT></FONT></B> <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Fully XMPP compliant. Fully XMPP compliant.
<LI CLASS="li-itemize">XML-based protocol. </LI><LI CLASS="li-itemize">XML-based protocol.
<LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many protocols supported</A>. </LI><LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many protocols supported</A>.
</UL></UL> </LI></UL></LI></UL><!--TOC section Additional Features-->
<!--TOC subsection Additional Features--> <H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2"></A>Additional Features</H2><!--SEC END --><P>
<H3 CLASS="subsection">Additional Features</H3><!--SEC END -->
<A NAME="addfeatures"></A> <A NAME="addfeatures"></A>
</P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>ejabberd is making inroads to solving the "buggy incomplete server" problem &#X2014;
<BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>ejabberd is making inroads to solving the "buggy incomplete server" problem &mdash; Justin Karneges, Founder of the Psi and the Delta projects</I></FONT></BLOCKQUOTE><P>Moreover, <TT>ejabberd</TT> comes with a wide range of other state-of-the-art features:
Justin Karneges, Founder of the Psi and the Delta projects</I></FONT></BLOCKQUOTE> </P><UL CLASS="itemize"><LI CLASS="li-itemize">
Moreover, <TT>ejabberd</TT> comes with a wide range of other state-of-the-art features:
<UL CLASS="itemize"><LI CLASS="li-itemize">
Modular Modular
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Load only the modules you want. Load only the modules you want.
<LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules. </LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules.
</UL> </LI></UL>
<LI CLASS="li-itemize">Security </LI><LI CLASS="li-itemize">Security
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
SASL and STARTTLS for c2s and s2s connections. SASL and STARTTLS for c2s and s2s connections.
<LI CLASS="li-itemize">STARTTLS and Dialback s2s connections. </LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections.
<LI CLASS="li-itemize">Web interface accessible via HTTPS secure access. </LI><LI CLASS="li-itemize">Web interface accessible via HTTPS secure access.
</UL> </LI></UL>
<LI CLASS="li-itemize">Databases </LI><LI CLASS="li-itemize">Databases
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Native MySQL support. Native MySQL support.
<LI CLASS="li-itemize">Native PostgreSQL support. </LI><LI CLASS="li-itemize">Native PostgreSQL support.
<LI CLASS="li-itemize">Mnesia. </LI><LI CLASS="li-itemize">Mnesia.
<LI CLASS="li-itemize">ODBC data storage support. </LI><LI CLASS="li-itemize">ODBC data storage support.
<LI CLASS="li-itemize">Microsoft SQL Server support.<FONT COLOR="red"><SPAN STYLE="font-variant:small-caps">new</SPAN></FONT> </LI><LI CLASS="li-itemize">Microsoft SQL Server support.<DIV CLASS="marginpar marginparright"><FONT COLOR="red"><SPAN STYLE="font-variant:small-caps">new</SPAN></FONT></DIV>
</UL> </LI></UL>
<LI CLASS="li-itemize">Authentication </LI><LI CLASS="li-itemize">Authentication
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
LDAP and ODBC.<FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT> LDAP and ODBC.<DIV CLASS="marginpar marginparright"><FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT></DIV>
<LI CLASS="li-itemize">External Authentication script. </LI><LI CLASS="li-itemize">External Authentication script.
<LI CLASS="li-itemize">Internal Authentication. </LI><LI CLASS="li-itemize">Internal Authentication.
</UL> </LI></UL>
<LI CLASS="li-itemize">Others </LI><LI CLASS="li-itemize">Others
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
<LI CLASS="li-itemize">Interface with networks such as AIM, ICQ and MSN. </LI><LI CLASS="li-itemize">Interface with networks such as AIM, ICQ and MSN.
<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 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 CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with logging.<FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT> </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with logging.<DIV CLASS="marginpar marginparright"><FONT COLOR="#FFAA00"><SPAN STYLE="font-variant:small-caps">improved</SPAN></FONT></DIV>
<LI CLASS="li-itemize">Users Directory based on users vCards. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
<LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component.
<LI CLASS="li-itemize">Support for virtual hosting. </LI><LI CLASS="li-itemize">Support for virtual hosting.
<LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> service. </LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> service.
<LI CLASS="li-itemize">IRC transport. </LI><LI CLASS="li-itemize">IRC transport.
</UL> </LI></UL>
</UL> </LI></UL><!--CUT END -->
<!--HTMLFOOT--> <!--HTMLFOOT-->
<!--ENDHTML--> <!--ENDHTML-->
<!--FOOTER--> <!--FOOTER-->
<HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by <HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by
</EM><A HREF="http://pauillac.inria.fr/~maranget/hevea/index.html"><EM>H<FONT SIZE=2><sup>E</sup></FONT>V<FONT SIZE=2><sup>E</sup></FONT>A</EM></A><EM>.</EM></BLOCKQUOTE></BODY> </EM><A HREF="http://hevea.inria.fr/index.html"><EM>H</EM><EM><FONT SIZE=2><sup>E</sup></FONT></EM><EM>V</EM><EM><FONT SIZE=2><sup>E</sup></FONT></EM><EM>A</EM></A><EM>.</EM></BLOCKQUOTE></BODY>
</HTML> </HTML>

4344
doc/guide.html
View file

File diff suppressed because it is too large Load diff

282
doc/guide.tex
View file

@ -1,17 +1,30 @@
\documentclass[a4paper,10pt]{article} \documentclass[a4paper,10pt]{book}
%% Packages %% Packages
\usepackage{float} \usepackage{float}
\usepackage{graphics} \usepackage{graphics}
\usepackage{hevea} \usepackage{hevea}
\usepackage[pdftex,colorlinks,unicode,urlcolor=blue,linkcolor=blue, \usepackage[pdftex,colorlinks,unicode,urlcolor=blue,linkcolor=blue,
pdftitle=Ejabberd\ Installation\ and\ Operation\ Guide,pdfauthor=Alexey\ pdftitle=Ejabberd\ Installation\ and\ Operation\ Guide,pdfauthor=Process-one,pdfsubject=ejabberd,pdfkeywords=ejabberd,
Shchepin,pdfsubject=ejabberd,pdfkeywords=ejabberd,
pdfpagelabels=false]{hyperref} pdfpagelabels=false]{hyperref}
\usepackage{makeidx} \usepackage{makeidx}
%\usepackage{showidx} % Only for verifying the index entries. %\usepackage{showidx} % Only for verifying the index entries.
\usepackage{verbatim} \usepackage{verbatim}
\usepackage{geometry} \usepackage{geometry}
\usepackage{fancyhdr}
\pagestyle{fancy} %Forces the page to use the fancy template
\renewcommand{\chaptermark}[1]{\markboth{\textbf{\thechapter}.\ \emph{#1}}{}}
\renewcommand{\sectionmark}[1]{\markright{\thesection\ \boldmath\textbf{#1}\unboldmath}}
\fancyhf{}
\fancyhead[LE,RO]{\textbf{\thepage}} %Displays the page number in bold in the header,
% to the left on even pages and to the right on odd pages.
\fancyhead[RE]{\nouppercase{\leftmark}} %Displays the upper-level (chapter) information---
% as determined above---in non-upper case in the header, to the right on even pages.
\fancyhead[LO]{\rightmark} %Displays the lower-level (section) information---as
% determined above---in the header, to the left on odd pages.
\renewcommand{\headrulewidth}{0.5pt} %Underlines the header. (Set to 0pt if not required).
\renewcommand{\footrulewidth}{0.5pt} %Underlines the footer. (Set to 0pt if not required).
%% Index %% Index
\makeindex \makeindex
@ -75,8 +88,7 @@
%% Common options %% Common options
\newcommand{\iqdiscitem}[1]{\titem{iqdisc} \ind{options!iqdisc}This specifies \newcommand{\iqdiscitem}[1]{\titem{iqdisc} \ind{options!iqdisc}This specifies
the processing discipline for #1 IQ queries the processing discipline for #1 IQ queries (see section~\ref{modiqdiscoption}).}
(see section~\ref{modiqdiscoption}).}
\newcommand{\hostitem}[1]{ \newcommand{\hostitem}[1]{
\titem{hosts} \ind{options!hosts} This option defines the hostnames of the \titem{hosts} \ind{options!hosts} This option defines the hostnames of the
service (see section~\ref{modhostsoption}). If neither \texttt{hosts} nor service (see section~\ref{modhostsoption}). If neither \texttt{hosts} nor
@ -84,21 +96,36 @@ the processing discipline for #1 IQ queries
\ejabberd{} hostnames. \ejabberd{} hostnames.
} }
%\newcommand{\quoting}[2][yozhik]{\begin{quotation}\textcolor{#1}{\textit{#2}}\end{quotation}} % Quotes enabled
%\renewcommand{command}[args][default]{def}
%\renewcommand{\headrule}{{\color{ejblue}%
%\hrule width\headwidth height\headrulewidth \vskip-\headrulewidth}}
%% Title page %% Title page
\include{version} \include{version}
\title{Ejabberd \version\ Installation and Operation Guide} \newlength{\larg}
\author{ejabberd development Team} \setlength{\larg}{14.5cm}
\title{
{\rule{\larg}{1mm}}\vspace{7mm}
\begin{tabular}{p{4cm} r}
& {\huge {\bf ejabberd \version\ }} \\
& \\
& {\huge Installation and Operation Guide}
\end{tabular}\\
\vspace{2mm}
{\rule{\larg}{1mm}}
\vspace{2mm} \\
\begin{tabular}{p{11cm} r}
& {\large \bf \today}
\end{tabular}\\
\vspace{5.5cm}
}
\author{\begin{tabular}{p{13.7cm}}
ejabberd Development Team
\end{tabular}}
\date{}
%% Options %% Options
\newcommand{\marking}[1]{#1} % Marking disabled \newcommand{\marking}[1]{#1} % Marking disabled
\newcommand{\quoting}[2][yozhik]{} % Quotes disabled \newcommand{\quoting}[2][yozhik]{} % Quotes disabled
\newcommand{\new}{\marginpar{\textsc{new}}} % Highlight new features %\newcommand{\new}{\marginpar{\textsc{new}}} % Highlight new features
\newcommand{\improved}{\marginpar{\textsc{improved}}} % Highlight improved features %\newcommand{\improved}{\marginpar{\textsc{improved}}} % Highlight improved features
%% To by-pass errors in the HTML version. %% To by-pass errors in the HTML version.
\newstyle{SPAN}{width:20\%; float:right; text-align:left; margin-left:auto;} \newstyle{SPAN}{width:20\%; float:right; text-align:left; margin-left:auto;}
@ -119,14 +146,15 @@ the processing discipline for #1 IQ queries
\begin{titlepage} \begin{titlepage}
\maketitle{} \maketitle{}
\begin{center} %% Commenting. Breaking clean layout for now:
{\insscaleimg{\logoscale}{logo.png} %% \begin{center}
\par %% {\insscaleimg{\logoscale}{logo.png}
} %% \par
\end{center} %% }
%% \end{center}
\begin{quotation}\textit{I can thoroughly recommend ejabberd for ease of setup --- %% \begin{quotation}\textit{I can thoroughly recommend ejabberd for ease of setup ---
Kevin Smith, Current maintainer of the Psi project}\end{quotation} %% Kevin Smith, Current maintainer of the Psi project}\end{quotation}
\end{titlepage} \end{titlepage}
@ -142,6 +170,17 @@ the processing discipline for #1 IQ queries
% Input introduction.tex % Input introduction.tex
\input{introduction} \input{introduction}
\chapter{Installing ejabberd}
\section{Installing ejabberd with Graphical Installer}
The easiest approach to install an ejabberd Instant Messaging server
is to use the graphical installer. The installer is available from
Process-one
website\footahref{http://www.process-one.net/en/ejabberd/downloads/}.
The installer will deploy and configure a full featured ejabberd
server and does not require any extra dependancies.
\section{Installation from Source} \section{Installation from Source}
\label{installsource} \label{installsource}
\ind{installation} \ind{installation}
@ -307,7 +346,41 @@ To reduce memory usage, you may set the environment variable
\end{verbatim} \end{verbatim}
But in this case \ejabberd{} can start to work slower. But in this case \ejabberd{} can start to work slower.
\section{Creating an Initial Administrator}
\label{initialadmin}
Before the web interface can be entered to perform administration tasks, an
account with administrator rights is needed on your \ejabberd{} deployment.
Instructions to create an initial administrator account:
\begin{enumerate}
\item Register an account on your \ejabberd{} deployment. An account can be
created in two ways:
\begin{enumerate}
\item Using the tool \term{ejabberdctl}\ind{ejabberdctl} (see
section~\ref{ejabberdctl}):
\begin{verbatim}
% ejabberdctl node@host register admin example.org password
\end{verbatim}
\item Using In-Band Registration (see section~\ref{modregister}): you can
use a \Jabber{} client to register an account.
\end{enumerate}
\item Edit the configuration file to promote the account created in the previous
step to an account with administrator rights. Note that if you want to add
more administrators, a seperate acl entry is needed for each administrator.
\begin{verbatim}
{acl, admins, {user, "admin", "example.org"}}.
{access, configure, [{allow, admins}]}.
\end{verbatim}
\item Restart \ejabberd{} to load the new configuration.
\item Open the web interface (\verb|http://server:port/admin/|) in your
favourite browser. Make sure to enter the \emph{full} JID as username (in this
example: \jid{admin@example.org}. The reason that you also need to enter the
suffix, is because \ejabberd{}'s virtual hosting support.
\end{enumerate}
\chapter{Configuring ejabberd}
\section{Basic Configuration} \section{Basic Configuration}
\label{basicconfig} \label{basicconfig}
\ind{configuration file} \ind{configuration file}
@ -905,48 +978,6 @@ Examples:
\end{verbatim} \end{verbatim}
\end{itemize} \end{itemize}
\section{Advanced configuration}
\subsection{Components Load-Balancing}
\label{componentlb}
\ind{component load-balancing}
\subsection{Domain Load-Balancing Algorithm}
\label{domainlb}
\ind{options!domain\_balancing}
\ejabberd{} includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.
The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is choosen randomly. If no instance is available locally, one instance is choosen randomly among the remote component instances.
If you need a different behaviour, you can change the load balancing behaviour with the option \option{domain\_balancing}. The syntax of the option is the following:
\begin{verbatim}
{domain_balancing, "component.example.com", <balancing_criterium>}.
\end{verbatim}
Several balancing criteria are available:
\begin{itemize}
\item \term{destination}: the full JID of the packet \term{to} attribute is used.
\item \term{source}: the full JID of the packet \term{from} attribute is used.
\item \term{bare\_destination}: the bare JID (without resource) of the packet \term{to} attribute is used.
\item \term{bare\_source}: the bare JID (without resource) of the packet \term{from} attribute is used.
\end{itemize}
If the value corresponding to the criterium is the same, the same component instance in the cluster will be used.
\subsection{Load-Balancing Buckets}
\label{lbbuckets}
\ind{options!domain\_balancing\_component\_number}
When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failling the service will not work correctly unless the sessions are rebalanced.
In this case, it is best to limit the problem to the sessions handled by the failling component. This is what the \term{domain\_balancing\_component\_number} option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.
The syntax is the following:
\begin{verbatim}
{domain_balancing_component_number, "component.example.com", N}
\end{verbatim}
\section{Database and LDAP Configuration} \section{Database and LDAP Configuration}
\label{database} \label{database}
\ind{database} \ind{database}
@ -2884,41 +2915,7 @@ Options:
\iqdiscitem{Software Version (\ns{jabber:iq:version})} \iqdiscitem{Software Version (\ns{jabber:iq:version})}
\end{description} \end{description}
\chapter{Managing an ejabberd server}
\section{Creating an Initial Administrator}
\label{initialadmin}
Before the web interface can be entered to perform administration tasks, an
account with administrator rights is needed on your \ejabberd{} deployment.
Instructions to create an initial administrator account:
\begin{enumerate}
\item Register an account on your \ejabberd{} deployment. An account can be
created in two ways:
\begin{enumerate}
\item Using the tool \term{ejabberdctl}\ind{ejabberdctl} (see
section~\ref{ejabberdctl}):
\begin{verbatim}
% ejabberdctl node@host register admin example.org password
\end{verbatim}
\item Using In-Band Registration (see section~\ref{modregister}): you can
use a \Jabber{} client to register an account.
\end{enumerate}
\item Edit the configuration file to promote the account created in the previous
step to an account with administrator rights. Note that if you want to add
more administrators, a seperate acl entry is needed for each administrator.
\begin{verbatim}
{acl, admins, {user, "admin", "example.org"}}.
{access, configure, [{allow, admins}]}.
\end{verbatim}
\item Restart \ejabberd{} to load the new configuration.
\item Open the web interface (\verb|http://server:port/admin/|) in your
favourite browser. Make sure to enter the \emph{full} JID as username (in this
example: \jid{admin@example.org}. The reason that you also need to enter the
suffix, is because \ejabberd{}'s virtual hosting support.
\end{enumerate}
\section{Online Configuration and Monitoring} \section{Online Configuration and Monitoring}
\label{onlineconfig} \label{onlineconfig}
@ -3040,7 +3037,7 @@ Additional information:
is very high. is very high.
\end{description} \end{description}
\chapter{Securing ejabberd}
\section{Firewall Settings} \section{Firewall Settings}
\label{firewall} \label{firewall}
\ind{firewall}\ind{ports}\ind{SASL}\ind{TLS}\ind{clustering!ports} \ind{firewall}\ind{ports}\ind{SASL}\ind{TLS}\ind{clustering!ports}
@ -3060,7 +3057,7 @@ You need to take the following TCP ports in mind when configuring your firewall:
\end{tabular} \end{tabular}
\end{table} \end{table}
\chapter{Integrating ejabberd with other Instant Messaging servers}
\section{SRV Records} \section{SRV Records}
\label{srv} \label{srv}
\ind{SRV Records}\ind{clustering!SRV Records} \ind{SRV Records}\ind{clustering!SRV Records}
@ -3072,12 +3069,11 @@ You need to take the following TCP ports in mind when configuring your firewall:
\footahref{http://jabberd.jabberstudio.org/2/docs/section05.html\#5\_7}{Setting DNS SRV Records} \footahref{http://jabberd.jabberstudio.org/2/docs/section05.html\#5\_7}{Setting DNS SRV Records}
\end{itemize} \end{itemize}
\chapter{Clustering}
\section{Clustering}
\label{clustering} \label{clustering}
\ind{clustering} \ind{clustering}
\subsection{How it Works} \section{How it Works}
\label{howitworks} \label{howitworks}
\ind{clustering!how it works} \ind{clustering!how it works}
@ -3097,7 +3093,7 @@ Each \ejabberd{} node has the following modules:
\item s2s manager. \item s2s manager.
\end{itemize} \end{itemize}
\subsubsection{Router} \subsection{Router}
\label{router} \label{router}
\ind{clustering!router} \ind{clustering!router}
@ -3107,7 +3103,7 @@ routing table. The domain of the packet's destination is searched in the
routing table, and if it is found, the packet is routed to the routing table, and if it is found, the packet is routed to the
appropriate process. If not, it is sent to the s2s manager. appropriate process. If not, it is sent to the s2s manager.
\subsubsection{Local Router} \subsection{Local Router}
\label{localrouter} \label{localrouter}
\ind{clustering!local router} \ind{clustering!local router}
@ -3116,7 +3112,7 @@ one of this server's host names. If the destination JID has a non-empty user
part, it is routed to the session manager, otherwise it is processed depending part, it is routed to the session manager, otherwise it is processed depending
on its content. on its content.
\subsubsection{Session Manager} \subsection{Session Manager}
\label{sessionmanager} \label{sessionmanager}
\ind{clustering!session manager} \ind{clustering!session manager}
@ -3125,7 +3121,7 @@ resource a packet must be sent via a presence table. Then the packet is
either routed to the appropriate c2s process, or stored in offline either routed to the appropriate c2s process, or stored in offline
storage, or bounced back. storage, or bounced back.
\subsubsection{s2s Manager} \subsection{s2s Manager}
\label{s2smanager} \label{s2smanager}
\ind{clustering!s2s manager} \ind{clustering!s2s manager}
@ -3135,7 +3131,7 @@ source to the domain of the packet's destination exists. If that is the case,
the s2s manager routes the packet to the process the s2s manager routes the packet to the process
serving this connection, otherwise a new connection is opened. serving this connection, otherwise a new connection is opened.
\subsection{Clustering Setup} \section{Clustering Setup}
\label{cluster} \label{cluster}
\ind{clustering!setup} \ind{clustering!setup}
@ -3217,17 +3213,61 @@ mnesia:change_table_copy_type(schema, node(), disc_copies).
You can repeat these steps for other machines supposed to serve this You can repeat these steps for other machines supposed to serve this
domain. domain.
\section{Service Load-Balancing}
\subsection{Components Load-Balancing}
\label{componentlb}
\ind{component load-balancing}
\subsection{Domain Load-Balancing Algorithm}
\label{domainlb}
\ind{options!domain\_balancing}
\ejabberd{} includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.
The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is choosen randomly. If no instance is available locally, one instance is choosen randomly among the remote component instances.
If you need a different behaviour, you can change the load balancing behaviour with the option \option{domain\_balancing}. The syntax of the option is the following:
\begin{verbatim}
{domain_balancing, "component.example.com", <balancing_criterium>}.
\end{verbatim}
Several balancing criteria are available:
\begin{itemize}
\item \term{destination}: the full JID of the packet \term{to} attribute is used.
\item \term{source}: the full JID of the packet \term{from} attribute is used.
\item \term{bare\_destination}: the bare JID (without resource) of the packet \term{to} attribute is used.
\item \term{bare\_source}: the bare JID (without resource) of the packet \term{from} attribute is used.
\end{itemize}
If the value corresponding to the criterium is the same, the same component instance in the cluster will be used.
\subsection{Load-Balancing Buckets}
\label{lbbuckets}
\ind{options!domain\_balancing\_component\_number}
When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failling the service will not work correctly unless the sessions are rebalanced.
In this case, it is best to limit the problem to the sessions handled by the failling component. This is what the \term{domain\_balancing\_component\_number} option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.
The syntax is the following:
\begin{verbatim}
{domain_balancing_component_number, "component.example.com", N}
\end{verbatim}
% TODO % TODO
% See also the section about ejabberdctl!!!! % See also the section about ejabberdctl!!!!
%\section{Backup and Restore} %\section{Backup and Restore}
%\label{backup} %\label{backup}
%\ind{backup} %\ind{backup}
\section{Debugging} \chapter{Debugging}
\label{debugging} \label{debugging}
\ind{debugging} \ind{debugging}
\subsection{Watchdog alerts} \section{Watchdog alerts}
\label{watchdog} \label{watchdog}
\ind{debugging!watchdog} \ind{debugging!watchdog}
@ -3242,7 +3282,7 @@ To enable the watchdog, add the \term{watchdog\_admins}
\end{verbatim} \end{verbatim}
\appendix{} \appendix{}
\section{Internationalization and Localization} \chapter{Internationalization and Localization}
\label{i18nl10n} \label{i18nl10n}
\ind{xml:lang}\ind{internationalization}\ind{localization}\ind{i18n}\ind{l10n} \ind{xml:lang}\ind{internationalization}\ind{localization}\ind{i18n}\ind{l10n}
@ -3281,32 +3321,32 @@ figure~\ref{fig:webadmmainru} with figure~\ref{fig:webadmmain})
%TODO: a very big example covering the whole guide, with a good explanation before the example: different authenticaton mechanisms, transports, ACLs, multple virtual hosts, virtual host specific settings and general settings, modules,... %TODO: a very big example covering the whole guide, with a good explanation before the example: different authenticaton mechanisms, transports, ACLs, multple virtual hosts, virtual host specific settings and general settings, modules,...
\newpage \newpage
\section{Release Notes} \chapter{Release Notes}
\label{releasenotes} \label{releasenotes}
\ind{release notes} \ind{release notes}
\subsection{ejabberd 0.9} \section{ejabberd 0.9}
\verbatiminput{release_notes_0.9.txt} \verbatiminput{release_notes_0.9.txt}
\subsection{ejabberd 0.9.1} \section{ejabberd 0.9.1}
\verbatiminput{release_notes_0.9.1.txt} \verbatiminput{release_notes_0.9.1.txt}
\subsection{ejabberd 0.9.8} \section{ejabberd 0.9.8}
\verbatiminput{release_notes_0.9.8.txt} \verbatiminput{release_notes_0.9.8.txt}
\subsection{ejabberd 1.0.0} \section{ejabberd 1.0.0}
\verbatiminput{release_notes_1.0.0.txt} \verbatiminput{release_notes_1.0.0.txt}
\subsection{ejabberd 1.1.0} \section{ejabberd 1.1.0}
\verbatiminput{release_notes_1.1.0.txt} \verbatiminput{release_notes_1.1.0.txt}
\subsection{ejabberd 1.1.1} \section{ejabberd 1.1.1}
\verbatiminput{release_notes_1.1.1.txt} \verbatiminput{release_notes_1.1.1.txt}
\subsection{ejabberd 1.1.2} \section{ejabberd 1.1.2}
\verbatiminput{release_notes_1.1.2.txt} \verbatiminput{release_notes_1.1.2.txt}
\section{Acknowledgements} \chapter{Acknowledgements}
\label{acknowledgements} \label{acknowledgements}
Thanks to all people who contributed to this guide: Thanks to all people who contributed to this guide:
\begin{itemize} \begin{itemize}
@ -3322,7 +3362,7 @@ Thanks to all people who contributed to this guide:
\end{itemize} \end{itemize}
\section{Copyright Information} \chapter{Copyright Information}
\label{copyright} \label{copyright}
Ejabberd Installation and Operation Guide.\\ Ejabberd Installation and Operation Guide.\\

20
doc/introduction.tex
View file

@ -1,6 +1,8 @@
\section{Introduction} \chapter{Introduction}
\label{intro} \label{intro}
%% TODO: improve the feature sheet with a nice table to highlight new features.
\quoting{I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. --- \quoting{I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. ---
Joeri} Joeri}
@ -38,7 +40,7 @@ Joeri}
%\end{itemize} %\end{itemize}
\newpage \newpage
\subsection{Key Features} \section{Key Features}
\label{keyfeatures} \label{keyfeatures}
\ind{features!key features} \ind{features!key features}
@ -56,17 +58,17 @@ Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
\item \marking{Administrator Friendly:} \ejabberd{} is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include: \item \marking{Administrator Friendly:} \ejabberd{} is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
\begin{itemize} \begin{itemize}
\item Comprehensive documentation. \item Comprehensive documentation.
\item Straightforward installers for Linux, Mac OS X, and Windows.\improved{} \item Straightforward installers for Linux, Mac OS X, and Windows. %%\improved{}
\item Web interface for administration tasks. \item Web interface for administration tasks.
\item Shared Roster Groups. \item Shared Roster Groups.
\item Command line administration tool.\improved{} \item Command line administration tool. %%\improved{}
\item Can integrate with existing authentication mechanisms. \item Can integrate with existing authentication mechanisms.
\item Capability to send announce messages. \item Capability to send announce messages.
\end{itemize} \end{itemize}
\item \marking{Internationalized:} \ejabberd{} leads in internationalization. Hence it is very well suited in a globalized world. Related features are: \item \marking{Internationalized:} \ejabberd{} leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
\begin{itemize} \begin{itemize}
\item Translated in 12 languages.\improved{} \item Translated in 12 languages. %%\improved{}
\item Support for \footahref{http://www.ietf.org/rfc/rfc3490.txt}{IDNA}. \item Support for \footahref{http://www.ietf.org/rfc/rfc3490.txt}{IDNA}.
\end{itemize} \end{itemize}
@ -81,7 +83,7 @@ Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
\newpage \newpage
\subsection{Additional Features} \section{Additional Features}
\label{addfeatures} \label{addfeatures}
\ind{features!additional features} \ind{features!additional features}
@ -107,11 +109,11 @@ Moreover, \ejabberd{} comes with a wide range of other state-of-the-art features
\item Native PostgreSQL support. \item Native PostgreSQL support.
\item Mnesia. \item Mnesia.
\item ODBC data storage support. \item ODBC data storage support.
\item Microsoft SQL Server support.\new{} \item Microsoft SQL Server support. %%\new{}
\end{itemize} \end{itemize}
\item Authentication \item Authentication
\begin{itemize} \begin{itemize}
\item LDAP and ODBC.\improved{} \item LDAP and ODBC. %%\improved{}
\item External Authentication script. \item External Authentication script.
\item Internal Authentication. \item Internal Authentication.
\end{itemize} \end{itemize}
@ -121,7 +123,7 @@ Moreover, \ejabberd{} comes with a wide range of other state-of-the-art features
\item Interface with networks such as AIM, ICQ and MSN. \item Interface with networks such as AIM, ICQ and MSN.
\item Statistics via Statistics Gathering (\xepref{0039}). \item Statistics via Statistics Gathering (\xepref{0039}).
\item IPv6 support both for c2s and s2s connections. \item IPv6 support both for c2s and s2s connections.
\item \txepref{0045}{Multi-User Chat} module with logging.\improved{} \item \txepref{0045}{Multi-User Chat} module with logging. %%\improved{}
\item Users Directory based on users vCards. \item Users Directory based on users vCards.
\item \txepref{0060}{Publish-Subscribe} component. \item \txepref{0060}{Publish-Subscribe} component.
\item Support for virtual hosting. \item Support for virtual hosting.

2
doc/version.tex
View file

@ -1,2 +1,2 @@
% ejabberd version (automatically generated). % ejabberd version (automatically generated).
\newcommand{\version}{1.1.2} \newcommand{\version}{2.0.0 beta 1}