mirror of
https://github.com/processone/ejabberd.git
synced 2024-07-19 00:11:01 +02:00
Merge branch '2.2.x' of gitorious.process-one.net:+ejabberd-developers/ejabberd/maincustomers into 2.2.x
This commit is contained in:
Eric Cestari
commit
b0c79c57b0
413
doc/dev.html
413
doc/dev.html
|
|
@ -1,413 +0,0 @@
|
||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
|
|
||||||
"http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
||||||
<HTML>
|
|
||||||
<HEAD>
|
|
||||||
<TITLE>Ejabberd 2.1.x Developers Guide
|
|
||||||
</TITLE>
|
|
||||||
|
|
||||||
<META http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
||||||
<META name="GENERATOR" content="hevea 1.10">
|
|
||||||
<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;}
|
|
||||||
.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:2ex 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;}
|
|
||||||
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:2ex auto;text-align:center}
|
|
||||||
</STYLE>
|
|
||||||
</HEAD>
|
|
||||||
<BODY >
|
|
||||||
<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic dev.tex -->
|
|
||||||
<!--CUT DEF section 1 --><P><A NAME="titlepage"></A>
|
|
||||||
|
|
||||||
</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 2.1.x 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><DIV CLASS="center">
|
|
||||||
|
|
||||||
<IMG SRC="logo.png" ALT="logo.png">
|
|
||||||
|
|
||||||
|
|
||||||
</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-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR -->Contents</H2><!--SEC END --><UL CLASS="toc"><LI CLASS="li-toc">
|
|
||||||
<A HREF="#htoc1">1  Key Features</A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc2">2  Additional Features</A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc3">3  How it Works</A>
|
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
|
||||||
<A HREF="#htoc4">3.1  Router</A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc5">3.2  Local Router</A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc6">3.3  Session Manager</A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc7">3.4  S2S Manager</A>
|
|
||||||
</LI></UL>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc8">4  Authentication</A>
|
|
||||||
<UL CLASS="toc">
|
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
|
||||||
<A HREF="#htoc9">4.0.1  External</A>
|
|
||||||
</LI></UL>
|
|
||||||
</UL>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc10">5  XML Representation</A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc11">6  Module <TT>xml</TT></A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc12">7  Module <TT>xml_stream</TT></A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc13">8  Modules</A>
|
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
|
||||||
<A HREF="#htoc14">8.1  Module gen_iq_handler</A>
|
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc15">8.2  Services</A>
|
|
||||||
</LI></UL>
|
|
||||||
</LI></UL><P>Introduction
|
|
||||||
<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/OTP</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-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc1">1</A>  Key Features</H2><!--SEC END --><P>
|
|
||||||
<A NAME="keyfeatures"></A>
|
|
||||||
</P><P><TT>ejabberd</TT> is:
|
|
||||||
</P><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:
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Comprehensive documentation.
|
|
||||||
</LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Web Administration.
|
|
||||||
</LI><LI CLASS="li-itemize">Shared Roster Groups.
|
|
||||||
</LI><LI CLASS="li-itemize">Command line administration tool. </LI><LI CLASS="li-itemize">Can integrate with existing authentication mechanisms.
|
|
||||||
</LI><LI CLASS="li-itemize">Capability to send announce messages.
|
|
||||||
</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:
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Translated to 25 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
|
|
||||||
</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.
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Fully XMPP compliant.
|
|
||||||
</LI><LI CLASS="li-itemize">XML-based protocol.
|
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.ejabberd.im/protocols">Many protocols supported</A>.
|
|
||||||
</LI></UL></LI></UL><!--TOC section Additional Features-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2">2</A>  Additional Features</H2><!--SEC END --><P>
|
|
||||||
<A NAME="addfeatures"></A>
|
|
||||||
</P><P>Moreover, <TT>ejabberd</TT> comes with a wide range of other state-of-the-art features:
|
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Modular
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Load only the modules you want.
|
|
||||||
</LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules.
|
|
||||||
</LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">Security
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
SASL and STARTTLS for c2s and s2s connections.
|
|
||||||
</LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections.
|
|
||||||
</LI><LI CLASS="li-itemize">Web Admin accessible via HTTPS secure access.
|
|
||||||
</LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">Databases
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Internal database for fast deployment (Mnesia).
|
|
||||||
</LI><LI CLASS="li-itemize">Native MySQL support.
|
|
||||||
</LI><LI CLASS="li-itemize">Native PostgreSQL support.
|
|
||||||
</LI><LI CLASS="li-itemize">ODBC data storage support.
|
|
||||||
</LI><LI CLASS="li-itemize">Microsoft SQL Server support. </LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">Authentication
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Internal Authentication.
|
|
||||||
</LI><LI CLASS="li-itemize">PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script.
|
|
||||||
</LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">Others
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Support for virtual hosting.
|
|
||||||
</LI><LI CLASS="li-itemize">Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
|
|
||||||
</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>).
|
|
||||||
</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections.
|
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
|
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
|
|
||||||
</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
|
|
||||||
</LI><LI CLASS="li-itemize">IRC transport.
|
|
||||||
</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
|
|
||||||
</LI></UL>
|
|
||||||
</LI></UL><!--TOC section How it Works-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc3">3</A>  How it Works</H2><!--SEC END --><P>
|
|
||||||
<A NAME="howitworks"></A></P><P>A XMPP 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
|
|
||||||
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
|
|
||||||
<TT>~ejabberd/.erlang.cookie</TT> must be the same on all nodes). This is
|
|
||||||
needed because all nodes exchange information about connected users, S2S
|
|
||||||
connections, registered services, etc…</P><P>Each <TT>ejabberd</TT> node have following modules:
|
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
router;
|
|
||||||
</LI><LI CLASS="li-itemize">local router.
|
|
||||||
</LI><LI CLASS="li-itemize">session manager;
|
|
||||||
</LI><LI CLASS="li-itemize">S2S manager;
|
|
||||||
</LI></UL><!--TOC subsection Router-->
|
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc4">3.1</A>  Router</H3><!--SEC END --><P>This module is the main router of XMPP packets on each node. It routes
|
|
||||||
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
|
|
||||||
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
|
|
||||||
process. If it does not exists in either tables, then it sent to the S2S
|
|
||||||
manager.</P><!--TOC subsection Local Router-->
|
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc5">3.2</A>  Local Router</H3><!--SEC END --><P>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.</P><!--TOC subsection Session Manager-->
|
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc6">3.3</A>  Session Manager</H3><!--SEC END --><P>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.</P><!--TOC subsection S2S Manager-->
|
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc7">3.4</A>  S2S Manager</H3><!--SEC END --><P>This module routes packets to other XMPP servers. First, it checks if an
|
|
||||||
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
|
|
||||||
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
|
|
||||||
does not exist, then it is opened and registered.</P><!--TOC section Authentication-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc8">4</A>  Authentication</H2><!--SEC END --><!--TOC subsubsection External-->
|
|
||||||
<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A NAME="htoc9">4.0.1</A>  External</H4><!--SEC END --><P>
|
|
||||||
<A NAME="externalauth"></A>
|
|
||||||
</P><P>The external authentication script follows
|
|
||||||
<A HREF="http://www.erlang.org/doc/tutorial/c_portdriver.html">the erlang port driver API</A>.</P><P>That script is supposed to do theses actions, in an infinite loop:
|
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
read from stdin: AABBBBBBBBB.....
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
A: 2 bytes of length data (a short in network byte order)
|
|
||||||
</LI><LI CLASS="li-itemize">B: a string of length found in A that contains operation in plain text
|
|
||||||
operation are as follows:
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
auth:User:Server:Password (check if a username/password pair is correct)
|
|
||||||
</LI><LI CLASS="li-itemize">isuser:User:Server (check if it’s a valid user)
|
|
||||||
</LI><LI CLASS="li-itemize">setpass:User:Server:Password (set user’s password)
|
|
||||||
</LI><LI CLASS="li-itemize">tryregister:User:Server:Password (try to register an account)
|
|
||||||
</LI><LI CLASS="li-itemize">removeuser:User:Server (remove this account)
|
|
||||||
</LI><LI CLASS="li-itemize">removeuser3:User:Server:Password (remove this account if the password is correct)
|
|
||||||
</LI></UL>
|
|
||||||
</LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">write to stdout: AABB
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
A: the number 2 (coded as a short, which is bytes length of following result)
|
|
||||||
</LI><LI CLASS="li-itemize">B: the result code (coded as a short), should be 1 for success/valid, or 0 for failure/invalid
|
|
||||||
</LI></UL>
|
|
||||||
</LI></UL><P>Example python script
|
|
||||||
</P><PRE CLASS="verbatim">#!/usr/bin/python
|
|
||||||
|
|
||||||
import sys
|
|
||||||
from struct import *
|
|
||||||
|
|
||||||
def from_ejabberd():
|
|
||||||
input_length = sys.stdin.read(2)
|
|
||||||
(size,) = unpack('>h', input_length)
|
|
||||||
return sys.stdin.read(size).split(':')
|
|
||||||
|
|
||||||
def to_ejabberd(bool):
|
|
||||||
answer = 0
|
|
||||||
if bool:
|
|
||||||
answer = 1
|
|
||||||
token = pack('>hh', 2, answer)
|
|
||||||
sys.stdout.write(token)
|
|
||||||
sys.stdout.flush()
|
|
||||||
|
|
||||||
def auth(username, server, password):
|
|
||||||
return True
|
|
||||||
|
|
||||||
def isuser(username, server):
|
|
||||||
return True
|
|
||||||
|
|
||||||
def setpass(username, server, password):
|
|
||||||
return True
|
|
||||||
|
|
||||||
while True:
|
|
||||||
data = from_ejabberd()
|
|
||||||
success = False
|
|
||||||
if data[0] == "auth":
|
|
||||||
success = auth(data[1], data[2], data[3])
|
|
||||||
elif data[0] == "isuser":
|
|
||||||
success = isuser(data[1], data[2])
|
|
||||||
elif data[0] == "setpass":
|
|
||||||
success = setpass(data[1], data[2], data[3])
|
|
||||||
to_ejabberd(success)
|
|
||||||
</PRE><!--TOC section XML Representation-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc10">5</A>  XML Representation</H2><!--SEC END --><P>
|
|
||||||
<A NAME="xmlrepr"></A></P><P>Each XML stanza is represented as the following tuple:
|
|
||||||
</P><PRE CLASS="verbatim">XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
|
|
||||||
Name = string()
|
|
||||||
Attrs = [Attr]
|
|
||||||
Attr = {Key, Val}
|
|
||||||
Key = string()
|
|
||||||
Val = string()
|
|
||||||
ElementOrCDATA = XMLElement | CDATA
|
|
||||||
CDATA = {xmlcdata, string()}
|
|
||||||
</PRE><P>E. g. this stanza:
|
|
||||||
</P><PRE CLASS="verbatim"><message to='test@conference.example.org' type='groupchat'>
|
|
||||||
<body>test</body>
|
|
||||||
</message>
|
|
||||||
</PRE><P>is represented as the following structure:
|
|
||||||
</P><PRE CLASS="verbatim">{xmlelement, "message",
|
|
||||||
[{"to", "test@conference.example.org"},
|
|
||||||
{"type", "groupchat"}],
|
|
||||||
[{xmlelement, "body",
|
|
||||||
[],
|
|
||||||
[{xmlcdata, "test"}]}]}}
|
|
||||||
</PRE><!--TOC section Module <TT>xml</TT>-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc11">6</A>  Module <TT>xml</TT></H2><!--SEC END --><P>
|
|
||||||
<A NAME="xmlmod"></A></P><DL CLASS="description"><DT CLASS="dt-description">
|
|
||||||
</DT><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>.</DD><DT CLASS="dt-description"></DT><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.</DD><DT CLASS="dt-description"></DT><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.</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>get_path_s(El, Path) -> Res</CODE>
|
|
||||||
<PRE CLASS="verbatim">El = XMLElement
|
|
||||||
Path = [PathItem]
|
|
||||||
PathItem = PathElem | PathAttr | PathCDATA
|
|
||||||
PathElem = {elem, Name}
|
|
||||||
PathAttr = {attr, Name}
|
|
||||||
PathCDATA = cdata
|
|
||||||
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 CLASS="description"><DT CLASS="dt-description">
|
|
||||||
</DT><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.
|
|
||||||
</DD><DT CLASS="dt-description"></DT><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.
|
|
||||||
</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>cdata</CODE> Returns CDATA of <TT>El</TT>.
|
|
||||||
</DD></DL></DD><DT CLASS="dt-description"></DT><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
|
|
||||||
get_subtag/2
|
|
||||||
</PRE></DD></DL><!--TOC section Module <TT>xml_stream</TT>-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc12">7</A>  Module <TT>xml_stream</TT></H2><!--SEC END --><P>
|
|
||||||
<A NAME="xmlstreammod"></A></P><DL CLASS="description"><DT CLASS="dt-description">
|
|
||||||
</DT><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
|
|
||||||
tuple.
|
|
||||||
</DD></DL><!--TOC section Modules-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc13">8</A>  Modules</H2><!--SEC END --><P>
|
|
||||||
<A NAME="emods"></A></P><!--TOC subsection Module gen_iq_handler-->
|
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc14">8.1</A>  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
|
|
||||||
of particular XML namespaces that addressed to server or to users bare JIDs.</P><P>In this module the following functions are defined:
|
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
|
||||||
</DT><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
|
|
||||||
</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
|
|
||||||
<CODE>Component</CODE>. Queueing discipline is <CODE>Type</CODE>. There are at least
|
|
||||||
two components defined:
|
|
||||||
<DL CLASS="description"><DT CLASS="dt-description">
|
|
||||||
</DT><DD CLASS="dd-description"><CODE>ejabberd_local</CODE> Handles packets that addressed to server JID;
|
|
||||||
</DD><DT CLASS="dt-description"></DT><DD CLASS="dd-description"><CODE>ejabberd_sm</CODE> Handles packets that addressed to users bare JIDs.
|
|
||||||
</DD></DL>
|
|
||||||
</DD><DT CLASS="dt-description"></DT><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>.
|
|
||||||
</DD></DL><P>Handler function must have the following type:
|
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
|
||||||
</DT><DD CLASS="dd-description"><CODE>Module:Function(From, To, IQ)</CODE>
|
|
||||||
<PRE CLASS="verbatim">From = To = jid()
|
|
||||||
</PRE></DD></DL><PRE CLASS="verbatim">-module(mod_cputime).
|
|
||||||
|
|
||||||
-behaviour(gen_mod).
|
|
||||||
|
|
||||||
-export([start/2,
|
|
||||||
stop/1,
|
|
||||||
process_local_iq/3]).
|
|
||||||
|
|
||||||
-include("ejabberd.hrl").
|
|
||||||
-include("jlib.hrl").
|
|
||||||
|
|
||||||
-define(NS_CPUTIME, "ejabberd:cputime").
|
|
||||||
|
|
||||||
start(Host, Opts) ->
|
|
||||||
IQDisc = gen_mod:get_opt(iqdisc, Opts, one_queue),
|
|
||||||
gen_iq_handler:add_iq_handler(ejabberd_local, Host, ?NS_CPUTIME,
|
|
||||||
?MODULE, process_local_iq, IQDisc).
|
|
||||||
|
|
||||||
stop(Host) ->
|
|
||||||
gen_iq_handler:remove_iq_handler(ejabberd_local, Host, ?NS_CPUTIME).
|
|
||||||
|
|
||||||
process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) ->
|
|
||||||
case Type of
|
|
||||||
set ->
|
|
||||||
{iq, ID, error, XMLNS,
|
|
||||||
[SubEl, ?ERR_NOT_ALLOWED]};
|
|
||||||
get ->
|
|
||||||
CPUTime = element(1, erlang:statistics(runtime))/1000,
|
|
||||||
SCPUTime = lists:flatten(io_lib:format("~.3f", CPUTime)),
|
|
||||||
{iq, ID, result, XMLNS,
|
|
||||||
[{xmlelement, "query",
|
|
||||||
[{"xmlns", ?NS_CPUTIME}],
|
|
||||||
[{xmlelement, "cputime", [], [{xmlcdata, SCPUTime}]}]}]}
|
|
||||||
end.
|
|
||||||
</PRE><!--TOC subsection Services-->
|
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc15">8.2</A>  Services</H3><!--SEC END --><P>
|
|
||||||
<A NAME="services"></A></P><PRE CLASS="verbatim">-module(mod_echo).
|
|
||||||
|
|
||||||
-behaviour(gen_mod).
|
|
||||||
|
|
||||||
-export([start/2, init/1, stop/1]).
|
|
||||||
|
|
||||||
-include("ejabberd.hrl").
|
|
||||||
-include("jlib.hrl").
|
|
||||||
|
|
||||||
start(Host, Opts) ->
|
|
||||||
MyHost = gen_mod:get_opt(host, Opts, "echo." ++ Host),
|
|
||||||
register(gen_mod:get_module_proc(Host, ?PROCNAME),
|
|
||||||
spawn(?MODULE, init, [MyHost])).
|
|
||||||
|
|
||||||
init(Host) ->
|
|
||||||
ejabberd_router:register_local_route(Host),
|
|
||||||
loop(Host).
|
|
||||||
|
|
||||||
loop(Host) ->
|
|
||||||
receive
|
|
||||||
{route, From, To, Packet} ->
|
|
||||||
ejabberd_router:route(To, From, Packet),
|
|
||||||
loop(Host);
|
|
||||||
stop ->
|
|
||||||
ejabberd_router:unregister_route(Host),
|
|
||||||
ok;
|
|
||||||
_ ->
|
|
||||||
loop(Host)
|
|
||||||
end.
|
|
||||||
|
|
||||||
stop(Host) ->
|
|
||||||
Proc = gen_mod:get_module_proc(Host, ?PROCNAME),
|
|
||||||
Proc ! stop,
|
|
||||||
{wait, Proc}.
|
|
||||||
</PRE><!--CUT END -->
|
|
||||||
<!--HTMLFOOT-->
|
|
||||||
<!--ENDHTML-->
|
|
||||||
<!--FOOTER-->
|
|
||||||
<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://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>
|
|
||||||
|
|
@ -1,132 +0,0 @@
|
||||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
|
|
||||||
"http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
||||||
<HTML>
|
|
||||||
<HEAD>
|
|
||||||
<TITLE>Ejabberd 2.1.x Feature Sheet
|
|
||||||
</TITLE>
|
|
||||||
|
|
||||||
<META http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
||||||
<META name="GENERATOR" content="hevea 1.10">
|
|
||||||
<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;}
|
|
||||||
.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:2ex 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;}
|
|
||||||
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:2ex auto;text-align:center}
|
|
||||||
SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
|
|
||||||
</STYLE>
|
|
||||||
</HEAD>
|
|
||||||
<BODY >
|
|
||||||
<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic features.tex -->
|
|
||||||
<!--CUT DEF section 1 --><P><A NAME="titlepage"></A>
|
|
||||||
|
|
||||||
</P><TABLE CLASS="title"><TR><TD><H1 CLASS="titlemain">Ejabberd 2.1.x 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><DIV CLASS="center">
|
|
||||||
|
|
||||||
<IMG SRC="logo.png" ALT="logo.png">
|
|
||||||
|
|
||||||
|
|
||||||
</DIV><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>I can thoroughly recommend ejabberd for ease of setup –
|
|
||||||
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. —
|
|
||||||
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/OTP</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-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc1"></A>Key Features</H2><!--SEC END --><P>
|
|
||||||
<A NAME="keyfeatures"></A>
|
|
||||||
</P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>Erlang seems to be tailor-made for writing stable, robust servers. —
|
|
||||||
Peter Saint-André, Executive Director of the Jabber Software Foundation</I></FONT></BLOCKQUOTE><P><TT>ejabberd</TT> is:
|
|
||||||
</P><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.</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">
|
|
||||||
Comprehensive documentation.
|
|
||||||
</LI><LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </LI><LI CLASS="li-itemize">Web Administration.
|
|
||||||
</LI><LI CLASS="li-itemize">Shared Roster Groups.
|
|
||||||
</LI><LI CLASS="li-itemize">Command line administration tool. </LI><LI CLASS="li-itemize">Can integrate with existing authentication mechanisms.
|
|
||||||
</LI><LI CLASS="li-itemize">Capability to send announce messages.
|
|
||||||
</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:
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Translated to 25 languages. </LI><LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>.
|
|
||||||
</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.
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Fully XMPP compliant.
|
|
||||||
</LI><LI CLASS="li-itemize">XML-based protocol.
|
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.ejabberd.im/protocols">Many protocols supported</A>.
|
|
||||||
</LI></UL></LI></UL><!--TOC section Additional Features-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2"></A>Additional Features</H2><!--SEC END --><P>
|
|
||||||
<A NAME="addfeatures"></A>
|
|
||||||
</P><BLOCKQUOTE CLASS="quotation"><FONT COLOR="#921700"><I>ejabberd is making inroads to solving the "buggy incomplete server" problem —
|
|
||||||
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:
|
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Modular
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Load only the modules you want.
|
|
||||||
</LI><LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules.
|
|
||||||
</LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">Security
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
SASL and STARTTLS for c2s and s2s connections.
|
|
||||||
</LI><LI CLASS="li-itemize">STARTTLS and Dialback s2s connections.
|
|
||||||
</LI><LI CLASS="li-itemize">Web Admin accessible via HTTPS secure access.
|
|
||||||
</LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">Databases
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Internal database for fast deployment (Mnesia).
|
|
||||||
</LI><LI CLASS="li-itemize">Native MySQL support.
|
|
||||||
</LI><LI CLASS="li-itemize">Native PostgreSQL support.
|
|
||||||
</LI><LI CLASS="li-itemize">ODBC data storage support.
|
|
||||||
</LI><LI CLASS="li-itemize">Microsoft SQL Server support. </LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">Authentication
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Internal Authentication.
|
|
||||||
</LI><LI CLASS="li-itemize">PAM, LDAP and ODBC. </LI><LI CLASS="li-itemize">External Authentication script.
|
|
||||||
</LI></UL>
|
|
||||||
</LI><LI CLASS="li-itemize">Others
|
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
Support for virtual hosting.
|
|
||||||
</LI><LI CLASS="li-itemize">Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
|
|
||||||
</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>).
|
|
||||||
</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections.
|
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
|
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
|
|
||||||
</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
|
|
||||||
</LI><LI CLASS="li-itemize">IRC transport.
|
|
||||||
</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
|
|
||||||
</LI></UL>
|
|
||||||
</LI></UL><!--CUT END -->
|
|
||||||
<!--HTMLFOOT-->
|
|
||||||
<!--ENDHTML-->
|
|
||||||
<!--FOOTER-->
|
|
||||||
<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://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>
|
|
||||||
4121
doc/guide.html
4121
doc/guide.html
File diff suppressed because it is too large
Load Diff
6310
src/configure
vendored
6310
src/configure
vendored
File diff suppressed because it is too large
Load Diff
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
{application, ejabberd,
|
{application, ejabberd,
|
||||||
[{description, "ejabberd"},
|
[{description, "ejabberd"},
|
||||||
{vsn, "2.1.x"},
|
{vsn, "2.2.x"},
|
||||||
{modules, [acl,
|
{modules, [acl,
|
||||||
adhoc,
|
adhoc,
|
||||||
configure,
|
configure,
|
||||||
|
|
|
||||||
|
|
@ -76,8 +76,7 @@ terminate(Host, ServerHost) ->
|
||||||
node_hometree_odbc:terminate(Host, ServerHost).
|
node_hometree_odbc:terminate(Host, ServerHost).
|
||||||
|
|
||||||
options() ->
|
options() ->
|
||||||
[{node_type, flat},
|
[{deliver_payloads, true},
|
||||||
{deliver_payloads, true},
|
|
||||||
{notify_config, false},
|
{notify_config, false},
|
||||||
{notify_delete, false},
|
{notify_delete, false},
|
||||||
{notify_retract, true},
|
{notify_retract, true},
|
||||||
|
|
|
||||||
|
|
@ -86,7 +86,6 @@ terminate(Host, ServerHost) ->
|
||||||
|
|
||||||
options() ->
|
options() ->
|
||||||
[{odbc, true},
|
[{odbc, true},
|
||||||
{node_type, pep},
|
|
||||||
{deliver_payloads, true},
|
{deliver_payloads, true},
|
||||||
{notify_config, false},
|
{notify_config, false},
|
||||||
{notify_delete, false},
|
{notify_delete, false},
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
-define(TIMEOUT, 1000*600). % 1 minute
|
-define(TIMEOUT, 1000*600). % 1 minute
|
||||||
|
|
||||||
-export([start/0, loop/0, subscribed/1, offline/1]).
|
-export([start/0, loop/0, offline/1]).
|
||||||
|
|
||||||
start() ->
|
start() ->
|
||||||
Pid = spawn(?MODULE, loop, []),
|
Pid = spawn(?MODULE, loop, []),
|
||||||
|
|
@ -24,17 +24,12 @@ purge() ->
|
||||||
I=element(3,N),
|
I=element(3,N),
|
||||||
lists:foreach(fun(JID) ->
|
lists:foreach(fun(JID) ->
|
||||||
mnesia:dirty_delete({pubsub_state, {JID, I}})
|
mnesia:dirty_delete({pubsub_state, {JID, I}})
|
||||||
end, offline(subscribed(I)))
|
end, offline(pubsub_debug:subscribed(I)))
|
||||||
end, mnesia:dirty_all_keys(pubsub_node));
|
end, mnesia:dirty_all_keys(pubsub_node));
|
||||||
true ->
|
true ->
|
||||||
ok
|
ok
|
||||||
end.
|
end.
|
||||||
|
|
||||||
subscribed(NodeId) ->
|
|
||||||
lists:map(fun(S) ->
|
|
||||||
element(1,element(2,S))
|
|
||||||
end, mnesia:dirty_match_object({pubsub_state, {'_',NodeId},'_',none,subscribed})).
|
|
||||||
|
|
||||||
offline(Jids) ->
|
offline(Jids) ->
|
||||||
lists:filter(fun({U,S,""}) -> ejabberd_sm:get_user_resources(U,S) == [];
|
lists:filter(fun({U,S,""}) -> ejabberd_sm:get_user_resources(U,S) == [];
|
||||||
({U,S,R}) -> not lists:member(R,ejabberd_sm:get_user_resources(U,S))
|
({U,S,R}) -> not lists:member(R,ejabberd_sm:get_user_resources(U,S))
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,7 @@ nodeids_by_type(Type) -> [nodeid(N) || N <- mnesia:dirty_match_object(#pubsub_no
|
||||||
nodeids_by_option(Key, Value) -> [nodeid(N) || N <- mnesia:dirty_match_object(#pubsub_node{_='_'}), lists:member({Key, Value}, N#pubsub_node.options)].
|
nodeids_by_option(Key, Value) -> [nodeid(N) || N <- mnesia:dirty_match_object(#pubsub_node{_='_'}), lists:member({Key, Value}, N#pubsub_node.options)].
|
||||||
nodeids_by_owner(JID) -> [nodeid(N) || N <- mnesia:dirty_match_object(#pubsub_node{_='_'}), lists:member(JID, N#pubsub_node.owners)].
|
nodeids_by_owner(JID) -> [nodeid(N) || N <- mnesia:dirty_match_object(#pubsub_node{_='_'}), lists:member(JID, N#pubsub_node.owners)].
|
||||||
nodes_by_id(I) -> mnesia:dirty_match_object(#pubsub_node{id=I, _='_'}).
|
nodes_by_id(I) -> mnesia:dirty_match_object(#pubsub_node{id=I, _='_'}).
|
||||||
|
nodes() -> [element(2, element(2, N)) || N <- mnesia:dirty_match_object(#pubsub_node{_='_'})].
|
||||||
|
|
||||||
state(JID, NodeId) ->
|
state(JID, NodeId) ->
|
||||||
case mnesia:dirty_read({pubsub_state, {JID, NodeId}}) of
|
case mnesia:dirty_read({pubsub_state, {JID, NodeId}}) of
|
||||||
|
|
|
||||||
136
tools/joincluster
Executable file
136
tools/joincluster
Executable file
|
|
@ -0,0 +1,136 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Add the current ejabberd node in a cluster
|
||||||
|
|
||||||
|
# copyright (c) 2010 ProcessOne
|
||||||
|
#
|
||||||
|
# This script is proprietary software and cannot be published or redistribute.
|
||||||
|
|
||||||
|
# Return Code:
|
||||||
|
# 0 : groovy baby
|
||||||
|
# 11 : erl not found
|
||||||
|
# 12 : erlc not found
|
||||||
|
# 20 : database dir doesn't exist
|
||||||
|
# 21 : database dir not writable
|
||||||
|
# 21 : database dir variable not set
|
||||||
|
# 30 : network issue
|
||||||
|
# 31 : node names incompatibility
|
||||||
|
|
||||||
|
function error
|
||||||
|
{
|
||||||
|
echo "Error: $1" >&2
|
||||||
|
exit $2
|
||||||
|
}
|
||||||
|
|
||||||
|
echo "--------------------------------------------------------------------"
|
||||||
|
echo ""
|
||||||
|
echo "ejabberd cluster configuration"
|
||||||
|
echo ""
|
||||||
|
echo "This ejabberd node will be configured for use in an ejabberd cluster."
|
||||||
|
echo "IMPORTANT: all local data from the database will be lost, and"
|
||||||
|
echo "cluster database will be initialized. All data from the master"
|
||||||
|
echo "node will be replicated to this one."
|
||||||
|
echo ""
|
||||||
|
echo "--------------------------------------------------------------------"
|
||||||
|
echo "Press any key to continue, or Ctrl+C to stop now"
|
||||||
|
read foo
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "Make sure you have a running remote master ejabberd node"
|
||||||
|
echo "Before continuing, you must copy the ~/.erlang.cookie file from"
|
||||||
|
echo "remote master node and check ejabberd.cfg compatibility."
|
||||||
|
echo "e.g. hosts definition must match on all nodes"
|
||||||
|
echo ""
|
||||||
|
echo "The remote master node name is defined as ERLANG_NODE into"
|
||||||
|
echo "ejabberdctl.cfg on that remote node."
|
||||||
|
echo ""
|
||||||
|
echo -n "Remote master node name: "
|
||||||
|
read REMOTE
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
cont=Y
|
||||||
|
ping -q -c 1 ${REMOTE#*@} 2>/dev/null >/dev/null
|
||||||
|
[ $? -eq 0 ] || {
|
||||||
|
echo "Cannot ping ${REMOTE#*@}. Are you sure network setup is correct ?"
|
||||||
|
echo -n "Should we continue anyway ? (Y/n) "
|
||||||
|
read cont
|
||||||
|
}
|
||||||
|
cont=`echo $cont | tr a-z A-Z`
|
||||||
|
[ "$cont" == "Y" ] || error "Check your network configuration (dns, firewall, etc...)" 30
|
||||||
|
|
||||||
|
HERE=`which "$0"`
|
||||||
|
BASE=`dirname $HERE`/..
|
||||||
|
ROOTDIR=`cd $BASE; pwd`
|
||||||
|
. $ROOTDIR/bin/ejabberdctl stop 2>/dev/null >/dev/null
|
||||||
|
NAME=-name
|
||||||
|
[ "$ERLANG_NODE" = "${ERLANG_NODE%.*}" ] && NAME=-sname
|
||||||
|
PA=/tmp/clustersetup_$$
|
||||||
|
CLUSTERSETUP=clustersetup
|
||||||
|
CLUSTERSETUP_ERL=$PA/$CLUSTERSETUP.erl
|
||||||
|
|
||||||
|
REMOTENAME=-name
|
||||||
|
[ "$REMOTE" = "${REMOTE%.*}" ] && REMOTENAME=-sname
|
||||||
|
[ "$REMOTENAME" = "$NAME" ] || {
|
||||||
|
echo "IMPORTANT!: node names are incompatible"
|
||||||
|
echo "Remote node name is $REMOTE"
|
||||||
|
echo "Local node name is $ERLANG_NODE"
|
||||||
|
echo ""
|
||||||
|
echo "Both node names must be short or fqdn names."
|
||||||
|
echo "Using short and fqdn names is impossible."
|
||||||
|
echo ""
|
||||||
|
error "incompatible node names" 31
|
||||||
|
}
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
|
||||||
|
echo "Using commands:"
|
||||||
|
which erl || error "can't find erl" 11
|
||||||
|
which erlc || error "can't find erlc" 12
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
[ -d $EJABBERD_DB ] && rm -Rf $EJABBERD_DB
|
||||||
|
mkdir $EJABBERD_DB || error "$EJABBERD_DB cannot be created" 20
|
||||||
|
[ -w $EJABBERD_DB ] || error "$EJABBERD_DB directory is not writable" 21
|
||||||
|
|
||||||
|
cd $ROOTDIR
|
||||||
|
mkdir -p $PA
|
||||||
|
cat <<EOF > $CLUSTERSETUP_ERL
|
||||||
|
-module($CLUSTERSETUP).
|
||||||
|
|
||||||
|
-export([start/0]).
|
||||||
|
|
||||||
|
set_table_copy(Table, _Node, {badrpc, Reason}) ->
|
||||||
|
io:format("Error: cannot get storage type for table ~p on node $REMOTE:~n ~p~n",[Table, Reason]);
|
||||||
|
set_table_copy(Table, Node, Type) ->
|
||||||
|
io:format("setting table ~p to mode ~p~n",[Table, Type]),
|
||||||
|
case mnesia:add_table_copy(Table, Node, Type) of
|
||||||
|
{aborted, _} ->
|
||||||
|
mnesia:change_table_copy_type(Table, Node, Type);
|
||||||
|
_ ->
|
||||||
|
ok
|
||||||
|
end.
|
||||||
|
|
||||||
|
set_tables({badrpc, Reason}) ->
|
||||||
|
io:format("ERROR: cannot get tables list on $REMOTE : ~p~n",[Reason]);
|
||||||
|
set_tables([]) ->
|
||||||
|
ok;
|
||||||
|
set_tables([schema | Tables]) ->
|
||||||
|
set_tables(Tables);
|
||||||
|
set_tables([Table | Tables]) ->
|
||||||
|
set_table_copy(Table, node(),
|
||||||
|
rpc:call('$REMOTE', mnesia, table_info, [Table, storage_type])),
|
||||||
|
set_tables(Tables).
|
||||||
|
|
||||||
|
start() ->
|
||||||
|
io:format("~n",[]),
|
||||||
|
set_table_copy(schema, node(), disc_copies),
|
||||||
|
set_tables(rpc:call('$REMOTE', mnesia, system_info, [tables])),
|
||||||
|
halt(0).
|
||||||
|
EOF
|
||||||
|
erlc -o $PA $CLUSTERSETUP_ERL
|
||||||
|
erl $NAME $ERLANG_NODE -pa $PA $KERNEL_OPTS -mnesia extra_db_nodes "['$REMOTE']" dir "\"$EJABBERD_DB\"" -s mnesia -s $CLUSTERSETUP start
|
||||||
|
rm -Rf $PA
|
||||||
|
|
||||||
|
echo "End."
|
||||||
|
echo "Check that there is no error in the above messages."
|
||||||
93
tools/leavecluster
Executable file
93
tools/leavecluster
Executable file
|
|
@ -0,0 +1,93 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Remove the current ejabberd node in a cluster
|
||||||
|
|
||||||
|
# Return Code:
|
||||||
|
# 0 : groovy baby
|
||||||
|
# 11 : erl not found
|
||||||
|
# 12 : erlc not found
|
||||||
|
# 20 : database dir doesn't exist
|
||||||
|
# 21 : database dir not writable
|
||||||
|
# 21 : database dir variable not set
|
||||||
|
|
||||||
|
function error
|
||||||
|
{
|
||||||
|
echo "Error: $1" >&2
|
||||||
|
exit $2
|
||||||
|
}
|
||||||
|
|
||||||
|
echo "--------------------------------------------------------------------"
|
||||||
|
echo ""
|
||||||
|
echo "ejabberd cluster configuration"
|
||||||
|
echo ""
|
||||||
|
echo "This ejabberd node will be removed from the cluster."
|
||||||
|
echo "IMPORTANT: this node will be stopped. At least one other clustered"
|
||||||
|
echo "node must be running."
|
||||||
|
echo ""
|
||||||
|
echo "--------------------------------------------------------------------"
|
||||||
|
echo "Press any key to continue, or Ctrl+C to stop now"
|
||||||
|
read foo
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
HERE=`which "$0"`
|
||||||
|
BASE=`dirname $HERE`/..
|
||||||
|
ROOTDIR=`cd $BASE; pwd`
|
||||||
|
. $ROOTDIR/bin/ejabberdctl stop 2>/dev/null >/dev/null
|
||||||
|
$ROOTDIR/bin/ejabberdctl stopped
|
||||||
|
PA=/tmp/clustersetup_$$
|
||||||
|
CLUSTERSETUP=clustersetup
|
||||||
|
CLUSTERSETUP_ERL=$PA/$CLUSTERSETUP.erl
|
||||||
|
|
||||||
|
set -o errexit
|
||||||
|
set -o nounset
|
||||||
|
|
||||||
|
echo "Using commands:"
|
||||||
|
which erl || error "can't find erl" 11
|
||||||
|
which erlc || error "can't find erlc" 12
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
cd $ROOTDIR
|
||||||
|
mkdir -p $PA
|
||||||
|
cat <<EOF > $CLUSTERSETUP_ERL
|
||||||
|
-module($CLUSTERSETUP).
|
||||||
|
|
||||||
|
-export([start/0]).
|
||||||
|
|
||||||
|
del_table_copy(Table, Node) ->
|
||||||
|
case mnesia:del_table_copy(Table, Node) of
|
||||||
|
{aborted, Reason} -> io:format("Error: can not remove ~p table: ~p~n", [Table, Reason]);
|
||||||
|
_ -> io:format("table ~p removed from cluster~n", [Table])
|
||||||
|
end.
|
||||||
|
|
||||||
|
del_tables([],_) ->
|
||||||
|
ok;
|
||||||
|
del_tables([schema | Tables], Node) ->
|
||||||
|
del_tables(Tables, Node);
|
||||||
|
del_tables([Table | Tables], Node) ->
|
||||||
|
del_table_copy(Table, Node),
|
||||||
|
del_tables(Tables, Node).
|
||||||
|
|
||||||
|
start() ->
|
||||||
|
io:format("~n",[]),
|
||||||
|
Removed = node(),
|
||||||
|
case mnesia:system_info(running_db_nodes)--[Removed] of
|
||||||
|
[] -> io:format("Error: no other node running in the cluster~n");
|
||||||
|
Nodes ->
|
||||||
|
del_tables(mnesia:system_info(local_tables), Removed),
|
||||||
|
mnesia:stop(),
|
||||||
|
case rpc:call(hd(Nodes), mnesia, del_table_copy, [schema, Removed]) of
|
||||||
|
{badrpc,Reason} -> io:format("Error: can not unregister node ~p from cluster: ~p~n", [Removed, Reason]);
|
||||||
|
{aborted,Reason} -> io:format("Error: can not unregister node ~p from cluster: ~p~n", [Removed, Reason]);
|
||||||
|
{atomic, ok} ->
|
||||||
|
mnesia:delete_schema([Removed]),
|
||||||
|
io:format("node ~p removed from cluster~n", [Removed])
|
||||||
|
end
|
||||||
|
end,
|
||||||
|
halt(0).
|
||||||
|
EOF
|
||||||
|
erlc -o $PA $CLUSTERSETUP_ERL
|
||||||
|
erl $NAME $ERLANG_NODE -pa $PA $KERNEL_OPTS -mnesia dir "\"$EJABBERD_DB\"" -s mnesia -s $CLUSTERSETUP start
|
||||||
|
rm -Rf $PA
|
||||||
|
|
||||||
|
echo "End."
|
||||||
|
echo "Check that there is no error in the above messages."
|
||||||
38
tools/tcp-tuning.sh
Executable file
38
tools/tcp-tuning.sh
Executable file
|
|
@ -0,0 +1,38 @@
|
||||||
|
#!/bin/sh
|
||||||
|
ulimit -n 562524
|
||||||
|
# /etc/security/limits.conf
|
||||||
|
#@ejabberd soft nofile 562000
|
||||||
|
#@ejabberd hard nofile 562000
|
||||||
|
# 4KB send buffer, 20,480 connections max at worst case
|
||||||
|
#echo 83886080 > /proc/sys/net/core/wmem_max
|
||||||
|
#echo 83886080 > /proc/sys/net/core/wmem_default
|
||||||
|
echo 327680000 > /proc/sys/net/core/wmem_max
|
||||||
|
echo 327680000 > /proc/sys/net/core/wmem_default
|
||||||
|
# 16KB receive buffer, 20,480 connections max at worst case
|
||||||
|
#echo 335544320 > /proc/sys/net/core/rmem_max
|
||||||
|
#echo 335544320 > /proc/sys/net/core/rmem_default
|
||||||
|
echo 1310720000 > /proc/sys/net/core/rmem_max
|
||||||
|
echo 1310720000 > /proc/sys/net/core/rmem_default
|
||||||
|
# Max open files
|
||||||
|
echo 562524 > /proc/sys/fs/file-max
|
||||||
|
# Fast port recycling (TIME_WAIT)
|
||||||
|
echo 1 >/proc/sys/net/ipv4/tcp_tw_recycle
|
||||||
|
echo 1 >/proc/sys/net/ipv4/tcp_tw_reuse
|
||||||
|
# TIME_WAIT buckets increased
|
||||||
|
echo 360000 > /proc/sys/net/ipv4/tcp_max_tw_buckets
|
||||||
|
# FIN timeout decreased
|
||||||
|
echo 15 > /proc/sys/net/ipv4/tcp_fin_timeout
|
||||||
|
# SYN backlog increased
|
||||||
|
echo 65536 > /proc/sys/net/ipv4/tcp_max_syn_backlog
|
||||||
|
# SYN cookies enabled
|
||||||
|
echo 1 > /proc/sys/net/ipv4/tcp_syncookies
|
||||||
|
# Local port range maximized
|
||||||
|
echo "1024 65535" > /proc/sys/net/ipv4/ip_local_port_range
|
||||||
|
# Netdev backlog increased
|
||||||
|
echo 100000 > /proc/sys/net/core/netdev_max_backlog
|
||||||
|
# Do no save route metrics
|
||||||
|
echo 1 > /proc/sys/net/ipv4/route/flush
|
||||||
|
echo 30 > /proc/sys/net/ipv4/tcp_fin_timeout
|
||||||
|
# Interface transmit queuelen increased
|
||||||
|
ifconfig eth0 txqueuelen 10000
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user