Go to file
Evgeniy Khramtsov fddd6110e0 Don't validate an option in gen_mod:get*opt() functions
The changes are very similar to those from previous commit:
* Now there is no need to pass validating function in
  gen_mod:get_opt() and gen_mod:get_module_opt() functions,
  because the modules' configuration keeps already validated values.
* New functions gen_mod:get_opt/2 and gen_mod:get_module_opt/3 are
  introduced.
* Functions gen_mod:get_opt/4 and get_module_opt/5 are deprecated.
  If the functions are still called, the "function" argument is
  simply ignored.
* Validating callback Mod:listen_opt_type/1 is introduced to validate
  listening options at startup.
2017-04-30 19:01:47 +03:00
.github Apply cosmetic changes to GitHub templates 2016-03-15 00:12:01 +01:00
.travis Travis CI: Update MySQL APT repository key 2017-02-20 21:17:34 +01:00
asn1 Remove obsolete/temp file 2016-11-16 14:18:51 +01:00
config Support for Elixir configuration file #1208 2016-09-08 11:37:14 +02:00
contrib/extract_translations Don't require ejabberd to be installed to run "make translations" 2016-05-06 13:47:02 +02:00
docker Fix typo 2017-04-26 17:35:51 +09:00
examples Update example extauth script with tryregister, removeuser and removeuser3 (EJAB-641) 2010-12-03 17:26:10 +01:00
include Default config file should be ejabberd.yml 2017-04-16 01:26:33 +03:00
lib Support for Elixir configuration file #1208 2016-09-08 11:37:14 +02:00
m4 Add SQLite3 library checks at the configure script 2015-04-08 14:49:14 +03:00
plugins Add plugin for passing extra erl_opts flags to deps, and use it for hipe 2015-12-16 12:23:13 +01:00
priv/msgs Fixes pt-br translation (thanks to Rodrigues)(#1393) 2016-11-30 16:51:42 +01:00
rel Update copyright date automatically (#1442) 2017-01-02 21:42:06 +01:00
sql Add SQL as mod_proxy65 RAM backend 2017-03-31 08:16:28 +03:00
src Don't validate an option in gen_mod:get*opt() functions 2017-04-30 19:01:47 +03:00
test Don't validate an option in gen_mod:get*opt() functions 2017-04-30 19:01:47 +03:00
tools tools/hook_deps.sh: Search for escript in PATH 2017-02-23 17:38:56 +01:00
win32 Switch to rebar build tool 2013-06-13 11:11:02 +02:00
.dockerignore add docker support 2016-11-16 11:48:50 +01:00
.gitignore Tell git to ignore the example file ejabberd.service 2016-11-16 13:12:57 +01:00
.travis.yml Travis CI: Update MySQL package 2017-04-11 13:52:10 +02:00
COPYING Update FSF address 2014-02-22 10:27:40 +00:00
Dockerfile Update docker files from latest Rafael's changes 2017-03-21 18:59:12 +01:00
Makefile.in Remove webtool from erlang.plt creation 2017-03-20 13:48:17 +03:00
README Link to Hex.pm 2016-02-08 11:34:52 +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 Set default prefix to /usr/local 2017-04-06 15:35:02 +02:00
configure.bat Switch to rebar build tool 2013-06-13 11:11:02 +02:00
cover.spec Add Coveralls support 2016-03-21 12:01:20 +01: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.service.template Specify "ExecReload" command in systemd unit 2017-02-23 18:16:56 +01:00
ejabberd.yml.example Improve S2S examples (#1583) 2017-04-07 11:12:27 +02:00
ejabberdctl.cfg.example ejabberdctl.cfg: Document CONTRIB_MODULES_CONF_DIR 2015-10-26 22:46:58 +01:00
ejabberdctl.template Fix typo from d8bb5d9c 2016-06-23 17:31:32 +02: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
mix.exs Mix needs include path to p1_utils 2017-03-28 16:08:10 +02:00
mix.lock Update mix dependencies 2017-03-22 11:59:39 +01:00
rebar Ignore warnings_as_errors everywhere 2015-01-15 13:49:24 +03:00
rebar.config Bump cache_tab version 2017-04-27 20:07:44 +03:00
rebar.config.script Resolve vars.config relative to to rebar.config.script 2017-03-20 18:28:49 +01:00
vars.config.in Update copyright date automatically (#1442) 2017-01-02 21:42:06 +01:00

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