10 KiB
ejabberd Community Server
ejabberd is an open-source XMPP server, robust, scalable and modular, built using Erlang/OTP, and also includes MQTT Broker and SIP Service.
This Docker image allows you to run a single node ejabberd instance in a Docker container.
There is an Alternative Image in GitHub Packages, built using a different method and some improvements.
If you are using a Windows operating system, check the tutorials mentioned in ejabberd Docs > Docker Image.
Start ejabberd
With default configuration
You can start ejabberd in a new container with the following command:
docker run --name ejabberd -d -p 5222:5222 --init ejabberd/ecs
This command will run Docker image as a daemon, using ejabberd default configuration file and XMPP domain "localhost".
To stop the running container, you can run:
docker stop ejabberd
If needed, you can restart the stopped ejabberd container with:
docker restart ejabberd
Start with Erlang console attached
If you would like to start ejabberd with an Erlang console attached you can use the live
command:
docker run -it -p 5222:5222 --init ejabberd/ecs live
This command will use default configuration file and XMPP domain "localhost".
Start with your configuration and database
The following command will pass config file using Docker volume feature and share local directory to store database:
mkdir database
docker run -d --name ejabberd -v $(pwd)/ejabberd.yml:/home/ejabberd/conf/ejabberd.yml -v $(pwd)/database:/home/ejabberd/database -p 5222:5222 --init ejabberd/ecs
Next steps
Register the administrator account
The default ejabberd configuration has already granted admin privilege
to an account that would be called admin@localhost
,
so you just need to register such an account
to start using it for administrative purposes.
You can register this account using the ejabberdctl
script, for example:
docker exec -it ejabberd bin/ejabberdctl register admin localhost passw0rd
Check ejabberd log files
You can execute a Docker command to check the content of the log files from inside to container, even if you do not put it on a shared persistent drive:
docker exec -it ejabberd tail -f logs/ejabberd.log
Inspect the container files
The container uses Alpine Linux. You can start a shell there with:
docker exec -it ejabberd sh
Open ejabberd debug console
You can open a live debug Erlang console attached to a running container:
docker exec -it ejabberd bin/ejabberdctl debug
CAPTCHA
ejabberd includes two example CAPTCHA scripts. If you want to use any of them, first install some additional required libraries:
docker exec --user root ejabberd apk add imagemagick ghostscript-fonts bash
Now update your ejabberd configuration file, for example:
docker exec -it ejabberd vi conf/ejabberd.yml
and add the required options:
captcha_cmd: /home/ejabberd/lib/ejabberd-21.1.0/priv/bin/captcha.sh
captcha_url: https://localhost:5443/captcha
Finally, reload the configuration file or restart the container:
docker exec ejabberd bin/ejabberdctl reload_config
Use ejabberdapi
When the container is running (and thus ejabberd), you can exec commands inside the container
using ejabberdctl
or any other of the available interfaces, see
Understanding ejabberd "commands"
Additionally, this Docker image includes the ejabberdapi
executable.
Please check the ejabberd-api homepage
for configuration and usage details.
For example, if you configure ejabberd like this:
listen:
-
port: 5282
module: ejabberd_http
request_handlers:
"/api": mod_http_api
acl:
loopback:
ip:
- 127.0.0.0/8
- ::1/128
- ::FFFF:127.0.0.1/128
api_permissions:
"admin access":
who:
access:
allow:
acl: loopback
what:
- "register"
Then you could register new accounts with this query:
docker exec -it ejabberd bin/ejabberdapi register --endpoint=http://127.0.0.1:5282/ --jid=admin@localhost --password=passw0rd
Advanced Docker configuration
Ports
This Docker image exposes the ports:
5222
: The default port for XMPP clients.5269
: For XMPP federation. Only needed if you want to communicate with users on other servers.5280
: For admin interface.5443
: With encryption, used for admin interface, API, CAPTCHA, OAuth, Websockets and XMPP BOSH.1883
: Used for MQTT4369-4399
: EPMD and Erlang connectivity, used forejabberdctl
and clustering
Volumes
ejabberd produces two types of data: log files and database (Mnesia). This is the kind of data you probably want to store on a persistent or local drive (at least the database).
Here are the volume you may want to map:
/home/ejabberd/conf/
: Directory containing configuration and certificates/home/ejabberd/database/
: Directory containing Mnesia database. You should back up or export the content of the directory to persistent storage (host storage, local storage, any storage plugin)/home/ejabberd/logs/
: Directory containing log files/home/ejabberd/upload/
: Directory containing uploaded files. This should also be backed up.
All these files are owned by ejabberd user inside the container. Corresponding
UID:GID
is 9000:9000
. If you prefer bind mounts instead of docker volumes, then
you need to map this to valid UID:GID
on your host to get read/write access on
mounted directories.
Commands on start
The ejabberdctl script reads the CTL_ON_CREATE
environment variable
the first time the docker container is started,
and reads CTL_ON_START
every time the container is started.
Those variables can contain one ejabberdctl command,
or several commands separated with the blankspace and ;
characters.
Example usage (or check the full example):
environment:
- CTL_ON_CREATE=register admin localhost asd
- CTL_ON_START=stats registeredusers ;
check_password admin localhost asd ;
status
Generating ejabberd release
Configuration
Image is built by embedding an ejabberd Erlang/OTP standalone release in the image.
The configuration of ejabberd Erlang/OTP release is customized with:
rel/config.exs
: Customize ejabberd releaserel/dev.exs
: ejabberd environment configuration for development releaserel/prod.exs
: ejabberd environment configuration for production Docker releasevars.config
: ejabberd compilation configuration optionsconf/ejabberd.yml
: ejabberd default config file
Build ejabberd Community Server base image from ejabberd master on Github:
docker build -t ejabberd/ecs .
Build ejabberd Community Server base image for a given ejabberd version:
./build.sh 18.03
Composer Examples
Minimal Example
This is the barely minimal file to get a usable ejabberd.
Store it as docker-compose.yml
:
services:
main:
image: ejabberd/ecs
container_name: ejabberd
ports:
- "5222:5222"
- "5269:5269"
- "5280:5280"
- "5443:5443"
Create and start the container with the command:
docker-compose up
Customized Example
This example shows the usage of several customizations: it uses a local configuration file, stores the mnesia database in a local path, registers an account when it's created, and checks the number of registered accounts every time it's started.
Download or copy the ejabberd configuration file:
wget https://raw.githubusercontent.com/processone/ejabberd/master/ejabberd.yml.example
mv ejabberd.yml.example ejabberd.yml
Create the database directory and allow the container access to it:
mkdir database
sudo chown 9000:9000 database
Now write this docker-compose.yml
file:
version: '3.7'
services:
main:
image: ejabberd/ecs
container_name: ejabberd
environment:
- CTL_ON_CREATE=register admin localhost asd
- CTL_ON_START=registered_users localhost ;
status
ports:
- "5222:5222"
- "5269:5269"
- "5280:5280"
- "5443:5443"
volumes:
- ./ejabberd.yml:/home/ejabberd/conf/ejabberd.yml:ro
- ./database:/home/ejabberd/database
Clustering Example
In this example, the main container is created first. Once it is fully started and healthy, a second container is created, and once ejabberd is started in it, it joins the first one.
An account is registered in the first node when created, and it should exist in the second node after join.
Notice that in this example the main container does not have access to the exterior; the replica exports the ports and can be accessed.
version: '3.7'
services:
main:
image: ejabberd/ecs
container_name: main
environment:
- ERLANG_NODE_ARG=ejabberd@main
- ERLANG_COOKIE=dummycookie123
- CTL_ON_CREATE=register admin localhost asd
healthcheck:
test: netstat -nl | grep -q 5222
start_period: 5s
interval: 5s
timeout: 5s
retries: 120
replica:
image: ejabberd/ecs
container_name: replica
depends_on:
main:
condition: service_healthy
ports:
- "5222:5222"
- "5269:5269"
- "5280:5280"
- "5443:5443"
environment:
- ERLANG_NODE_ARG=ejabberd@replica
- ERLANG_COOKIE=dummycookie123
- CTL_ON_CREATE=join_cluster ejabberd@main
- CTL_ON_START=registered_users localhost ;
status