summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 180a3a7b1b5cfab46ff7cd59c34a88c3fad786c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
.. VyOS documentation master file, created by
   sphinx-quickstart on Sun Jul  1 14:35:07 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to VyOS's documentation!
================================

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

Introduction
============
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.

.. include:: ch01-install.rst

.. include:: ch02-cli.rst

.. include:: ch03-quick-start.rst

.. include:: ch04-configuration-overview.rst

.. include:: ch05-network-interfaces.rst

.. include:: ch06-routing.rst

.. include:: ch07-firewall.rst

.. include:: ch08-nat.rst

.. include:: ch09-vpn.rst

.. include:: ch10-qos.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`