Chapril/xmpp.chapril.org-ejabberd
25
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-11-24 16:23:40 +01:00
Code Releases Activity

* doc/guide.tex: Large improvements for ejabberd 1.1.2 (thanks to Sander

Browse Source 
Devrieze)
* doc/version.tex: Likewise.
* doc/features.tex: Likewise.
* doc/Makefile: Likewise.
* doc/dev.tex: Likewise.

SVN Revision: 617
This commit is contained in:
Mickaël Rémond 2006-09-22 09:09:28 +00:00
parent da53c02892
commit b7fc7fdada
9 changed files with 3400 additions and 2614 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
2006-09-22 Mickael Remond <mickael.remond@process-one.net>
* doc/guide.tex: Large improvements (thanks to Sander Devrieze)
2006-09-14 Mickael Remond <mickael.remond@process-one.net> 2006-09-14 Mickael Remond <mickael.remond@process-one.net>
* doc/guide.tex: Minor fix on index generation. * doc/guide.tex: Minor fix on index generation.

9
doc/Makefile
View File

@ -27,16 +27,13 @@ clean:
rm -f *.toc rm -f *.toc
guide.html: guide.tex guide.html: guide.tex
hevea guide.tex hevea -fix -noiso -pedantic guide.tex
hevea guide.tex
dev.html: dev.tex dev.html: dev.tex
hevea dev.tex hevea -fix -noiso -pedantic dev.tex
hevea dev.tex
features.html: features.tex features.html: features.tex
hevea features.tex hevea -fix -noiso -pedantic features.tex
hevea features.tex
guide.pdf: guide.tex guide.pdf: guide.tex
pdflatex guide.tex pdflatex guide.tex

73
doc/dev.html
View File

