Difference between revisions of "How To Use Docker Toolbox With MPB"

From MOD Wiki
Jump to navigation Jump to search
(more advanced)
(4 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
This is a quick start guide to get the mod-plugin-plugin working inside docker, running in Windows or MacOS.
 
This is a quick start guide to get the mod-plugin-plugin working inside docker, running in Windows or MacOS.
  
We'll be using [https://www.docker.com/products/docker-toolbox Docker Toolbox] for this.<br/>
+
If you're not using Linux please install [https://www.docker.com/products/docker-toolbox Docker Toolbox], so you can access docker from within a nice pre-setup VM for it.
So before we begin please install that first.
 
  
== Docker Basics ==
+
== Pre-compiled image ==
  
 
After you install and run docker toolbox you should be presented with a command-line interface.<br/>
 
After you install and run docker toolbox you should be presented with a command-line interface.<br/>
Line 33: Line 32:
 
</source>
 
</source>
  
== Docker Advanced ==
+
== Full build (advanced, long) ==
  
 
If you don't want to use a pre-compiled image, you can build mod-plugin-builder yourself.
 
If you don't want to use a pre-compiled image, you can build mod-plugin-builder yourself.
Line 39: Line 38:
  
 
<source lang="console">
 
<source lang="console">
$ docker run --rm -ti --name mpb -p 9000:9000 mpb
+
$ git clone --depth 1 git://github.com/moddevices/mod-plugin-builder
 +
$ cd mod-plugin-builder/docker
 +
$ docker build -t mod-plugin-builder .
 
</source>
 
</source>
  
If you wish to have a local folder accessible inside the docker environment, use the '-v' argument with the local and docker mapped folder joined by a semi-colon. Like this:
+
Note: It will take a very long time...
 
 
<source lang="console">
 
$ docker run --rm -ti --name mpb -p 9000:9000 -v /path/to/docker/files:/tmp/mbs mpb
 
</source>
 
  
Without closing the console window, run the following to start building mod-plugin-builder:
+
After it's done, we create a container from mod-plugin-builder by running:
  
 
<source lang="console">
 
<source lang="console">
$ git clone git://github.com/moddevices/mod-plugin-builder
+
$ docker run -ti --name mpb -p 9000:9000 -v ~/local-mod-folder:/tmp/local-mod-folder mod-plugin-builder
$ cd mod-plugin-builder
+
$ exit
$ ./bootstrap.sh
 
 
</source>
 
</source>
  
 
+
That's it, the command to start the mod-plugin-builder environment is:
After you close the console window, you can resume where you left off by running:
 
  
 
<source lang="console">
 
<source lang="console">

Revision as of 13:15, 1 September 2016

Introduction

This is a quick start guide to get the mod-plugin-plugin working inside docker, running in Windows or MacOS.

If you're not using Linux please install Docker Toolbox, so you can access docker from within a nice pre-setup VM for it.

Pre-compiled image

After you install and run docker toolbox you should be presented with a command-line interface.
This console is actually running Linux inside a virtual machine, but without you having to do any configuration or setup.

To begin, we download the pre-compiled mod-plugin-builder docker image by running:

$ docker run -ti --name mpb -p 9000:9000 moddevices/mod-plugin-builder

If you wish to have a local folder accessible inside the docker environment, use the '-v' argument with the local and docker mapped folder joined by a semi-colon. Like this:

$ docker run -ti --name mpb -p 9000:9000 -v ~/local-mod-folder:/tmp/local-mod-folder moddevices/mod-plugin-builder

Some notes:

  • The image size is around 1Gb, split across several files.
  • The previous commands will create a new docker environment every time you run them. You only need them once.


After you close the console window, you can resume where you left off by running:

$ docker start -i mpb

Full build (advanced, long)

If you don't want to use a pre-compiled image, you can build mod-plugin-builder yourself. To begin, start docker and run:

$ git clone --depth 1 git://github.com/moddevices/mod-plugin-builder
$ cd mod-plugin-builder/docker
$ docker build -t mod-plugin-builder .

Note: It will take a very long time...

After it's done, we create a container from mod-plugin-builder by running:

$ docker run -ti --name mpb -p 9000:9000 -v ~/local-mod-folder:/tmp/local-mod-folder mod-plugin-builder
$ exit

That's it, the command to start the mod-plugin-builder environment is:

$ docker start -i mpb


You can find more information about docker here.