diff options
| author | Daniil Baturin <daniil@vyos.io> | 2020-05-20 01:05:01 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-20 01:05:01 +0700 |
| commit | f84e1d07cf3f833a84aba0b2000bb61a15308b3c (patch) | |
| tree | a4691682f541040d723752f256065af33f7cdf06 | |
| parent | 074e2c1268a654c9196a4966c7a8cbfbd2c2a3c1 (diff) | |
| parent | 7a64d8cab0004ee17a26085f22fc532ad6151da0 (diff) | |
| download | vyos-documentation-f84e1d07cf3f833a84aba0b2000bb61a15308b3c.tar.gz vyos-documentation-f84e1d07cf3f833a84aba0b2000bb61a15308b3c.zip | |
Merge pull request #255 from fetzerms/clarfiy-docker-documentation
T2474: Contributing/Docker: Put more detail into building instructions.
| -rw-r--r-- | docs/contributing/build-vyos.rst | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 5c7f5205..302f828c 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -48,7 +48,14 @@ will ensure that the container is always up-to-date. A rebuild is triggered once the container changes (please note this will take 2-3 hours after pushing to the vyos-build repository). -The container can always be built directly from source: +To download the container from DockerHub run: + +.. code-block:: none + + $ docker pull vyos/vyos-build:crux # for the LTS version + $ docker pull vyos/vyos-build:current # for the current version + +The container can also be built directly from source: .. code-block:: none @@ -69,16 +76,29 @@ Build ISO --------- After the container is generated either manually or fetched from DockerHub, -a fresh build of the VyOS ISO can begin. +a fresh build of the VyOS ISO can begin. + +If you pulled the image from DockerHub, you need to clone the repository to +your local machine: + +.. code-block:: none + + $ git clone -b current --single-branch https://github.com/vyos/vyos-build + +After cloning, change directory to the ``vyos-build`` directory and run: .. code-block:: none + $ cd vyos-build $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build bash vyos_bld@d4220bb519a0:/vyos# ./configure --architecture amd64 \ --build-by "your@email.tld" \ --build-type release --version 1.2.0 vyos_bld@d4220bb519a0:/vyos# sudo make iso +When the build is successful, the resulting iso can be found inside the ``build`` +directory. + .. note:: Attempting to use the docker build image on MacOS or Windows will fail as docker does not expose all the filesystem feature required to the container. Building within a VirtualBox server on Mac or Windows is however possible. |