summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlexey Shchepin <alexey@process-one.net>2004-08-08 19:07:55 +0000
committerAlexey Shchepin <alexey@process-one.net>2004-08-08 19:07:55 +0000
commit357554265e4c86c5cd0dc3b6ae2f69f20c85786b (patch)
tree41219e7fbcccd2f24ca040c8fad8237bdc6e2e8b /doc
parent* src/aclocal.m4: Updated to check for openssl library (thanks to (diff)
* src/ejabberd_c2s.erl: Use resend_offline_messages_hook to fetch
offline messages * src/mod_offline.erl: Likewise * src/mod_offline.erl: Added table locking in remove_old_messages/1 * src/ejabberd_sm.erl: Use offline_message_hook to store offline messages * src/mod_offline.erl: Likewise * src/ejabberd_hooks.erl: Hooks support * src/ejabberd_sup.erl: Added ejabberd_hooks * doc/guide.tex: Updated * src/ejabberd.cfg.example: Updated * src/ejabberd_c2s.erl: Changed TLS options (thanks to Sergei Golovan) SVN Revision: 255
Diffstat (limited to '')
-rw-r--r--doc/guide.html16
-rw-r--r--doc/guide.tex18
2 files changed, 24 insertions, 10 deletions
diff --git a/doc/guide.html b/doc/guide.html
index 2db53425..851bb038 100644
--- a/doc/guide.html
+++ b/doc/guide.html
@@ -142,7 +142,7 @@ Works on most of popular platforms: *nix (tested on Linux, FreeBSD and
The misfeatures of <TT>ejabberd</TT> are:
<UL><LI>
No support for virtual domains
-<LI>No support for STARTTLS
+<LI>No support for authentification and STARTTLS in S2S connections
</UL>
<!--TOC section Installation-->
@@ -164,7 +164,8 @@ To compile <TT>ejabberd</TT>, you will need the following packages:
GNU Make;
<LI>GCC;
<LI>libexpat 1.95 or later;
-<LI>Erlang/OTP R8B or later.
+<LI>Erlang/OTP R8B or later;
+<LI>OpenSSL 0.9.6 or later (optional).
</UL>
<!--TOC subsubsection Windows-->
@@ -473,8 +474,15 @@ The following options are defined:
<DT><B><TT>{ip, IPAddress}</TT></B><DD> This option specifies which network interface to
listen on. For example <CODE>{ip, {192, 168, 1, 1}}</CODE>.
<DT><B><TT>inet6</TT></B><DD> Set up the socket for IPv6.
+ <DT><B><TT>tls</TT></B><DD> This option specifies that STARTTLS extension is available on
+ connections to this port. You should also set ``<CODE>certfile</CODE>'' option.
+ <DT><B><TT>tls_from_start</TT></B><DD> Among with <TT>tls</TT> this option specifies that
+ traffic on this port will be encrypted using SSL immediately after
+ connecting.
<DT><B><TT>ssl</TT></B><DD> This option specifies that traffic on this port will be
- encrypted using SSL. You should also set ``<CODE>certfile</CODE>'' option.
+ encrypted using SSL. You should also set ``<CODE>certfile</CODE>'' option. It
+ is recommended to use <TT>tls</TT> and <TT>tls_from_start</TT> options
+ instead.
<DT><B><TT>{certfile, Path}</TT></B><DD> Path to a file containing the SSL certificate.
</DL>
<DT><B><TT>ejabberd_s2s_in</TT></B><DD> This module serves incoming S2S connections.
@@ -495,7 +503,7 @@ The following additional options are defined for <TT>ejabberd_service</TT>
<BR>
The following options are defined:
<DL COMPACT=compact><DT>
- <B><TT>http_poll</TT></B><DD> This option enables <A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A> .
+ <B><TT>http_poll</TT></B><DD> This option enables <A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A>
support. It is available then at <CODE>http://server:port/http-poll/</CODE>.<BR>
<BR>
<DT><B><TT>web_admin</TT></B><DD> This option enables web-based interface for <TT>ejabberd</TT>
diff --git a/doc/guide.tex b/doc/guide.tex
index 732aec45..dd78dbb9 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -126,7 +126,7 @@ The main features of \ejabberd{} are:
The misfeatures of \ejabberd{} are:
\begin{itemize}
\item No support for virtual domains
-\item No support for STARTTLS
+\item No support for authentification and STARTTLS in S2S connections
\end{itemize}
@@ -144,7 +144,8 @@ To compile \ejabberd{}, you will need the following packages:
\item GNU Make;
\item GCC;
\item libexpat 1.95 or later;
-\item Erlang/OTP R8B or later.
+\item Erlang/OTP R8B or later;
+\item OpenSSL 0.9.6 or later (optional).
\end{itemize}
\subsubsection{Windows}
@@ -285,8 +286,6 @@ But in this case \ejabberd{} can start to work slower.
\subsection{Initial Configuration}
\label{sec:initconfig}
-%\verbatiminput{../src/ejabberd.cfg}
-
The configuration file is initially loaded the first time \ejabberd{} is
executed, when it is parsed and stored in a database. Subsequently the
configuration is loaded from the database and any commands in the configuration
@@ -477,8 +476,15 @@ Currently these modules are implemented:
\titem{\{ip, IPAddress\}} This option specifies which network interface to
listen on. For example \verb|{ip, {192, 168, 1, 1}}|.
\titem{inet6} Set up the socket for IPv6.
+ \titem{starttls} This option specifies that STARTTLS extension is available
+ on connections to this port. You should also set ``\verb|certfile|''
+ option.
+ \titem{tls} This option specifies that traffic on this port will be
+ encrypted using SSL immediately after connecting. You should also set
+ ``\verb|certfile|'' option.
\titem{ssl} This option specifies that traffic on this port will be
- encrypted using SSL. You should also set ``\verb|certfile|'' option.
+ encrypted using SSL. You should also set ``\verb|certfile|'' option. It
+ is recommended to use \term{tls} option instead.
\titem{\{certfile, Path\}} Path to a file containing the SSL certificate.
\end{description}
\titem{ejabberd\_s2s\_in} This module serves incoming S2S connections.
@@ -499,7 +505,7 @@ Currently these modules are implemented:
The following options are defined:
\begin{description}
- \titem{http\_poll} This option enables \tjepref{0025}{HTTP Polling} .
+ \titem{http\_poll} This option enables \tjepref{0025}{HTTP Polling}
support. It is available then at \verb|http://server:port/http-poll/|.
\titem{web\_admin} This option enables web-based interface for \ejabberd{}