@ -4,7 +4,7 @@
<HEAD> <HEAD>
<TITLE>Ejabberd 1.1.1 Developers Guide</TITLE> <TITLE>Ejabberd 1.1.2 Developers Guide</TITLE>
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<META name="GENERATOR" content="hevea 1.08"> <META name="GENERATOR" content="hevea 1.08">
@ -22,7 +22,7 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
</HEAD> </HEAD>
<BODY > <BODY >
<!--HEVEA command line is: hevea dev.tex --> <!--HEVEA command line is: hevea -fix -noiso -pedantic dev.tex -->
<!--HTMLHEAD--> <!--HTMLHEAD-->
<!--ENDHTML--> <!--ENDHTML-->
<!--PREFIX <ARG ></ARG>--> <!--PREFIX <ARG ></ARG>-->
@ -34,7 +34,7 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
<TABLE CLASS="title"> <TABLE CLASS="title">
<TR><TD> <TR><TD>
<H1 CLASS="titlemain">Ejabberd 1.1.1 Developers Guide</H1> <H1 CLASS="titlemain">Ejabberd 1.1.2 Developers Guide</H1>
<H3 CLASS="titlerest">Alexey Shchepin<BR> <H3 CLASS="titlerest">Alexey Shchepin<BR>
<A HREF="mailto:alexey@sevcom.net"><TT>mailto:alexey@sevcom.net</TT></A><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> <A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A></H3></TD>
@ -42,7 +42,7 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
<BR> <BR>
<DIV CLASS="center"> <DIV CLASS="center">
<IMG SRC="logo.png"> <IMG SRC="logo.png" ALT="logo.png">
<BR> <BR>
@ -61,49 +61,50 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;}
<A HREF="#htoc2">1.1&nbsp;&nbsp;Key Features</A> <A HREF="#htoc2">1.1&nbsp;&nbsp;Key Features</A>
<LI CLASS="li-toc"><A HREF="#htoc3">1.2&nbsp;&nbsp;Additional Features</A> <LI CLASS="li-toc"><A HREF="#htoc3">1.2&nbsp;&nbsp;Additional Features</A>
</UL> </UL>
<LI CLASS="li-toc"><A HREF="#htoc4">2&nbsp;&nbsp;How it works</A> <LI CLASS="li-toc"><A HREF="#htoc4">2&nbsp;&nbsp;How it Works</A>
<UL CLASS="toc"><LI CLASS="li-toc"> <UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc5">2.1&nbsp;&nbsp;Router</A> <A HREF="#htoc5">2.1&nbsp;&nbsp;Router</A>
<LI CLASS="li-toc"><A HREF="#htoc6">2.2&nbsp;&nbsp;Local Router</A> <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="#htoc7">2.3&nbsp;&nbsp;Session Manager</A>
<LI CLASS="li-toc"><A HREF="#htoc8">2.4&nbsp;&nbsp;S2S Manager</A> <LI CLASS="li-toc"><A HREF="#htoc8">2.4&nbsp;&nbsp;S2S Manager</A>
</UL> </UL>
<LI CLASS="li-toc"><A HREF="#htoc9">3&nbsp;&nbsp;XML representation</A> <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="#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="#htoc11">5&nbsp;&nbsp;Module <TT>xml_stream</TT></A>
<LI CLASS="li-toc"><A HREF="#htoc12">6&nbsp;&nbsp;<TT>ejabberd</TT> modules</A> <LI CLASS="li-toc"><A HREF="#htoc12">6&nbsp;&nbsp;Modules</A>
<UL CLASS="toc"><LI CLASS="li-toc"> <UL CLASS="toc"><LI CLASS="li-toc">
<A HREF="#htoc13">6.1&nbsp;&nbsp;gen_mod behaviour</A> <A HREF="#htoc13">6.1&nbsp;&nbsp;Module gen_iq_handler</A>
<LI CLASS="li-toc"><A HREF="#htoc14">6.2&nbsp;&nbsp;Module gen_iq_handler</A> <LI CLASS="li-toc"><A HREF="#htoc14">6.2&nbsp;&nbsp;Services</A>
<LI CLASS="li-toc"><A HREF="#htoc15">6.3&nbsp;&nbsp;Services</A>
</UL> </UL>
</UL> </UL>
<!--TOC section Introduction--> <!--TOC section Introduction-->
<H2 CLASS="section"><A NAME="htoc1">1</A>&nbsp;&nbsp;Introduction</H2><!--SEC END --> <H2 CLASS="section"><A NAME="htoc1">1</A>&nbsp;&nbsp;<A NAME="intro">Introduction</A></H2><!--SEC END -->
<A NAME="sec:intr"></A> <A NAME="sec:intro"></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> <TT>ejabberd</TT> is a free and open source instant messaging server written in <A HREF="http://www.erlang.org/">Erlang</A>.<BR>
<BR> <BR>
<TT>ejabberd</TT> is designed to be a stable, standards compliant, and feature rich Jabber/XMPP server.<BR> <TT>ejabberd</TT> is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.<BR>
<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> <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> <BR>
<!--TOC subsection Key Features--> <!--TOC subsection Key Features-->
<H3 CLASS="subsection"><A NAME="htoc2">1.1</A>&nbsp;&nbsp;Key Features</H3><!--SEC END --> <H3 CLASS="subsection"><A NAME="htoc2">1.1</A>&nbsp;&nbsp;<A NAME="keyfeatures">Key Features</A></H3><!--SEC END -->
<A NAME="sec:keyfeatures"></A> <A NAME="sec:keyfeatures"></A>
<TT>ejabberd</TT> is: <TT>ejabberd</TT> is:
<UL CLASS="itemize"><LI CLASS="li-itemize"> <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> Cross-platform: <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.<BR>
<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> <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> <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 &#8220;on the fly&#8221;.<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> <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: <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">
@ -124,17 +125,17 @@ Translated in 11 languages.
<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. <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 CLASS="li-itemize">XML-based protocol.
<LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many JEPs supported</A>. <LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many JEPs supported</A>.
</UL></UL> </UL></UL>
<!--TOC subsection Additional Features--> <!--TOC subsection Additional Features-->
<H3 CLASS="subsection"><A NAME="htoc3">1.2</A>&nbsp;&nbsp;Additional Features</H3><!--SEC END --> <H3 CLASS="subsection"><A NAME="htoc3">1.2</A>&nbsp;&nbsp;<A NAME="addfeatures">Additional Features</A></H3><!--SEC END -->
<A NAME="sec:addfeatures"></A> <A NAME="sec:addfeatures"></A>
Besides common Jabber server features, <TT>ejabberd</TT> comes with a wide range of other features: Moreover, <TT>ejabberd</TT> comes with a wide range of other state-of-the-art features:
<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">
@ -153,7 +154,7 @@ Native MySQL support.
<LI CLASS="li-itemize">Native PostgreSQL support. <LI CLASS="li-itemize">Native PostgreSQL support.
<LI CLASS="li-itemize">Mnesia. <LI CLASS="li-itemize">Mnesia.
<LI CLASS="li-itemize">ODBC data storage support. <LI CLASS="li-itemize">ODBC data storage support.
<LI CLASS="li-itemize">Microsoft SQL Server support (via ODBC). <LI CLASS="li-itemize">Microsoft SQL Server support.
</UL> </UL>
<LI CLASS="li-itemize">Authentication <LI CLASS="li-itemize">Authentication
<UL CLASS="itemize"><LI CLASS="li-itemize"> <UL CLASS="itemize"><LI CLASS="li-itemize">
@ -175,9 +176,9 @@ Compressing XML streams with Stream Compression (<A HREF="http://www.jabber.org/
<LI CLASS="li-itemize">IRC transport. <LI CLASS="li-itemize">IRC transport.
</UL> </UL>
</UL> </UL>
<!--TOC section How it works--> <!--TOC section How it Works-->
<H2 CLASS="section"><A NAME="htoc4">2</A>&nbsp;&nbsp;How it works</H2><!--SEC END --> <H2 CLASS="section"><A NAME="htoc4">2</A>&nbsp;&nbsp;How it Works</H2><!--SEC END -->
<A NAME="sec:howitworks"></A> <A NAME="sec:howitworks"></A>
A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
@ -235,9 +236,9 @@ 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.<BR>
<BR> <BR>
<!--TOC section XML representation--> <!--TOC section XML Representation-->
<H2 CLASS="section"><A NAME="htoc9">3</A>&nbsp;&nbsp;XML representation</H2><!--SEC END --> <H2 CLASS="section"><A NAME="htoc9">3</A>&nbsp;&nbsp;XML Representation</H2><!--SEC END -->
<A NAME="sec:xmlrepr"></A> <A NAME="sec:xmlrepr"></A>
Each XML stanza is represented as the following tuple: Each XML stanza is represented as the following tuple:
@ -325,21 +326,14 @@ 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> </DL>
<!--TOC section <TT>ejabberd</TT> modules--> <!--TOC section Modules-->
<H2 CLASS="section"><A NAME="htoc12">6</A>&nbsp;&nbsp;<TT>ejabberd</TT> modules</H2><!--SEC END --> <H2 CLASS="section"><A NAME="htoc12">6</A>&nbsp;&nbsp;Modules</H2><!--SEC END -->
<A NAME="sec:emods"></A> <A NAME="sec:emods"></A>
<!--TOC subsection gen_mod behaviour-->
<H3 CLASS="subsection"><A NAME="htoc13">6.1</A>&nbsp;&nbsp;gen_mod behaviour</H3><!--SEC END -->
<A NAME="sec:genmod"></A>
TBD<BR>
<BR>
<!--TOC subsection Module gen_iq_handler--> <!--TOC subsection Module gen_iq_handler-->
<H3 CLASS="subsection"><A NAME="htoc14">6.2</A>&nbsp;&nbsp;Module gen_iq_handler</H3><!--SEC END --> <H3 CLASS="subsection"><A NAME="htoc13">6.1</A>&nbsp;&nbsp;Module gen_iq_handler</H3><!--SEC END -->
<A NAME="sec:geniqhandl"></A> <A NAME="sec:geniqhandl"></A>
The module <CODE>gen_iq_handler</CODE> allows to easily write handlers for IQ packets The module <CODE>gen_iq_handler</CODE> allows to easily write handlers for IQ packets
@ -408,12 +402,9 @@ process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) -&gt;
</PRE> </PRE>
<!--TOC subsection Services--> <!--TOC subsection Services-->
<H3 CLASS="subsection"><A NAME="htoc15">6.3</A>&nbsp;&nbsp;Services</H3><!--SEC END --> <H3 CLASS="subsection"><A NAME="htoc14">6.2</A>&nbsp;&nbsp;Services</H3><!--SEC END -->
<A NAME="sec:services"></A> <A NAME="sec:services"></A>
TBD<BR>
<BR>
TODO: use <CODE>proc_lib</CODE>
<PRE CLASS="verbatim"> <PRE CLASS="verbatim">
-module(mod_echo). -module(mod_echo).

