Dockerfile to build an ejabberd container image.
Current Version: 15.11
Docker Tag Names are based on ejabberd versions in git branches and tags. The image tag :latest
is based on the master branch.
You can start of with the following container:
docker run -d \
--name "ejabberd" \
-p 5222:5222 \
-p 5269:5269 \
-p 5280:5280 \
-h 'xmpp.example.de' \
-e "XMPP_DOMAIN=example.de" \
-e "ERLANG_NODE=ejabberd" \
-e "[email protected] [email protected]" \
-e "[email protected]:password1234 [email protected]" \
-e "TZ=Europe/Berlin" \
rroemhild/ejabberd
or with the docker-compose example
wget https://raw.githubusercontent.com/rroemhild/docker-ejabberd/master/examples/docker-compose/docker-compose.yml
docker-compose up
For storage of the application data, you can mount volumes at
/opt/ejabberd/ssl
/opt/ejabberd/backup
/opt/ejabberd/upload
/opt/ejabberd/database
or use a data container
docker create --name ejabberd-data rroemhild/ejabberd-data
docker run -d --name ejabberd --volumes-from ejabberd-data rroemhild/ejabberd
TLS is enabled by default and the run script will auto-generate two snake-oil certificates during boot if you don't provide your SSL certificates.
To use your own certificates, there are two options.
- Mount the volume
/opt/ejabberd/ssl
to a local directory with the.pem
files:
- /tmp/ssl/host.pem (SERVER_HOSTNAME)
- /tmp/ssl/xmpp_domain.pem (XMPP_DOMAIN)
Make sure that the certificate and private key are in one .pem
file. If one file is missing it will be auto-generated. I.e. you can provide your certificate for your XMMP_DOMAIN and use a snake-oil certificate for the SERVER_HOSTNAME
.
- Specify the certificates via environment variables: SSLCERT_HOST and SSLCERT_EXAMPLE_COM. For the domain certificates, make sure you match the domain names given in XMPP_DOMAIN.
Build your own ejabberd container image and add your config templates, certificates or extend it for your needs.
FROM rroemhild/ejabberd
ADD ./ejabberd.yml.tpl /opt/ejabberd/conf/ejabberd.yml.tpl
ADD ./ejabberdctl.cfg.tpl /opt/ejabberd/conf/ejabberdctl.cfg.tpl
ADD ./example.com.pem /opt/ejabberd/ssl/example.com.pem
If you need root privileges switch to USER root
and go back to USER ejabberd
when you're done.
By default ejabberd runs as user ejabberd(999). To run ejabberd as root add the -u root
argument to docker run
.
docker run -d -u root -P rroemhild/ejabberd
The docker-compose-cluster example demonstrates how to extend this container image to setup a multi-master cluster.
You can additionally provide extra runtime configuration in a downstream image by replacing the config template ejabberd.yml.tpl
with one based on this image's template and include extra interpolation of environment variables. The template is parsed by Jinja2 with the runtime environment (equivalent to Python's os.environ
available as env
).
By default the container will serve the XMPP domain localhost
. In order to serve a different domain at runtime, provide the XMPP_DOMAIN variable with a domain name. You can add more domains separated with whitespace.
XMPP_DOMAIN=example.ninja xyz.io test.com
Authentication methods can be set with the EJABBERD_AUTH_METHOD environment variable. The default authentication mode is internal
.
Supported authentication methods:
- anonymous
- internal
Internal and anonymous authentication:
AUTH_METHOD=internal anonymous
Set one or more admin user (seperated by whitespace) with the EJABBERD_ADMINS environment variable. You can register admin users with the EJABBERD_USERS environment variable during container startup, use you favorite XMPP client or the ejabberdctl
command line utility.
Automatically register users during container startup. Uses random password if you don't provide a password for the user. Format is JID:PASSWORD
. Register more users separated with whitespace.
Register the admin user from EJABBERD_ADMINS with a give password:
[email protected]:password1234
Or without a random password printed to stdout (check container logs):
Register more than one user:
[email protected]:password1234 [email protected] [email protected]
- EJABBERD_SSLCERT_HOST: SSL Certificate for the hostname.
- EJABBERD_SSLCERT_EXAMPLE_COM: SSL Certificates for XMPP domains.
- EJABBERD_STARTTLS: Set to
false
to disable StartTLS for client to server connections. Defaults totrue
. - EJABBERD_S2S_SSL: Set to
false
to disable SSL in server 2 server connections. Defaults totrue
. - EJABBERD_HTTPS: If your proxy terminates SSL you may want to disable HTTPS on port 5280 and 5443. Defaults to
true
. - EJABBERD_PROTOCOL_OPTIONS_TLSV1: Allow TLSv1 protocol. Defaults to
false
.
- ERLANG_NODE: Allows to explicitly specify erlang node for ejabberd. Set to
ejabberd
lets erlang add the hostname. Defaults toejabberd@localhost
. - ERLANG_COOKIE: Set erlang cookie. Defaults to auto-generated cookie.
- ERLANG_OPTIONS: Overwrite additional options passed to erlang while starting ejabberd.
- EJABBERD_SKIP_MODULES_UPDATE: If you do not need to update ejabberd modules specs, skip the update task and speedup start. Defaults to
false
. - EJABBERD_MOD_MUC_ADMIN: Activate the mod_muc_admin module. Defaults to
false
. - EJABBERD_MOD_ADMIN_EXTRA: Activate the mod_muc_admin module. Defaults to
true
. - EJABBERD_REGISTER_TRUSTED_NETWORK_ONLY: Only allow user registration from the trusted_network access rule. Defaults to
true
.
Use the EJABBERD_LOGLEVEL environment variable to set verbosity. Defaults to 4
(Info).
loglevel: Verbosity of log files generated by ejabberd.
0: No ejabberd log at all (not recommended)
1: Critical
2: Error
3: Warning
4: Info
5: Debug
The ejabberdctl
command is in the search path and can be run by:
docker exec CONTAINER ejabberdctl help
docker exec CONTAINER ejabberdctl register user XMPP_DOMAIN PASSWORD
Create a backupfile with ejabberdctl and copy the file from the container to localhost
docker exec CONTAINER ejabberdctl backup /opt/ejabberd/backup/ejabberd.backup
docker cp CONTAINER:/opt/ejabberd/backup/ejabberd.backup /tmp/ejabberd.backup
Copy the backupfile from localhost to the running container and restore with ejabberdctl
docker cp /tmp/ejabberd.backup CONTAINER:/opt/ejabberd/backup/ejabberd.backup
docker exec CONTAINER ejabberdctl restore /opt/ejabberd/backup/ejabberd.backup
Set -i
and -t
option and append live
to get an interactive erlang shell:
docker run -i -t -P rroemhild/ejabberd live
You can terminate the erlang shell with q().
.
docker run -i -t rroemhild/ejabberd shell
docker run -i -t rroemhild/ejabberd env
- 4560 (XMLRPC)
- 5222 (Client 2 Server)
- 5269 (Server 2 Server)
- 5280 (HTTP admin/websocket/http-bind)
- 5443 (HTTP Upload)