blob: 4db014a9738db40b6942c86281ca47a8a74082f4 (
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
.. _index:
###############
VyOS User Guide
###############
.. grid:: 3
:gutter: 2
.. grid-item-card:: Get / Build VyOS
Quickly :ref:`Build<contributing/build-vyos:build vyos>` your own Image or take a look at how to :ref:`download<installation/install:download>` a free or supported version.
.. grid-item-card:: Install VyOS
Read about how to install VyOS on :ref:`Bare Metal<installation/install:installation>` or in a
:ref:`Virtual Environment<installation/virtual/index:running vyos in virtual environments>` and
how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers
.. grid-item-card:: Configuration and Operation
Use the :ref:`Quickstart Guide<quick-start:Quick Start>`, to have a fast overview. Or go deeper and
set up :ref:`advanced routing<configuration/protocols/index:protocols>`,
:ref:`VRFs<configuration/vrf/index:vrf>`, or
:ref:`VPNs<configuration/vpn/index:vpn>` for example.
.. grid-item-card:: Automate
Integrate VyOS in your automation Workflow with
:ref:`Ansible<vyos-ansible>`,
have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`.
.. grid-item-card:: Examples
Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
to build your infrastructure.
.. grid-item-card:: Contribute and Community
| There are many ways to contribute to the project.
| Add missing parts or improve the :ref:`Documentation<documentation:Write Documentation>`.
| Discuss in `Slack <https://slack.vyos.io/>`_ or the `Forum <https://forum.vyos.io>`_.
| Or you can pick up a `Task <https://vyos.dev/>`_ and fix the :ref:`code<contributing/development:development>`.
.. toctree::
:hidden:
:maxdepth: 1
introducing/about
introducing/history
changelog/index
.. toctree::
:maxdepth: 2
:hidden:
:caption: First Steps
installation/index
quick-start
cli
.. toctree::
:maxdepth: 2
:hidden:
:caption: Adminguide
configuration/index
operation/index
automation/index
troubleshooting/index
configexamples/index
.. toctree::
:maxdepth: 2
:hidden:
:caption: Development
contributing/build-vyos
contributing/development
contributing/issues-features
contributing/upstream-packages
contributing/debugging
contributing/testing
.. toctree::
:maxdepth: 2
:hidden:
:caption: Misc
documentation
coverage
copyright
|
