+February 3, 2003
+
+
+
@@ -32,9 +34,28 @@ ejabberd is a Free and Open Source distributed fault-tolerant Jabber server. It writen mostly in Erlang.
-TBD
-
- +Main features of ejabberd is: +
-
+
- + Distribution. You can run ejaberd on cluster of machines and all them + will serve one Jabber domain. + +
- Fault-tolerance. You can setup ejabberd cluster in such way, that all + information required for properly working will be stored permanently on more + then one machine, so if one of them crashed, then all other ones continue + working without any pauses. Also you can replace or add more machines ``on + the fly''. + +
- Support of JEP-0030 + (Service Discovery). + +
- Support of JEP-0039 + (Statistics Gathering). + +
- Support of xml:lang attribute in many XML elements. + +
- JUD based on users vCards. +
2 Installation
@@ -121,8 +142,8 @@ serves. E. g. to use jabber.org domain add following line in confi3.1.2 Access Rules
-Access control in ejabberd is done via Access Control Lists (ACL). In -config file they looks like this: +Access control in ejabberd is done via Access Control Lists (ACL). +Declaration of ACL in config file have following syntax:
{acl, <aclname>, {<acltype>, ...}}.
<acltype> can be one of following:
@@ -202,7 +223,7 @@ config file they looks like this:
]}.
When JID is checked to have access to <accessname>, server
sequentially checks if this JID in one of the ACLs that are second elements in
-eache tuple in list. If one of them matched, then returned first element of
+each tuple in list. If one of them matched, then returned first element of
matched tuple. Else returned ``deny''.Example: @@ -285,9 +306,9 @@ Example: {mod_time, [{iqdisc, no_queue}]}, {mod_version, []} ]}. - + -
3.2 Online Configuration
+3.2 Online Configuration and Monitoring
To use facility of online reconfiguration of ejabberd needed to have mod_configure loaded (see section 5.4). Also highly @@ -298,6 +319,74 @@ xdata-capable client developed synchronously with ejabberd, its CVS version use most of ejabberd features).+On disco query ejabberd returns following items: +
-
+
- + Identity of server. + +
- List of features, including defined namespaces. + +
- List of JIDs from route table. + +
- List of disco-nodes described in following subsections. +
3.2.1 Node config: Global Configuration
+Under this node exists following nodes:+
+ + +
Node config/hostname
+Via jabber:x:data queries to this node possible to change host name of +this ejabberd server. (See figure 1) (Currently will work +correctly only after restart) ++ +
Node config/acls
+Via jabber:x:data queries to this node possible edit ACLs list. (See +figure 2) ++ +
Node config/access
+Via jabber:x:data queries to this node possible edit access rules. +Not work yet.+
+ + +
Node config/remusers
+Via jabber:x:data queries to this node possible to remove users. If +removed user is online, then he will be disconnected. Also user-related data +(e.g. his roster) is removed (but appropriate module must be loaded).+
+ + +
3.2.2 Node online users: List of Online Users
+ + +3.2.3 Node all users: List of Connected User
+ + +3.2.4 Node outgoing s2s: List of Outgoing S2S connections
+ + +3.2.5 Node running nodes: List of Running ejabberd Nodes
+ + +3.2.6 Node stopped nodes: List of Stopped Nodes
TBDdiff --git a/doc/guide.tex b/doc/guide.tex index 7f516a8e2..da22aca77 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -6,7 +6,12 @@ \newcommand{\imgscale}{0.7} - +\newcommand{\insimg}[1]{ + \imgsrc{#1}{} + \begin{latexonly} + \scalebox{\imgscale}{\includegraphics{#1}} + \end{latexonly} +} \newcommand{\ns}[1]{\texttt{#1}} \newcommand{\ejabberd}{\texttt{ejabberd}} @@ -30,17 +35,14 @@ \author{Alexey Shchepin \\ \ahrefurl{mailto:alexey@sevcom.net} \\ \ahrefurl{xmpp:aleksey@jabber.ru}} -\date{January 29, 2003} +\date{February 3, 2003} \begin{document} \begin{titlepage} \maketitle{} {\centering - \imgsrc{logo.png}{} - \begin{latexonly} - \scalebox{\imgscale}{\includegraphics{logo.png}} - \end{latexonly} + \insimg{logo.png} \par } \end{titlepage} @@ -54,7 +56,23 @@ \ejabberd{} is a Free and Open Source distributed fault-tolerant \Jabber{} server. It writen mostly in Erlang. -TBD +Main features of ejabberd is: +\begin{itemize} +\item Distribution. You can run ejaberd on cluster of machines and all them + will serve one Jabber domain. +\item Fault-tolerance. You can setup ejabberd cluster in such way, that all + information required for properly working will be stored permanently on more + then one machine, so if one of them crashed, then all other ones continue + working without any pauses. Also you can replace or add more machines ``on + the fly''. +\item Support of \footahref{http://www.jabber.org/jeps/jep-0030.html}{JEP-0030} + (Service Discovery). +\item Support of \footahref{http://www.jabber.org/jeps/jep-0039.html}{JEP-0039} + (Statistics Gathering). +\item Support of \ns{xml:lang} attribute in many XML elements. +\item JUD based on users vCards. +\end{itemize} + @@ -158,8 +176,8 @@ serves. E.\,g.\ to use \texttt{jabber.org} domain add following line in config: \subsubsection{Access Rules} \label{sec:configaccess} -Access control in \ejabberd{} is done via Access Control Lists (ACL). In -config file they looks like this: +Access control in \ejabberd{} is done via Access Control Lists (ACL). +Declaration of ACL in config file have following syntax: \begin{verbatim} {acl,