VyOS image build scripts
Find a file
Simon 571943a976
Some checks failed
Perform CodeQL Analysis / codeql-analysis-call (push) Has been cancelled
Trigger to build package / changes (push) Has been cancelled
Merge pull request #1097 from giga1699/T8146
T8146: Confirm the key when config encryption is configured without TPM
2026-01-07 13:00:04 +01:00
.github T8144: Updated trigger-docker-image-build workflow for pull_request_target policy change 2026-01-04 15:58:41 +05:30
data Merge pull request #1083 from c-po/qemu-reuse-qcow2 2025-12-29 17:45:32 +01:00
docker kea: T8092: Build kea from source 2025-12-19 12:55:54 +01:00
docker-vyos Docker: T7568: clean apt cache + clean some /tmp files 2025-06-22 12:57:54 +03:00
packages T6754: Ignore everyhting under packages folder via .gitignore 2024-10-06 12:50:00 +02:00
scripts T8146: Confirm the key when config encryption is configured without TPM 2026-01-06 23:16:55 -05:00
tools T1771: enable "reboot-on-upgrade-failure" for new VyOS installations 2025-05-17 15:14:07 +02:00
.gitignore Testsuite: T8111: add --cloud-init test target 2025-12-25 14:03:53 +01:00
build-vyos-image build scripts: T3664: move image build scripts to a dedicated directory 2024-03-23 21:02:44 +00:00
CODEOWNERS T7291: disabled codeowners review 2025-03-28 23:55:50 +05:30
CONTRIBUTING.md T6674: remove all references to Jenkins 2024-12-23 09:47:19 +01:00
LICENSE Import the license. 2015-12-17 01:25:03 -05:00
LICENSE.artwork Add a file with artwork license and modified image distribution guidelines 2021-11-06 18:16:18 +07:00
Makefile Makefile: T8111: add missing --iso argument for testraid, testsb and testtpm 2025-12-31 15:09:42 +01:00
README.md T6674: remove all references to Jenkins 2024-12-23 09:47:19 +01:00

VyOS toplevel build

For the most up-to-date documentation, please read the online build guide at docs.vyos.io.

What is VyOS

VyOS is an open source operating system for network devices (routers, firewalls and so on). If you want to use it in your network, check out download and installation instructions at https://docs.vyos.io/en/latest/installation/index.html

If you want to modify VyOS and/or join its development, read on.

About this repository

VyOS is a GNU/Linux distribution based on Debian. Just like any other distribution, it consists of multiple packages.

Some packages are taken from the upstream, while other are modified or written from scratch by VyOS developers. Every package maintained by the VyOS team has its own git repository. VyOS image build is therefore a multi-step process. Packages are compiled first, then an ISO is built from Debian packages and our own packages.

This is the top level repository that contains links to repositories with VyOS specific packages (organized as Git submodules) and scripts and data that are used for building those packages and the installation image.

Repository Structure

There are several directories with their own purpose:

  • build/ Used for temporary files used for the build and for build artifacts
  • data/ Data required for building the ISO (e.g. boot splash/configs)
  • packages/ This directory can hold arbitrary *.deb packages which will be embeded into the resulting ISO. Among other things those packages will be: Linux Kernel, FRR, Netfiler...
  • scripts/ Scripts that are used for the build process
  • tools/ Scripts that are used for maintainer's tasks automation and other purposes, but not during ISO build process

Building VyOS

In order to have a single manual and not maintining multiple copies the instructions on how to build VyOS either in a Docker container or natively can be found in our Documentation - Build VyOS.

Development Branches

The default branch that contains the most recent VyOS code is called current. We may or may not eventually switch to main.

All new code goes to the current branch. When a new LTS release is ready for feature freeze, a new branch is created for the release, and new code from current is backported to the release branch as needed.

Post-1.2.0 branches are named after constellations sorted by area from smallest to largest. There are 88 of them, here's the complete list.

Existing branches:

  • VyOS 1.4: sagitta (Arrow) [LTS]
  • VyOS 1.3: equuleus (Little Horse) [LTS]
  • VyOS 1.2: crux (Southern Cross) [Unsupported]

The next LTS release will be VyOS 1.5 circinus (Compasses).