diff options
| author | Alexey Shchepin <alexey@process-one.net> | 2004-07-11 00:06:27 +0400 |
|---|---|---|
| committer | Alexey Shchepin <alexey@process-one.net> | 2004-07-11 00:06:27 +0400 |
| commit | 6251519591b3e18e29a453a86dcba2bdb97e650d (patch) | |
| tree | 8ac40d5d2fcaf0a19804ca50217806abbbb0a43f /doc | |
| parent | d2eab0d5350cd2fc09987d43f39b7f00dde406d6 (diff) | |
* doc/guide.tex: Updated
SVN Revision: 242
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guide.html | 145 | ||||
| -rw-r--r-- | doc/guide.tex | 31 |
2 files changed, 122 insertions, 54 deletions
diff --git a/doc/guide.html b/doc/guide.html index 19038a75a..9e6c0c6fa 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -63,42 +63,46 @@ <LI><A HREF="#htoc18">3.1.6 Modules</A> </UL> <LI><A HREF="#htoc19">3.2 Online Configuration and Monitoring</A> +<UL><LI> +<A HREF="#htoc20">3.2.1 Web-based Administration Interface</A> +<LI><A HREF="#htoc21">3.2.2 <TT>ejabberdctl</TT> tool</A> +</UL> </UL> -<LI><A HREF="#htoc20">4 Distribution</A> +<LI><A HREF="#htoc22">4 Distribution</A> <UL><LI> -<A HREF="#htoc21">4.1 How it works</A> +<A HREF="#htoc23">4.1 How it works</A> <UL><LI> -<A HREF="#htoc22">4.1.1 Router</A> -<LI><A HREF="#htoc23">4.1.2 Local Router</A> -<LI><A HREF="#htoc24">4.1.3 Session Manager</A> -<LI><A HREF="#htoc25">4.1.4 S2S Manager</A> +<A HREF="#htoc24">4.1.1 Router</A> +<LI><A HREF="#htoc25">4.1.2 Local Router</A> +<LI><A HREF="#htoc26">4.1.3 Session Manager</A> +<LI><A HREF="#htoc27">4.1.4 S2S Manager</A> </UL> </UL> -<LI><A HREF="#htoc26">A Built-in Modules</A> +<LI><A HREF="#htoc28">A Built-in Modules</A> <UL><LI> -<A HREF="#htoc27">A.1 Common Options</A> +<A HREF="#htoc29">A.1 Common Options</A> <UL><LI> -<A HREF="#htoc28">A.1.1 Option <TT>iqdisc</TT></A> -<LI><A HREF="#htoc29">A.1.2 Option <TT>host</TT></A> +<A HREF="#htoc30">A.1.1 Option <TT>iqdisc</TT></A> +<LI><A HREF="#htoc31">A.1.2 Option <TT>host</TT></A> </UL> -<LI><A HREF="#htoc30">A.2 <TT>mod_configure</TT></A> -<LI><A HREF="#htoc31">A.3 <TT>mod_disco</TT></A> -<LI><A HREF="#htoc32">A.4 <TT>mod_echo</TT></A> -<LI><A HREF="#htoc33">A.5 <TT>mod_irc</TT></A> -<LI><A HREF="#htoc34">A.6 <TT>mod_last</TT></A> -<LI><A HREF="#htoc35">A.7 <TT>mod_muc</TT></A> -<LI><A HREF="#htoc36">A.8 <TT>mod_offline</TT></A> -<LI><A HREF="#htoc37">A.9 <TT>mod_privacy</TT></A> -<LI><A HREF="#htoc38">A.10 <TT>mod_private</TT></A> -<LI><A HREF="#htoc39">A.11 <TT>mod_pubsub</TT></A> -<LI><A HREF="#htoc40">A.12 <TT>mod_register</TT></A> -<LI><A HREF="#htoc41">A.13 <TT>mod_roster</TT></A> -<LI><A HREF="#htoc42">A.14 <TT>mod_stats</TT></A> -<LI><A HREF="#htoc43">A.15 <TT>mod_time</TT></A> -<LI><A HREF="#htoc44">A.16 <TT>mod_vcard</TT></A> -<LI><A HREF="#htoc45">A.17 <TT>mod_version</TT></A> +<LI><A HREF="#htoc32">A.2 <TT>mod_configure</TT></A> +<LI><A HREF="#htoc33">A.3 <TT>mod_disco</TT></A> +<LI><A HREF="#htoc34">A.4 <TT>mod_echo</TT></A> +<LI><A HREF="#htoc35">A.5 <TT>mod_irc</TT></A> +<LI><A HREF="#htoc36">A.6 <TT>mod_last</TT></A> +<LI><A HREF="#htoc37">A.7 <TT>mod_muc</TT></A> +<LI><A HREF="#htoc38">A.8 <TT>mod_offline</TT></A> +<LI><A HREF="#htoc39">A.9 <TT>mod_privacy</TT></A> +<LI><A HREF="#htoc40">A.10 <TT>mod_private</TT></A> +<LI><A HREF="#htoc41">A.11 <TT>mod_pubsub</TT></A> +<LI><A HREF="#htoc42">A.12 <TT>mod_register</TT></A> +<LI><A HREF="#htoc43">A.13 <TT>mod_roster</TT></A> +<LI><A HREF="#htoc44">A.14 <TT>mod_stats</TT></A> +<LI><A HREF="#htoc45">A.15 <TT>mod_time</TT></A> +<LI><A HREF="#htoc46">A.16 <TT>mod_vcard</TT></A> +<LI><A HREF="#htoc47">A.17 <TT>mod_version</TT></A> </UL> -<LI><A HREF="#htoc46">B I18n/L10n</A> +<LI><A HREF="#htoc48">B I18n/L10n</A> </UL> <!--TOC section Introduction--> @@ -616,6 +620,11 @@ Example: <H3><A NAME="htoc19">3.2</A> Online Configuration and Monitoring</H3><!--SEC END --> <A NAME="sec:onlineconfig"></A> +<!--TOC subsubsection Web-based Administration Interface--> + +<H4><A NAME="htoc20">3.2.1</A> Web-based Administration Interface</H4><!--SEC END --> + +<A NAME="sec:webadm"></A> To perform online reconfiguration of <TT>ejabberd</TT> you need to enable <TT>ejabberd_http</TT> listener with option <TT>web_admin</TT> (see section <A HREF="#sec:configlistened">3.1.5</A>). After that you can open URL @@ -646,14 +655,42 @@ authentification you should see something like in figure <A HREF="#fig:weba Here you can edit access restrictions, manage users, create backup files, manage DB, enable/disable listened ports, and view statistics.<BR> <BR> +<!--TOC subsubsection <TT>ejabberdctl</TT> tool--> + +<H4><A NAME="htoc21">3.2.2</A> <TT>ejabberdctl</TT> tool</H4><!--SEC END --> + +<A NAME="sec:ejabberdctl"></A> +It is possible to do some administration operations using <TT>ejabberdctl</TT> +command-line tool. You can check available options running this command +without arguments: +<PRE> +% ejabberdctl +Usage: ejabberdctl node command + +Available commands: + stop stop ejabberd + restart restart ejabberd + reopen-log reopen log file + register user password register a user + unregister user unregister a user + backup file store a database backup in file + restore file restore a database backup from file + install-fallback file install a database fallback from file + dump file dump a database in a text file + load file restore a database from a text file + registered-users list all registered users + +Example: + ejabberdctl ejabberd@host restart +</PRE> <!--TOC section Distribution--> -<H2><A NAME="htoc20">4</A> Distribution</H2><!--SEC END --> +<H2><A NAME="htoc22">4</A> Distribution</H2><!--SEC END --> <A NAME="sec:distribution"></A> <!--TOC subsection How it works--> -<H3><A NAME="htoc21">4.1</A> How it works</H3><!--SEC END --> +<H3><A NAME="htoc23">4.1</A> How it works</H3><!--SEC END --> <A NAME="sec:howitworks"></A> A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can @@ -673,7 +710,7 @@ router; </UL> <!--TOC subsubsection Router--> -<H4><A NAME="htoc22">4.1.1</A> Router</H4><!--SEC END --> +<H4><A NAME="htoc24">4.1.1</A> Router</H4><!--SEC END --> This module is the main router of Jabber packets on each node. It routes them based on their destinations domains. It has two tables: local and global @@ -685,7 +722,7 @@ manager.<BR> <BR> <!--TOC subsubsection Local Router--> -<H4><A NAME="htoc23">4.1.2</A> Local Router</H4><!--SEC END --> +<H4><A NAME="htoc25">4.1.2</A> Local Router</H4><!--SEC END --> This module routes packets which have a destination domain equal to this server name. If destination JID has a non-empty user part, then it routed to the @@ -693,7 +730,7 @@ session manager, else it is processed depending on it's content.<BR> <BR> <!--TOC subsubsection Session Manager--> -<H4><A NAME="htoc24">4.1.3</A> Session Manager</H4><!--SEC END --> +<H4><A NAME="htoc26">4.1.3</A> Session Manager</H4><!--SEC END --> This module routes packets to local users. It searches for what user resource packet must be sended via presence table. If this resource is connected to @@ -702,7 +739,7 @@ the packet is sent to session manager on that node.<BR> <BR> <!--TOC subsubsection S2S Manager--> -<H4><A NAME="htoc25">4.1.4</A> S2S Manager</H4><!--SEC END --> +<H4><A NAME="htoc27">4.1.4</A> S2S Manager</H4><!--SEC END --> This module routes packets to other Jabber servers. First, it checks if an open S2S connection from the domain of the packet source to the domain of @@ -713,12 +750,12 @@ does not exist, then it is opened and registered.<BR> <BR> <!--TOC section Built-in Modules--> -<H2><A NAME="htoc26">A</A> Built-in Modules</H2><!--SEC END --> +<H2><A NAME="htoc28">A</A> Built-in Modules</H2><!--SEC END --> <A NAME="sec:modules"></A> <!--TOC subsection Common Options--> -<H3><A NAME="htoc27">A.1</A> Common Options</H3><!--SEC END --> +<H3><A NAME="htoc29">A.1</A> Common Options</H3><!--SEC END --> <A NAME="sec:modcommonopts"></A> The following options are used by many modules, so they are described in @@ -726,7 +763,7 @@ separate section.<BR> <BR> <!--TOC subsubsection Option <TT>iqdisc</TT>--> -<H4><A NAME="htoc28">A.1.1</A> Option <TT>iqdisc</TT></H4><!--SEC END --> +<H4><A NAME="htoc30">A.1.1</A> Option <TT>iqdisc</TT></H4><!--SEC END --> <A NAME="sec:modiqdiscoption"></A> Many modules define handlers for processing IQ queries of different namespaces @@ -759,7 +796,7 @@ Example: </PRE> <!--TOC subsubsection Option <TT>host</TT>--> -<H4><A NAME="htoc29">A.1.2</A> Option <TT>host</TT></H4><!--SEC END --> +<H4><A NAME="htoc31">A.1.2</A> Option <TT>host</TT></H4><!--SEC END --> <A NAME="sec:modhostoption"></A> This option explicitly defines hostname for the module which acts as a service.<BR> @@ -775,7 +812,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_configure</TT>--> -<H3><A NAME="htoc30">A.2</A> <TT>mod_configure</TT></H3><!--SEC END --> +<H3><A NAME="htoc32">A.2</A> <TT>mod_configure</TT></H3><!--SEC END --> <A NAME="sec:modconfigure"></A> Options: @@ -785,7 +822,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_disco</TT>--> -<H3><A NAME="htoc31">A.3</A> <TT>mod_disco</TT></H3><!--SEC END --> +<H3><A NAME="htoc33">A.3</A> <TT>mod_disco</TT></H3><!--SEC END --> <A NAME="sec:moddisco"></A> This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0030.html">JEP-0030</A> (Service Discovery).<BR> @@ -810,7 +847,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_echo</TT>--> -<H3><A NAME="htoc32">A.4</A> <TT>mod_echo</TT></H3><!--SEC END --> +<H3><A NAME="htoc34">A.4</A> <TT>mod_echo</TT></H3><!--SEC END --> <A NAME="sec:modecho"></A> This module acts as a service and simply returns to sender any Jabber packet. Module may be @@ -824,7 +861,7 @@ then prefix <TT>echo.</TT> is added to main <TT>ejabberd</TT> hostname. </DL> <!--TOC subsection <TT>mod_irc</TT>--> -<H3><A NAME="htoc33">A.5</A> <TT>mod_irc</TT></H3><!--SEC END --> +<H3><A NAME="htoc35">A.5</A> <TT>mod_irc</TT></H3><!--SEC END --> <A NAME="sec:modirc"></A> This module implements IRC transport.<BR> @@ -837,7 +874,7 @@ then prefix <TT>irc.</TT> is added to main <TT>ejabberd</TT> hostname. </DL> <!--TOC subsection <TT>mod_last</TT>--> -<H3><A NAME="htoc34">A.6</A> <TT>mod_last</TT></H3><!--SEC END --> +<H3><A NAME="htoc36">A.6</A> <TT>mod_last</TT></H3><!--SEC END --> <A NAME="sec:modlast"></A> This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0012.html">JEP-0012</A> (Last Activity)<BR> @@ -849,7 +886,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_muc</TT>--> -<H3><A NAME="htoc35">A.7</A> <TT>mod_muc</TT></H3><!--SEC END --> +<H3><A NAME="htoc37">A.7</A> <TT>mod_muc</TT></H3><!--SEC END --> <A NAME="sec:modmuc"></A> This module implements <A HREF="http://www.jabber.org/jeps/jep-0045.html">JEP-0045</A> (Multi-User Chat) service.<BR> @@ -884,14 +921,14 @@ Example: </PRE> <!--TOC subsection <TT>mod_offline</TT>--> -<H3><A NAME="htoc36">A.8</A> <TT>mod_offline</TT></H3><!--SEC END --> +<H3><A NAME="htoc38">A.8</A> <TT>mod_offline</TT></H3><!--SEC END --> <A NAME="sec:modoffline"></A> This module implements offline message storage.<BR> <BR> <!--TOC subsection <TT>mod_privacy</TT>--> -<H3><A NAME="htoc37">A.9</A> <TT>mod_privacy</TT></H3><!--SEC END --> +<H3><A NAME="htoc39">A.9</A> <TT>mod_privacy</TT></H3><!--SEC END --> <A NAME="sec:modprivacy"></A> This module implements Privacy Rules as defined in XMPP IM @@ -904,7 +941,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_private</TT>--> -<H3><A NAME="htoc38">A.10</A> <TT>mod_private</TT></H3><!--SEC END --> +<H3><A NAME="htoc40">A.10</A> <TT>mod_private</TT></H3><!--SEC END --> <A NAME="sec:modprivate"></A> This module adds support of <A HREF="http://www.jabber.org/jeps/jep-0049.html">JEP-0049</A> (Private XML Storage).<BR> @@ -916,7 +953,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_pubsub</TT>--> -<H3><A NAME="htoc39">A.11</A> <TT>mod_pubsub</TT></H3><!--SEC END --> +<H3><A NAME="htoc41">A.11</A> <TT>mod_pubsub</TT></H3><!--SEC END --> <A NAME="sec:modpubsub"></A> This module implements <A HREF="http://www.jabber.org/jeps/jep-0060.html">JEP-0060</A> (Publish-Subscribe Service).<BR> @@ -941,7 +978,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_register</TT>--> -<H3><A NAME="htoc40">A.12</A> <TT>mod_register</TT></H3><!--SEC END --> +<H3><A NAME="htoc42">A.12</A> <TT>mod_register</TT></H3><!--SEC END --> <A NAME="sec:modregister"></A> This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</A> (In-Band Registration). @@ -973,7 +1010,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_roster</TT>--> -<H3><A NAME="htoc41">A.13</A> <TT>mod_roster</TT></H3><!--SEC END --> +<H3><A NAME="htoc43">A.13</A> <TT>mod_roster</TT></H3><!--SEC END --> <A NAME="sec:modroster"></A> This module implements roster management.<BR> @@ -985,7 +1022,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_stats</TT>--> -<H3><A NAME="htoc42">A.14</A> <TT>mod_stats</TT></H3><!--SEC END --> +<H3><A NAME="htoc44">A.14</A> <TT>mod_stats</TT></H3><!--SEC END --> <A NAME="sec:modstats"></A> This module adds support for <A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A> (Statistics Gathering).<BR> @@ -999,7 +1036,7 @@ TBD about access.<BR> <BR> <!--TOC subsection <TT>mod_time</TT>--> -<H3><A NAME="htoc43">A.15</A> <TT>mod_time</TT></H3><!--SEC END --> +<H3><A NAME="htoc45">A.15</A> <TT>mod_time</TT></H3><!--SEC END --> <A NAME="sec:modtime"></A> This module answers UTC time on <TT>jabber:iq:time</TT> queries.<BR> @@ -1011,7 +1048,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC subsection <TT>mod_vcard</TT>--> -<H3><A NAME="htoc44">A.16</A> <TT>mod_vcard</TT></H3><!--SEC END --> +<H3><A NAME="htoc46">A.16</A> <TT>mod_vcard</TT></H3><!--SEC END --> <A NAME="sec:modvcard"></A> This module implements simple Jabber User Directory (based on user vCards) @@ -1039,7 +1076,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_version</TT>--> -<H3><A NAME="htoc45">A.17</A> <TT>mod_version</TT></H3><!--SEC END --> +<H3><A NAME="htoc47">A.17</A> <TT>mod_version</TT></H3><!--SEC END --> <A NAME="sec:modversion"></A> This module answers <TT>ejabberd</TT> version on <TT>jabber:iq:version</TT> queries.<BR> @@ -1051,7 +1088,7 @@ discipline (see <A HREF="#sec:modiqdiscoption">A.1.1</A>). </DL> <!--TOC section I18n/L10n--> -<H2><A NAME="htoc46">B</A> I18n/L10n</H2><!--SEC END --> +<H2><A NAME="htoc48">B</A> I18n/L10n</H2><!--SEC END --> <A NAME="sec:i18nl10n"></A> All built-in modules support <TT>xml:lang</TT> attribute inside IQ queries. diff --git a/doc/guide.tex b/doc/guide.tex index 1752a8606..540091a8b 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -626,6 +626,9 @@ Example: \subsection{Online Configuration and Monitoring} \label{sec:onlineconfig} +\subsubsection{Web-based Administration Interface} +\label{sec:webadm} + To perform online reconfiguration of \ejabberd{} you need to enable \term{ejabberd\_http} listener with option \term{web\_admin} (see section~\ref{sec:configlistened}). After that you can open URL @@ -654,6 +657,34 @@ Here you can edit access restrictions, manage users, create backup files, manage DB, enable/disable listened ports, and view statistics. +\subsubsection{\term{ejabberdctl} tool} +\label{sec:ejabberdctl} + +It is possible to do some administration operations using \term{ejabberdctl} +command-line tool. You can check available options running this command +without arguments: +\begin{verbatim} +% ejabberdctl +Usage: ejabberdctl node command + +Available commands: + stop stop ejabberd + restart restart ejabberd + reopen-log reopen log file + register user password register a user + unregister user unregister a user + backup file store a database backup in file + restore file restore a database backup from file + install-fallback file install a database fallback from file + dump file dump a database in a text file + load file restore a database from a text file + registered-users list all registered users + +Example: + ejabberdctl ejabberd@host restart +\end{verbatim} + + \section{Distribution} \label{sec:distribution} |