Go to file
Badlop 5c3b3d22db Other minor translation updates 2021-01-27 18:18:18 +01:00
.devcontainer Update Dockerfile 2020-12-16 08:40:30 +01:00
.github Try removing label as bug 2019-10-04 09:02:45 +02:00
.travis Travis CI: Update MySQL APT repository key 2019-02-20 17:09:56 +01:00
_checkouts/configure_deps Improve rebar3 configure-deps plugin output 2020-09-23 17:56:49 +01:00
config Replace Jabber->XMPP and Ejabberd (thanks to Neustradamus)(#3469) 2021-01-11 21:11:20 +01:00
examples Remove old and obsolete examples/transport-configs/ (#3487) 2021-01-27 17:10:56 +01:00
include Update newest copyright year to 2021 (#3464) 2021-01-27 17:02:06 +01:00
lib Adopt mix task to changes in ejabberd_config 2019-08-05 10:55:30 +02:00
m4 Do not check for deprecated types 2018-06-14 18:58:35 +03:00
man Document the recent oauth_cache_rest_failure_life_time option 2021-01-27 17:44:17 +01:00
plugins Rename plugin to not clash with plugin from dep 2020-01-08 10:41:48 +01:00
priv Other minor translation updates 2021-01-27 18:18:18 +01:00
rel Update newest copyright year to 2021 (#3464) 2021-01-27 17:02:06 +01:00
sql Update newest copyright year to 2021 (#3464) 2021-01-27 17:02:06 +01:00
src Document the recent oauth_cache_rest_failure_life_time option 2021-01-27 17:44:17 +01:00
test Update newest copyright year to 2021 (#3464) 2021-01-27 17:02:06 +01:00
tools Update newest copyright year to 2021 (#3464) 2021-01-27 17:02:06 +01: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 Add default values so Travis config validation stops warning 2020-06-08 15:27:37 +02:00
CHANGELOG.md Update changelog 2020-12-15 15:26:23 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-01-09 14:17:55 +01:00
CONTRIBUTING.md + ejabberd mucroom logs (#3468) 2021-01-06 17:33:29 +01: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 Miscellaneous rebar3 fixes 2020-09-23 15:52:21 +01:00
README.md Mention gettext and weblate to update translations 2021-01-12 18:33:27 +01:00
autogen.sh Force regeneration of configure script 2014-04-18 12:13:17 +02:00
configure.ac rebar3 support for main build process 2020-09-21 15:14:12 +01: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 Allow for listening on privileged ports 2021-01-06 18:56:08 +01:00
ejabberd.yml.example Fix YAML syntax in example configuration (#3301) 2020-06-25 12:39:44 +02:00
ejabberdctl.cfg.example Replace Jabber->XMPP and Ejabberd (thanks to Neustradamus)(#3469) 2021-01-11 21:11:20 +01:00
ejabberdctl.template Add 'ejabberdctl foreground-quiet' 2021-01-27 09:24:05 +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 Update 'stun' dependency 2021-01-22 16:12:48 +01:00
mix.lock Update 'stun' dependency 2021-01-22 16:12:48 +01:00
rebar Recompile rebar script with OTP17.5 2017-08-23 11:45:10 +03:00
rebar.config Update newest copyright year to 2021 (#3464) 2021-01-27 17:02:06 +01:00
rebar.config.script Update newest copyright year to 2021 (#3464) 2021-01-27 17:02:06 +01:00
vars.config.in Update newest copyright year to 2021 (#3464) 2021-01-27 17:02: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.
    • 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.

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

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/