summaryrefslogtreecommitdiff
path: root/docs/configexamples/autotest
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-04-23 14:46:35 +0300
committerGitHub <noreply@github.com>2026-04-23 14:46:35 +0300
commitfed793f8a0daae064dd58d52ed2396a98646d567 (patch)
tree2861d1d3d54415511c68a57a3d372de48c7b4e80 /docs/configexamples/autotest
parentcac7b484e89354fae0054c8f33c4dc5139df42fa (diff)
parentabc3e9d38f8ce56fd73cd2007b96152fcbd083a2 (diff)
downloadvyos-documentation-fed793f8a0daae064dd58d52ed2396a98646d567.tar.gz
vyos-documentation-fed793f8a0daae064dd58d52ed2396a98646d567.zip
Merge pull request #1841 from vyos/yuriy/convert-images-to-webp
perf: convert all images to WebP with PDF fallback
Diffstat (limited to 'docs/configexamples/autotest')
-rw-r--r--docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.rst2
-rw-r--r--docs/configexamples/autotest/DHCPRelay_through_GRE/_include/topology.webpbin0 -> 20146 bytes
-rw-r--r--docs/configexamples/autotest/L3VPN_EVPN/L3VPN_EVPN.rst2
-rw-r--r--docs/configexamples/autotest/L3VPN_EVPN/_include/topology.webpbin0 -> 49416 bytes
-rw-r--r--docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst20
-rw-r--r--docs/configexamples/autotest/OpenVPN_with_LDAP/_include/topology.webpbin0 -> 11392 bytes
-rw-r--r--docs/configexamples/autotest/Wireguard/Wireguard.rst2
-rw-r--r--docs/configexamples/autotest/Wireguard/_include/topology.webpbin0 -> 31422 bytes
-rw-r--r--docs/configexamples/autotest/tunnelbroker/_include/topology.webpbin0 -> 8464 bytes
-rw-r--r--docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst33
10 files changed, 41 insertions, 18 deletions
diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.rst b/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.rst
index 77f9b118..f2a98479 100644
--- a/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.rst
+++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/DHCPRelay_through_GRE.rst
@@ -18,7 +18,7 @@ The topology has 3 VyOS routers and one client. Between the DHCP Server and
the DHCP Relay is a GRE tunnel. The `transport` VyOS represent a large
Network.
-.. image:: _include/topology.png
+.. image:: _include/topology.*
:alt: Ansible Example topology image
*************
diff --git a/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/topology.webp b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/topology.webp
new file mode 100644
index 00000000..592484cb
--- /dev/null
+++ b/docs/configexamples/autotest/DHCPRelay_through_GRE/_include/topology.webp
Binary files differ
diff --git a/docs/configexamples/autotest/L3VPN_EVPN/L3VPN_EVPN.rst b/docs/configexamples/autotest/L3VPN_EVPN/L3VPN_EVPN.rst
index 2a528852..6092199b 100644
--- a/docs/configexamples/autotest/L3VPN_EVPN/L3VPN_EVPN.rst
+++ b/docs/configexamples/autotest/L3VPN_EVPN/L3VPN_EVPN.rst
@@ -53,7 +53,7 @@ Topology
We use the following network topology in this example:
-.. image:: _include/topology.png
+.. image:: _include/topology.*
:alt: L3VPN EVPN with VyOS topology image
diff --git a/docs/configexamples/autotest/L3VPN_EVPN/_include/topology.webp b/docs/configexamples/autotest/L3VPN_EVPN/_include/topology.webp
new file mode 100644
index 00000000..f3218799
--- /dev/null
+++ b/docs/configexamples/autotest/L3VPN_EVPN/_include/topology.webp
Binary files differ
diff --git a/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst b/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst
index 6666399d..acb880d1 100644
--- a/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst
+++ b/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst
@@ -14,7 +14,7 @@ Topology consists of:
* VyOS as a OpenVPN Server
* VyOS as Client
-.. image:: _include/topology.png
+.. image:: _include/topology.*
:alt: OpenVPN with LDAP topology image
Active Directory on Windows server
@@ -39,13 +39,20 @@ Here are some PowerShell commands to quickly add a Test Active Directory.
Configure VyOS as OpenVPN Server
====================================
-In this example OpenVPN will be setup with a client certificate and username / password authentication.
+In this example OpenVPN will be setup with a client certificate and
+username / password authentication.
-First a CA, a signed server and client ceftificate and a Diffie-Hellman parameter musst be generated and installed.
-Please look :ref:`here <configuration/pki/index:pki>` for more information.
+First a CA, a signed server and client ceftificate and a
+Diffie-Hellman parameter musst be generated and installed.
+Please look :ref:`here <configuration/pki/index:pki>` for more
+information.
| Add the LDAP plugin configuration file `/config/auth/ldap-auth.config`
-| Check all possible settings `here <https://github.com/threerings/openvpn-auth-ldap/blob/master/auth-ldap.conf>`_
+
+| Check all possible settings `here`_.
+
+.. _here:
+ https://github.com/threerings/openvpn-auth-ldap/blob/master/auth-ldap.conf
.. literalinclude:: _include/ldap-auth.config
:language: none
@@ -93,7 +100,8 @@ OpenVPN Server configuration can be carried out.
Client configuration
====================
-One advantage of having the client certificate stored is the ability to create the client configuration.
+One advantage of having the client certificate stored is the ability to
+create the client configuration.
.. code-block:: none
diff --git a/docs/configexamples/autotest/OpenVPN_with_LDAP/_include/topology.webp b/docs/configexamples/autotest/OpenVPN_with_LDAP/_include/topology.webp
new file mode 100644
index 00000000..13bf2d73
--- /dev/null
+++ b/docs/configexamples/autotest/OpenVPN_with_LDAP/_include/topology.webp
Binary files differ
diff --git a/docs/configexamples/autotest/Wireguard/Wireguard.rst b/docs/configexamples/autotest/Wireguard/Wireguard.rst
index 1feb03e8..7d7b216a 100644
--- a/docs/configexamples/autotest/Wireguard/Wireguard.rst
+++ b/docs/configexamples/autotest/Wireguard/Wireguard.rst
@@ -17,7 +17,7 @@ Topology
The topology have a central and a branch VyOS router and one client, to
test, in each site.
-.. image:: _include/topology.png
+.. image:: _include/topology.*
:alt: Ansible Example topology image
*************
diff --git a/docs/configexamples/autotest/Wireguard/_include/topology.webp b/docs/configexamples/autotest/Wireguard/_include/topology.webp
new file mode 100644
index 00000000..3cc5e992
--- /dev/null
+++ b/docs/configexamples/autotest/Wireguard/_include/topology.webp
Binary files differ
diff --git a/docs/configexamples/autotest/tunnelbroker/_include/topology.webp b/docs/configexamples/autotest/tunnelbroker/_include/topology.webp
new file mode 100644
index 00000000..c3a812ab
--- /dev/null
+++ b/docs/configexamples/autotest/tunnelbroker/_include/topology.webp
Binary files differ
diff --git a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
index 370cf9d6..e34cb779 100644
--- a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
+++ b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
@@ -28,7 +28,7 @@ Topology
The example topology has 2 VyOS routers. One as The WAN Router and on as a
Client, to test a single LAN setup
-.. image:: _include/topology.png
+.. image:: _include/topology.*
:alt: Tunnelbroker topology image
@@ -64,6 +64,7 @@ Setup the IPv6 default route to the tunnel interface
Now you should be able to ping a public IPv6 Address
+.. stop_vyoslinter
.. code-block:: none
@@ -73,11 +74,13 @@ Now you should be able to ping a public IPv6 Address
64 bytes from 2001:470:20::2: icmp_seq=2 ttl=64 time=43.9 ms
64 bytes from 2001:470:20::2: icmp_seq=3 ttl=64 time=43.4 ms
64 bytes from 2001:470:20::2: icmp_seq=4 ttl=64 time=42.5 ms
-
+
--- 2001:470:20::2 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 2999ms
rtt min/avg/max/mdev = 33.802/40.920/43.924/4.139 ms
+.. start_vyoslinter
+
Assuming the pings are successful, you need to add some DNS servers.
Some options:
@@ -88,6 +91,7 @@ Some options:
You should now be able to ping something by IPv6 DNS name:
+.. stop_vyoslinter
.. code-block:: none
@@ -97,11 +101,13 @@ You should now be able to ping something by IPv6 DNS name:
64 bytes from tunnelbroker.net (2001:470:0:63::2): icmp_seq=2 ttl=48 time=186 ms
64 bytes from tunnelbroker.net (2001:470:0:63::2): icmp_seq=3 ttl=48 time=178 ms
64 bytes from tunnelbroker.net (2001:470:0:63::2): icmp_seq=4 ttl=48 time=177 ms
-
+
--- tunnelbroker.net ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3002ms
rtt min/avg/max/mdev = 176.707/206.638/285.128/45.457 ms
+.. start_vyoslinter
+
*****************
LAN Configuration
@@ -151,6 +157,7 @@ This accomplishes a few things:
Now the Client is able to ping a public IPv6 address
+.. stop_vyoslinter
.. code-block:: none
@@ -160,11 +167,13 @@ Now the Client is able to ping a public IPv6 address
64 bytes from 2001:470:20::2: icmp_seq=2 ttl=63 time=41.8 ms
64 bytes from 2001:470:20::2: icmp_seq=3 ttl=63 time=41.7 ms
64 bytes from 2001:470:20::2: icmp_seq=4 ttl=63 time=47.1 ms
-
+
--- 2001:470:20::2 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3005ms
rtt min/avg/max/mdev = 32.128/40.688/47.107/5.403 ms
+.. start_vyoslinter
+
Multiple LAN/DMZ Setup
======================
@@ -186,6 +195,8 @@ In the above examples, 1,2,ffff are all chosen by you. You can use 1-ffff
So, when your LAN is eth1, your DMZ is eth2, your cameras are on eth3, etc:
+.. stop_vyoslinter
+
.. code-block:: none
set interfaces ethernet eth1 address '2001:470:xxxx:1::1/64'
@@ -200,6 +211,8 @@ So, when your LAN is eth1, your DMZ is eth2, your cameras are on eth3, etc:
set service router-advert interface eth3 name-server '2001:470:20::2'
set service router-advert interface eth3 prefix 2001:470:xxxx:3::/64
+.. start_vyoslinter
+
Please note, 'autonomous-flag' and 'on-link-flag' are enabled by default,
'valid-lifetime' and 'preferred-lifetime' are set to default values of
30 days and 4 hours respectively.
@@ -207,9 +220,11 @@ Please note, 'autonomous-flag' and 'on-link-flag' are enabled by default,
Firewall
========
-Finally, don't forget the :ref:`Firewall<configuration/firewall/index:Firewall>`. The usage is identical, except for
-instead of `set firewall ipv4 name NAME`, you would use `set firewall ipv6 name
-NAME`.
+Finally, don't forget the
+:ref:`Firewall<configuration/firewall/index:Firewall>`. The usage is
+identical, except instead of `set firewall ipv4 name NAME`, you would
+use `set firewall ipv6 name NAME`.
-Similarly, to attach the firewall, you would use `set firewall ipv6 name NAME rule N inbound-interface name eth0` or `set firewall zone LOCAL from WAN firewall
-ipv6-name`.
+Similarly, to attach the firewall, you would use
+`set firewall ipv6 name NAME rule N inbound-interface name eth0` or
+`set firewall zone LOCAL from WAN firewall ipv6-name`.