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

Merge pull request #1210 from sofukong/equuleus

Browse Source 
Equuleus Adjusted some content for easier reading
This commit is contained in:
Christian Breunig 2023-12-30 10:54:56 +01:00 committed by GitHub
commit 125e2a2ef2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,15 +26,46 @@ also set up your own build machine and run a :ref:`build_native`.
Due to some differences in the version update and construction process,
this page no longer includes content related to VyOS 1.4 and above.
This will guide you though the process of building a VyOS ISO using Docker_.
This process has been tested on clean installs of Debian Bullseye (11) and
Bookworm (12).
.. _build_native:
Native Build
============
To build VyOS natively you require a properly configured build host with the
following Debian versions installed:
- Debian Jessie for VyOS 1.2 (crux)
- Debian Buster for VyOS 1.3 (equuleus)
To start, clone the repository to your local machine:
.. code-block:: none
# For VyOS 1.2 (crux)
$ git clone -b crux --single-branch https://github.com/vyos/vyos-build
# For VyOS 1.3 (equuleus)
$ git clone -b equuleus --single-branch https://github.com/vyos/vyos-build
$ cd vyos-build
# For VyOS 1.2 (crux) and VyOS 1.3 (equuleus)
$ ./configure --architecture amd64 --build-by "j.randomhacker@vyos.io"
$ sudo make iso
For the packages required, you can refer to the ``docker/Dockerfile`` file
in the repository_. The ``./build-vyos-image`` script will also warn you if any
dependencies are missing.
.. _build_docker:
Docker
======
This will guide you though the process of building a VyOS ISO using Docker_.
This process has been tested on clean installs of Debian Bullseye (11) and
Bookworm (12).
Installing Docker_ and prerequisites:
.. hint:: Due to the updated version of Docker, the following examples may
@ -208,34 +239,6 @@ directory.
``--sysctl net.ipv6.conf.lo.disable_ipv6=0``, otherwise those tests
will fail.
.. _build_native:
Native Build
============
To build VyOS natively you require a properly configured build host with the
following Debian versions installed:
- Debian Jessie for VyOS 1.2 (crux)
- Debian Buster for VyOS 1.3 (equuleus)
To start, clone the repository to your local machine:
.. code-block:: none
# For VyOS 1.2 (crux)
$ git clone -b crux --single-branch https://github.com/vyos/vyos-build
# For VyOS 1.3 (equuleus)
$ git clone -b equuleus --single-branch https://github.com/vyos/vyos-build
For the packages required, you can refer to the ``docker/Dockerfile`` file
in the repository_. The ``./configure`` script will also warn you if any
dependencies are missing.
Once you have the required dependencies installed, you may proceed with the
steps described in :ref:`build_iso`.
.. _build_iso: