x/dox
Code Issues Proposed changes

Update doc for 1.3 bootdocker

Browse Source 
Change-Id: Ib5bb960de9dc76b2a87b3bed916da77519453e22
This commit is contained in:
Chmouel Boudjnah 2014-10-20 22:17:30 +02:00
parent 94fe98a0d0
commit 6e48f91bde
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.rst
View File

@ -114,16 +114,15 @@ there is a tool called `boot2docker <http://boot2docker.io/>`_ which
allows you to run a remote docker server in a VirtualBox VM and the
client running on the non Linux desktop.
There is no support for mounted volumes by default with `boot2docker` which is needed by `dox`.
To get this feature you will need to follow these steps documented here :
Volume support started to be supported by `boot2docker` since docker version
1.3. You will need to be at least on that version to have volume mount support.
https://medium.com/boot2docker-lightweight-linux-for-docker/boot2docker-together-with-virtualbox-guest-additions-da1e3ab2465c
When running dox you will need to specify the docker username from the boot2docker vm, commonly like this::
If you username id is different from the docker username on the `boot2docker` vm,
you will need to specify it on the command line, like this::
dox --user-map=docker:1000:10
If you use VirtualBox guest additions to mount your osx onto the boot2docker vm,
If you use VirtualBox guest additions to mount your osx onto the `boot2docker` vm,
example /Users/your_name/openstack/oslo-incubator as /home/your_name/openstack/oslo-incubator,
then you can add the following mapping::