summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharles Teese <charles@unixninja92.com>2018-09-02 16:24:34 -0400
committerDaniil Baturin <daniil@baturin.org>2018-09-03 03:24:34 +0700
commit4f7540f6f8e04352cc7f3c879fa129e9abb155de (patch)
treeb19c0a5c0325bcff1286dc773dcda34a9daae079 /README.md
parentc8297009c5158a47378503c2571b0885fe383de4 (diff)
downloadvyos-build-4f7540f6f8e04352cc7f3c879fa129e9abb155de.tar.gz
vyos-build-4f7540f6f8e04352cc7f3c879fa129e9abb155de.zip
Added simpler docker instructions for linux and fixed for mac and windows (#24)
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index 835b687f..96957fd9 100644
--- a/README.md
+++ b/README.md
@@ -77,8 +77,8 @@ package build scripts will tell you.
## Building the ISO image inside a docker container
Using our `Dockerfile` you can create your own Docker container that can be used
-to build a VyOS ISO image. The `Dockerfile` contains some of the most used
-packages needed for a VyOS build ISO process.
+to build a VyOS ISO image. The `Dockerfile` contains all of the packages needed
+for the VyOS build ISO process.
```
squashfs-tools # Required for squashfs file system
@@ -109,9 +109,21 @@ To build the docker image:
docker build -t vyos-builder $PATH_TO_Dockerfile
```
+### Linux
+
+To run the docker image:
+```
+docker run -it --privileged -v /HOST_PATH_OF_VYOS_BUILD_REPO:/vyos -w="/vyos" vyos-builder bash
+```
+
+This will drop you into a bash shell with this vyos-build repo mounted at /vyos.
+Then follow the instructions bellow to build the VyOS iso.
+
+### MacOS and Windows
+
To run the docker image:
```
-docker run --privileged -v /HOST_PATH/images:/vyos --name=vyos_node_builder -d vyos-builder bash
+docker run -dt --privileged -v /HOST_PATH/images:/vyos --name=vyos_node_builder vyos-builder bash
```
NOTE: