From ae09e48b49b97e7a558eebf5c0b223c877f7d6cf Mon Sep 17 00:00:00 2001
From: bjoern <bjoern.riemer@web.de>
Date: Thu, 18 Feb 2016 17:36:01 +0100
Subject: added readme for docker

---
 README_DOCKER.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README_DOCKER.md

(limited to 'README_DOCKER.md')

diff --git a/README_DOCKER.md b/README_DOCKER.md
new file mode 100644
index 0000000..038af85
--- /dev/null
+++ b/README_DOCKER.md
@@ -0,0 +1,38 @@
+# HowTo use the Docker version of Voctomix
+## build the docker container locally
+- checkout branch: 
+```
+git checkout quickstart-docker
+```
+- build docker
+```
+docker build -t local/voctomix .
+```
+- rebuild docker after changes
+```
+docker tag local/voctomix:latest local/voctomix:old; \
+docker build -t local/voctomix . && docker rmi local/voctomix:old
+```
+
+## Test the docker
+the entrypoint script of the container provides some commands to ease the startup of the individual components. get a list by running
+```docker run --rm -it --name=voctocore local/voctomix core```
+
+## Run the components
+### CORE
+```
+docker run --rm -it --name=voctocore local/voctomix core
+```
+### Source example scripts
+```
+docker run -it --rm --name=cam1 --link=voctocore:corehost local/voctomix ./gstreamer/source-videotestsrc-as-cam1.sh
+docker run -it --rm --name=bg --link=voctocore:corehost local/voctomix gstreamer/source-videotestsrc-as-background-loop.sh
+```
+
+### GUI
+to run the GUI in a docker the docker user needs access to the local X server. This is done by sharing the ```/tmp/.X11-unix``` socket with the container. Depending on your X11 setup you have to allow access to the X-Server session by running: ```xhost +local:$(id -un)```
+The example below maps the local voctogui config file ```/tmp/vocto/configgui.ini``` into the container. Please create and change this file to change the voctogui configuration.
+```
+docker run -it --rm --name=gui --env=gid=$(id -g) --env=uid=$(id -u) --env=DISPLAY=:0 --link=voctocore:corehost \
+  -v /tmp/vocto/configgui.ini:/opt/voctomix/voctogui/config.ini -v /tmp/.X11-unix:/tmp/.X11-unix -v /tmp/.docker.xauth:/tmp/.docker.xauth local/voctomix gui
+```
-- 
cgit v1.2.3


From d83f3983119d0a9c97b684c94eaeb8ed58fdb591 Mon Sep 17 00:00:00 2001
From: bjoern <bjoern.riemer@web.de>
Date: Thu, 18 Feb 2016 18:09:55 +0100
Subject: some typo fixes in the documentation

---
 README_DOCKER.md | 2 +-
 docker-ep.sh     | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'README_DOCKER.md')

diff --git a/README_DOCKER.md b/README_DOCKER.md
index 038af85..e03e77b 100644
--- a/README_DOCKER.md
+++ b/README_DOCKER.md
@@ -25,7 +25,7 @@ docker run --rm -it --name=voctocore local/voctomix core
 ```
 ### Source example scripts
 ```
-docker run -it --rm --name=cam1 --link=voctocore:corehost local/voctomix ./gstreamer/source-videotestsrc-as-cam1.sh
+docker run -it --rm --name=cam1 --link=voctocore:corehost local/voctomix gstreamer/source-videotestsrc-as-cam1.sh
 docker run -it --rm --name=bg --link=voctocore:corehost local/voctomix gstreamer/source-videotestsrc-as-background-loop.sh
 ```
 
diff --git a/docker-ep.sh b/docker-ep.sh
index e61bad5..17b1ac4 100755
--- a/docker-ep.sh
+++ b/docker-ep.sh
@@ -3,7 +3,7 @@
 ## entrypoint for the docker images
 
 if [ ! -f /.dockerenv ] && [ ! -f /.dockerinit ]; then
-	echo "WARNING: this scrip should be only runed inside docker!!"
+	echo "WARNING: this script should be only run inside docker!!"
 	exit 1
 fi
 
-- 
cgit v1.2.3