Skip to content

Commit aa7975c

Browse files
ppikulappikula
committed
Merge pull request #2 from ppikula/distributed
cleand up and add automatic clustering
2 parents d4ac584 + 4e52f12 commit aa7975c

File tree

5 files changed

+375
-24
lines changed

5 files changed

+375
-24
lines changed

‎.dockerignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.git

‎Dockerfile‎

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,48 @@
1-
FROM ubuntu:14.04
1+
FROM ubuntu:14.10
22
MAINTAINER Pawel Pikula <[email protected]>
33

44
ENV HOME /opt/mongooseim
5-
ENV MONGOOSEIM_VERSION 1.5
6-
ENV DEBIAN_FRONTEND noninteractive
5+
ENV MONGOOSEIM_VERSION stable
6+
ENV MONGOOSEIM_REL_DIR /opt/mongooseim/rel/mongooseim
7+
ENV PATH /opt/mongooseim/rel/mongooseim/bin/:$PATH
8+
9+
# install required packages
10+
RUN apt-get update && apt-get install -y wget \
11+
git \
12+
make \
13+
gcc \
14+
libc6-dev \
15+
libncurses5-dev \
16+
libssl-dev \
17+
libexpat1-dev \
18+
libpam0g-dev
719

820
# add esl packages
9-
RUN apt-get install wget -y
10-
RUN wget https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb
11-
RUN dpkg -i erlang-solutions_1.0_all.deb
12-
RUN wget http://packages.erlang-solutions.com/debian/erlang_solutions.asc
13-
RUN apt-key add erlang_solutions.asc
21+
RUN wget https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb \
22+
&& dpkg -i erlang-solutions_1.0_all.deb \
23+
&& wget http://packages.erlang-solutions.com/debian/erlang_solutions.asc\
24+
&& apt-key add erlang_solutions.asc \
25+
&& apt-get update \
26+
&& apt-get install -y erlang-base \
27+
erlang-dev \
28+
erlang-nox \
29+
erlang-dialyzer \
30+
erlang-reltool
31+
32+
# install mim from source
33+
RUN git clone https://github.com/esl/MongooseIM.git -b $MONGOOSEIM_VERSION /opt/mongooseim \
34+
&& cd /opt/mongooseim \
35+
&& make rel \
36+
&& rm -rf /opt/mongooseim/rel/mongooseim/log \
37+
&& ln -s /data/log /opt/mongooseim/rel/mongooseim/log
1438

39+
ADD ./start.sh start.sh
1540

16-
RUN apt-get -q update
17-
RUN apt-get install mongooseim -y
41+
# expose xmpp, rest, s2s, epmd, distributed erlang
42+
EXPOSE 5222 5280 5269 4369 9100
1843

19-
EXPOSE 5222 5280 5269
20-
#VOLUME ["/usr/lib/mongooseim/", "/usr/lib/mongooseim/"]
44+
# Define mount points.
45+
VOLUME ["/data/mnesia", "/data/log"]
2146

22-
CMD ["live"]
23-
ENTRYPOINT ["/usr/lib/mongooseim/bin/mongooseimctl"]
47+
ENTRYPOINT ["./start.sh"]
2448

‎LICENSE‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+

‎README.md‎

Lines changed: 130 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,142 @@
11
# mongooseim-docker
22

