Go to file
Badlop cde089ce9c Disable some shellcheck warnings 2021-12-23 13:57:06 +01:00
.devcontainer Use the new Github container registry 2021-05-12 11:51:40 +02:00
.github Revert "Github Actions: use MD5 pass encryption to support PostgreSQL 14 (#3691)" 2021-12-15 00:50:52 +01:00
_checkouts/configure_deps Improve rebar3 configure-deps plugin output 2020-09-23 17:56:49 +01:00
config As Mix config now must be evaluated at runtime, rename to runtime.exs 2021-07-16 13:57:25 +02:00
examples Remove old and obsolete examples/transport-configs/ (#3487) 2021-01-27 17:10:56 +01:00
include Merge pull request #3652 from weiss/bump-max-items 2021-12-03 16:11:18 +01:00
lib Revert "Add workaround so rebar2 can use Elixir 1.12.0" 2021-07-22 15:51:43 +02:00
m4 Do not check for deprecated types 2018-06-14 18:58:35 +03:00
man Update man page 2021-12-09 10:55:19 +01:00
plugins Rename plugin to not clash with plugin from dep 2020-01-08 10:41:48 +01:00
priv Update Chinese translation (thanks to Eric and 52871299hzy) 2021-12-09 10:55:26 +01:00
rel Remove CTLLOCKDIR (/var/lock/ejabberdctl) from Makefile.in 2021-12-07 10:15:47 +01:00
sql Handle user removal in mod_muc 2021-12-14 09:55:55 +03:00
src Merge remote-tracking branch 'processone/pr/3735' 2021-12-20 09:37:37 +01:00
test Fix roster_tests:get_items 2021-09-21 13:30:52 +03:00
tools "sort -R" command not POSIX, added "shuf" and "cat" as fallback 2021-08-12 15:14:31 +02:00
.dockerignore add docker support 2016-11-16 11:48:50 +01:00
.gitignore Add support to build release with back to old Elixir 1.10.3 2021-07-16 13:36:27 +02:00
.shellcheckrc Disable some shellcheck warnings 2021-12-23 13:57:06 +01:00
CHANGELOG.md Update CHANGELOG.md to 21.12 2021-12-09 11:07:43 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-01-09 14:17:55 +01:00
CONTRIBUTING.md Remove .travis.yml as it's superseded by ci.yml (#3613) 2021-05-25 19:16:06 +02:00
CONTRIBUTORS.md CONTRIBUTORS: UTF-8 encode my name 2018-11-19 15:23:35 +01:00
COPYING Update FSF address 2014-02-22 10:27:40 +00:00
Makefile.in Remove CTLLOCKDIR (/var/lock/ejabberdctl) from Makefile.in 2021-12-07 10:15:47 +01:00
README.md Simplify the --with-rebar example in README 2021-07-21 13:11:06 +02:00
autogen.sh Force regeneration of configure script 2014-04-18 12:13:17 +02:00
configure.ac Add support for mix to: ./configure --enable-rebar=mix 2021-07-16 13:36:23 +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 Replace Jabber->XMPP and Ejabberd (thanks to Neustradamus)(#3469) 2021-01-11 21:11:20 +01:00
ejabberd.service.template Use the configured user in systemd's ejabberd.service 2021-10-21 16:12:38 +02:00
ejabberd.yml.example New listener for encrypted ejabberd_c2s 2021-02-02 15:25:19 +01:00
ejabberdctl.cfg.example Remove SMP option from ejabberdctl.cfg, -smp was removed in OTP 21 (#3560) 2021-04-15 20:28:43 +02:00
ejabberdctl.template The read value is useless, so use throwaway variable name 2021-12-23 13:57:04 +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
mix.exs Handle mix version when running docker-ejabberd/ecs/build.sh latest 2021-12-08 16:31:36 +01:00
mix.lock Update stun and esip dependencies 2021-12-09 12:13:48 +01:00
rebar Recompile rebar script with OTP17.5 2017-08-23 11:45:10 +03:00
rebar.config Only provide Relx start script in dev profile 2021-12-23 13:54:08 +01:00
rebar.config.script Use P1's coveralls-erl fork to handle unicode in git commit author 2021-12-07 01:33:16 +01:00
rebar3 Add rebar3 3.15.2 2021-07-16 13:36:25 +02:00
vars.config.in Generate enabled_backends in ejabberd.app instead of configure (#3549) 2021-03-15 10:11:05 +01:00

README.md

ejabberd Community Edition

CI Coverage Status Translation 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.
    • Docker packaging to help with deploy / development on Linux, Windows or MacOS.
    • Deb and RPM packaging to support most Linux distributions.
    • 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 XMPP 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).
    • 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.
  • Libyaml ≥ 0.1.4.
  • Erlang/OTP ≥ 19.3.
  • OpenSSL ≥ 1.0.0.
  • Zlib ≥ 1.2.3, for Stream Compression support (XEP-0138). Optional.
  • PAM library. Optional. For Pluggable Authentication Modules (PAM).
  • ImageMagick's Convert program and Ghostscript fonts. Optional. For CAPTCHA challenges.
  • Elixir ≥ 1.10.3. Optional. Alternative to build ejabberd

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 Documentation

3. Use ejabberd locally

Alternatively, you can setup ejabberd without installing in your system:

./configure --with-rebar=rebar3
make dev

Or, if you have Elixir available and plan to develop Elixir code:

./configure --with-rebar=mix
make dev

Check the full list of targets:

make help

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

Translation

Using any gettext editor, you can improve the translation files found in priv/msgs/*.po, and then submit your changes.

Alternatively, a simple way to improve translations is using our Weblate project: https://hosted.weblate.org/projects/ejabberd/ejabberd-po/