From 3454f2fe04f5efa39f95656883fee7c6fde4f1ef Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 5 Mar 2009 19:48:24 +0000 Subject: [PATCH] * doc/guide.tex: Require OpenSSL 0.9.8f or higher (EJAB-877) * doc/guide.html: Likewise SVN Revision: 1967 --- ChangeLog | 5 +++ doc/guide.html | 97 ++------------------------------------------------ doc/guide.tex | 4 +-- 3 files changed, 10 insertions(+), 96 deletions(-) diff --git a/ChangeLog b/ChangeLog index ed5705e86..3b966a752 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2009-03-05 Badlop + + * doc/guide.tex: Require OpenSSL 0.9.8f or higher (EJAB-877) + * doc/guide.html: Likewise + 2009-03-04 Badlop * src/ejabberd_auth.erl: If anonymous auth is enabled, when diff --git a/doc/guide.html b/doc/guide.html index d0edd2215..45dae7b9c 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -329,7 +329,7 @@ GNU Make
  • GCC
  • Libexpat 1.95 or higher
  • Erlang/OTP R10B-9 or higher. -
  • OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended. +
  • OpenSSL 0.9.8f or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
  • Zlib 1.2.3 or higher, for Stream Compression support (XEP-0138). Optional.
  • Erlang mysql library. Optional. For MySQL authentication or storage. See section 3.2.1.
  • Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section 3.2.3. @@ -436,7 +436,7 @@ MS Visual C++ 6.0 Compiler
  • Expat 2.0.0 or higher
  • GNU Iconv 1.9.2 (optional) -
  • Shining Light OpenSSL 0.9.8d or higher +
  • Shining Light OpenSSL 0.9.8f or higher (to enable SSL connections)
  • Zlib 1.2.3 or higher

    • @@ -1119,101 +1119,10 @@ To define a shaper named ‘normal’ with traffic speed limi can be seen by Jabber clients. If a Jabber client do not support xml:lang, the specified language is used. The default value is en. In order to take effect there must be a translation file -<<<<<<< HEAD:doc/guide.html -<language>.msg in ejabberd’s msgs directory.

    Examples: -

    • -To set Russian as default language: -
      {language, "ru"}.
-
    • To set Spanish as default language: -
      {language, "es"}.
-

    -

    3.2  Database and LDAP Configuration

    -======= <language>.msg in ejabberd’s msgs directory.

    For example, to set Russian as default language: 

    {language, "ru"}.
-

    Appendix A provides more details about internationalization and localization.

    -

    3.1.8  Include Additional Configuration Files

    -

    The option include_config_file in a configuration file instructs ejabberd to include other configuration files immediately.

    The basic usage is: -

    {include_config_file, <filename>}.
-

    It is also possible to specify suboptions: -

    {include_config_file, <filename>, [<suboption>, <suboption>, ...]}.
-

    The filename can be indicated either as an absolute path, -or relative to the main ejabberd configuration file. -It isn’t possible to use wildcards. -The file must exist and be readable.

    The allowed suboptions are: -

    -{disallow, [<option>, <option>, ...]}
    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: [] -
    {allow_only, [<option>, <option>, ...]}
    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: all -

    This is a basic example: -

    {include_config_file, "/etc/ejabberd/additional.cfg"}.
-

    In this example, the included file is not allowed to contain a listen 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. -

    {include_config_file, "./example.org/additional_not_listen.cfg", [{disallow, [listen]}]}.
-

    In this example, ejabberd.cfg defines some ACL and Access rules, -and later includes another file with additional rules: -

    {acl, admin, {user, "admin", "localhost"}}.
-{access, announce, [{allow, admin}]}.
-{include_config_file, "/etc/ejabberd/acl_and_access.cfg", [{allow_only, [acl, access]}]}.
-

    and content of the file acl_and_access.cfg can be, for example: -

    {acl, admin, {user, "bob", "localhost"}}.
-{acl, admin, {user, "jan", "localhost"}}.
-

    -

    3.1.9  Option Macros in Configuration File

    -

    In the ejabberd configuration file, -it is possible to define a macro for a value -and later use this macro when defining an option.

    A macro is defined with this syntax: -

    {define_macro, '<MACRO>', <value>}.
-

    The MACRO must be surrounded by single quotation marks, -and all letters in uppercase; check the examples bellow. -The value can be any valid arbitrary Erlang term.

    The first definition of a macro is preserved, -and additional definitions of the same macro are forgotten.

    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.

    It isn’t possible to use a macro in the definition -of another macro.

    There are two ways to use a macro: -

    ’<MACRO>’
    -You can put this instead of a value in an ejabberd option, -and will be replaced with the value previously defined. -If the macro is not defined previously, -the program will crash and report an error.
    {use_macro, ’<MACRO>’, <defaultvalue>}
    -Use a macro even if it may not be defined. -If the macro is not defined previously, -the provided defaultvalue is used. -This usage behaves as if it were defined and used this way: -
    {define_macro, '<MACRO>', <defaultvalue>}.
-'<MACRO>'
-

    This example shows the basic usage of a macro: -

    {define_macro, 'LOG_LEVEL_NUMBER', 5}.
-{loglevel, 'LOG_LEVEL_NUMBER'}.
-

    The resulting option interpreted by ejabberd is: {loglevel, 5}.

    This example shows that values can be any arbitrary Erlang term: -

    {define_macro, 'USERBOB', {user, "bob", "localhost"}}.
-{acl, admin, 'USERBOB'}.
-

    The resulting option interpreted by ejabberd is: {acl, admin, {user, "bob", "localhost"}}.

    This complex example: -

    {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, []}
- ]
-}.
-

    produces this result after being interpreted: -

    {listen,
- [
-  {5222, ejabberd_c2s, []},
-  {5269, ejabberd_s2s_in, []},
-  {5280, ejabberd_http, []}
- ]
-}.

    -

    3.2  Database and LDAP Configuration

    ->>>>>>> d106311... * doc/guide.tex: Provide only an example of language option:doc/guide.html +

    3.2  Database and LDAP Configuration

    ejabberd uses its internal Mnesia database by default. However, it is possible to use a relational database or an LDAP server to store persistent, diff --git a/doc/guide.tex b/doc/guide.tex index d3e570604..aa49e0cf2 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -299,7 +299,7 @@ To compile \ejabberd{} on a `Unix-like' operating system, you need: \item GCC \item Libexpat 1.95 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 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}. @@ -469,7 +469,7 @@ To compile \ejabberd{} on a Microsoft Windows system, you need: \item \footahref{http://www.gnu.org/software/libiconv/}{GNU Iconv 1.9.2} (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) \item \footahref{http://www.zlib.net/}{Zlib 1.2.3 or higher} \end{itemize}