From: Christophe Romain Date: Thu, 20 Dec 2007 09:29:30 +0000 (+0000) Subject: Explain how to launch installer and improve ejabberdctl usage example (EJAB-420) X-Git-Tag: v2.0.0~86 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=027adc6c38d33ad360e7377d6da440de342cfe0a;p=ejabberd Explain how to launch installer and improve ejabberdctl usage example (EJAB-420) SVN Revision: 1084 --- diff --git a/ChangeLog b/ChangeLog index 1eacb42c6..bc29c9e09 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2007-12-20 Christophe Romain + + * doc/guide.tex: Explain how to launch installer and improve + ejabberdctl usage example (EJAB-420) + * doc/guide.html: Likewise + 2007-12-20 Badlop * src/msgs/zh.msg: Small update (thanks to Shelley Shyan) diff --git a/doc/guide.html b/doc/guide.html index 1a789f776..d8e901237 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -140,7 +140,7 @@ SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
  • 3.1.1  Host Names
  • 3.1.2  Virtual Hosting -
  • 3.1.3  Listened Sockets +
  • 3.1.3  Listening Ports
  • 3.1.4  Authentication
  • 3.1.5  Access Rules
  • 3.1.6  Shapers @@ -294,7 +294,11 @@ Compressing XML streams with Stream Compression (downloads page.

    The installer will deploy and configure a full featured ejabberd -server and does not require any extra dependencies.

    +server and does not require any extra dependencies.

    The installer must be set executable and started. Example: +

      wget http://www.process-one.net/downloads/ejabberd/1.1.4/ejabberd-1.1.4_2-linux-x86-installer.bin
+  chmod +x ejabberd-1.1.4_2-linux-x86-installer.bin
+  ./ejabberd-1.1.4_2-linux-x86-installer.bin
+

    2.2  Installing ejabberd with Operating System specific packages

    Some Operating Systems provide a specific ejabberd package adapted to your system architecture and libraries, which also checks dependencies and performs basic configuration tasks like creating the initial @@ -381,18 +385,21 @@ To get the full list run the command:

    2.4.5  Start

    You can use the ejabberdctl command line administration script to start and stop ejabberd. -You must execute this program with root access. For example: -

    $ sudo ejabberdctl start
+This script is located into tools directory of sources archive. If you installed ejabberd from sources,
+ejabberdctl is located into destination sbin directory (default /usr/local/sbin). If you installed
+ejabberd with the installer, ejabberdctl is located into ejabberd’s bin directory.
    Usage example:
+
    $ ejabberdctl start
 
-$ sudo ejabberdctl status
+$ ejabberdctl status
 Node ejabberd@localhost is started. Status: started
 ejabberd is running
 
-$ sudo ejabberdctl stop
-
-$      
+$ ejabberdctl stop
 
    Please refer to the section 4.1 for details about ejabberdctl,
-and configurable options to fine tune the Erlang runtime system.
    
+and configurable options to fine tune the Erlang runtime system.
    Note: if you installed ejabberd with your distribution packaging system, ejabberdctl should be called
+by an /etc/init.d/ejabberd script to allow you to start and stop ejabberd as a service at boot time.
    If you installed ejabberd using CEAN package, you will have to create your own ejabberd start
+script depending of how you handle your CEAN installation. The default ejabberdctl script is located
+into ejabberd’s priv directory and can be used as an example.
    
 
    2.4.6  Specific Notes for BSD
    
 
 
    The command to compile ejabberd in BSD systems is:
@@ -564,8 +571,8 @@ instead of defining each option with the syntax
 {host_config, "two.example.org", [{{add, modules}, [
   {mod_echo,       [{host, "mirror.two.example.org"}]}
 ]}]}.
-
-

3.1.3  Listened Sockets

+ +

3.1.3  Listening Ports

The option listen defines for which addresses and ports ejabberd will listen and what services will be run on them. Each element of the list is a @@ -580,7 +587,7 @@ The available modules, their purpose and the options allowed by each one are: - + + @@ -1497,6 +1501,7 @@ Last connection date and time: Use mod_last_odbc instead of
  • Rosters: Use mod_roster_odbc instead of mod_roster.
  • Users’ VCARD: Use mod_vcard_odbc instead of mod_vcard.
  • Private XML storage: Use mod_private_odbc instead of mod_private. +
  • User rules for blocking communications: Use mod_privacy_odbc instead of mod_privacy.

    • You can find more contributed modules on the ejabberd website. Please remember that these contributions might not work or @@ -2282,7 +2287,10 @@ To log all end user packets to the Bandersnatch service running on create groups of people that can see members from (other) groups in their rosters. The big advantages of this feature are that end users do not need to manually add all users to their rosters, and that they cannot permanently delete -users from the shared roster groups.

    Shared roster groups can be edited only via the web interface. Each group +users from the shared roster groups. +A shared roster group can have members from any Jabber server, +but the presence will only be available from and to members +of the same virtual host where the group is created.

    Shared roster groups can be edited only via the web interface. Each group has a unique identification and the following parameters:

    Name
    The name of the group, which will be displayed in the roster. @@ -2290,6 +2298,9 @@ has a unique identification and the following parameters: anything.
    Members
    A list of full JIDs of group members, entered one per line in the web interface. +To put as members all the registered users in the virtual hosts, +you can use the special directive: @all@. +Note that this directive is designed for a small server with just a few hundred users.
    Displayed groups
    A list of groups that will be in the rosters of this group’s members.

    Examples: diff --git a/doc/guide.tex b/doc/guide.tex index 75b189547..57d2249c6 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -191,6 +191,13 @@ ejabberd Process-one The installer will deploy and configure a full featured ejabberd server and does not require any extra dependencies. +The installer must be set executable and started. Example: +\begin{verbatim} + wget http://www.process-one.net/downloads/ejabberd/1.1.4/ejabberd-1.1.4_2-linux-x86-installer.bin + chmod +x ejabberd-1.1.4_2-linux-x86-installer.bin + ./ejabberd-1.1.4_2-linux-x86-installer.bin +\end{verbatim} + \section{Installing ejabberd with Operating System specific packages} Some Operating Systems provide a specific ejabberd package adapted to @@ -207,7 +214,6 @@ packages from many Erlang programs, including ejabberd and all its dependencies. The binaries are available for many different system architectures, so this is an alternative to the binary installer and Operating System's ejabberd packages. - \section{Installing ejabberd from Source Code} \label{installation} \ind{install} @@ -324,21 +330,29 @@ The files and directories created are, by default: \ind{install!start} You can use the \term{ejabberdctl} command line administration script to start and stop ejabberd. -You must execute this program with root access. For example: +This script is located into tools directory of sources archive. If you installed ejabberd from sources, +\term{ejabberdctl} is located into destination sbin directory (default /usr/local/sbin). If you installed +ejabberd with the installer, \term{ejabberdctl} is located into ejabberd's bin directory. + +Usage example: \begin{verbatim} -$ sudo ejabberdctl start +$ ejabberdctl start -$ sudo ejabberdctl status +$ ejabberdctl status Node ejabberd@localhost is started. Status: started ejabberd is running -$ sudo ejabberdctl stop - -$ +$ ejabberdctl stop \end{verbatim} Please refer to the section~\ref{ejabberdctl} for details about \term{ejabberdctl}, and configurable options to fine tune the Erlang runtime system. +Note: if you installed ejabberd with your distribution packaging system, \term{ejabberdctl} should be called +by an /etc/init.d/ejabberd script to allow you to start and stop ejabberd as a service at boot time. + +If you installed ejabberd using CEAN package, you will have to create your own ejabberd start +script depending of how you handle your CEAN installation. The default \term{ejabberdctl} script is located +into ejabberd's priv directory and can be used as an example. \subsection{Specific Notes for BSD} \label{bsd}

    ejabberd_c2sDescriptionHandles c2s connections.
     Optionsaccess, certfile, inet6, -ip, max_stanza_size, shaper, ssl, +ip, max_stanza_size, shaper, starttls, starttls_required, tls, zlib
    ejabberd_s2s_inDescriptionHandles incoming s2s @@ -641,10 +648,6 @@ use this option: {request_handlers, [{["a", "b"], mod_foo}, {["http-bind"],
    {shaper, <access rule>}
    This option defines a shaper for the port (see section 3.1.6). The default value is none. -
    ssl
    This option specifies that traffic on -the port will be encrypted using SSL. You should also set the -certfile option. It is recommended to use the tls option -instead of this one.
    starttls
    This option specifies that STARTTLS encryption is available on connections to the port. You should also set the certfile option. @@ -1456,7 +1459,8 @@ all entries end with a comma:
    mod_muc_logMulti-User Chat room loggingmod_mucNo
    mod_offlineOffline message storage No
    mod_offline_odbcOffline message storagesupported database (*)No
    mod_privacyBlocking Communication Yes
    mod_privacyBlocking Communications Yes
    mod_privacy_odbcBlocking Communicationssupported database (*)Yes
    mod_privatePrivate XML Storage (XEP-0049) No
    mod_private_odbcPrivate XML Storage (XEP-0049)supported database (*)No
    mod_proxy65SOCKS5 Bytestreams (XEP-0065) No