summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorRichard Chen Zheng <58443436+rchenzheng@users.noreply.github.com>2021-04-18 19:14:44 -0400
committerRichard Chen Zheng <58443436+rchenzheng@users.noreply.github.com>2021-04-26 18:47:15 -0400
commit43f5179a9fdbcf27253ef65fa26cc3577e50f637 (patch)
tree5e63000d6625a5c17effcd3947ff81b8addfb347 /docs/contributing
parent5ad87224870d249c75469e828da0afa6c2d55f90 (diff)
downloadvyos-documentation-43f5179a9fdbcf27253ef65fa26cc3577e50f637.tar.gz
vyos-documentation-43f5179a9fdbcf27253ef65fa26cc3577e50f637.zip
T3485: Update build to include MacOS support
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/build-vyos.rst19
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst
index 453edd30..c8924462 100644
--- a/docs/contributing/build-vyos.rst
+++ b/docs/contributing/build-vyos.rst
@@ -188,6 +188,21 @@ Now a fresh build of the VyOS ISO can begin. Change directory to the
# For VyOS 1.3 (equuleus, current)
$ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build:current bash
+.. code-block:: none
+
+ # For MacOS (crux, equuleus, sagitta)
+ $ git clone https://github.com/vyos/vyos-utils-misc
+ $ cd build-tools/macos-build
+
+ # For VyOS 1.2 (crux)
+ $ os=jessie64 branch=crux make build
+
+ # For VyOS 1.3 (equuleus)
+ $ os=buster64 branch=equuleus make build
+
+ # For VyOS 1.4 (sagitta)
+ $ os=buster64 branch=sagitta make build
+
Start the build:
.. code-block:: none
@@ -200,10 +215,6 @@ When the build is successful, the resulting iso can be found inside the
Good luck!
-.. hint:: Attempting to use the Docker build image on MacOS will fail as
- Docker does not expose all the filesystem feature required to the container.
- Building within a VirtualBox server on Mac however possible.
-
.. hint:: Building VyOS on Windows WSL2 with Docker integrated into WSL2 will
work like a charm. No problems are known so far!