vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

contribution: build: use 80 char line breaks

Browse Source
This commit is contained in:
Christian Poessinger 2019-11-09 11:19:21 +01:00
parent ae21024935
commit c1c736ff6e
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/contributing/build-vyos.rst
View File

@ -3,8 +3,9 @@
Building VyOS Building VyOS
============= =============
This will guide you though the process of building a VyOS ISO using This will guide you though the process of building a VyOS ISO using Docker_.
Docker_. This process has been tested on clean installs of Debian Jessie, Stretch, and Buster. This process has been tested on clean installs of Debian Jessie, Stretch, and
Buster.
.. note:: Starting with VyOS 1.2 the release model of VyOS has changed. .. note:: Starting with VyOS 1.2 the release model of VyOS has changed.
VyOS is now **free as in speech, but not as in beer**. This means VyOS is now **free as in speech, but not as in beer**. This means
@ -15,7 +16,7 @@ Docker_. This process has been tested on clean installs of Debian Jessie, Stret
The source code remains public and an ISO can be built The source code remains public and an ISO can be built
using the process outlined here. using the process outlined here.
Installing Docker_ and prerequisites Installing Docker_ and prerequisites:
.. code-block:: sh .. code-block:: sh
@ -40,10 +41,10 @@ To be able to use Docker_, the current non-root user should be added to the
Generating the container Generating the container
---------------------- ----------------------
The container can built by hand or by fetching the pre-built one from The container can built by hand or by fetching the pre-built one from DockerHub.
DockerHub. Using the pre-built VyOS DockerHub organisation (https://hub.docker.com/u/vyos) will Using the pre-built VyOS DockerHub organisation (https://hub.docker.com/u/vyos)
ensure that the container is always up-to-date. A rebuild is triggered once the will ensure that the container is always up-to-date. A rebuild is triggered once
container changes (please note this will take 2-3 hours after pushing to the container changes (please note this will take 2-3 hours after pushing to
the vyos-build repository). the vyos-build repository).
The container can always be built directly from source: The container can always be built directly from source:
@ -57,9 +58,8 @@ The container can always be built directly from source:
found on your local machine when the below command is executed. found on your local machine when the below command is executed.
.. note: We require one container per build branch, this means that the used .. note: We require one container per build branch, this means that the used
container in ``crux`` and ``current`` can and will differ once VyOS makes the container in ``crux`` and ``current`` can and will differ once VyOS makes
move towards Debian (10) Buster. the move towards Debian (10) Buster.
Build ISO inside container Build ISO inside container
-------------------------- --------------------------
@ -116,7 +116,8 @@ The successfully built ISO should now be in the `build/` directory.
Good luck! Good luck!
.. note: The build process does not differentiate when building a ``crux`` ISO or ``rolling`` .. note:: The build process does not differentiate when building a ``crux`` ISO
image. Make sure to choose the matching container for the version of VyOS that is being built. or ``rolling`` image. Make sure to choose the matching container for the
version of VyOS that is being built.
.. _Docker: https://www.docker.com .. _Docker: https://www.docker.com