.. _index:

VyOS User Guide
===============

VyOS is an open source network operating system based on Debian GNU/Linux.

VyOS provides a free routing platform that competes directly with other
commercially available solutions from well known network providers. Because
VyOS is run on standard amd64, i586 and ARM systems, it is able to be used
as a router and firewall platform for cloud deployments.

.. toctree::
    :maxdepth: 2
    :caption: Contents:
    :includehidden:

    history.rst
    install.rst
    cli.rst
    quick-start.rst
    configuration-overview.rst
    interfaces/index.rst
    routing/index.rst
    firewall.rst
    nat.rst
    vpn/index.rst
    qos.rst
    services/index.rst
    system/index.rst
    high-availability.rst
    clustering.rst
    load-balancing.rst
    image-mgmt.rst
    commandscripting.rst

.. toctree::
    :maxdepth: 2
    :caption: Appendix:
    :includehidden:

    appendix/releasenotes.rst
    appendix/troubleshooting.rst
    appendix/examples/index.rst
    appendix/commandtree/index.rst
    appendix/vyos-on-vmware.rst
    appendix/vyos-on-baremetal.rst
    appendix/migrate-from-vyatta.rst

.. toctree::
    :maxdepth: 2
    :caption: Contributing:
    :includehidden:

    contributing/index.rst


################
Copyright Notice
################

Copyright (C) 2018-2019 VyOS maintainers and contributors

Permission is granted to make and distribute verbatim copies of this manual
provided the copyright notice and this permission notice are preserved on all
copies.

Permission is granted to copy and distribute modified versions of this manual
under the conditions for verbatim copying, provided that the entire resulting
derived work is distributed under the terms of a permission notice identical
to this one.

Permission is granted to copy and distribute translations of this manual into
another language, under the above conditions for modified versions, except that
this permission notice may be stated in a translation approved by the VyOS
maintainers.