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 @@
  • 3.1.6  Modules
  • 3.2  Online Configuration and Monitoring - -
  • 4  Distribution + +
  • 4  Distribution - -
  • A  Built-in Modules +4.1  How it works + +
  • A  Built-in Modules -
  • B  I18n/L10n +
  • B  I18n/L10n @@ -616,6 +620,11 @@ Example:

    3.2  Online Configuration and Monitoring

    + + +

    3.2.1  Web-based Administration Interface

    + + To perform online reconfiguration of ejabberd you need to enable ejabberd_http listener with option web_admin (see section 3.1.5). After that you can open URL @@ -646,14 +655,42 @@ authentification you should see something like in figure 3.2.2  ejabberdctl tool + + +It is possible to do some administration operations using ejabberdctl +command-line tool. You can check available options running this command +without arguments: +
    +% 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
    +
    -

    4  Distribution

    +

    4  Distribution

    -

    4.1  How it works

    +

    4.1  How it works

    A Jabber domain is served by one or more ejabberd nodes. These nodes can @@ -673,7 +710,7 @@ router; -

    4.1.1  Router

    +

    4.1.1  Router

    This module is the main router of Jabber packets on each node. It routes them based on their destinations domains. It has two tables: local and global @@ -685,7 +722,7 @@ manager.

    -

    4.1.2  Local Router

    +

    4.1.2  Local Router

    This module routes packets which have a destination domain equal to this server name. If destination JID has a non-empty user part, then it routed to the @@ -693,7 +730,7 @@ session manager, else it is processed depending on it's content.

    -

    4.1.3  Session Manager

    +

    4.1.3  Session Manager

    This module routes packets to local users. It searches for what user resource packet must be sended via presence table. If this resource is connected to @@ -702,7 +739,7 @@ the packet is sent to session manager on that node.

    -

    4.1.4  S2S Manager

    +

    4.1.4  S2S Manager

    This module routes packets to other Jabber servers. First, it checks if an open S2S connection from the domain of the packet source to the domain of @@ -713,12 +750,12 @@ does not exist, then it is opened and registered.

    -

    A  Built-in Modules

    +

    A  Built-in Modules

    -

    A.1  Common Options

    +

    A.1  Common Options

    The following options are used by many modules, so they are described in @@ -726,7 +763,7 @@ separate section.

    -

    A.1.1  Option iqdisc

    +

    A.1.1  Option iqdisc

    Many modules define handlers for processing IQ queries of different namespaces @@ -759,7 +796,7 @@ Example: -

    A.1.2  Option host

    +

    A.1.2  Option host

    This option explicitly defines hostname for the module which acts as a service.
    @@ -775,7 +812,7 @@ Example: -

    A.2  mod_configure

    +

    A.2  mod_configure

    Options: @@ -785,7 +822,7 @@ discipline (see A.1.1). -

    A.3  mod_disco

    +

    A.3  mod_disco

    This module adds support for JEP-0030 (Service Discovery).
    @@ -810,7 +847,7 @@ Example: -

    A.4  mod_echo

    +

    A.4  mod_echo

    This module acts as a service and simply returns to sender any Jabber packet. Module may be @@ -824,7 +861,7 @@ then prefix echo. is added to main ejabberd hostname. -

    A.5  mod_irc

    +

    A.5  mod_irc

    This module implements IRC transport.
    @@ -837,7 +874,7 @@ then prefix irc. is added to main ejabberd hostname. -

    A.6  mod_last

    +

    A.6  mod_last

    This module adds support for JEP-0012 (Last Activity)
    @@ -849,7 +886,7 @@ discipline (see A.1.1). -

    A.7  mod_muc

    +

    A.7  mod_muc

    This module implements JEP-0045 (Multi-User Chat) service.
    @@ -884,14 +921,14 @@ Example: -

    A.8  mod_offline

    +

    A.8  mod_offline

    This module implements offline message storage.

    -

    A.9  mod_privacy

    +

    A.9  mod_privacy

    This module implements Privacy Rules as defined in XMPP IM @@ -904,7 +941,7 @@ discipline (see A.1.1). -

    A.10  mod_private

    +

    A.10  mod_private

    This module adds support of JEP-0049 (Private XML Storage).
    @@ -916,7 +953,7 @@ discipline (see A.1.1). -

    A.11  mod_pubsub

    +

    A.11  mod_pubsub

    This module implements JEP-0060 (Publish-Subscribe Service).
    @@ -941,7 +978,7 @@ Example: -

    A.12  mod_register

    +

    A.12  mod_register

    This module adds support for JEP-0077 (In-Band Registration). @@ -973,7 +1010,7 @@ Example: -

    A.13  mod_roster

    +

    A.13  mod_roster

    This module implements roster management.
    @@ -985,7 +1022,7 @@ discipline (see A.1.1). -

    A.14  mod_stats

    +

    A.14  mod_stats

    This module adds support for JEP-0039 (Statistics Gathering).
    @@ -999,7 +1036,7 @@ TBD about access.

    -

    A.15  mod_time

    +

    A.15  mod_time

    This module answers UTC time on jabber:iq:time queries.
    @@ -1011,7 +1048,7 @@ discipline (see A.1.1). -

    A.16  mod_vcard

    +

    A.16  mod_vcard

    This module implements simple Jabber User Directory (based on user vCards) @@ -1039,7 +1076,7 @@ Example: -

    A.17  mod_version

    +

    A.17  mod_version

    This module answers ejabberd version on jabber:iq:version queries.
    @@ -1051,7 +1088,7 @@ discipline (see A.1.1). -

    B  I18n/L10n

    +

    B  I18n/L10n

    All built-in modules support xml:lang 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}