Go to file
Pablo Polvorin 41aa693896 Allow customizing the StateData in p1_fsm before error reporting.
A new callback is introduced on the p1_fsm behaviour:

print_error/1

If the module implements this function, it will be invoked
in case of process crash with the current state data *before*
printing the error in the log. The function must return the
desired State to print.

It is used in ejabberd_c2s to prune the presence sets that
can be large. Instead, the state is changed to include only
the # of elements on each set.

Change inspired in comming changes to gen_server on OTP, and
b01d15abc3 (diff-0)
2010-03-30 16:39:34 -03:00
contrib Remove references to the old SVN repository. 2010-02-16 11:55:01 +01:00
doc Update ejabberd version number to 2.1.3 2010-03-12 10:21:32 +01:00
examples * examples/extauth/check_pass_null.pl: Fixed external 2007-11-22 13:46:50 +00:00
src Allow customizing the StateData in p1_fsm before error reporting. 2010-03-30 16:39:34 -03:00
tools Change captcha.sh to not depend on bash (thanks to Konstantin Khomoutov)(EJAB-1105) 2009-11-23 12:43:15 +00:00
COPYING * src/msgs/nl.msg: Updated (thanks to Sander Devrieze) 2004-10-09 20:15:49 +00:00
README Fix character in README file 2010-02-05 13:30:27 +01:00

README

ejabberd - High-Performance Enterprise Instant Messaging Server 

Quickstart guide


0. Requirements

To compile ejabberd you need:
 - GNU Make
 - GCC
 - Libexpat 1.95 or higher
 - Erlang/OTP R10B-9 or higher. The recommended version is R12B-5.
   Support for R13 is experimental.
 - OpenSSL 0.9.6 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. MySQL authentication/storage.
 - Erlang pgsql library. Optional. PostgreSQL authentication/storage.
 - PAM library. Optional. For Pluggable Authentication Modules (PAM).
 - GNU Iconv 1.8 or higher, for the IRC Transport
   (mod_irc). Optional. Not needed on systems with GNU Libc.
 - ImageMagick's Convert program. Optional. For CAPTCHA challenges.
 - exmpp 0.9.2 or higher. Optional. For import/export XEP-0227 files. 


1. Compile and install on *nix systems

To compile ejabberd, go to the directory src/ and execute the commands:
  ./configure
  make

To install ejabberd, run this command with system administrator rights
(root user):

  sudo make install

These commands will:
 - Install the configuration files in /etc/ejabberd/
 - Install ejabberd binary, header and runtime files in /lib/ejabberd/
 - Install the administration script: /sbin/ejabberdctl
 - Install ejabberd documentation in /share/doc/ejabberd/
 - Create a spool directory: /var/lib/ejabberd/
 - Create a directory for log files: /var/log/ejabberd/


2. Start ejabberd

You can use the ejabberdctl command line administration script to
start and stop ejabberd. For example:
  ejabberdctl start


For detailed information please refer to the
ejabberd Installation and Operation Guide