* doc/guide.tex: Improve explanation of how to start ejabberd when
binary installer. Don't recommend R12 in Windows compilation. Describe what happens if maxrate shaper is exceeded. * doc/guide.html: Likewise SVN Revision: 1238
This commit is contained in:
parent
4cef493b91
commit
694baba127
|
@ -1,3 +1,10 @@
|
||||||
|
2008-03-20 Badlop <badlop@process-one.net>
|
||||||
|
|
||||||
|
* doc/guide.tex: Improve explanation of how to start ejabberd when
|
||||||
|
binary installer. Don't recommend R12 in Windows compilation.
|
||||||
|
Describe what happens if maxrate shaper is exceeded.
|
||||||
|
* doc/guide.html: Likewise
|
||||||
|
|
||||||
2008-03-20 Mickael Remond <mremond@process-one.net>
|
2008-03-20 Mickael Remond <mremond@process-one.net>
|
||||||
|
|
||||||
* src/eldap.erl: Improved logging. We now use ejabberd logging
|
* src/eldap.erl: Improved logging. We now use ejabberd logging
|
||||||
|
|
|
@ -299,14 +299,17 @@ are available in the Process-one <TT>ejabberd</TT> downloads page:
|
||||||
server and does not require any extra dependencies.</P><P>In *nix systems, remember to set executable the binary installer before starting it. For example:
|
server and does not require any extra dependencies.</P><P>In *nix systems, remember to set executable the binary installer before starting it. For example:
|
||||||
</P><PRE CLASS="verbatim"> chmod +x ejabberd-2.0.0_1-linux-x86-installer.bin
|
</P><PRE CLASS="verbatim"> chmod +x ejabberd-2.0.0_1-linux-x86-installer.bin
|
||||||
./ejabberd-2.0.0_1-linux-x86-installer.bin
|
./ejabberd-2.0.0_1-linux-x86-installer.bin
|
||||||
</PRE><P>The installer generates desktop shortcuts to start and stop ejabberd.</P><P>The Windows installer also adds ejabberd as a system service,
|
</PRE><P><TT>ejabberd</TT> can be started manually at any time,
|
||||||
|
or automatically by the operating system at system boot time.</P><P>To start and stop <TT>ejabberd</TT> manually,
|
||||||
|
use the desktop shortcuts created by the installer.
|
||||||
|
If the machine doesn’t have a graphical system, use the scripts ’start’
|
||||||
|
and ’stop’ in the ’bin’ directory where <TT>ejabberd</TT> is installed.</P><P>The Windows installer also adds ejabberd as a system service,
|
||||||
and a shortcut to a debug console for experienced administrators.
|
and a shortcut to a debug console for experienced administrators.
|
||||||
You can start ejabberd using the shortcut or the Windows service.
|
|
||||||
Note that the Windows service is a feature still in development,
|
|
||||||
and for example it doesn’t keep track of changes made manually in ejabberdctl.cfg.
|
|
||||||
If you want ejabberd to be started automatically at boot time,
|
If you want ejabberd to be started automatically at boot time,
|
||||||
go to the Windows service settings and set ejabberd to be automatic started.</P><P>On a Linux system, if you want ejabberd to start as daemon at boot time,
|
go to the Windows service settings and set ejabberd to be automatically started.
|
||||||
copy <TT>ejabberd.init</TT> from the bin directory to something like <TT>/etc/init.d/ejabberd</TT>
|
Note that the Windows service is a feature still in development,
|
||||||
|
and for example it doesn’t read the file ejabberdctl.cfg.</P><P>On a *nix system, if you want ejabberd to be started as daemon at boot time,
|
||||||
|
copy <TT>ejabberd.init</TT> from the ’bin’ directory to something like <TT>/etc/init.d/ejabberd</TT>
|
||||||
(depending on your distribution) and call <TT>/etc/inid.d/ejabberd start</TT> to start it.</P><P>The <TT>ejabberdctl</TT> administration script is included in the <TT>bin</TT> directory.
|
(depending on your distribution) and call <TT>/etc/inid.d/ejabberd start</TT> to start it.</P><P>The <TT>ejabberdctl</TT> administration script is included in the <TT>bin</TT> directory.
|
||||||
Please refer to the section <A HREF="#ejabberdctl">4.1</A> for details about <TT>ejabberdctl</TT>,
|
Please refer to the section <A HREF="#ejabberdctl">4.1</A> for details about <TT>ejabberdctl</TT>,
|
||||||
and configurable options to fine tune the Erlang runtime system.</P><!--TOC section Installing <TT>ejabberd</TT> with Operating System specific packages-->
|
and configurable options to fine tune the Erlang runtime system.</P><!--TOC section Installing <TT>ejabberd</TT> with Operating System specific packages-->
|
||||||
|
@ -423,7 +426,7 @@ and configurable options to fine tune the Erlang runtime system.</P><!--TOC subs
|
||||||
<A NAME="windowsreq"></A></P><P>To compile <TT>ejabberd</TT> on a Microsoft Windows system, you need:
|
<A NAME="windowsreq"></A></P><P>To compile <TT>ejabberd</TT> on a Microsoft Windows system, you need:
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
MS Visual C++ 6.0 Compiler
|
MS Visual C++ 6.0 Compiler
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://erlang.org/download.html">Erlang/OTP R11B-5 or higher</A>
|
</LI><LI CLASS="li-itemize"><A HREF="http://erlang.org/download.html">Erlang/OTP R11B-5</A>
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 2.0.0 or higher</A>
|
</LI><LI CLASS="li-itemize"><A HREF="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 2.0.0 or higher</A>
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.gnu.org/software/libiconv/">GNU Iconv 1.9.2</A>
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.gnu.org/software/libiconv/">GNU Iconv 1.9.2</A>
|
||||||
(optional)
|
(optional)
|
||||||
|
@ -1055,7 +1058,9 @@ shapers is like this:
|
||||||
following syntax:
|
following syntax:
|
||||||
</P><PRE CLASS="verbatim"> {maxrate, <rate>}
|
</P><PRE CLASS="verbatim"> {maxrate, <rate>}
|
||||||
</PRE><P>where <TT><rate></TT> stands for the maximum allowed incoming rate in bytes per
|
</PRE><P>where <TT><rate></TT> stands for the maximum allowed incoming rate in bytes per
|
||||||
second.</P><P>Examples:
|
second.
|
||||||
|
When a connection exceeds this limit, <TT>ejabberd</TT> stops reading from the socket
|
||||||
|
until the average rate is again below the allowed maximum.</P><P>Examples:
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
To define a shaper named ‘<TT>normal</TT>’ with traffic speed limited to
|
To define a shaper named ‘<TT>normal</TT>’ with traffic speed limited to
|
||||||
1,000 bytes/second:
|
1,000 bytes/second:
|
||||||
|
|
|
@ -199,18 +199,23 @@ In *nix systems, remember to set executable the binary installer before starting
|
||||||
./ejabberd-2.0.0_1-linux-x86-installer.bin
|
./ejabberd-2.0.0_1-linux-x86-installer.bin
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
The installer generates desktop shortcuts to start and stop ejabberd.
|
\ejabberd{} can be started manually at any time,
|
||||||
|
or automatically by the operating system at system boot time.
|
||||||
|
|
||||||
|
To start and stop \ejabberd{} manually,
|
||||||
|
use the desktop shortcuts created by the installer.
|
||||||
|
If the machine doesn't have a graphical system, use the scripts 'start'
|
||||||
|
and 'stop' in the 'bin' directory where \ejabberd{} is installed.
|
||||||
|
|
||||||
The Windows installer also adds ejabberd as a system service,
|
The Windows installer also adds ejabberd as a system service,
|
||||||
and a shortcut to a debug console for experienced administrators.
|
and a shortcut to a debug console for experienced administrators.
|
||||||
You can start ejabberd using the shortcut or the Windows service.
|
|
||||||
Note that the Windows service is a feature still in development,
|
|
||||||
and for example it doesn't keep track of changes made manually in ejabberdctl.cfg.
|
|
||||||
If you want ejabberd to be started automatically at boot time,
|
If you want ejabberd to be started automatically at boot time,
|
||||||
go to the Windows service settings and set ejabberd to be automatic started.
|
go to the Windows service settings and set ejabberd to be automatically started.
|
||||||
|
Note that the Windows service is a feature still in development,
|
||||||
|
and for example it doesn't read the file ejabberdctl.cfg.
|
||||||
|
|
||||||
On a Linux system, if you want ejabberd to start as daemon at boot time,
|
On a *nix system, if you want ejabberd to be started as daemon at boot time,
|
||||||
copy \term{ejabberd.init} from the bin directory to something like \term{/etc/init.d/ejabberd}
|
copy \term{ejabberd.init} from the 'bin' directory to something like \term{/etc/init.d/ejabberd}
|
||||||
(depending on your distribution) and call \term{/etc/inid.d/ejabberd start} to start it.
|
(depending on your distribution) and call \term{/etc/inid.d/ejabberd start} to start it.
|
||||||
|
|
||||||
The \term{ejabberdctl} administration script is included in the \term{bin} directory.
|
The \term{ejabberdctl} administration script is included in the \term{bin} directory.
|
||||||
|
@ -394,7 +399,7 @@ The command to compile \ejabberd{} in BSD systems is:
|
||||||
To compile \ejabberd{} on a Microsoft Windows system, you need:
|
To compile \ejabberd{} on a Microsoft Windows system, you need:
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
\item MS Visual C++ 6.0 Compiler
|
\item MS Visual C++ 6.0 Compiler
|
||||||
\item \footahref{http://erlang.org/download.html}{Erlang/OTP R11B-5 or higher}
|
\item \footahref{http://erlang.org/download.html}{Erlang/OTP R11B-5}
|
||||||
\item \footahref{http://sourceforge.net/project/showfiles.php?group\_id=10127\&package\_id=11277}{Expat 2.0.0 or higher}
|
\item \footahref{http://sourceforge.net/project/showfiles.php?group\_id=10127\&package\_id=11277}{Expat 2.0.0 or higher}
|
||||||
\item
|
\item
|
||||||
\footahref{http://www.gnu.org/software/libiconv/}{GNU Iconv 1.9.2}
|
\footahref{http://www.gnu.org/software/libiconv/}{GNU Iconv 1.9.2}
|
||||||
|
@ -1235,6 +1240,8 @@ following syntax:
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
where \term{<rate>} stands for the maximum allowed incoming rate in bytes per
|
where \term{<rate>} stands for the maximum allowed incoming rate in bytes per
|
||||||
second.
|
second.
|
||||||
|
When a connection exceeds this limit, \ejabberd{} stops reading from the socket
|
||||||
|
until the average rate is again below the allowed maximum.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
|
|
Loading…
Reference in New Issue