3-
MongooseIM server version 1.5.
3+
MongooseIM server stable version ([other versions](#other-versions))
44

55
MongooseIM is Erlang Solutions' robust and efficient XMPP server aimed at large installations. Specifically designed for enterprise purposes, it is fault-tolerant, can utilize resources of multiple clustered machines and easily scale in need of more capacity (by just adding a box/VM). It provides support for WebSockets and reimplemented BOSH.
66

77
Its home at GitHub is http://github.com/esl/MongooseIM.
88

9-
## Usage
9+
## Exposed ports
1010

11-
### Run in foreground
11+
* 4369 - epmd - erlang port mapper daemon
12+
* 5222 - xmpp port
13+
* 5280 - rest endpoint
14+
* 5269 - port for the s2s communication
15+
* 9100 - port for distributed erlang
1216

13-
`$ docker run -i -t mongooseim/mongooseim-docker`
17+
## Volumes
1418

15-
### Run in background
19+
* `/data/log` - mongooseim logs directory (logs are also available via `docker logs CONTAINER_NAME`
20+
* `/data/mnesia` - mnesia directory. It contains Mnesia.mongoose@hostname directory
1621

17-
`$ docker run -d mongooseim/mongooseim-docker`
22+
## Usage
23+
24+
### Start single node
25+
26+
To start an interactive session and map the XMPP port to the host:
27+
28+
`$ docker run -i -t -p 5222:5222 mongooseim/mongooseim-docker live`
29+
30+
To start MongooseIM in the background (logs are available via `docker logs CONTAINER_NAME`).
31+
32+
`$ docker run -d -t -p 5222:5222 mongooseim/mongooseim-docker`
33+
34+
Note the -t option also for the background case, without it
35+
the `mongooseim debug` shell won't be able to attach to running MongooseIM.
36+
37+
To attach the menstioned debug shell to already running node use:
38+
39+
`$ docker exec -it CONTAINER_NAME mongooseimctl debug`
40+
41+
where CONTAINER_NAME can be obtained via `docker ps` or by explicitly specifing
42+
it using the `--name` option during `docker run`.
43+
44+
Actually with the `docker exec` command you can do any mongoosectl command for example
45+
we can register a new user:
46+
47+
`$ docker exec -it CONTAINER_NAME mongooseimctl mongooseimctl register pawel localhost test`
48+
49+
### Create cluster of the MongooseIM nodes
50+
51+
To be able to create a MongooseIM cluster you need to set the hostname for
52+
the containers. Based on the hostname the `start.sh` script will start a node with
53+
the following sname `mongooseim@HOSTNAME`.
54+
55+
Then, to create a cluster, you first need to start an initial node:
56+
57+
`$ docker run -d -t -h mim1 --name mim1 mongooseim/mongooseim-docker `
58+
59+
sname of initial node will be `mongooseim@mim1`. To start the next node and make
60+
it part of the existing cluster you need to add the `--link` option and set the
61+
`CLUSTER_WITH` env variable:
62+
63+
`$ docker run -d -t -h mim2 --name mim2 --link mim1:mim1 -e CLUSTER_WITH=mim1 mongooseim/mongooseim-docker `
64+
65+
In this example we started a new node with sname: `mognooseim@mim2`
66+
which will join the cluster to which mim1 belongs. Note that link name
67+
and CLUSTER_WITH *must* match the hostname of initial node.
68+
It wouldn't work if set in the following way:
69+
70+
`--link mim1:my_initial_node` and `-e CLUSTER_WITH=my_initial_node_name`.
71+
72+
In this case the IP address will be resolved correctly but it won't match
73+
sname of the CLUSTER_WITH host - as a result nodes won't be able to cluster.
74+
75+
## Change configuration
76+
77+
The best way to replace the default config file is to create a new image that uses
78+
`mongooseim/mongooseim-docker` as a base image and just replace the config file
79+
with the ADD command. Moreover this approach allows you to update any MongooseIM file.
80+
81+
For example new Dockerfile might look like this (assuming that ejabberd.cfg is present in the
82+
current directory:
83+
84+
```
85+
FROM mongooseim/mongooseim-docker
86+
87+
ADD ./ejabberd.cfg /opt/mongooseim/rel/mongooseim/etc/ejabberd.cfg
88+
```
89+
90+
There is also a way that doesn't require creating, so we should be
91+
able to mount the given file with `-v option`:
92+
93+
```
94+
docker run -v `pwd`/ejabberd.cfg:/opt/mongooseim/rel/mongooseim/etc/ejabberd.cfg mongooseim/mongooseim-docker`
95+
```
96+
97+
To get the default config you need to run a container and then use the `docker cp`
98+
command to copy it from container or just take it from https://github.com/esl/MongooseIM/blob/master/rel/files/ejabberd.cfg (remember to select correct branch!)
99+
100+
## Persistent data
101+
102+
There are two volumes that one might want to persist or share between image upgrades:
103+
104+
* `/data/log`
105+
* `/data/mnesia`
106+
107+
To bind a volume you can use -v option:
108+
109+
```
110+
docker run -td -h mim1 -v `pwd`/mnesia:/data/mnesia -v `pwd`/log:/data/log --name mim1 mongooseim/mongooseim-docker
111+
```
112+
113+
It will start a MongooseIM instance and it will bind the mnesia dir and log directory
114+
to the `mnesia` and `log` dir in the current working dir.
115+
116+
The mnesia directory will look like this:
117+
118+
```
119+
ls -l mnesia
120+
drwxr-xr-x 16 pawel.pikula staff 544 May 25 16:05 Mnesia.mongooseim@mim1
121+
drwxr-xr-x 16 pawel.pikula staff 544 May 25 16:05 Mnesia.mongooseim@mim2
122+
```
123+
124+
As a result it is possible to use one volume for all instances, but in case of
125+
the log directory the log files are saved directly in that directory:
126+
127+
```
128+
ls -la log
129+
-rw-r--r-- 1 pawel.pikula staff 0 May 25 16:02 crash.log
130+
-rw-r--r-- 1 pawel.pikula staff 472 May 25 16:02 ejabberd.log
131+
```
132+
133+
Of course we can use data containers instead of our local filesystem. Look at
134+
https://docs.docker.com/userguide/dockervolumes/ for more details.
135+
136+
## Other versions
137+
138+
For the different versions of MongooseIM check the tags tab:
139+
https://registry.hub.docker.com/u/mongooseim/mongooseim-docker/tags/manage/
140+
141+
In case you need a different version you have to fork and edit Dockerfile and change `MONGOOSEIM_VERSION` to desired branch/tag and then build a new image.
18142

19-
## Exposed ports
20-
* 5222
21-
* 5280
22-
* 5269

0 commit comments

Comments
 (0)