Go to file
Christophe Romain 0c0947a241 Add compatibility macros for deprecated types (thanks to Alexey) 2015-02-23 09:58:00 +01:00
asn1 Do not generate LDAP's ASN.1 code when compiling ejabberd. 2013-06-22 03:27:59 +10:00
contrib/extract_translations Provide header with latin-1 encoding in translations to work with Erlang/OTP R17 2014-03-12 17:26:27 +01:00
doc Update mod_vcard_ldap Guide documentation from Erlang to YAML format (Github #274 #394) 2015-02-17 13:41:06 +01:00
examples Update example extauth script with tryregister, removeuser and removeuser3 (EJAB-641) 2010-12-03 17:26:10 +01:00
include Add compatibility macros for deprecated types (thanks to Alexey) 2015-02-23 09:58:00 +01:00
lib Fix incorrect Elixir name 2015-02-11 10:19:40 +01:00
m4 Add compatibility macros for deprecated types (thanks to Alexey) 2015-02-23 09:58:00 +01:00
priv/msgs Update id.msg 2014-05-24 17:53:39 +07:00
rel Remove "xmlrpc" dependency for "make rel" 2014-10-12 17:23:25 +02:00
sql Update copyright dates to 2015 (EJAB-1733) 2015-01-08 17:34:43 +01:00
src Add compatibility macros for deprecated types (thanks to Alexey) 2015-02-23 09:58:00 +01:00
test Improve interface for adding timestamps 2014-12-07 15:55:18 +01:00
tools Update copyright dates to 2015 (EJAB-1733) 2015-01-08 17:34:43 +01:00
win32 Switch to rebar build tool 2013-06-13 11:11:02 +02:00
.gitignore Add Elixir support to ejabberd 2015-02-10 17:56:44 +01:00
.travis.yml Disable elixir support in travis tests 2015-02-10 18:22:54 +01:00
COPYING Update FSF address 2014-02-22 10:27:40 +00:00
Makefile.in Fix "make install" without Elixir support 2015-02-11 00:23:40 +01:00
Makefile.win32 Switch to rebar build tool 2013-06-13 11:11:02 +02:00
README Update links 2015-02-19 12:17:39 +01:00
README.md Convert README to Markdown 2014-04-29 23:54:14 +02:00
autogen.sh Force regeneration of configure script 2014-04-18 12:13:17 +02:00
configure.ac Add compatibility macros for deprecated types (thanks to Alexey) 2015-02-23 09:58:00 +01:00
configure.bat Switch to rebar build tool 2013-06-13 11:11:02 +02:00
ejabberd.init.template Fix init script: use getent to allow ejabberd user from external authentication sources (LDAP) 2014-09-17 21:28:50 +02:00
ejabberd.yml.example Remove append_host_config from ejabberd.yml.example 2014-10-20 12:59:30 +04:00
ejabberdctl.cfg.example Document EJABBERD_CONFIG_PATH in ejabberdctl.cfg 2015-02-10 00:15:06 +01:00
ejabberdctl.template Add Elixir support to ejabberd 2015-02-10 17:56:44 +01:00
inetrc Switch to rebar build tool 2013-06-13 11:11:02 +02:00
install-sh Switch to rebar build tool 2013-06-13 11:11:02 +02:00
rebar Ignore warnings_as_errors everywhere 2015-01-15 13:49:24 +03:00
rebar.config.script Add compatibility macros for deprecated types (thanks to Alexey) 2015-02-23 09:58:00 +01:00
vars.config.in Add compatibility macros for deprecated types (thanks to Alexey) 2015-02-23 09:58:00 +01:00

README.md

ejabberd Community Edition Build Status

ejabberd is a distributed, fault-tolerant technology that allows the creation of large-scale instant messaging applications. The server can reliably support thousands of simultaneous users on a single node and has been designed to provide exceptional standards of fault tolerance. As an open source technology, based on industry-standards, ejabberd can be used to build bespoke solutions very cost effectively.

Key Features

  • Cross-platform
    ejabberd runs under Microsoft Windows and Unix-derived systems such as Linux, FreeBSD and NetBSD.

  • Distributed
    You can run ejabberd on a cluster of machines and all of them will serve the same XMPP domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.

  • Fault-tolerant
    You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced on the fly.

  • Administrator-friendly
    ejabberd is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:

    • Comprehensive documentation.
    • Straightforward installers for Linux and Mac OS X.
    • Web administration.
    • Shared roster groups.
    • Command line administration tool.
    • Can integrate with existing authentication mechanisms.
    • Capability to send announce messages.
  • Internationalized
    ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are:

    • Translated to 25 languages.
    • Support for IDNA.
  • Open Standards
    ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard.

    • Fully XMPP-compliant.
    • XML-based protocol.
    • Many protocols supported.

Additional Features

Moreover, ejabberd comes with a wide range of other state-of-the-art features:

  • Modularity

    • Load only the modules you want.
    • Extend ejabberd with your own custom modules.
  • Security

    • SASL and STARTTLS for c2s and s2s connections.
    • STARTTLS and Dialback s2s connections.
    • Web Admin accessible via HTTPS secure access.
  • Databases

    • Internal database for fast deployment (Mnesia).
    • Native MySQL support.
    • Native PostgreSQL support.
    • ODBC data storage support.
    • Microsoft SQL Server support.
  • Authentication

    • Internal authentication.
    • PAM, LDAP and ODBC.
    • External authentication script.
  • Others

    • Support for virtual hosting.
    • Compressing XML streams with Stream Compression (XEP-0138).
    • Statistics via Statistics Gathering (XEP-0039).
    • IPv6 support both for c2s and s2s connections.
    • Multi-User Chat module with support for clustering and HTML logging.
    • Users Directory based on users vCards.
    • Publish-Subscribe component with support for Personal Eventing.
    • Support for web clients: HTTP Polling and HTTP Binding (BOSH).
    • IRC transport.
    • Component support: interface with networks such as AIM, ICQ and MSN.

Quickstart guide

0. Requirements

To compile ejabberd you need:

  • GNU Make.
  • GCC.
  • Libexpat 1.95 or higher.
  • Libyaml 0.1.4 or higher.
  • Erlang/OTP R15B or higher.
  • OpenSSL 0.9.8 or higher, for STARTTLS, SASL and SSL encryption.
  • Zlib 1.2.3 or higher, for Stream Compression support (XEP-0138). Optional.
  • 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.

1. Compile and install on *nix systems

To compile ejabberd, execute the following commands. The first one is only necessary if your source tree didn't come with a configure script.

./autogen.sh
./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 available online and in the doc directory of the source tarball.