blob: 8230ffacfb74e9729e527e953588529a40889428 (
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
106
107
108
109
|
.. _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.
#####
About
#####
We use multiple live versions of our manual hosted thankfully by
https://readthedocs.org. We will provide one version of the manual for every
VyOS major version starting with VyOS 1.2 which will receive Long-term support
(LTS).
The manual version is selected/specified by it's Git branch name. You can
switch between versions of the documentation by selecting the appropriate
branch on the bottom left corner.
############
Introduction
############
.. _introduction:
.. toctree::
:caption: Introduction
:maxdepth: 2
history
install
cli
quick-start
configuration-overview
interfaces/index
routing/index
firewall
nat
vpn/index
qos
services/index
system/index
high-availability
clustering
load-balancing
image-mgmt
commandscripting
.. modules
########
Appendix
########
.. _appendix:
.. toctree::
:caption: Appendix
:maxdepth: 2
appendix/releasenotes
appendix/troubleshooting
appendix/examples/index
appendix/commandtree/index
appendix/vyos-on-vmware
appendix/vyos-on-baremetal
appendix/migrate-from-vyatta
############
Contributing
############
.. _contributing:
.. toctree::
:caption: Contributing
:maxdepth: 2
contributing/build-vyos
contributing/issues_features
contributing/development
contributing/vyos_cli
contributing/coding_guidelines
contributing/documentation
contributing/upstream-packages
################
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.
|
