From 983022438ecd6e1e7f63207af1fb84842a76643b Mon Sep 17 00:00:00 2001 From: Badlop Date: Sat, 12 Jul 2008 21:32:45 +0000 Subject: * src/configure.ac: Improve legibility * src/aclocal.m4: Likewise * src/configure: Likewise * src/ejabberdctl.template: Remove garbage variable. Document node option * doc/guide.tex: Add references to sections. * doc/guide.html: Likewise SVN Revision: 1438 --- doc/guide.html | 14 ++++++++------ doc/guide.tex | 13 ++++++++----- 2 files changed, 16 insertions(+), 11 deletions(-) (limited to 'doc') diff --git a/doc/guide.html b/doc/guide.html index d1841a4c..a3963637 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -333,14 +333,14 @@ Alternatively, the latest development version can be retrieved from the Subversi

To compile ejabberd execute the commands: 

./configure
 make
-

The build configuration script provides several parameters. +

The build configuration script allows several options. To get the full list run the command: 

./configure --help

Some options that you may be interested in modifying:

--prefix=/
Specify the path prefix where the files will be copied when running the make install command.

--enable-pam
- Enable the PAM authentication method.

--enable-odbc or --enable-mssql
+ Enable the PAM authentication method (see section 3.1.4).

--enable-odbc or --enable-mssql
Required if you want to use an external database. See section 3.2 for more information.

--enable-full-xml
Enable the use of XML based optimisations. @@ -351,7 +351,8 @@ To get the full list run the command:

2.4.4  Install

To install ejabberd in the destination directories, run the command: 

make install
-

Note that you may need to have administrative privileges in the system.

The files and directories created are, by default: +

Note that you probably need administrative privileges in the system +to install ejabberd.

The files and directories created are, by default:

/etc/ejabberd/
Configuration files:
@@ -359,7 +360,7 @@ To get the full list run the command:
ejabberdctl.cfg
Configuration file of the administration script
inetrc
Network DNS configuration
-
/sbin/ejabberdctl
Administration script +
/sbin/ejabberdctl
Administration script (see section 4.1)
/var/lib/ejabberd/
.erlang.cookie
Erlang cookie file (see section 5.3) @@ -367,7 +368,8 @@ To get the full list run the command:
ebin
Binary Erlang files (*.beam)
priv
- lib
Binary system libraries (*.so) + bin
Binary C programs +
lib
Binary system libraries (*.so)
msgs
Translated strings (*.msgs)
@@ -939,7 +941,7 @@ for more information.

Though it is quite easy to set up PAM support in ejabberd, PAM itself introduces some security issues:

  • To perform PAM authentication ejabberd uses external C-program called -epam. By default, it is located in /var/lib/ejabberd/priv/lib/ +epam. By default, it is located in /var/lib/ejabberd/priv/bin/ directory. You have to set it root on execution in the case when your PAM module requires root privileges (pam_unix.so for example). Also you have to grant access for ejabberd to this file and remove all other permissions from it. diff --git a/doc/guide.tex b/doc/guide.tex index 49e40400..b5dbc41d 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -313,7 +313,7 @@ To compile \ejabberd{} execute the commands: make \end{verbatim} -The build configuration script provides several parameters. +The build configuration script allows several options. To get the full list run the command: \begin{verbatim} ./configure --help @@ -325,7 +325,7 @@ Some options that you may be interested in modifying: Specify the path prefix where the files will be copied when running the make install command. \titem{--enable-pam} - Enable the PAM authentication method. + Enable the PAM authentication method (see section \ref{pam}). \titem{--enable-odbc or --enable-mssql} Required if you want to use an external database. @@ -348,7 +348,8 @@ To install \ejabberd{} in the destination directories, run the command: \begin{verbatim} make install \end{verbatim} -Note that you may need to have administrative privileges in the system. +Note that you probably need administrative privileges in the system +to install \term{ejabberd}. The files and directories created are, by default: \begin{description} @@ -358,7 +359,7 @@ The files and directories created are, by default: \titem{ejabberdctl.cfg} Configuration file of the administration script \titem{inetrc} Network DNS configuration \end{description} - \titem{/sbin/ejabberdctl} Administration script + \titem{/sbin/ejabberdctl} Administration script (see section~\ref{ejabberdctl}) \titem{/var/lib/ejabberd/} \begin{description} \titem{.erlang.cookie} Erlang cookie file (see section \ref{cookie}) @@ -366,6 +367,7 @@ The files and directories created are, by default: \titem{ebin} Binary Erlang files (*.beam) \titem{priv} \begin{description} + \titem{bin} Binary C programs \titem{lib} Binary system libraries (*.so) \titem{msgs} Translated strings (*.msgs) \end{description} @@ -393,6 +395,7 @@ ejabberd is running 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. @@ -1117,7 +1120,7 @@ security issues: \begin{itemize} \item To perform PAM authentication \ejabberd{} uses external C-program called -\term{epam}. By default, it is located in \verb|/var/lib/ejabberd/priv/lib/| +\term{epam}. By default, it is located in \verb|/var/lib/ejabberd/priv/bin/| directory. You have to set it root on execution in the case when your PAM module requires root privileges (\term{pam\_unix.so} for example). Also you have to grant access for \ejabberd{} to this file and remove all other permissions from it. -- cgit v1.2.3