Robust, ubiquitous and massively scalable Jabber / XMPP Instant Messaging platform
Erlang Elixir Shell M4 Smarty NSIS Other
Permalink
Failed to load latest commit information.
.github Apply cosmetic changes to GitHub templates Mar 14, 2016
.travis Travis CI: Update MySQL APT repository key Feb 20, 2017
asn1 Remove obsolete/temp file Nov 16, 2016
config Replace example config of drop_chat_states with queue_* in mod_client… Sep 6, 2017
contrib/extract_translations Don't require ejabberd to be installed to run "make translations" May 6, 2016
docker The redis_reconnect_timeout was no longer used (#1983) Sep 7, 2017
examples Update example extauth script with tryregister, removeuser and remove… Dec 3, 2010
include Implement cache for mod_privacy/mod_blocking May 20, 2017
lib Support for Elixir configuration file #1208 Sep 8, 2016
m4 Add SQLite3 library checks at the configure script Apr 8, 2015
plugins Override version of subdeps with version from main rebar.config Jun 7, 2017
priv/msgs Fixes pt-br translation (thanks to Rodrigues)(#1393) Nov 30, 2016
rel Update copyright date automatically (#1442) Jan 2, 2017
sql Clean up database code related to mod_vcard_xupdate May 17, 2017
src Also replace vcard-x-update in direct presences Sep 18, 2017
test Explicitly match against <domain/resource> Aug 23, 2017
tools Add ability to update changelog in update-deps-releases Jul 20, 2017
win32 Switch to rebar build tool Jun 13, 2013
.dockerignore add docker support Nov 16, 2016
.gitignore Tell git to ignore the example file ejabberd.service Nov 16, 2016
.travis.yml Add OTP 20.0 to Travis testsing platforms Aug 17, 2017
COPYING Update FSF address Feb 22, 2014
Dockerfile Prepare packaging for 17.08 Aug 3, 2017
Makefile.in Fix 'make install' to work with new output from rebar list-deps Aug 24, 2017
README Add minor details (#1353) Aug 4, 2017
README.md Convert README to Markdown Apr 29, 2014
autogen.sh Force regeneration of configure script Apr 18, 2014
configure.ac Introduce mod_avatar Sep 17, 2017
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 Specify "ExecReload" command in systemd unit Feb 23, 2017
ejabberd.yml.example Deprecate `s2s_use_starttls: required_trusted` Sep 2, 2017
ejabberdctl.cfg.example ejabberdctl.cfg: Document CONTRIB_MODULES_CONF_DIR Oct 26, 2015
ejabberdctl.template Merge pull request #1996 from nosnilmot/ejabberdctl-quote-peer Sep 18, 2017
inetrc Switch to rebar build tool Jun 13, 2013
install-sh Switch to rebar build tool Jun 13, 2013
mix.exs Prepare packaging for 17.08 Aug 3, 2017
mix.lock Prepare packaging for 17.08 Aug 3, 2017
rebar Recompile rebar script with OTP17.5 Aug 23, 2017
rebar.config Add GIF support Sep 17, 2017
rebar.config.script Override version of subdeps with version from main rebar.config Jun 7, 2017
vars.config.in Introduce mod_avatar Sep 17, 2017

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.5 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.

If your system splits packages in libraries and development headers, you must install the development packages also.

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 (In this case you need autoconf installed).

./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