diff options
author | Badlop <badlop@process-one.net> | 2008-07-13 19:10:01 +0000 |
---|---|---|
committer | Badlop <badlop@process-one.net> | 2008-07-13 19:10:01 +0000 |
commit | f25316c1e757047e5f535bdf7093943d9c45b15b (patch) | |
tree | c74e292185b3fcfc5b5efafe008033951dbca167 /doc | |
parent | Install ejabberdctl in /sbin as usual because it is a daemon, not a user prog... (diff) |
* src/configure.ac: Update installation permissions (EJAB-402)
* src/configure: Likewise
* src/Makefile.in: The mnesia, ebin and priv dirs are now
installed in different locations. Install header files and
documentation (EJAB-696)
* doc/guide.tex: Likewise
* doc/guide.html: Likewise
* include/*.hrl: Place for all ejabberd header files (EJAB-696)
* src/*/*.erl: Update references to header files
* src/*/Makefile.in: Include the include/ dir
SVN Revision: 1441
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile | 2 | ||||
-rw-r--r-- | doc/guide.html | 35 | ||||
-rw-r--r-- | doc/guide.tex | 35 |
3 files changed, 41 insertions, 31 deletions
diff --git a/doc/Makefile b/doc/Makefile index c1f35fdff..2fda395a0 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -16,7 +16,7 @@ all: release pdf html release: @echo "Notes for the releaser:" @echo "* Do not forget to add a link to the release notes in guide.tex" - @echo "* Do not forget to update the version number in src/ejabberd.hrl!" + @echo "* Do not forget to update the version number in src/ejabberd.app!" @echo "* Do not forget to update the features in introduction.tex (including \new{} and \improved{} tags)." @echo "Press any key to continue" @read foo diff --git a/doc/guide.html b/doc/guide.html index c429714fc..9b655b7b8 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -359,26 +359,31 @@ To get the full list run the command: </PRE><P>Note that you probably need administrative privileges in the system to install <TT>ejabberd</TT>.</P><P>The files and directories created are, by default: </P><DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>/etc/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Configuration files: + <B><TT>/etc/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Configuration directory: <DL CLASS="description"><DT CLASS="dt-description"> <B><TT>ejabberd.cfg</TT></B></DT><DD CLASS="dd-description"> ejabberd configuration file </DD><DT CLASS="dt-description"><B><TT>ejabberdctl.cfg</TT></B></DT><DD CLASS="dd-description"> Configuration file of the administration script - </DD><DT CLASS="dt-description"><B><TT>inetrc</TT></B></DT><DD CLASS="dd-description"> Network DNS configuration + </DD><DT CLASS="dt-description"><B><TT>inetrc</TT></B></DT><DD CLASS="dd-description"> Network DNS configuration file </DD></DL> - </DD><DT CLASS="dt-description"><B><TT>/sbin/ejabberdctl</TT></B></DT><DD CLASS="dd-description"> Administration script (see section <A HREF="#ejabberdctl">4.1</A>) - </DD><DT CLASS="dt-description"><B><TT>/var/lib/ejabberd/</TT></B></DT><DD CLASS="dd-description"> + </DD><DT CLASS="dt-description"><B><TT>/lib/ejabberd/</TT></B></DT><DD CLASS="dd-description"> <DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>.erlang.cookie</TT></B></DT><DD CLASS="dd-description"> Erlang cookie file (see section <A HREF="#cookie">5.3</A>) - </DD><DT CLASS="dt-description"><B><TT>db</TT></B></DT><DD CLASS="dd-description"> Mnesia database spool files - </DD><DT CLASS="dt-description"><B><TT>ebin</TT></B></DT><DD CLASS="dd-description"> Binary Erlang files (*.beam) - </DD><DT CLASS="dt-description"><B><TT>priv</TT></B></DT><DD CLASS="dd-description"> + <B><TT>ebin/</TT></B></DT><DD CLASS="dd-description"> Erlang binary files (*.beam) + </DD><DT CLASS="dt-description"><B><TT>include/</TT></B></DT><DD CLASS="dd-description"> Erlang header files (*.hrl) + </DD><DT CLASS="dt-description"><B><TT>priv/</TT></B></DT><DD CLASS="dd-description"> Additional files required at runtime <DL CLASS="description"><DT CLASS="dt-description"> - <B><TT>bin</TT></B></DT><DD CLASS="dd-description"> Binary C programs - </DD><DT CLASS="dt-description"><B><TT>lib</TT></B></DT><DD CLASS="dd-description"> Binary system libraries (*.so) - </DD><DT CLASS="dt-description"><B><TT>msgs</TT></B></DT><DD CLASS="dd-description"> Translated strings (*.msgs) + <B><TT>bin/</TT></B></DT><DD CLASS="dd-description"> Binary C programs + </DD><DT CLASS="dt-description"><B><TT>lib/</TT></B></DT><DD CLASS="dd-description"> Binary system libraries (*.so) + </DD><DT CLASS="dt-description"><B><TT>msgs/</TT></B></DT><DD CLASS="dd-description"> Translation files (*.msgs) </DD></DL> </DD></DL> - </DD><DT CLASS="dt-description"><B><TT>/var/log/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Log files (see section <A HREF="#logfiles">7.2</A>): + </DD><DT CLASS="dt-description"><B><TT>/sbin/ejabberdctl</TT></B></DT><DD CLASS="dd-description"> Administration script (see section <A HREF="#ejabberdctl">4.1</A>) + </DD><DT CLASS="dt-description"><B><TT>/share/doc/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Documentation of ejabberd + </DD><DT CLASS="dt-description"><B><TT>/var/lib/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Spool directory: + <DL CLASS="description"><DT CLASS="dt-description"> + <B><TT>.erlang.cookie</TT></B></DT><DD CLASS="dd-description"> Erlang cookie file (see section <A HREF="#cookie">5.3</A>) + </DD><DT CLASS="dt-description"><B><TT>acl.DCD, ...</TT></B></DT><DD CLASS="dd-description"> Mnesia database spool files (*.DCD, *.DCL, *.DAT) + </DD></DL> + </DD><DT CLASS="dt-description"><B><TT>/var/log/ejabberd/</TT></B></DT><DD CLASS="dd-description"> Log directory (see section <A HREF="#logfiles">7.2</A>): <DL CLASS="description"><DT CLASS="dt-description"> <B><TT>ejabberd.log</TT></B></DT><DD CLASS="dd-description"> ejabberd service log </DD><DT CLASS="dt-description"><B><TT>sasl.log</TT></B></DT><DD CLASS="dd-description"> Erlang/OTP system log @@ -2904,7 +2909,7 @@ Starts the Erlang system detached from the system console. Specify the directory where Erlang binary files (*.beam) are located. </DD><DT CLASS="dt-description"><B><TT>-s ejabberd</TT></B></DT><DD CLASS="dd-description"> Tell Erlang runtime system to start the <TT>ejabberd</TT> application. -</DD><DT CLASS="dt-description"><B><TT>-mnesia dir "/var/lib/ejabberd/db/nodename"</TT></B></DT><DD CLASS="dd-description"> +</DD><DT CLASS="dt-description"><B><TT>-mnesia dir "/var/lib/ejabberd/"</TT></B></DT><DD CLASS="dd-description"> Specify the Mnesia database directory. </DD><DT CLASS="dt-description"><B><TT>-sasl sasl_error_logger {file, "/var/log/ejabberd/sasl.log"}</TT></B></DT><DD CLASS="dd-description"> Path to the Erlang/OTP system log file. @@ -3074,10 +3079,10 @@ Contains IP addresses of clients. If the loglevel is set to 5, it contains whole conversations and passwords. If a logrotate system is used, there may be several log files with similar information, so it is preferable to secure the whole <TT>/var/log/ejabberd/</TT> directory. -</DD><DT CLASS="dt-description"><B><TT>Mnesia database spool files: /var/lib/ejabberd/db/*</TT></B></DT><DD CLASS="dd-description"> +</DD><DT CLASS="dt-description"><B><TT>Mnesia database spool files in /var/lib/ejabberd/</TT></B></DT><DD CLASS="dd-description"> The files store binary data, but some parts are still readable. The files are generated by Mnesia and their permissions cannot be set directly, -so it is preferable to secure the whole <TT>/var/lib/ejabberd/db/</TT> directory. +so it is preferable to secure the whole <TT>/var/lib/ejabberd/</TT> directory. </DD><DT CLASS="dt-description"><B><TT>Erlang cookie file: /var/lib/ejabberd/.erlang.cookie</TT></B></DT><DD CLASS="dd-description"> See section <A HREF="#cookie">5.3</A>. </DD></DL><P> <A NAME="clustering"></A> </P><!--TOC chapter Clustering--> diff --git a/doc/guide.tex b/doc/guide.tex index faf37104e..7e440ac7c 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -360,26 +360,31 @@ to install \term{ejabberd}. The files and directories created are, by default: \begin{description} - \titem{/etc/ejabberd/} Configuration files: + \titem{/etc/ejabberd/} Configuration directory: \begin{description} \titem{ejabberd.cfg} ejabberd configuration file \titem{ejabberdctl.cfg} Configuration file of the administration script - \titem{inetrc} Network DNS configuration + \titem{inetrc} Network DNS configuration file \end{description} - \titem{/sbin/ejabberdctl} Administration script (see section~\ref{ejabberdctl}) - \titem{/var/lib/ejabberd/} + \titem{/lib/ejabberd/} \begin{description} - \titem{.erlang.cookie} Erlang cookie file (see section \ref{cookie}) - \titem{db} Mnesia database spool files - \titem{ebin} Binary Erlang files (*.beam) - \titem{priv} + \titem{ebin/} Erlang binary files (*.beam) + \titem{include/} Erlang header files (*.hrl) + \titem{priv/} Additional files required at runtime \begin{description} - \titem{bin} Binary C programs - \titem{lib} Binary system libraries (*.so) - \titem{msgs} Translated strings (*.msgs) + \titem{bin/} Binary C programs + \titem{lib/} Binary system libraries (*.so) + \titem{msgs/} Translation files (*.msgs) \end{description} \end{description} - \titem{/var/log/ejabberd/} Log files (see section~\ref{logfiles}): + \titem{/sbin/ejabberdctl} Administration script (see section~\ref{ejabberdctl}) + \titem{/share/doc/ejabberd/} Documentation of ejabberd + \titem{/var/lib/ejabberd/} Spool directory: + \begin{description} + \titem{.erlang.cookie} Erlang cookie file (see section \ref{cookie}) + \titem{acl.DCD, ...} Mnesia database spool files (*.DCD, *.DCL, *.DAT) + \end{description} + \titem{/var/log/ejabberd/} Log directory (see section~\ref{logfiles}): \begin{description} \titem{ejabberd.log} ejabberd service log \titem{sasl.log} Erlang/OTP system log @@ -3720,7 +3725,7 @@ The command line parameters: Specify the directory where Erlang binary files (*.beam) are located. \titem{-s ejabberd} Tell Erlang runtime system to start the \ejabberd{} application. - \titem{-mnesia dir "/var/lib/ejabberd/db/nodename"} + \titem{-mnesia dir "/var/lib/ejabberd/"} Specify the Mnesia database directory. \titem{-sasl sasl\_error\_logger \{file, "/var/log/ejabberd/sasl.log"\}} Path to the Erlang/OTP system log file. @@ -3953,10 +3958,10 @@ write and execute those files and directories. If the loglevel is set to 5, it contains whole conversations and passwords. If a logrotate system is used, there may be several log files with similar information, so it is preferable to secure the whole \term{/var/log/ejabberd/} directory. - \titem{Mnesia database spool files: /var/lib/ejabberd/db/*} + \titem{Mnesia database spool files in /var/lib/ejabberd/} The files store binary data, but some parts are still readable. The files are generated by Mnesia and their permissions cannot be set directly, - so it is preferable to secure the whole \term{/var/lib/ejabberd/db/} directory. + so it is preferable to secure the whole \term{/var/lib/ejabberd/} directory. \titem{Erlang cookie file: /var/lib/ejabberd/.erlang.cookie} See section \ref{cookie}. \end{description} |