summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsofukong <130022807+sofukong@users.noreply.github.com>2023-12-23 11:03:57 +0800
committerChristian Breunig <christian@breunig.cc>2023-12-30 10:53:54 +0100
commit759fa2c156293c3baf75d8e496e85f936159c0f9 (patch)
treec9ae19ec0536d188fa18782fd43e5600eeb97602
parent993888a81301bc08a0b434f262c4f977ee623c73 (diff)
downloadvyos-documentation-759fa2c156293c3baf75d8e496e85f936159c0f9.tar.gz
vyos-documentation-759fa2c156293c3baf75d8e496e85f936159c0f9.zip
build: optimized placement of content for easier reading
-rw-r--r--docs/contributing/build-vyos.rst65
1 files changed, 34 insertions, 31 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst
index e873a3c4..d107879e 100644
--- a/docs/contributing/build-vyos.rst
+++ b/docs/contributing/build-vyos.rst
@@ -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: