2018-11-19 10:39:54 +01:00
2022-05-04 02:36:40 +02:00
< p align = "center" >
2023-04-24 11:27:13 +02:00
< img src = "https://www.process-one.net/wp-content/uploads/2022/05/ejabberd-logo-rounded-index.png" >
2022-05-04 02:36:40 +02:00
< / p >
< p align = "center" >
< a href = "https://github.com/processone/ejabberd/tags" alt = "GitHub tag (latest SemVer)" >
< img src = "https://img.shields.io/github/v/tag/processone/ejabberd?sort=semver&logo=embarcadero&label=&color=3fb0d2&logoWidth=20" / > < / a >
< a href = "https://hex.pm/packages/ejabberd" alt = "Hex version" >
< img src = "https://img.shields.io/hexpm/v/ejabberd.svg" / > < / a >
< a href = "https://formulae.brew.sh/formula/ejabberd" alt = "homebrew version" >
< img src = "https://img.shields.io/homebrew/v/ejabberd" / > < / a >
2023-04-24 11:27:13 +02:00
< a href = "https://hub.docker.com/r/ejabberd/ecs/" alt = "Docker Image Version (latest semver)" >
< img src = "https://img.shields.io/docker/v/ejabberd/ecs?label=ecs&logo=docker" / > < / a >
< a href = "https://github.com/processone/ejabberd/pkgs/container/ejabberd" alt = "GitHub Container" >
< img src = "https://img.shields.io/github/v/tag/processone/ejabberd?label=ejabberd&sort=semver&logo=docker" / > < / a >
2022-05-04 02:36:40 +02:00
< br / >
< a href = "https://github.com/processone/ejabberd/actions/workflows/ci.yml" alt = "CI" >
< img src = "https://github.com/processone/ejabberd/actions/workflows/ci.yml/badge.svg" / > < / a >
< a href = "https://coveralls.io/github/processone/ejabberd?branch=master" alt = "Coverage Status" >
2024-03-11 12:58:48 +01:00
< img src = "https://coveralls.io/repos/github/processone/ejabberd/badge.svg?branch=master" / > < / a >
2022-05-04 02:36:40 +02:00
< a href = "https://hosted.weblate.org/projects/ejabberd/ejabberd-po/" alt = "Translation status" >
2024-03-11 12:58:48 +01:00
< img src = "https://hosted.weblate.org/widgets/ejabberd/-/ejabberd-po/svg-badge.svg" / > < / a >
< a href = "https://docs.ejabberd.im/" alt = "ejabberd Docs" >
< img src = "https://img.shields.io/github/v/tag/processone/docs.ejabberd.im?sort=semver&logo=&label=docs&logoWidth=0" / > < / a >
2022-05-04 02:36:40 +02:00
< / p >
2018-11-19 10:39:54 +01:00
2022-04-22 20:32:57 +02:00
[ejabberd][im] is an open-source,
robust, scalable and extensible realtime platform built using [Erlang/OTP][erlang],
that includes [XMPP][xmpp] Server, [MQTT][mqtt] Broker and [SIP][sip] Service.
2018-11-19 10:39:54 +01:00
2022-04-22 20:32:57 +02:00
Check the features in [ejabberd.im][im], [ejabberd Docs][features],
2022-11-07 18:54:11 +01:00
[ejabberd at ProcessOne][p1home], and the list of [supported protocols in ProcessOne][xeps]
and [XMPP.org][xmppej].
2021-07-16 10:10:12 +02:00
2022-04-22 20:32:57 +02:00
Installation
------------
2021-07-16 10:10:12 +02:00
2022-04-22 20:32:57 +02:00
There are several ways to install ejabberd:
2021-07-16 10:10:12 +02:00
2022-04-22 20:32:57 +02:00
- Source code: compile yourself, see [COMPILE ](COMPILE.md )
2024-02-07 18:49:34 +01:00
- Installers: [ProcessOne Download][p1download] and [GitHub Releases][releases] for releases, [GitHub Actions ](https://github.com/processone/ejabberd/actions/workflows/installers.yml ) for master branch (run/deb/rpm for x64 and arm64)
- `ecs` container image: [Docker Hub][hubecs] and [Github Packages][packagesecs], see [ecs README][docker-ecs-readme] (for x64)
- `ejabberd` container image: [Github Packages][packages] for releases and master branch, see [CONTAINER ](CONTAINER.md ) (for x64 and arm64)
2022-04-22 20:32:57 +02:00
- Using your [Operating System package][osp]
- Using the [Homebrew][homebrew] package manager
2021-07-16 10:10:12 +02:00
2022-04-22 20:32:57 +02:00
Documentation
-------------
2021-07-16 10:10:12 +02:00
2022-04-22 20:32:57 +02:00
Please check the [ejabberd Docs][docs] website.
2021-07-16 10:10:12 +02:00
2022-04-22 20:32:57 +02:00
When compiling from source code, you can get some help with:
2021-07-16 10:10:12 +02:00
2022-04-22 20:32:57 +02:00
./configure --help
2021-07-16 10:10:12 +02:00
make help
2018-11-19 10:39:54 +01:00
2022-04-22 20:32:57 +02:00
Once ejabberd is installed, try:
2018-11-19 10:39:54 +01:00
2022-04-22 20:32:57 +02:00
ejabberdctl help
man ejabberd.yml
2021-01-12 18:33:27 +01:00
2022-04-22 20:32:57 +02:00
Development
-----------
2021-01-12 18:33:27 +01:00
2022-04-22 20:32:57 +02:00
Bug reports and features are tracked using [GitHub Issues][issues],
please check [CONTRIBUTING ](CONTRIBUTING.md ) for details.
Translations can be improved online [using Weblate][weblate]
or in your local machine as explained in [Localization][localization].
Documentation for developers is available in [ejabberd docs: Developers][docs-dev].
2024-02-07 18:49:34 +01:00
There are nightly builds of ejabberd, both for `master` branch and for Pull Requests:
- Installers: go to [GitHub Actions: Installers ](https://github.com/processone/ejabberd/actions/workflows/installers.yml ), open the most recent commit, on the bottom of that commit page, download the `ejabberd-packages.zip` artifact.
- `ejabberd` container image: go to [ejabberd Github Packages][packages]
2022-04-22 20:32:57 +02:00
Security reports or concerns should preferably be reported privately,
2023-02-14 16:12:18 +01:00
please send an email to the address: contact at process-one dot net
2022-04-22 20:32:57 +02:00
or some other method from [ProcessOne Contact][p1contact].
2022-05-04 02:36:40 +02:00
For commercial offering and support, including [ejabberd Business Edition][p1home]
and [Fluux (ejabberd in the Cloud)][fluux], please check [ProcessOne ejabberd page][p1home].
2022-04-22 20:32:57 +02:00
Community
---------
There are several places to get in touch with other ejabberd developers and administrators:
2023-02-14 16:12:18 +01:00
- ejabberd XMPP chatroom: [ejabberd@conference.process-one.net][muc]
2022-04-22 20:32:57 +02:00
- [GitHub Discussions][discussions]
- [Stack Overflow][stackoverflow]
License
-------
2024-02-23 17:16:34 +01:00
ejabberd is released under the GNU General Public License v2 (see [COPYING ](COPYING )),
2022-04-22 20:32:57 +02:00
and [ejabberd translations ](https://github.com/processone/ejabberd-po/ ) under MIT License.
[discussions]: https://github.com/processone/ejabberd/discussions
[docker-ecs-readme]: https://github.com/processone/docker-ejabberd/tree/master/ecs#readme
[docs-dev]: https://docs.ejabberd.im/developer/
[docs]: https://docs.ejabberd.im
[erlang]: https://www.erlang.org/
[features]: https://docs.ejabberd.im/admin/introduction/
2022-05-04 02:36:40 +02:00
[fluux]: https://fluux.io/
2024-04-24 17:23:53 +02:00
[homebrew]: https://docs.ejabberd.im/admin/install/homebrew/
2022-04-22 20:32:57 +02:00
[hubecs]: https://hub.docker.com/r/ejabberd/ecs/
[im]: https://ejabberd.im/
[issues]: https://github.com/processone/ejabberd/issues
[localization]: https://docs.ejabberd.im/developer/extending-ejabberd/localization/
[mqtt]: https://mqtt.org/
[muc]: xmpp:ejabberd@conference.process-one.net
2024-04-24 17:23:53 +02:00
[osp]: https://docs.ejabberd.im/admin/install/os-package/
2022-04-22 20:32:57 +02:00
[p1contact]: https://www.process-one.net/en/company/contact/
2022-10-29 15:15:01 +02:00
[p1download]: https://www.process-one.net/en/ejabberd/downloads/
2022-04-22 20:32:57 +02:00
[p1home]: https://www.process-one.net/en/ejabberd/
[packages]: https://github.com/processone/ejabberd/pkgs/container/ejabberd
2023-04-24 11:27:13 +02:00
[packagesecs]: https://github.com/processone/docker-ejabberd/pkgs/container/ecs
2022-04-22 20:32:57 +02:00
[releases]: https://github.com/processone/ejabberd/releases
[sip]: https://en.wikipedia.org/wiki/Session_Initiation_Protocol
[stackoverflow]: https://stackoverflow.com/questions/tagged/ejabberd?sort=newest
[weblate]: https://hosted.weblate.org/projects/ejabberd/ejabberd-po/
[xeps]: https://www.process-one.net/en/ejabberd/protocols/
[xmpp]: https://xmpp.org/
2022-11-07 18:54:11 +01:00
[xmppej]: https://xmpp.org/software/servers/ejabberd/
2024-02-07 18:49:34 +01:00