Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Equuleus Adjusted some content for easier reading #1210

Merged
merged 1 commit into from
Dec 30, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 34 additions & 31 deletions docs/contributing/build-vyos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down
Loading