Skip to content
Robust, ubiquitous and massively scalable Jabber / XMPP Instant Messaging platform
Erlang Elixir Shell NSIS M4 Makefile
Latest commit 13c6430 May 4, 2016 Christophe Romain Add missing odbc->sql in comment from commit 1aae8a9
Failed to load latest commit information.
.github Apply cosmetic changes to GitHub templates Mar 15, 2016
.travis Use static key for mysql repo Mar 21, 2016
asn1 Do not generate LDAP's ASN.1 code when compiling ejabberd. Jun 22, 2013
config Better to keep config file in a different config directory Sep 2, 2015
contrib/extract_translations Support binary strings in extract_translations Dec 23, 2015
examples Update example extauth script with tryregister, removeuser and remove… Dec 3, 2010
include Rename odbc to sql everywhere Apr 20, 2016
lib Log Elixir test result for investigation and include this log file in… Apr 6, 2016
m4 Add SQLite3 library checks at the configure script Apr 8, 2015
plugins Add plugin for passing extra erl_opts flags to deps, and use it for hipe Dec 16, 2015
priv/msgs Update gl.po Mar 14, 2016
rel Update copyright to 2016 (#901) Jan 13, 2016
sql Use MEDIUMTEXT type for muc_room.opts in MySQL schema May 2, 2016
src Add missing odbc->sql in comment from commit 1aae8a9 May 4, 2016
test Add ability to configure server loglevel when running tests May 2, 2016
tools Add tests for MUC MAM May 1, 2016
win32 Switch to rebar build tool Jun 13, 2013
.gitignore Add extra items to .gitignore Feb 25, 2016
.travis.yml Use erlang 18.3 in travis tests Apr 18, 2016
COPYING Update FSF address Feb 22, 2014
Makefile.in Fix ejabberdctl.template duplication May 3, 2016
README Link to Hex.pm Feb 8, 2016
README.md Convert README to Markdown Apr 29, 2014
autogen.sh Force regeneration of configure script Apr 18, 2014
configure.ac ejabberdctl: Fix path to epmd May 1, 2016
configure.bat Switch to rebar build tool Jun 13, 2013
cover.spec Add Coveralls support Mar 21, 2016
ejabberd.init.template Fix init script: use getent to allow ejabberd user from external auth… Sep 17, 2014
ejabberd.service.template Fix start via systemd (#978) Mar 24, 2016
ejabberd.yml.example Rename odbc to sql everywhere Apr 20, 2016
ejabberdctl.cfg.example ejabberdctl.cfg: Document CONTRIB_MODULES_CONF_DIR Oct 26, 2015
ejabberdctl.template ejabberdctl: Fix path to epmd May 1, 2016
inetrc Switch to rebar build tool Jun 13, 2013
install-sh Switch to rebar build tool Jun 13, 2013
mix.exs Prepare 16.04 release Apr 27, 2016
mix.lock Update esip and stun to match Fast TLS version Apr 27, 2016
rebar Ignore warnings_as_errors everywhere Jan 15, 2015
rebar.config Update esip and stun to match Fast TLS version Apr 27, 2016
rebar.config.script Add Coveralls support Mar 21, 2016
vars.config.in ejabberdctl: Fix path to epmd May 1, 2016

README.md

ejabberd Community Edition

Build Status Hex version

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 17.1 or higher.
  • OpenSSL 1.0.0 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.

Development

In order to assist in the development of ejabberd, and particularly the execution of the test suite, a Vagrant environment is available at https://github.com/processone/ejabberd-vagrant-dev.

To start ejabberd in development mode from the repository directory, you can type a command like:

EJABBERD_CONFIG_PATH=ejabberd.yml erl -pa ebin -pa deps/*/ebin -pa test -pa deps/elixir/lib/*/ebin/ -s ejabberd

Links

Something went wrong with that request. Please try again.