index.rst

VyOS User Guide

3

Get / Build VyOS

Quickly Build<contributing/build-vyos:build vyos> your own Image or take a look at how to download<installation/install:download> a free or supported version.

Install VyOS

Read about how to install VyOS on Bare Metal<installation/install:installation> or in a Virtual Environment<installation/virtual/index:running vyos in virtual environments> and how to use an image with the usual cloud<installation/cloud/index:running VyOS in Cloud Environments> providers

Configuration and Operation

Use the Quickstart Guide<quick-start:Quick Start>, to have a fast overview. Or go deeper and set up advanced routing<configuration/protocols/index:protocols>, VRFs<configuration/vrf/index:vrf>, or VPNs<configuration/vpn/index:vpn> for example.

Automate

Integrate VyOS in your automation Workflow with Ansible<vyos-ansible>, have your own local scripts<command-scripting>, or configure VyOS with the HTTPS-API<vyosapi>.

Examples

Get some inspiration from the Configuration Blueprints<configexamples/index:Configuration Blueprints> to build your infrastructure.

Contribute and Community

There are many ways to contribute to the project.
Add missing parts or improve the Documentation<documentation:Write Documentation>.
Discuss in Slack or the Forum.
Or you can pick up a Task and fix the code<contributing/development:development>.

introducing/about introducing/history changelog/index

installation/index quick-start cli

configuration/index operation/index automation/index troubleshooting/index configexamples/index

contributing/build-vyos contributing/development contributing/issues-features contributing/upstream-packages contributing/debugging contributing/testing

documentation coverage copyright