Main Page

From VyOS Wiki
Revision as of 11:24, 2 July 2017 by Max1e6 (talk | contribs)
Jump to: navigation, search

Welcome to the VyOS project, a Linux-based network operating system.

VyOS is a community fork of Vyatta, a Linux-based network operating system that provides software-based network routing, firewall, and VPN functionality.

How it's different from other router distros?

  • Unified command line interface in the style of hardware routers.
  • Scriptable CLI
  • Stateful configuration system: prepare changes and commit at once or discard, view previous revisions or rollback to them, archive revisions to remote server, execute hooks at commit time...
  • Image-based upgrade: keep multiple versions on the same system and revert to previous image if something went wrong.
  • Not just firewall and VPN: includes routing protocols such as BGP and OSPF and complex routing policy language.
  • Runs on physical and virtual platforms alike: small x86 boards, big servers, KVM, Xen, VMWare, Hyper-V...
  • Completely free and open source, with documented internal APIs and build procedures.
  • Community driven: patches are welcome, all code, bugs, and nightly builds are public.

What can it do?

See the feature list.

What it looks like?

Here's a command line session example.

Vyos session.png

Project news

Setting up GRE/IPsec behind NAT
— Daniil Baturin 2018-01-19 15:00:55
How to setup an IPsec connection between two NATed peers: using id's and RSA keys
— Daniil Baturin 2018-01-15 15:19:22
VyOS builds now use the load balanced mirror
— Daniil Baturin 2018-01-13 20:00:18
VyOS builds and HTTPS: build works again, HTTP still needs testing
— Daniil Baturin 2018-01-15 12:53:53
Follow-up: VyOS builds and HTTPS
— Daniil Baturin 2018-01-11 13:07:40

Wiki needs your contributions!

If everyone reading this page documented just one command, VyOS would have complete documentation by next morning.

Registration and editing is open for everyone, you do not need to request access. Just create an account and start editing right away.

Read the formatting guide to learn the wiki syntax.

Click on any red link or click here to create new page.

The most straightforward way to expand the wiki is to rewrite the old VC6.5 documentation, since VyOS remains backwards-compatible with VC6.5. However, do not copy anything verbatim from it, since it's not under a free license, write in your own words.

You can also document specific setup and use cases, and add examples of configuring VyOS to interact with other systems, such as those from the Interoperability category.

Get the Software

Current stable release: VyOS 1.1.7 (Helium)

Read about the versioning scheme.


  • Physical and virtual 64-bit: [2]
  • Legacy hardware 32-bit: [3]
  • VMWare OVA: [4]
  • Virtual 32-bit: [5] (DEPRECATED)

Which image should I use?

  • 64-bit physical machines: amd64.
  • Virtual platforms (KVM, Xen, VMWare, Hyper-V): amd64 (drivers and tools included!).
  • Legacy 32-bit machines without PAE: i586.

i586 image kernel is built without PAE support so it works on older CPUs often found in small embedded boards.

Upgrading from previous versions or Vyatta Core

Check out the upgrade instructions.

Cloud services

Amazon EC2

Amazon is a popular public cloud service where you can run your VMs and create private networks.

Please send us feedback if you find any bugs!

Distribution infrastructure

You can verify the build signature against our public key.

VyOS images are hosted on multiple mirrors for better availability.