Customizable images

The entire codebase and build toolchain are available for everyone to use, inspect, and contribute to.

Our image build scripts are easy to use and allow multiple customization options. Build flavours—reusable JSON files with build configuration, make it easy to maintain your own builds without entering the same options every time. Binary package repositories of official VyOS releases are open to the public, so there is no need to build the entire system from source.

These are some customizations you can make:

• Add custom package sources (repositories)
• Include additional packages from remote repositories or a local directory
• Use a custom default configuration file

In the future we plan to setup a web service for our customers to build images online.

Open API

VyOS uses a layered architecture. All components such as firewall, IPsec, or routing protocols are built on top of a configuration management framework that includes a custom shell environment, libraries for loading the config file and committing config changes, and libraries for reading values from the running config.

This makes it easy to integrate new applications into the system seamlessly. In fact, a number of VyOS features started their life as community-developed addons. There is no special “plugin API”, what you get to use is exactly what the maintainers use to add features to the mainline VyOS.

Command definitions are written in XML and can be automatically validated using a RelaxNG schema. Scripts that generate target application configs can be written in Python 3, Perl, or shell.

To ensure forward compatibility even if command syntax changes, we provide an API for writing migration scripts that parse config files and automatically update the syntax.

We are here to help

We provide custom development and consulting services. If there’s a missing feature you want to see in VyOS, you can sponsor its development. If you are a managed service provider and need a VyOS image with vendor or in-house software, we can help you integrate it and maintain the custom build.

We are actively working with community contributors and try to merge pull requests as soon as possible, or make suggestions how to improve them.