[server] Build and run dozmod-server as Docker container

1 files changed, 28 insertions, 0 deletions

diff --git a/dozentenmodulserver/README.md b/dozentenmodulserver/README.md
new file mode 100644
index 00000000..d5a48233
--- /dev/null
+++ b/dozentenmodulserver/README.md
@@ -0,0 +1,28 @@
+# dozmod-server - Server to manage virtual machine images
+
+## Build
+
+### Java package
+The dozmod-server can be built as a Java archive (.jar) using the following command line call:
+
+```shell
+mvn package
+```
+
+The built package can be found at `target/dozmod-server-*-jar-with-dependencies.jar`.
+
+
+### Docker container
+A docker image of the dozmod-server and its required infrastructure can be built and started with the following command line call:
+
+```shell
+mvn -P dozmod-server:start
+```
+
+Note that a complete Docker infrastructure (images, containers, networks and volumes) is created and started after this call. To stop the dozmod-server container and its entire infrastructure, use the following command line call:
+
+The running containers can be stopped with the following command line call:
+
+```shell
+mvn -P dozmod-server:stop
+```