25
doc/dev.tex
View File

@ -29,24 +29,31 @@
%% Modules %% Modules
\newcommand{\module}[1]{\texttt{#1}} \newcommand{\module}[1]{\texttt{#1}}
\newcommand{\modadhoc}{\module{mod\_adhoc}}
\newcommand{\modannounce}{\module{mod\_announce}} \newcommand{\modannounce}{\module{mod\_announce}}
\newcommand{\modconfigure}{\module{mod\_configure}} \newcommand{\modconfigure}{\module{mod\_configure}}
\newcommand{\moddisco}{\module{mod\_disco}} \newcommand{\moddisco}{\module{mod\_disco}}
\newcommand{\modecho}{\module{mod\_echo}}
\newcommand{\modirc}{\module{mod\_irc}} \newcommand{\modirc}{\module{mod\_irc}}
\newcommand{\modlast}{\module{mod\_last}} \newcommand{\modlast}{\module{mod\_last}}
\newcommand{\modlastodbc}{\module{mod\_last\_odbc}}
\newcommand{\modmuc}{\module{mod\_muc}} \newcommand{\modmuc}{\module{mod\_muc}}
\newcommand{\modecho}{\module{mod\_echo}} \newcommand{\modmuclog}{\module{mod\_muc\_log}}
\newcommand{\modoffline}{\module{mod\_offline}} \newcommand{\modoffline}{\module{mod\_offline}}
\newcommand{\modofflineodbc}{\module{mod\_offline\_odbc}}
\newcommand{\modprivacy}{\module{mod\_privacy}} \newcommand{\modprivacy}{\module{mod\_privacy}}
\newcommand{\modprivate}{\module{mod\_private}} \newcommand{\modprivate}{\module{mod\_private}}
\newcommand{\modpubsub}{\module{mod\_pubsub}} \newcommand{\modpubsub}{\module{mod\_pubsub}}
\newcommand{\modregister}{\module{mod\_register}} \newcommand{\modregister}{\module{mod\_register}}
\newcommand{\modroster}{\module{mod\_roster}} \newcommand{\modroster}{\module{mod\_roster}}
\newcommand{\modrosterodbc}{\module{mod\_roster\_odbc}}
\newcommand{\modservicelog}{\module{mod\_service\_log}} \newcommand{\modservicelog}{\module{mod\_service\_log}}
\newcommand{\modsharedroster}{\module{mod\_shared\_roster}} \newcommand{\modsharedroster}{\module{mod\_shared\_roster}}
\newcommand{\modstats}{\module{mod\_stats}} \newcommand{\modstats}{\module{mod\_stats}}
\newcommand{\modtime}{\module{mod\_time}} \newcommand{\modtime}{\module{mod\_time}}
\newcommand{\modvcard}{\module{mod\_vcard}} \newcommand{\modvcard}{\module{mod\_vcard}}
\newcommand{\modvcardldap}{\module{mod\_vcard\_ldap}}
\newcommand{\modvcardodbc}{\module{mod\_vcard\_odbc}}
\newcommand{\modversion}{\module{mod\_version}} \newcommand{\modversion}{\module{mod\_version}}
%% Title page %% Title page
@ -89,7 +96,7 @@
% Input introduction.tex % Input introduction.tex
\input{introduction} \input{introduction}
\section{How it works} \section{How it Works}
\label{sec:howitworks} \label{sec:howitworks}
@ -150,7 +157,7 @@ does not exist, then it is opened and registered.
\section{XML representation} \section{XML Representation}
\label{sec:xmlrepr} \label{sec:xmlrepr}
Each XML stanza is represented as the following tuple: Each XML stanza is represented as the following tuple:
@ -254,14 +261,14 @@ Err = term()
\end{description} \end{description}
\section{\ejabberd{} modules} \section{Modules}
\label{sec:emods} \label{sec:emods}
\subsection{gen\_mod behaviour} %\subsection{gen\_mod behaviour}
\label{sec:genmod} %\label{sec:genmod}
TBD %TBD
\subsection{Module gen\_iq\_handler} \subsection{Module gen\_iq\_handler}
\label{sec:geniqhandl} \label{sec:geniqhandl}
@ -345,10 +352,10 @@ process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) ->
\subsection{Services} \subsection{Services}
\label{sec:services} \label{sec:services}
TBD %TBD
TODO: use \verb|proc_lib| %TODO: use \verb|proc_lib|
\begin{verbatim} \begin{verbatim}
-module(mod_echo). -module(mod_echo).

18
doc/features.tex
View File

@ -9,7 +9,7 @@
Feature\ Sheet,pdfauthor=Sander\ Feature\ Sheet,pdfauthor=Sander\
Devrieze,pdfsubject=ejabberd,pdfkeywords=ejabberd]{hyperref} Devrieze,pdfsubject=ejabberd,pdfkeywords=ejabberd]{hyperref}
\usepackage{verbatim} \usepackage{verbatim}
\usepackage{xcolor} \usepackage{color}
%% Index %% Index
% Remove the index anchors from the HTML version to save size and bandwith. % Remove the index anchors from the HTML version to save size and bandwith.
@ -49,11 +49,14 @@
% Options % Options
\newcommand{\marking}[1]{\textbf{\begin{large}\textcolor{ejblue}{#1}\end{large}}} % Marking enabled \newcommand{\marking}[1]{\textbf{\begin{large}\textcolor{ejblue}{#1}\end{large}}} % Marking enabled
\newcommand{\quoting}[2][yozhik]{\begin{quotation}\textcolor{#1}{\textit{#2}}\end{quotation}} % Quotes enabled \newcommand{\quoting}[2][yozhik]{\begin{quotation}\textcolor{#1}{\textit{#2}}\end{quotation}} % Quotes enabled
\newcommand{\new}{\begin{latexonly}\marginpar{\textcolor{red}{\textsc{new}}}\end{latexonly}} % Highlight new features \newcommand{\new}{\marginpar{\textcolor{red}{\textsc{new}}}} % Highlight new features
\newcommand{\improved}{\begin{latexonly}\marginpar{\textcolor{orange}{\textsc{improved}}}\end{latexonly}} % Highlight improved features \newcommand{\improved}{\marginpar{\textcolor{orange}{\textsc{improved}}}} % Highlight improved features
\newcommand{\moreinfo}[1]{} % Hide details
\setcounter{secnumdepth}{-1} % Disable section numbering \setcounter{secnumdepth}{-1} % Disable section numbering
%% To by-pass errors in the HTML version.
\newstyle{SPAN}{width:20\%; float:right; text-align:left; margin-left:auto;}
\definecolor{orange} {cmyk}{0.000,0.333,1.000,0.000}
%% Footnotes %% Footnotes
\begin{latexonly} \begin{latexonly}
\global\parskip=9pt plus 3pt minus 1pt \global\parskip=9pt plus 3pt minus 1pt
@ -67,7 +70,7 @@
%% Fancy header %% Fancy header
\fancyhf{} \fancyhf{}
\pagestyle{fancy} \pagestyle{fancy}
\rhead{\textcolor{ejblue}{The expandable Jabber daemon.}} \rhead{\textcolor{ejblue}{The Expandable Jabber Daemon.}}
\renewcommand{\headrule}{{\color{ejblue}% \renewcommand{\headrule}{{\color{ejblue}%
\hrule width\headwidth height\headrulewidth \vskip-\headrulewidth}} \hrule width\headwidth height\headrulewidth \vskip-\headrulewidth}}
\lhead{\setlength{\unitlength}{-6mm} \lhead{\setlength{\unitlength}{-6mm}
@ -85,7 +88,7 @@
\begin{document} \begin{document}
\label{sec:titlepage} \label{titlepage}
\begin{titlepage} \begin{titlepage}
\maketitle{} \maketitle{}
@ -107,9 +110,8 @@
% the same identifier". % the same identifier".
\begin{latexonly} \begin{latexonly}
\setcounter{page}{2} \setcounter{page}{2}
\end{latexonly}
\pagecolor{ejgreenwhite} \pagecolor{ejgreenwhite}
\end{latexonly}
% Input introduction.tex % Input introduction.tex
\input{introduction} \input{introduction}

3018
doc/guide.html
View File

File diff suppressed because it is too large Load Diff

2684
doc/guide.tex
View File

File diff suppressed because it is too large Load Diff

75
doc/introduction.tex
View File

@ -1,25 +1,31 @@
\section{Introduction} \section{\aname{intro}{Introduction}}
\label{sec:intr} \label{sec:intro}
\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}
\ejabberd{} is a free (GPL) distributed fault-tolerant \Jabber{}/XMPP server and is mainly written in \footahref{http://www.erlang.org/}{Erlang}. %ejabberd is a free and open source instant messaging server written in Erlang. ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication (Jabber/XMPP).
\ejabberd{} is designed to be a \marking{stable}, \marking{standards compliant}, and \marking{\mbox{feature rich}} \Jabber{}/XMPP server. \ejabberd{} is a \marking{free and open source} instant messaging server written in \footahref{http://www.erlang.org/}{Erlang}.
\ejabberd{} is suitable for small servers, whether they need to be scalable or not, as well as extremely big servers. \ejabberd{} is \marking{cross-platform}, distributed, fault-tolerant, and based on open standards to achieve real-time communication.
%\subsection{Layout with example deployment (title needs a better name)} \ejabberd{} is designed to be a \marking{rock-solid and feature rich} XMPP server.
\ejabberd{} is suitable for small deployments, whether they need to be \marking{scalable} or not, as well as extremely big deployments.
%\subsection{\aname{layout}{Layout with example deployment (title needs a better name)}}
%\label{sec:layout}
%In this section there will be a graphical overview like these:\\ %In this section there will be a graphical overview like these:\\
%\verb|http://www.tipic.com/var/timp/timp_dep.gif| \\ %\verb|http://www.tipic.com/var/timp/timp_dep.gif| \\
%\verb|http://www.jabber.com/images/jabber_Com_Platform.jpg| \\ %\verb|http://www.jabber.com/images/jabber_Com_Platform.jpg| \\
%\verb|http://www.antepo.com/files/OPN45systemdatasheet.pdf| \\ %\verb|http://www.antepo.com/files/OPN45systemdatasheet.pdf| \\
%Some small images of Jabber clients that are known to work greatly with ejabberd. Less text!!! %A page full with names of Jabber client that are known to work with ejabberd. \begin{tiny}tiny font\end{tiny}
%\subsection{Try It Today} %\subsection{\aname{trytoday}{Try It Today}}
%\label{sec:trytoday}
%(Not sure if I will include/finish this section for the next version.) %(Not sure if I will include/finish this section for the next version.)
@ -32,42 +38,42 @@ Joeri}
%\end{itemize} %\end{itemize}
\newpage \newpage
\subsection{Key Features} \subsection{\aname{keyfeatures}{Key Features}}
\label{sec:keyfeatures} \label{sec:keyfeatures}
\ind{features!key features} \ind{features!key features}
\quoting{Erlang seems to be tailor-made for writing stable, robust servers. -- \quoting{Erlang seems to be tailor-made for writing stable, robust servers. ---
Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation} Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
\ejabberd{} is: \ejabberd{} is:
\begin{itemize} \begin{itemize}
\item \marking{Multiplatform:} \ejabberd{} runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD. \item \marking{Cross-platform:} \ejabberd{} runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
\item \marking{Distributed:} You can run \ejabberd{} 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. \item \marking{Distributed:} You can run \ejabberd{} 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.
\item \marking{Fault-tolerant:} You can deploy an \ejabberd{} 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''. \item \marking{Fault-tolerant:} You can deploy an \ejabberd{} 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'.
\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.\moreinfo{ --- You can start in the \footahref{http://ejabberd.jabber.ru/book}{ejabberd Book}.} \item Comprehensive documentation.
\item Straightforward installers for Linux, Mac OS X, and Windows.\improved{}\moreinfo{ --- (\footahref{http://ejabberd.jabber.ru/screenshots-linux-installer}{Screenshots}).} \item Straightforward installers for Linux, Mac OS X, and Windows.\improved{}
\item Web interface for administration tasks.\moreinfo{ --- With HTTPS secure access. \footahref{http://ejabberd.jabber.ru/online-demo-webadmin}{Demo}.} \item Web interface for administration tasks.
\item Shared Roster Groups.\moreinfo{ --- The administrator can setup a common list of \Jabber{} users for all users on the server. Those users are virtually added to all rosters. They cannot be removed, but can be renamed or moved into different roster groups. Does not require client implementation. Not related to \jepref{0144} (Roster Item Exchange).\footahref{http://ejabberd.jabber.ru/screenshots-shared-roster-groups}{Screenshots})} \item Shared Roster Groups.
\item Command line administration tool.\improved{}\moreinfo{ --- Some basic administration tasks can be acomplished using the command line: register/remove users, backup/restore database, amongst others (\footahref{http://ejabberd.jabber.ru/screenshots-administration#ejabberdctl}{Screenshots}).} \item Command line administration tool.
\item Can integrate with existing authentication mechanisms. \item Can integrate with existing authentication mechanisms.
\item Capability to send announce messages.\improved{} \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 11 languages.\moreinfo{ --- More information is available \footahref{http://ejabberd.jabber.ru/localization}{here}.} \item Translated in 11 languages.
\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}
\item \marking{Open Standards:} \ejabberd{} is the first Open Source Jabber server claiming to fully comply to the XMPP standard. \item \marking{Open Standards:} \ejabberd{} is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
\begin{itemize} \begin{itemize}
\item Fully XMPP compliant \moreinfo{ --- ejabberd is fully compliant with XMPP Core 1.0 and XMPP IM 1.0. Check the \footahref{http://ejabberd.jabber.ru/protocols}{supported protocols}.} \item Fully XMPP compliant.
\item XML-based protocol \item XML-based protocol.
\item \footahref{http://ejabberd.jabber.ru/protocols}{Many JEPs supported}. \item \footahref{http://ejabberd.jabber.ru/protocols}{Many JEPs supported}.
\end{itemize} \end{itemize}
@ -75,52 +81,51 @@ Peter Saint-Andr\'e, Executive Director of the Jabber Software Foundation}
\newpage \newpage
\subsection{Additional Features} \subsection{\aname{addfeatures}{Additional Features}}
\label{sec:addfeatures} \label{sec:addfeatures}
\ind{features!additional features} \ind{features!additional features}
\quoting{ejabberd is making inroads to solving the "buggy incomplete server" problem -- \quoting{ejabberd is making inroads to solving the "buggy incomplete server" problem ---
Justin Karneges, Founder of the Psi and the Delta projects} Justin Karneges, Founder of the Psi and the Delta projects}
Besides common \Jabber{} server features, \ejabberd{} comes with a wide range of other features: Moreover, \ejabberd{} comes with a wide range of other state-of-the-art features:
\begin{itemize} \begin{itemize}
\item Modular \item Modular
\begin{itemize} \begin{itemize}
\item Load only the modules you want. \item Load only the modules you want.
\item Extend \ejabberd{} with your own custom modules.\moreinfo{ --- A list of contributed modules and patches is available on the \footahref{http://ejabberd.jabber.ru/contributions}{contributions page}.} \item Extend \ejabberd{} with your own custom modules.
\end{itemize} \end{itemize}
\item Security \item Security
\begin{itemize} \begin{itemize}
\item SASL and STARTTLS for c2s and s2s connections.\improved{} \item SASL and STARTTLS for c2s and s2s connections.
\item STARTTLS and Dialback s2s connections. \item STARTTLS and Dialback s2s connections.
\item Web interface accessible via HTTPS secure access. \item Web interface accessible via HTTPS secure access.
\end{itemize} \end{itemize}
\item Databases \item Databases
\begin{itemize} \begin{itemize}
\item Native MySQL support.\new{} \item Native MySQL support.
\item Native PostgreSQL support. \item Native PostgreSQL support.
\item Mnesia. \item Mnesia.
\item ODBC data storage support. \moreinfo{ --- ODBC requests can be load \item ODBC data storage support.
balanced between several connections.} \item Microsoft SQL Server support.\new{}
\item Microsoft SQL Server support (via ODBC).\new{}
\end{itemize} \end{itemize}
\item Authentication \item Authentication
\begin{itemize} \begin{itemize}
\item LDAP and ODBC. \moreinfo{ --- Accounts can authenticate in a LDAP server.} \item LDAP and ODBC.
\item External Authentication script. \item External Authentication script.
\item Internal Authentication. \item Internal Authentication.
\end{itemize} \end{itemize}
\item Others \item Others
\begin{itemize} \begin{itemize}
\item Compressing XML streams with Stream Compression (\jepref{0138}).\new{} \item Compressing XML streams with Stream Compression (\jepref{0138}).
\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 (\jepref{0039}). \item Statistics via Statistics Gathering (\jepref{0039}).
\item IPv6 support both for c2s and s2s connections. \item IPv6 support both for c2s and s2s connections.
\item \tjepref{0045}{Multi-User Chat} module with logging.\improved{} \item \tjepref{0045}{Multi-User Chat} module with logging.\improved{}
\item Users Directory based on users vCards. \item Users Directory based on users vCards.
\item \tjepref{0060}{Publish-Subscribe} component. \item \tjepref{0060}{Publish-Subscribe} component.
\item Support for virtual hosting. \moreinfo{ --- Several \Jabber{} hosts can be hosted on the same \ejabberd{} instance. As simple as adding a new domain name to the list of hosts in the configuration file.} \item Support for virtual hosting.
\item \tjepref{0025}{HTTP Polling} service. \item \tjepref{0025}{HTTP Polling} service.
\item IRC transport.\improved{} \item IRC transport.
\end{itemize} \end{itemize}
\end{itemize} \end{itemize}

2
doc/version.tex
View File

@ -1,2 +1,2 @@
% Define ejabberd version here. % Define ejabberd version here.
\newcommand{\version}{1.1.1} \newcommand{\version}{1.1.2}