Chapril/xmpp.chapril.org-ejabberd
25
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-11-22 16:20:52 +01:00
Code Releases Activity
6,907 Commits 7 Branches 109 Tags 66 MiB
Erlang 93.7%
Shell 2.3%
Elixir 1.1%
TSQL 1%
Perl 0.5%
Other 1.3%
1ed788d00c
Go to file
Christophe Romain 1ed788d00c Remove useless config file (#2665) 
Config file should be generated at packaging/installation stage
/ejabberd.yml.example is the default template which can be used
as default configuration
2018-12-05 17:17:52 +01:00
.github Update issue templates 2018-11-19 10:37:04 +01:00
.travis Travis CI: Update MySQL APT repository key 2017-02-20 21:17:34 +01:00
config Remove useless config file (#2665) 2018-12-05 17:17:52 +01:00
examples Move mod_irc to ejabberd-contrib 2018-06-20 12:27:44 +03:00
include Keep info about carbons inside session table 2018-12-01 13:33:44 +03:00
lib Support for Elixir configuration file #1208 2016-09-08 11:37:14 +02:00
m4 Do not check for deprecated types 2018-06-14 18:58:35 +03:00
plugins Call configure on deps in separate rebar command that compile 2018-01-15 12:31:47 +01:00
priv Clean up contributed code for Redis SM 2018-07-14 17:53:00 +03:00
rel Update copyright date automatically (#1442) 2017-01-02 21:42:06 +01:00
sql Keep info about carbons inside session table 2018-12-01 13:33:44 +03:00
src Add auth:which_user_exist to bulk checking existence of list of users 2018-12-05 14:22:09 +01:00
test Improve tests for mod_private 2018-11-23 16:24:44 +03:00
tools Add xml compression to sql backend of mam 2018-11-28 11:25:16 +01:00
win32 Move mod_irc to ejabberd-contrib 2018-06-20 12:27:44 +03: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 Another attempt for db access on travis 2018-11-19 13:53:06 +01:00
autogen.sh Force regeneration of configure script 2014-04-18 12:13:17 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-01-09 14:17:55 +01:00
configure.ac Move mod_irc to ejabberd-contrib 2018-06-20 12:27:44 +03:00
configure.bat Switch to rebar build tool 2013-06-13 11:11:02 +02:00
CONTRIBUTING.md Remove unused link 2018-11-21 11:54:02 +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
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 Increase start-up/stop timeout in systemd unit 2018-06-07 17:40:05 +02:00
ejabberd.yml.example Config template recommend "open" access_model 2018-10-15 23:15:51 +00:00
ejabberdctl.cfg.example Fix Erlang limits in ejabberdctl.cfg.example to reflect current situation 2018-06-23 20:01:21 +03:00
ejabberdctl.template ejabberdctl: fix parameter parsing 2018-04-25 00:41:30 +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
Makefile.in missing priv/lua/redis_sm.lua 2018-10-29 18:25:04 +09:00
mix.exs Revert "Upgrade Elixir to 1.6.6 (#2653)" 2018-11-27 11:01:52 +01:00
mix.lock Bump lager version in mix as well 2018-11-23 13:00:19 +01:00
README.md Markdown version is the main README version 2018-11-19 10:39:54 +01:00
rebar Recompile rebar script with OTP17.5 2017-08-23 11:45:10 +03:00
rebar.config Use tagged version of pkix dependency 2018-12-05 10:11:37 +01:00
rebar.config.script Use named functions instead of carrying self as argument 2018-01-29 10:02:20 +01:00
vars.config.in Do not check for deprecated types 2018-06-14 18:58:35 +03: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).
    • 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.0.
  • 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. 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