mirror of
https://github.com/processone/ejabberd.git
synced 2024-12-02 16:37:52 +01:00
* doc/guide.tex: Require OpenSSL 0.9.8f or higher (EJAB-877)
* doc/guide.html: Likewise SVN Revision: 1967
This commit is contained in:
parent
5374c0b069
commit
3454f2fe04
@ -1,3 +1,8 @@
|
|||||||
|
2009-03-05 Badlop <badlop@process-one.net>
|
||||||
|
|
||||||
|
* doc/guide.tex: Require OpenSSL 0.9.8f or higher (EJAB-877)
|
||||||
|
* doc/guide.html: Likewise
|
||||||
|
|
||||||
2009-03-04 Badlop <badlop@process-one.net>
|
2009-03-04 Badlop <badlop@process-one.net>
|
||||||
|
|
||||||
* src/ejabberd_auth.erl: If anonymous auth is enabled, when
|
* src/ejabberd_auth.erl: If anonymous auth is enabled, when
|
||||||
|
@ -329,7 +329,7 @@ GNU Make
|
|||||||
</LI><LI CLASS="li-itemize">GCC
|
</LI><LI CLASS="li-itemize">GCC
|
||||||
</LI><LI CLASS="li-itemize">Libexpat 1.95 or higher
|
</LI><LI CLASS="li-itemize">Libexpat 1.95 or higher
|
||||||
</LI><LI CLASS="li-itemize">Erlang/OTP R10B-9 or higher.
|
</LI><LI CLASS="li-itemize">Erlang/OTP R10B-9 or higher.
|
||||||
</LI><LI CLASS="li-itemize">OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
|
</LI><LI CLASS="li-itemize">OpenSSL 0.9.8f or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
|
||||||
</LI><LI CLASS="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Optional.
|
</LI><LI CLASS="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Optional.
|
||||||
</LI><LI CLASS="li-itemize">Erlang mysql library. Optional. For MySQL authentication or storage. See section <A HREF="#compilemysql">3.2.1</A>.
|
</LI><LI CLASS="li-itemize">Erlang mysql library. Optional. For MySQL authentication or storage. See section <A HREF="#compilemysql">3.2.1</A>.
|
||||||
</LI><LI CLASS="li-itemize">Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section <A HREF="#compilepgsql">3.2.3</A>.
|
</LI><LI CLASS="li-itemize">Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section <A HREF="#compilepgsql">3.2.3</A>.
|
||||||
@ -436,7 +436,7 @@ MS Visual C++ 6.0 Compiler
|
|||||||
</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)
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL 0.9.8d or higher</A>
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL 0.9.8f or higher</A>
|
||||||
(to enable SSL connections)
|
(to enable SSL connections)
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.zlib.net/">Zlib 1.2.3 or higher</A>
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.zlib.net/">Zlib 1.2.3 or higher</A>
|
||||||
</LI></UL><P> <A NAME="windowscom"></A> </P><!--TOC subsubsection Compilation-->
|
</LI></UL><P> <A NAME="windowscom"></A> </P><!--TOC subsubsection Compilation-->
|
||||||
@ -1119,101 +1119,10 @@ To define a shaper named ‘<TT>normal</TT>’ with traffic speed limi
|
|||||||
can be seen by Jabber clients. If a Jabber client do not support
|
can be seen by Jabber clients. If a Jabber client do not support
|
||||||
<TT>xml:lang</TT>, the specified language is used. The default value is
|
<TT>xml:lang</TT>, the specified language is used. The default value is
|
||||||
<TT>en</TT>. In order to take effect there must be a translation file
|
<TT>en</TT>. In order to take effect there must be a translation file
|
||||||
<<<<<<< HEAD:doc/guide.html
|
|
||||||
<TT><language>.msg</TT> in <TT>ejabberd</TT>’s <TT>msgs</TT> directory.</P><P>Examples:
|
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
|
||||||
To set Russian as default language:
|
|
||||||
<PRE CLASS="verbatim">{language, "ru"}.
|
|
||||||
</PRE></LI><LI CLASS="li-itemize">To set Spanish as default language:
|
|
||||||
<PRE CLASS="verbatim">{language, "es"}.
|
|
||||||
</PRE></LI></UL><P> <A NAME="database"></A> </P><!--TOC section Database and LDAP Configuration-->
|
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc28">3.2</A>  <A HREF="#database">Database and LDAP Configuration</A></H2><!--SEC END --><P> <A NAME="database"></A>
|
|
||||||
=======
|
|
||||||
<TT><language>.msg</TT> in <TT>ejabberd</TT>’s <TT>msgs</TT> directory.</P><P>For example, to set Russian as default language:
|
<TT><language>.msg</TT> in <TT>ejabberd</TT>’s <TT>msgs</TT> directory.</P><P>For example, to set Russian as default language:
|
||||||
</P><PRE CLASS="verbatim">{language, "ru"}.
|
</P><PRE CLASS="verbatim">{language, "ru"}.
|
||||||
</PRE><P>Appendix <A HREF="#i18ni10n">A</A> provides more details about internationalization and localization.</P><P> <A NAME="includeconfigfile"></A> </P><!--TOC subsection Include Additional Configuration Files-->
|
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc28">3.1.8</A>  <A HREF="#includeconfigfile">Include Additional Configuration Files</A></H3><!--SEC END --><P> <A NAME="includeconfigfile"></A>
|
|
||||||
</P><P>The option <TT>include_config_file</TT> in a configuration file instructs <TT>ejabberd</TT> to include other configuration files immediately.</P><P>The basic usage is:
|
|
||||||
</P><PRE CLASS="verbatim">{include_config_file, <filename>}.
|
|
||||||
</PRE><P>It is also possible to specify suboptions:
|
|
||||||
</P><PRE CLASS="verbatim">{include_config_file, <filename>, [<suboption>, <suboption>, ...]}.
|
|
||||||
</PRE><P>The filename can be indicated either as an absolute path,
|
|
||||||
or relative to the main <TT>ejabberd</TT> configuration file.
|
|
||||||
It isn’t possible to use wildcards.
|
|
||||||
The file must exist and be readable.</P><P>The allowed suboptions are:
|
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
|
||||||
<B><TT>{disallow, [<option>, <option>, ...]}</TT></B></DT><DD CLASS="dd-description"> Disallows the usage of those options in the included configuration file.
|
|
||||||
The options that match this criteria are not accepted.
|
|
||||||
The default value is an empty list: <TT>[]</TT>
|
|
||||||
</DD><DT CLASS="dt-description"><B><TT>{allow_only, [<option>, <option>, ...]}</TT></B></DT><DD CLASS="dd-description"> Allows only the usage of those options in the included configuration file.
|
|
||||||
The options that do not match this criteria are not accepted.
|
|
||||||
The default value is: <TT>all</TT>
|
|
||||||
</DD></DL><P>This is a basic example:
|
|
||||||
</P><PRE CLASS="verbatim">{include_config_file, "/etc/ejabberd/additional.cfg"}.
|
|
||||||
</PRE><P>In this example, the included file is not allowed to contain a <TT>listen</TT> option.
|
|
||||||
If such an option is present, the option will not be accepted.
|
|
||||||
The file is in a subdirectory from where the main configuration file is.
|
|
||||||
</P><PRE CLASS="verbatim">{include_config_file, "./example.org/additional_not_listen.cfg", [{disallow, [listen]}]}.
|
|
||||||
</PRE><P>In this example, <TT>ejabberd.cfg</TT> defines some ACL and Access rules,
|
|
||||||
and later includes another file with additional rules:
|
|
||||||
</P><PRE CLASS="verbatim">{acl, admin, {user, "admin", "localhost"}}.
|
|
||||||
{access, announce, [{allow, admin}]}.
|
|
||||||
{include_config_file, "/etc/ejabberd/acl_and_access.cfg", [{allow_only, [acl, access]}]}.
|
|
||||||
</PRE><P>and content of the file <TT>acl_and_access.cfg</TT> can be, for example:
|
|
||||||
</P><PRE CLASS="verbatim">{acl, admin, {user, "bob", "localhost"}}.
|
|
||||||
{acl, admin, {user, "jan", "localhost"}}.
|
|
||||||
</PRE><P> <A NAME="optionmacros"></A> </P><!--TOC subsection Option Macros in Configuration File-->
|
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc29">3.1.9</A>  <A HREF="#optionmacros">Option Macros in Configuration File</A></H3><!--SEC END --><P> <A NAME="optionmacros"></A>
|
|
||||||
</P><P>In the <TT>ejabberd</TT> configuration file,
|
|
||||||
it is possible to define a macro for a value
|
|
||||||
and later use this macro when defining an option.</P><P>A macro is defined with this syntax:
|
|
||||||
</P><PRE CLASS="verbatim">{define_macro, '<MACRO>', <value>}.
|
|
||||||
</PRE><P>The <TT>MACRO</TT> must be surrounded by single quotation marks,
|
|
||||||
and all letters in uppercase; check the examples bellow.
|
|
||||||
The <TT>value</TT> can be any valid arbitrary Erlang term.</P><P>The first definition of a macro is preserved,
|
|
||||||
and additional definitions of the same macro are forgotten.</P><P>Macros are processed after
|
|
||||||
additional configuration files have been included,
|
|
||||||
so it is possible to use macros that
|
|
||||||
are defined in configuration files included before the usage.</P><P>It isn’t possible to use a macro in the definition
|
|
||||||
of another macro.</P><P>There are two ways to use a macro:
|
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>’<MACRO>’</TT></B></DT><DD CLASS="dd-description">
|
|
||||||
You can put this instead of a value in an <TT>ejabberd</TT> option,
|
|
||||||
and will be replaced with the <TT>value</TT> previously defined.
|
|
||||||
If the macro is not defined previously,
|
|
||||||
the program will crash and report an error.</DD><DT CLASS="dt-description"><B><TT>{use_macro, ’<MACRO>’, <defaultvalue>}</TT></B></DT><DD CLASS="dd-description">
|
|
||||||
Use a macro even if it may not be defined.
|
|
||||||
If the macro is not defined previously,
|
|
||||||
the provided <TT>defaultvalue</TT> is used.
|
|
||||||
This usage behaves as if it were defined and used this way:
|
|
||||||
<PRE CLASS="verbatim">{define_macro, '<MACRO>', <defaultvalue>}.
|
|
||||||
'<MACRO>'
|
|
||||||
</PRE></DD></DL><P>This example shows the basic usage of a macro:
|
|
||||||
</P><PRE CLASS="verbatim">{define_macro, 'LOG_LEVEL_NUMBER', 5}.
|
|
||||||
{loglevel, 'LOG_LEVEL_NUMBER'}.
|
|
||||||
</PRE><P>The resulting option interpreted by <TT>ejabberd</TT> is: <TT>{loglevel, 5}</TT>.</P><P>This example shows that values can be any arbitrary Erlang term:
|
|
||||||
</P><PRE CLASS="verbatim">{define_macro, 'USERBOB', {user, "bob", "localhost"}}.
|
|
||||||
{acl, admin, 'USERBOB'}.
|
|
||||||
</PRE><P>The resulting option interpreted by <TT>ejabberd</TT> is: <TT>{acl, admin, {user, "bob", "localhost"}}</TT>.</P><P>This complex example:
|
|
||||||
</P><PRE CLASS="verbatim">{define_macro, 'NUMBER_PORT_C2S', 5222}.
|
|
||||||
{define_macro, 'PORT_S2S_IN', {5269, ejabberd_s2s_in, []}}.
|
|
||||||
{listen,
|
|
||||||
[
|
|
||||||
{'NUMBER_PORT_C2S', ejabberd_c2s, []},
|
|
||||||
'PORT_S2S_IN',
|
|
||||||
{{use_macro, 'NUMBER_PORT_HTTP', 5280}, ejabberd_http, []}
|
|
||||||
]
|
|
||||||
}.
|
|
||||||
</PRE><P>produces this result after being interpreted:
|
|
||||||
</P><PRE CLASS="verbatim">{listen,
|
|
||||||
[
|
|
||||||
{5222, ejabberd_c2s, []},
|
|
||||||
{5269, ejabberd_s2s_in, []},
|
|
||||||
{5280, ejabberd_http, []}
|
|
||||||
]
|
|
||||||
}.
|
|
||||||
</PRE><P> <A NAME="database"></A> </P><!--TOC section Database and LDAP Configuration-->
|
</PRE><P> <A NAME="database"></A> </P><!--TOC section Database and LDAP Configuration-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc30">3.2</A>  <A HREF="#database">Database and LDAP Configuration</A></H2><!--SEC END --><P> <A NAME="database"></A>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc28">3.2</A>  <A HREF="#database">Database and LDAP Configuration</A></H2><!--SEC END --><P> <A NAME="database"></A>
|
||||||
>>>>>>> d106311... * doc/guide.tex: Provide only an example of language option:doc/guide.html
|
|
||||||
|
|
||||||
</P><P><TT>ejabberd</TT> uses its internal Mnesia database by default. However, it is
|
</P><P><TT>ejabberd</TT> uses its internal Mnesia database by default. However, it is
|
||||||
possible to use a relational database or an LDAP server to store persistent,
|
possible to use a relational database or an LDAP server to store persistent,
|
||||||
|
@ -299,7 +299,7 @@ To compile \ejabberd{} on a `Unix-like' operating system, you need:
|
|||||||
\item GCC
|
\item GCC
|
||||||
\item Libexpat 1.95 or higher
|
\item Libexpat 1.95 or higher
|
||||||
\item Erlang/OTP R10B-9 or higher.
|
\item Erlang/OTP R10B-9 or higher.
|
||||||
\item OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
|
\item OpenSSL 0.9.8f or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
|
||||||
\item Zlib 1.2.3 or higher, for Stream Compression support (\xepref{0138}). Optional.
|
\item Zlib 1.2.3 or higher, for Stream Compression support (\xepref{0138}). Optional.
|
||||||
\item Erlang mysql library. Optional. For MySQL authentication or storage. See section \ref{compilemysql}.
|
\item Erlang mysql library. Optional. For MySQL authentication or storage. See section \ref{compilemysql}.
|
||||||
\item Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section \ref{compilepgsql}.
|
\item Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section \ref{compilepgsql}.
|
||||||
@ -469,7 +469,7 @@ To compile \ejabberd{} on a Microsoft Windows system, you need:
|
|||||||
\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}
|
||||||
(optional)
|
(optional)
|
||||||
\item \footahref{http://www.slproweb.com/products/Win32OpenSSL.html}{Shining Light OpenSSL 0.9.8d or higher}
|
\item \footahref{http://www.slproweb.com/products/Win32OpenSSL.html}{Shining Light OpenSSL 0.9.8f or higher}
|
||||||
(to enable SSL connections)
|
(to enable SSL connections)
|
||||||
\item \footahref{http://www.zlib.net/}{Zlib 1.2.3 or higher}
|
\item \footahref{http://www.zlib.net/}{Zlib 1.2.3 or higher}
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
Loading…
Reference in New Issue
Block a user