aboutsummaryrefslogtreecommitdiff
path: root/test/docker/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/docker/README.md')
-rw-r--r--test/docker/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/test/docker/README.md b/test/docker/README.md
new file mode 100644
index 000000000..01bdeb832
--- /dev/null
+++ b/test/docker/README.md
@@ -0,0 +1,26 @@
+# Docker database images to run ejabberd tests
+
+You can start the Docker environment with Docker Compose, from ejabberd repository root.
+
+The following command will launch MySQL, PostgreSQL, Redis and Riak, and keep the console
+attached to it.
+
+```
+mkdir test/docker/db/mysql/data
+mkdir test/docker/db/postgres/data
+mkdir test/docker/db/riak/data
+(cd test/docker; docker-compose up)
+```
+
+You can stop all the databases with CTRL-C.
+
+You can fully clean up the environment with:
+
+```
+(cd test/docker; docker-compose down)
+```
+
+## TODO
+
+- Document how to fully clean the test data.
+