diff --git a/README.md b/README.md index 33cd376..63eb490 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,10 @@ VMX makes computer vision easy. Docker makes bundling complex applications easy. The vmx-docker-manager lets you run the VMX Object Detection server on a Linux computer, or a (Mac/Windows) - machine via boot2docker. [We also provide a non-docker native Mac - OS X build of VMX]. + machine via boot2docker. ##Requirements - 64 bit Linux and Docker >= 1.2 + 64 bit Linux and Docker >= 1.2, root permissions to run Docker boot2docker for Mac or Windows ##Instructions @@ -23,14 +22,14 @@ Or download the shell script directly: https://raw.githubusercontent.com/VISIONA Commands: start PORT: Start vmx on localhost:PORT stop: Stop vmx - enter: Shell access to docker + enter: Shell access to a Docker container for inspecting volumes init : Download and start the containers that have the pre-reqs, mcr, etc. (This is done automatically the first time you start vmx) update TAG: Update your vmx (will stop vmx first). TAG must be - "latest" or "dev", defaults to "latest" - backup BACKUP: Backup your vmx data (models, session logs, - config file) to folder BACKUP - + "latest" or "dev", defaults to "latest" when TAG is empty + backup BACKUP: Backup your vmx data (models and config file) to folder BACKUP + restore BACKUP: Restore from a backup + ##Example: Run vmx on port 3000 @@ -61,7 +60,17 @@ or $ ./vmx update dev +##Permissions + +vmx-docker-manager uses Docker which requires permission to run as root, or the +user to be added to the `docker` group. + +To make sure Docker is installed and running correctly on your machine, you can first +try a simple Docker command such as: +``` +docker run -t -i --rm ubuntu echo "Docker runs" +``` ##Explanation @@ -73,9 +82,13 @@ general, VMX requires a few files/folder to be available: - Local Model storage - Certain open source libraries -The VMX Docker manager is a set of sane defaults and configurations that store user data (session and models) in seperate volumes at /vmx/sessions and /vmx/models; and loads the binaries into /vmx/build. Those mount points, along with the matlab MCR dependency are run within the context of an Ubuntu 14.04 with the required libraries. +The VMX Docker manager is a set of sane defaults and configurations +that store user data (session and models) in seperate volumes at +/vmx/sessions and /vmx/models; and loads the binaries into /vmx/build. +Those mount points, along with the matlab MCR dependency are run +within the context of an Ubuntu 14.04 with the required libraries. -The dockerfiles that build the referenced docker images can be found here: +The Dockerfiles that build the referenced Docker images can be found here: - https://github.com/VISIONAI/docker-mcr-2014a - https://github.com/VISIONAI/docker-vmx-userdata