diff options
| author | Mickaël Rémond <mickael.remond@process-one.net> | 2005-12-16 19:33:42 +0300 |
|---|---|---|
| committer | Mickaël Rémond <mickael.remond@process-one.net> | 2005-12-16 19:33:42 +0300 |
| commit | c275a245970eb52549981df1508eee54b736884c (patch) | |
| tree | 5d72f71494806e1759c1c3215dbf2543faeadc65 /doc | |
| parent | 52fcdc716d61460840e2c2796eae7238d4e6c810 (diff) | |
Documentation update, code clean-up and Makefile improvement.
SVN Revision: 473
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 44 | ||||
| -rw-r--r-- | doc/dev.html | 326 | ||||
| -rw-r--r-- | doc/dev.tex | 159 | ||||
| -rw-r--r-- | doc/guide.html | 131 | ||||
| -rw-r--r-- | doc/guide.tex | 3 |
5 files changed, 453 insertions, 210 deletions
diff --git a/doc/Makefile b/doc/Makefile index c541c6254..cc8b4d1b3 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,11 +1,49 @@ # $Id$ -all: guide.html dev.html +all: release pdf html + +release: + @echo "Notes for the releaser:" + @echo "* Do not forget to add a link to the release notes in guide.tex" + @echo "* Do not forget to change the version number in version.tex" + @echo "* Do not forget to update the features in introduction.tex (including \new{} and \improved{} tags)." + @read -p "press any key to continue" + +html: guide.html dev.html features.html + +pdf: guide.pdf features.pdf + +clean: + rm -f *.aux + rm -f *.haux + rm -f *.html + rm -f *.htoc + rm -f *.idx + rm -f *.ilg + rm -f *.ind + rm -f *.log + rm -f *.out + rm -f *.pdf + rm -f *.toc guide.html: guide.tex - hevea -charset ISO8859-1 guide.tex + hevea guide.tex + hevea guide.tex dev.html: dev.tex - hevea -charset ISO8859-1 dev.tex + hevea dev.tex + hevea dev.tex + +features.html: features.tex + hevea features.tex + hevea features.tex +guide.pdf: guide.tex + pdflatex guide.tex + pdflatex guide.tex + pdflatex guide.tex + makeindex guide.idx + pdflatex guide.tex +features.pdf: features.tex + pdflatex features.tex diff --git a/doc/dev.html b/doc/dev.html index 22ee142bb..65a85172a 100644 --- a/doc/dev.html +++ b/doc/dev.html @@ -1,99 +1,186 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> <HTML> -<HEAD><TITLE>Ejabberd Developers Guide</TITLE> -<META http-equiv="Content-Type" content="text/html; charset=ISO8859-1"> -<META name="GENERATOR" content="hevea 1.07"> +<HEAD> + +<TITLE>Ejabberd 1.0.0 Developers Guide</TITLE> + +<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<META name="GENERATOR" content="hevea 1.08"> +<STYLE type="text/css"> +.toc{list-style:none;} +.title{margin:auto;text-align:center} +.center{text-align:center;margin-left:auto;margin-right:auto;} +.flushleft{text-align:left;margin-left:0ex;margin-right:auto;} +.flushright{text-align:right;margin-left:auto;margin-right:0ex;} +DIV TABLE{margin-left:inherit;margin-right:inherit;} +PRE{text-align:left;margin-left:0ex;margin-right:auto;} +BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} +.part{margin:auto;text-align:center} +</STYLE> </HEAD> + <BODY > -<!--HEVEA command line is: /usr/bin/hevea -charset ISO8859-1 dev.tex --> +<!--HEVEA command line is: hevea dev.tex --> <!--HTMLHEAD--> <!--ENDHTML--> <!--PREFIX <ARG ></ARG>--> <!--CUT DEF section 1 --> +<BR> +<BR> +<A NAME="sec:titlepage"></A> - -<H1 ALIGN=center>Ejabberd Developers Guide</H1> - -<H3 ALIGN=center>Alexey Shchepin<BR> + <TABLE CLASS="title"> +<TR><TD> +<H1 CLASS="titlemain">Ejabberd 1.0.0 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> - -<H3 ALIGN=center>August 21, 2005</H3><DIV ALIGN=center> - +<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"> - </DIV><BR> + <BR> <BR> + </DIV> +<BLOCKQUOTE CLASS="quotation"><I>I can thoroughly recommend ejabberd for ease of setup – + Kevin Smith, Current maintainer of the Psi project</I></BLOCKQUOTE> +<!--TOC section Contents--> -<!--TOC section Table of Contents--> +<H2 CLASS="section">Contents</H2><!--SEC END --> -<H2>Table of Contents</H2><!--SEC END --> - -<UL><LI> +<UL CLASS="toc"><LI CLASS="li-toc"> <A HREF="#htoc1">1 Introduction</A> -<UL><LI> -<A HREF="#htoc2">1.1 How it works</A> -<UL><LI> -<A HREF="#htoc3">1.1.1 Router</A> -<LI><A HREF="#htoc4">1.1.2 Local Router</A> -<LI><A HREF="#htoc5">1.1.3 Session Manager</A> -<LI><A HREF="#htoc6">1.1.4 S2S Manager</A> +<UL CLASS="toc"><LI CLASS="li-toc"> +<A HREF="#htoc2">1.1 Key Features</A> +<LI CLASS="li-toc"><A HREF="#htoc3">1.2 Additional Features</A> </UL> +<LI CLASS="li-toc"><A HREF="#htoc4">2 How it works</A> +<UL CLASS="toc"><LI CLASS="li-toc"> +<A HREF="#htoc5">2.1 Router</A> +<LI CLASS="li-toc"><A HREF="#htoc6">2.2 Local Router</A> +<LI CLASS="li-toc"><A HREF="#htoc7">2.3 Session Manager</A> +<LI CLASS="li-toc"><A HREF="#htoc8">2.4 S2S Manager</A> </UL> -<LI><A HREF="#htoc7">2 XML representation</A> -<LI><A HREF="#htoc8">3 Module <TT>xml</TT></A> -<LI><A HREF="#htoc9">4 Module <TT>xml_stream</TT></A> -<LI><A HREF="#htoc10">5 <TT>ejabberd</TT> modules</A> -<UL><LI> -<A HREF="#htoc11">5.1 <CODE>gen_mod</CODE> behaviour</A> -<LI><A HREF="#htoc12">5.2 Module <CODE>gen_iq_handler</CODE></A> -<LI><A HREF="#htoc13">5.3 Services</A> +<LI CLASS="li-toc"><A HREF="#htoc9">3 XML representation</A> +<LI CLASS="li-toc"><A HREF="#htoc10">4 Module <TT>xml</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc11">5 Module <TT>xml_stream</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc12">6 <TT>ejabberd</TT> modules</A> +<UL CLASS="toc"><LI CLASS="li-toc"> +<A HREF="#htoc13">6.1 gen_mod behaviour</A> +<LI CLASS="li-toc"><A HREF="#htoc14">6.2 Module gen_iq_handler</A> +<LI CLASS="li-toc"><A HREF="#htoc15">6.3 Services</A> </UL> </UL> <!--TOC section Introduction--> -<H2><A NAME="htoc1">1</A> Introduction</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc1">1</A> Introduction</H2><!--SEC END --> -<A NAME="sec:intro"></A> -<TT>ejabberd</TT> is a Free and Open Source fault-tolerant distributed Jabber -server. It is written mostly in Erlang.<BR> +<A NAME="sec:intr"></A> + +<TT>ejabberd</TT> is a free (GPL) distributed fault-tolerant Jabber/XMPP server and is mainly written in <A HREF="http://www.erlang.org/">Erlang</A>.<BR> <BR> -The main features of <TT>ejabberd</TT> are: -<UL><LI> -Works on most of popular platforms: *nix (tested on Linux, FreeBSD and - NetBSD) and Win32 -<LI>Distributed: You can run <TT>ejabberd</TT> on a cluster of machines to let all of - them serve one Jabber domain. -<LI>Fault-tolerance: You can setup an <TT>ejabberd</TT> cluster so that all the - information required for a properly working service will be stored - permanently on more than one node. This means that if one of the nodes - crashes, then the others will continue working without disruption. - You can also add or replace nodes ``on the fly''. -<LI>Support for virtual hosting -<LI>Built-in <A HREF="http://www.jabber.org/jeps/jep-0045.html">Multi-User Chat</A> service -<LI>Built-in IRC transport -<LI>Built-in <A HREF="http://www.jabber.org/jeps/jep-0060.html">Publish-Subscribe</A> service -<LI>Built-in Jabber Users Directory service based on users vCards -<LI>Built-in web-based administration interface -<LI>Built-in <A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A> service -<LI>SSL support -<LI>Support for LDAP authentication -<LI>Ability to interface with external components (JIT, MSN-t, Yahoo-t, etc.) -<LI>Migration from jabberd14 is possible -<LI>Mostly XMPP-compliant -<LI>Support for <A HREF="http://www.jabber.org/jeps/jep-0030.html">Service Discovery</A>. -<LI>Support for <A HREF="http://www.jabber.org/jeps/jep-0039.html">Statistics Gathering</A>. -<LI>Support for <TT>xml:lang</TT> +<TT>ejabberd</TT> is designed to be a stable, standards compliant, and feature rich Jabber/XMPP server.<BR> +<BR> +<TT>ejabberd</TT> is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers.<BR> +<BR> +<!--TOC subsection Key Features--> + +<H3 CLASS="subsection"><A NAME="htoc2">1.1</A> Key Features</H3><!--SEC END --> + +<A NAME="sec:keyfeatures"></A> + +<TT>ejabberd</TT> is: +<UL CLASS="itemize"><LI CLASS="li-itemize"> +Multiplatform: <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 one Jabber domain. 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"> +Comprehensive documentation. +<LI CLASS="li-itemize">Straightforward installers for Windows and Linux. +<LI CLASS="li-itemize">Web interface for administration tasks. +<LI CLASS="li-itemize">Shared Roster groups. +<LI CLASS="li-itemize">Command line administration tool. +<LI CLASS="li-itemize">Can integrate with existing authentication mechanisms. +<LI CLASS="li-itemize">Capability to send announce messages. +</UL><BR> +<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"> +Translated in 11 languages. +<LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. +</UL><BR> +<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"> +Fully XMPP compliant +<LI CLASS="li-itemize">XML-based protocol +<LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many JEPs supported</A>. +</UL></UL> +<!--TOC subsection Additional Features--> + +<H3 CLASS="subsection"><A NAME="htoc3">1.2</A> Additional Features</H3><!--SEC END --> + +<A NAME="sec:addfeatures"></A> + +Besides common Jabber server features, <TT>ejabberd</TT> comes with a wide range of other features: +<UL CLASS="itemize"><LI CLASS="li-itemize"> +Modular: <TT>ejabberd</TT>'s modular architecture allows easy customization: +<UL CLASS="itemize"><LI CLASS="li-itemize"> +Load only the modules you want. +<LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules. +</UL> +<LI CLASS="li-itemize">Security +<UL CLASS="itemize"><LI CLASS="li-itemize"> +SASL and STARTTLS for c2s and s2s connections. +<LI CLASS="li-itemize">STARTTLS and Dialback s2s connections. +<LI CLASS="li-itemize">Obsolete SSL for c2s connections also supported. +<LI CLASS="li-itemize">Web interface accessible via HTTPS secure access. +</UL> +<LI CLASS="li-itemize">Databases +<UL CLASS="itemize"><LI CLASS="li-itemize"> +Native PostgreSQL support. +<LI CLASS="li-itemize">Mnesia. +<LI CLASS="li-itemize">ODBC data storage support. +</UL> +<LI CLASS="li-itemize">Authentication +<UL CLASS="itemize"><LI CLASS="li-itemize"> +LDAP. +<LI CLASS="li-itemize">External Authentication script. +<LI CLASS="li-itemize">Internal Authentication. +</UL> +<LI CLASS="li-itemize">The ability to interface via external components with networks such as: +<UL CLASS="itemize"><LI CLASS="li-itemize"> +AIM +<LI CLASS="li-itemize">ICQ +<LI CLASS="li-itemize">MSN +</UL> +<LI CLASS="li-itemize">Others +<UL CLASS="itemize"><LI CLASS="li-itemize"> +IPv6 support both for c2s and s2s connections. +<LI CLASS="li-itemize">Support for virtual hosting. +<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A> service +<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0045.html">Multi-User Chat</A> module. +<LI CLASS="li-itemize">IRC transport. +<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0060.html">Publish-Subscribe</A> component. +<LI CLASS="li-itemize">Users Directory based on users vCards. +<LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A>). +</UL> </UL> -<!--TOC subsection How it works--> +<!--TOC section How it works--> -<H3><A NAME="htoc2">1.1</A> How it works</H3><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc4">2</A> How it works</H2><!--SEC END --> <A NAME="sec:howitworks"></A> A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can @@ -105,15 +192,15 @@ needed because all nodes exchange information about connected users, S2S connections, registered services, etc...<BR> <BR> Each <TT>ejabberd</TT> node have following modules: -<UL><LI> +<UL CLASS="itemize"><LI CLASS="li-itemize"> router; -<LI>local router. -<LI>session manager; -<LI>S2S manager; +<LI CLASS="li-itemize">local router. +<LI CLASS="li-itemize">session manager; +<LI CLASS="li-itemize">S2S manager; </UL> -<!--TOC subsubsection Router--> +<!--TOC subsection Router--> -<H4><A NAME="htoc3">1.1.1</A> Router</H4><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc5">2.1</A> 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 @@ -123,26 +210,26 @@ searches in global table, and is routed to the appropriate <TT>ejabberd</TT> nod process. If it does not exists in either tables, then it sent to the S2S manager.<BR> <BR> -<!--TOC subsubsection Local Router--> +<!--TOC subsection Local Router--> -<H4><A NAME="htoc4">1.1.2</A> Local Router</H4><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc6">2.2</A> 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 session manager, else it is processed depending on it's content.<BR> <BR> -<!--TOC subsubsection Session Manager--> +<!--TOC subsection Session Manager--> -<H4><A NAME="htoc5">1.1.3</A> Session Manager</H4><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc7">2.3</A> 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 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> <BR> -<!--TOC subsubsection S2S Manager--> +<!--TOC subsection S2S Manager--> -<H4><A NAME="htoc6">1.1.4</A> S2S Manager</H4><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc8">2.4</A> 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 @@ -153,11 +240,11 @@ does not exist, then it is opened and registered.<BR> <BR> <!--TOC section XML representation--> -<H2><A NAME="htoc7">2</A> XML representation</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc9">3</A> XML representation</H2><!--SEC END --> <A NAME="sec:xmlrepr"></A> Each XML stanza is represented as the following tuple: -<PRE> +<PRE CLASS="verbatim"> XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]} Name = string() Attrs = [Attr] @@ -167,12 +254,12 @@ XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]} ElementOrCDATA = XMLElement | CDATA CDATA = {xmlcdata, string()} </PRE>E. g. this stanza: -<PRE> +<PRE CLASS="verbatim"> <message to='test@conference.example.org' type='groupchat'> <body>test</body> </message> </PRE>is represented as the following structure: -<PRE> +<PRE CLASS="verbatim"> {xmlelement, "message", [{"to", "test@conference.example.org"}, {"type", "groupchat"}], @@ -182,29 +269,28 @@ XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]} </PRE> <!--TOC section Module <TT>xml</TT>--> -<H2><A NAME="htoc8">3</A> Module <TT>xml</TT></H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc10">4</A> Module <TT>xml</TT></H2><!--SEC END --> <A NAME="sec:xmlmod"></A> -<DL COMPACT=compact><DT> -<CODE><B>element_to_string(El) -> string()</B></CODE><DD> -<PRE> +<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>element_to_string(El) -> string()</CODE> +<PRE CLASS="verbatim"> El = XMLElement </PRE>Returns string representation of XML stanza <TT>El</TT>.<BR> <BR> -<DT><CODE><B>crypt(S) -> string()</B></CODE><DD> -<PRE> +<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>crypt(S) -> string()</CODE> +<PRE CLASS="verbatim"> S = string() </PRE>Returns string which correspond to <TT>S</TT> with encoded XML special characters.<BR> <BR> -<DT><CODE><B>remove_cdata(ECList) -> EList</B></CODE><DD> -<PRE> +<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>remove_cdata(ECList) -> EList</CODE> +<PRE CLASS="verbatim"> ECList = [ElementOrCDATA] EList = [XMLElement] </PRE><TT>EList</TT> is a list of all non-CDATA elements of ECList.<BR> <BR> -<DT><CODE><B>get_path_s(El, Path) -> Res</B></CODE><DD> -<PRE> +<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>get_path_s(El, Path) -> Res</CODE> +<PRE CLASS="verbatim"> El = XMLElement Path = [PathItem] PathItem = PathElem | PathAttr | PathCDATA @@ -215,17 +301,16 @@ Name = string() Res = string() | XMLElement </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: - <DL COMPACT=compact><DT> - <CODE><B>{elem, Name}</B></CODE><DD> <TT>Name</TT> is name of subelement 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 <TT>El</TT>, if such element exists, then this element considered in following steps, else returns empty string. - <DT><CODE><B>{attr, Name}</B></CODE><DD> If <TT>El</TT> have attribute <TT>Name</TT>, then + <DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>{attr, Name}</CODE> If <TT>El</TT> have attribute <TT>Name</TT>, then returns value of this attribute, else returns empty string. - <DT><CODE><B>cdata</B></CODE><DD> Returns CDATA of <TT>El</TT>. + <DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>cdata</CODE> Returns CDATA of <TT>El</TT>. </DL><BR> <BR> -<DT><B>TODO:</B><DD> -<PRE> +<DT CLASS="dt-description"><DD CLASS="dd-description">TODO: +<PRE CLASS="verbatim"> get_cdata/1, get_tag_cdata/1 get_attr/2, get_attr_s/2 get_tag_attr/2, get_tag_attr_s/2 @@ -233,12 +318,11 @@ Res = string() | XMLElement </PRE></DL> <!--TOC section Module <TT>xml_stream</TT>--> -<H2><A NAME="htoc9">4</A> Module <TT>xml_stream</TT></H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc11">5</A> Module <TT>xml_stream</TT></H2><!--SEC END --> <A NAME="sec:xmlstreammod"></A> -<DL COMPACT=compact><DT> -<CODE><B>parse_element(Str) -> XMLElement | {error, Err}</B></CODE><DD> -<PRE> +<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>parse_element(Str) -> XMLElement | {error, Err}</CODE> +<PRE CLASS="verbatim"> Str = string() Err = term() </PRE>Parses <TT>Str</TT> using XML parser, returns either parsed element or error @@ -246,28 +330,27 @@ Err = term() </DL> <!--TOC section <TT>ejabberd</TT> modules--> -<H2><A NAME="htoc10">5</A> <TT>ejabberd</TT> modules</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc12">6</A> <TT>ejabberd</TT> modules</H2><!--SEC END --> <A NAME="sec:emods"></A> -<!--TOC subsection <CODE>gen_mod</CODE> behaviour--> +<!--TOC subsection gen_mod behaviour--> -<H3><A NAME="htoc11">5.1</A> <CODE>gen_mod</CODE> behaviour</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc13">6.1</A> gen_mod behaviour</H3><!--SEC END --> <A NAME="sec:genmod"></A> TBD<BR> <BR> -<!--TOC subsection Module <CODE>gen_iq_handler</CODE>--> +<!--TOC subsection Module gen_iq_handler--> -<H3><A NAME="htoc12">5.2</A> Module <CODE>gen_iq_handler</CODE></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc14">6.2</A> Module gen_iq_handler</H3><!--SEC END --> <A NAME="sec: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 COMPACT=compact><DT> -<CODE><B>add_iq_handler(Component, Host, NS, Module, Function, Type)</B></CODE><DD> -<PRE> +<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() Type = no_queue | one_queue | parallel @@ -275,24 +358,22 @@ Type = no_queue | one_queue | parallel 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 two components defined: - <DL COMPACT=compact><DT> - <CODE><B>ejabberd_local</B></CODE><DD> Handles packets that addressed to server JID; - <DT><CODE><B>ejabberd_sm</B></CODE><DD> Handles packets that addressed to users bare JIDs. + <DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>ejabberd_local</CODE> Handles packets that addressed to server JID; + <DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>ejabberd_sm</CODE> Handles packets that addressed to users bare JIDs. </DL> -<DT><CODE><B>remove_iq_handler(Component, Host, NS)</B></CODE><DD> -<PRE> +<DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>remove_iq_handler(Component, Host, NS)</CODE> +<PRE CLASS="verbatim"> Component = atom() Host = NS = string() </PRE>Removes IQ handler on virtual host <CODE>Host</CODE> for namespace <CODE>NS</CODE> from <CODE>Component</CODE>. </DL> Handler function must have the following type: -<DL COMPACT=compact><DT> -<CODE><B>Module:Function(From, To, IQ)</B></CODE><DD> -<PRE> +<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"><DD CLASS="dd-description"><CODE>Module:Function(From, To, IQ)</CODE> +<PRE CLASS="verbatim"> From = To = jid() </PRE></DL> -<PRE> +<PRE CLASS="verbatim"> -module(mod_cputime). -behaviour(gen_mod). @@ -330,13 +411,13 @@ process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) -> </PRE> <!--TOC subsection Services--> -<H3><A NAME="htoc13">5.3</A> Services</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc15">6.3</A> Services</H3><!--SEC END --> <A NAME="sec:services"></A> TBD<BR> <BR> TODO: use <CODE>proc_lib</CODE> -<PRE> +<PRE CLASS="verbatim"> -module(mod_echo). -behaviour(gen_mod). @@ -375,9 +456,6 @@ stop(Host) -> <!--HTMLFOOT--> <!--ENDHTML--> <!--FOOTER--> -<HR SIZE=2> -<BLOCKQUOTE><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> +<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> </HTML> diff --git a/doc/dev.tex b/doc/dev.tex index 26497a191..9aa3b820a 100644 --- a/doc/dev.tex +++ b/doc/dev.tex @@ -1,14 +1,20 @@ -\documentclass[10pt]{article} +\documentclass[a4paper,10pt]{article} +%% Packages \usepackage{graphics} \usepackage{hevea} +\usepackage{makeidx} \usepackage{verbatim} +%% Index +\makeindex +% Remove the index anchors from the HTML version to save size and bandwith. +\newcommand{\ind}[1]{\begin{latexonly}\index{#1}\end{latexonly}} +%% Images \newcommand{\logoscale}{0.7} \newcommand{\imgscale}{0.58} \newcommand{\insimg}[1]{\insscaleimg{\imgscale}{#1}} - \newcommand{\insscaleimg}[2]{ \imgsrc{#2}{} \begin{latexonly} @@ -16,83 +22,74 @@ \end{latexonly} } +%% Various \newcommand{\ns}[1]{\texttt{#1}} \newcommand{\ejabberd}{\texttt{ejabberd}} \newcommand{\Jabber}{Jabber} -\newcommand{\modregister}{\texttt{mod\_register}} -\newcommand{\modroster}{\texttt{mod\_roster}} -\newcommand{\modconfigure}{\texttt{mod\_configure}} -\newcommand{\moddisco}{\texttt{mod\_disco}} -\newcommand{\modstats}{\texttt{mod\_stats}} -\newcommand{\modvcard}{\texttt{mod\_vcard}} -\newcommand{\modoffline}{\texttt{mod\_offline}} -\newcommand{\modecho}{\texttt{mod\_echo}} -\newcommand{\modprivate}{\texttt{mod\_private}} -\newcommand{\modtime}{\texttt{mod\_time}} -\newcommand{\modversion}{\texttt{mod\_version}} - -\newcommand{\tjepref}[2]{\footahref{http://www.jabber.org/jeps/jep-#1.html}{#2}} -\newcommand{\jepref}[1]{\tjepref{#1}{JEP-#1}} -%\setcounter{tocdepth}{3} - - -\title{Ejabberd Developers Guide} +%% Modules +\newcommand{\module}[1]{\texttt{#1}} +\newcommand{\modannounce}{\module{mod\_announce}} +\newcommand{\modconfigure}{\module{mod\_configure}} +\newcommand{\moddisco}{\module{mod\_disco}} +\newcommand{\modirc}{\module{mod\_irc}} +\newcommand{\modlast}{\module{mod\_last}} +\newcommand{\modmuc}{\module{mod\_muc}} +\newcommand{\modecho}{\module{mod\_echo}} +\newcommand{\modoffline}{\module{mod\_offline}} +\newcommand{\modprivacy}{\module{mod\_privacy}} +\newcommand{\modprivate}{\module{mod\_private}} +\newcommand{\modpubsub}{\module{mod\_pubsub}} +\newcommand{\modregister}{\module{mod\_register}} +\newcommand{\modroster}{\module{mod\_roster}} +\newcommand{\modservicelog}{\module{mod\_service\_log}} +\newcommand{\modsharedroster}{\module{mod\_shared\_roster}} +\newcommand{\modstats}{\module{mod\_stats}} +\newcommand{\modtime}{\module{mod\_time}} +\newcommand{\modvcard}{\module{mod\_vcard}} +\newcommand{\modversion}{\module{mod\_version}} + +%% Title page +\include{version} +\title{Ejabberd \version\ Developers Guide} \author{Alexey Shchepin \\ \ahrefurl{mailto:alexey@sevcom.net} \\ \ahrefurl{xmpp:aleksey@jabber.ru}} -\date{August 21, 2005} + +%% Options +\newcommand{\marking}[1]{#1} % Marking disabled +\newcommand{\quoting}[2][yozhik]{} % Quotes disabled +\newcommand{\new}{\begin{latexonly}\marginpar{\textsc{new}}\end{latexonly}} % Highlight new features +\newcommand{\improved}{\begin{latexonly}\marginpar{\textsc{improved}}\end{latexonly}} % Highlight improved features +\newcommand{\moreinfo}[1]{} % Hide details + +%% Footnotes +\newcommand{\tjepref}[2]{\footahref{http://www.jabber.org/jeps/jep-#1.html}{#2}} +\newcommand{\jepref}[1]{\tjepref{#1}{JEP-#1}} \begin{document} + +\label{sec:titlepage} \begin{titlepage} \maketitle{} - - {\centering - \insscaleimg{\logoscale}{logo.png} + + \begin{center} + {\insscaleimg{\logoscale}{logo.png} \par } -\end{titlepage} -%\newpage -\tableofcontents{} - -\newpage -\section{Introduction} -\label{sec:intro} + \end{center} -\ejabberd{} is a Free and Open Source fault-tolerant distributed \Jabber{} -server. It is written mostly in Erlang. + \begin{quotation}\textit{I can thoroughly recommend ejabberd for ease of setup -- + Kevin Smith, Current maintainer of the Psi project}\end{quotation} -The main features of \ejabberd{} are: -\begin{itemize} -\item Works on most of popular platforms: *nix (tested on Linux, FreeBSD and - NetBSD) and Win32 -\item Distributed: You can run \ejabberd{} on a cluster of machines to let all of - them serve one Jabber domain. -\item Fault-tolerance: You can setup an \ejabberd{} cluster so that all the - information required for a properly working service will be stored - permanently on more than one node. This means that if one of the nodes - crashes, then the others will continue working without disruption. - You can also add or replace nodes ``on the fly''. -\item Support for virtual hosting -\item Built-in \tjepref{0045}{Multi-User Chat} service -\item Built-in IRC transport -\item Built-in \tjepref{0060}{Publish-Subscribe} service -\item Built-in Jabber Users Directory service based on users vCards -\item Built-in web-based administration interface -\item Built-in \tjepref{0025}{HTTP Polling} service -\item SSL support -\item Support for LDAP authentication -\item Ability to interface with external components (JIT, MSN-t, Yahoo-t, etc.) -\item Migration from jabberd14 is possible -\item Mostly XMPP-compliant -\item Support for \tjepref{0030}{Service Discovery}. -\item Support for \tjepref{0039}{Statistics Gathering}. -\item Support for \ns{xml:lang} -\end{itemize} +\end{titlepage} +\tableofcontents{} +% Input introduction.tex +\input{introduction} -\subsection{How it works} +\section{How it works} \label{sec:howitworks} @@ -115,7 +112,7 @@ Each \ejabberd{} node have following modules: \end{itemize} -\subsubsection{Router} +\subsection{Router} 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 @@ -126,14 +123,14 @@ process. If it does not exists in either tables, then it sent to the S2S manager. -\subsubsection{Local Router} +\subsection{Local Router} 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 session manager, else it is processed depending on it's content. -\subsubsection{Session Manager} +\subsection{Session Manager} 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 @@ -141,7 +138,7 @@ 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. -\subsubsection{S2S Manager} +\subsection{S2S Manager} 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 @@ -189,20 +186,20 @@ is represented as the following structure: \label{sec:xmlmod} \begin{description} -\item[\verb|element_to_string(El) -> string()|] +\item{\verb|element_to_string(El) -> string()|} \begin{verbatim} El = XMLElement \end{verbatim} Returns string representation of XML stanza \texttt{El}. -\item[\verb|crypt(S) -> string()|] +\item{\verb|crypt(S) -> string()|} \begin{verbatim} S = string() \end{verbatim} Returns string which correspond to \texttt{S} with encoded XML special characters. -\item[\verb|remove_cdata(ECList) -> EList|] +\item{\verb|remove_cdata(ECList) -> EList|} \begin{verbatim} ECList = [ElementOrCDATA] EList = [XMLElement] @@ -211,7 +208,7 @@ EList = [XMLElement] -\item[\verb|get_path_s(El, Path) -> Res|] +\item{\verb|get_path_s(El, Path) -> Res|} \begin{verbatim} El = XMLElement Path = [PathItem] @@ -225,15 +222,15 @@ Res = string() | XMLElement If \texttt{Path} is empty, then returns \texttt{El}. Else sequentially consider elements of \texttt{Path}. Each element is one of: \begin{description} - \item[\verb|{elem, Name}|] \texttt{Name} is name of subelement of + \item{\verb|{elem, Name}|} \texttt{Name} is name of subelement of \texttt{El}, if such element exists, then this element considered in following steps, else returns empty string. - \item[\verb|{attr, Name}|] If \texttt{El} have attribute \texttt{Name}, then + \item{\verb|{attr, Name}|} If \texttt{El} have attribute \texttt{Name}, then returns value of this attribute, else returns empty string. - \item[\verb|cdata|] Returns CDATA of \texttt{El}. + \item{\verb|cdata|} Returns CDATA of \texttt{El}. \end{description} -\item[TODO:] +\item{TODO:} \begin{verbatim} get_cdata/1, get_tag_cdata/1 get_attr/2, get_attr_s/2 @@ -247,7 +244,7 @@ Res = string() | XMLElement \label{sec:xmlstreammod} \begin{description} -\item[\verb!parse_element(Str) -> XMLElement | {error, Err}!] +\item{\verb!parse_element(Str) -> XMLElement | {error, Err}!} \begin{verbatim} Str = string() Err = term() @@ -261,12 +258,12 @@ Err = term() \label{sec:emods} -\subsection{\verb|gen_mod| behaviour} +\subsection{gen\_mod behaviour} \label{sec:genmod} TBD -\subsection{Module \verb|gen_iq_handler|} +\subsection{Module gen\_iq\_handler} \label{sec:geniqhandl} The module \verb|gen_iq_handler| allows to easily write handlers for IQ packets @@ -274,7 +271,7 @@ of particular XML namespaces that addressed to server or to users bare JIDs. In this module the following functions are defined: \begin{description} -\item[\verb|add_iq_handler(Component, Host, NS, Module, Function, Type)|] +\item{\verb|add_iq_handler(Component, Host, NS, Module, Function, Type)|} \begin{verbatim} Component = Module = Function = atom() Host = NS = string() @@ -285,10 +282,10 @@ Type = no_queue | one_queue | parallel \verb|Component|. Queueing discipline is \verb|Type|. There are at least two components defined: \begin{description} - \item[\verb|ejabberd_local|] Handles packets that addressed to server JID; - \item[\verb|ejabberd_sm|] Handles packets that addressed to users bare JIDs. + \item{\verb|ejabberd_local|} Handles packets that addressed to server JID; + \item{\verb|ejabberd_sm|} Handles packets that addressed to users bare JIDs. \end{description} -\item[\verb|remove_iq_handler(Component, Host, NS)|] +\item{\verb|remove_iq_handler(Component, Host, NS)|} \begin{verbatim} Component = atom() Host = NS = string() @@ -299,7 +296,7 @@ Host = NS = string() Handler function must have the following type: \begin{description} -\item[\verb|Module:Function(From, To, IQ)|] +\item{\verb|Module:Function(From, To, IQ)|} \begin{verbatim} From = To = jid() \end{verbatim} diff --git a/doc/guide.html b/doc/guide.html index d76c55f3f..7456d9cf0 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -140,8 +140,9 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} <A HREF="#htoc59">C.1 ejabberd 0.9</A> <LI CLASS="li-toc"><A HREF="#htoc60">C.2 ejabberd 0.9.1</A> <LI CLASS="li-toc"><A HREF="#htoc61">C.3 ejabberd 0.9.8</A> +<LI CLASS="li-toc"><A HREF="#htoc62">C.4 ejabberd 1.0.0</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc62">D Acknowledgements</A> +<LI CLASS="li-toc"><A HREF="#htoc63">D Acknowledgements</A> </UL> <!--TOC section Introduction--> @@ -2433,9 +2434,135 @@ References END </PRE> +<!--TOC subsection ejabberd 1.0.0--> + +<H3 CLASS="subsection"><A NAME="htoc62">C.4</A> ejabberd 1.0.0</H3><!--SEC END --> + +<PRE CLASS="verbatim"> + Release Notes + ejabberd 1.0.0 + 14 December 2005 + + This document describes the main changes in ejabberd 1.0.0. Unique in this + version is the compliancy with the XMPP (eXtensible Messaging and Presence + Protocol) standard. ejabberd is the first Open Source Jabber server claiming + to fully comply to the XMPP standard. + + ejabberd can be downloaded from the Process-one website: + http://www.process-one.net/en/projects/ejabberd/ + + Detailed information can be found in the ejabberd Feature Sheet and User + Guide which are available on the Process-one website: + http://www.process-one.net/en/projects/ejabberd/docs.html + + + Recent changes include: + + +Server-to-server Encryption for Enhanced Security + + - Support for STARTTLS and SASL EXTERNAL to secure server-to-server traffic + has been added. + - Also, STARTTLS and Dialback has been implemented for server-to-server (s2s) + connections. Detailed information about these new features can be found on + http://ejabberd.jabber.ru/s2s-encryption + - commonName and dNSName fields matching were introduced to ease the process + of retrieving certificates. + - Different certificates can be defined for each virtual host. + +ODBC Support + + - ODBC support has been improved to allow production use of ejabberd with + relational databases. + - Support for vCard storage in ODBC has been added. + - ejd2odbc.erl is a tool to convert an installation from Erlang's database + Mnesia to an ODBC compatible relational database. + +Native PostgreSQL Support + + - Native PostgreSQL support gives you a better performance when you use + PostgreSQL. + +Shared Roster groups + + - Shared Roster groups support has been enhanced. New is the ability to add + all registered users to everyone's roster. Detailed information about this + new feature can be found on http://ejabberd.jabber.ru/shared-roster-all + +Web Interface + + - The web interface internal code has been modified for better integration + and compliancy with J-EAI, an ejabberd-based Enterprise Application + Integration platform. + - More XHTML 1.0 Transitional compliancy work was done. + +Transports + + - A transport workaround can be enabled during compilation. To do this, you + can pass the "--enable-roster-gateway-workaround" option to the configure + script. (./configure --enable-roster-gateway-workaround) + This option allows transports to add items with subscription "to" in the + roster by sending <presence type='subscribed'/> stanza to user. This option + is only needed for JIT ICQ transport. + Warning: by enabling this option, ejabberd will not be fully XMPP compliant + anymore. + +Documentation and Internationalization + + - Documentation has been extended to cover more topics. + - Translations have been updated. + +Bugfixes + + - This release contains several bugfixes. + - Among other bugfixes include improvements to the client-to-server (c2s) + connection management module. + - Please refer to the ChangeLog file supplied + with this release regarding all improvements in ejabberd. + + + Installation Notes + + +Supported Erlang Version + + - You need at least Erlang/OTP R9C to run ejabberd 1.0.0. + +Installation + + Installers are provided for Microsoft Windows and Linux/x86. + Installers can be retrieved from: + http://www.process-one.net/en/projects/ejabberd/download.html + +Migration Notes + + - Before any migration, ejabberd system and database must be properly + backed up. + - When upgrading an ODBC-based installation, you will need to change the + relational database schema. The following SQL commands must be run on the + database: + CREATE SEQUENCE spool_seq_seq; + ALTER TABLE spool ADD COLUMN seq integer; + ALTER TABLE spool ALTER COLUMN seq SET DEFAULT nextval('spool_seq_seq'); + UPDATE spool SET seq = DEFAULT; + ALTER TABLE spool ALTER COLUMN seq SET NOT NULL; + +References + + Contributed tutorials of interest are: + - Migration from Jabberd1.4 to ejabberd: + http://ejabberd.jabber.ru/jabberd1-to-ejabberd + - Migration from Jabberd2 to ejabberd: + http://ejabberd.jabber.ru/jabberd2-to-ejabberd + - Transport configuration for connecting to other networks: + http://ejabberd.jabber.ru/tutorials-transports + +END + +</PRE> <!--TOC section Acknowledgements--> -<H2 CLASS="section"><A NAME="htoc62">D</A> Acknowledgements</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc63">D</A> Acknowledgements</H2><!--SEC END --> <A NAME="sec:acknowledgements"></A> diff --git a/doc/guide.tex b/doc/guide.tex index ca510ebe4..a8bf7357f 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -1995,6 +1995,9 @@ figure~\ref{fig:webadmmainru} with figure~\ref{fig:webadmmain}) \subsection{ejabberd 0.9.8} \verbatiminput{release_notes_0.9.8.txt} +\subsection{ejabberd 1.0.0} +\verbatiminput{release_notes_1.0.0.txt} + \section{Acknowledgements} \label{sec:acknowledgements} |