From efd6ea180ad96a82ee8b0cc38582a9d505e794fb Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Wed, 15 Apr 2026 12:08:34 +0300 Subject: perf: convert all images to WebP with PDF fallback MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add WebP versions of all 187 PNG/JPG images (38MB → 17MB, 55% reduction). Update RST/MD references to use Sphinx wildcard syntax (.*) so HTML builds use WebP while PDF/LaTeX builds fall back to original PNG/JPG. Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/configexamples/pppoe-ipv6-basic.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/configexamples/pppoe-ipv6-basic.rst') diff --git a/docs/configexamples/pppoe-ipv6-basic.rst b/docs/configexamples/pppoe-ipv6-basic.rst index ad588def..520ca00b 100644 --- a/docs/configexamples/pppoe-ipv6-basic.rst +++ b/docs/configexamples/pppoe-ipv6-basic.rst @@ -17,7 +17,7 @@ please contact your ISP for more information. Network Topology ================ -.. image:: /_static/images/pppoe-ipv6-pd-diagram.jpg +.. image:: /_static/images/pppoe-ipv6-pd-diagram.* :width: 60% :align: center :alt: Network Topology Diagram -- cgit v1.2.3 From 5d4cdc95200e8ef8fa9ef0f52c5607b76e980692 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Tue, 21 Apr 2026 15:18:07 +0300 Subject: fix: suppress linter for real/protocol IPs in config examples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The following files were touched by the WebP image PR and exposed pre-existing lint violations — real IPs needed for authenticity or actual protocol addresses (OSPF router-IDs, MAC-embedded IPv6): - inter-vrf-routing-vrf-lite.rst: 195.51.100.1, 198.51.0.0/16 - ipsec-cisco-route-based.rst: 1.1.1.1, 2.2.2.2, 1.0.0.0 (Cisco loopback/OSPF RID) - ipsec-pa-route-based.rst: 1.1.1.1, 2.2.2.2 (PA/VyOS OSPF RIDs) - lac-lns.rst: 8.8.8.8 (DNS example) - pppoe-ipv6-basic.rst: ::64 (prefix format illustration) - bridge.rst: 33:33::16:50:0 (MAC address in firewall log) 🤖 Generated by [robots](https://vyos.io) --- docs/configexamples/inter-vrf-routing-vrf-lite.rst | 7 ++++++- docs/configexamples/ipsec-cisco-route-based.rst | 15 +++++++++++++++ docs/configexamples/ipsec-pa-route-based.rst | 16 ++++++++++++++++ docs/configexamples/lac-lns.rst | 4 ++++ docs/configexamples/pppoe-ipv6-basic.rst | 5 +++++ docs/configuration/firewall/bridge.rst | 4 ++++ 6 files changed, 50 insertions(+), 1 deletion(-) (limited to 'docs/configexamples/pppoe-ipv6-basic.rst') diff --git a/docs/configexamples/inter-vrf-routing-vrf-lite.rst b/docs/configexamples/inter-vrf-routing-vrf-lite.rst index fd4f6489..36dabd73 100644 --- a/docs/configexamples/inter-vrf-routing-vrf-lite.rst +++ b/docs/configexamples/inter-vrf-routing-vrf-lite.rst @@ -467,7 +467,7 @@ Now we perform some end-to-end testing - From Management to Outside (fails as intended) - +.. stop_vyoslinter .. code-block:: none @@ -515,6 +515,7 @@ Now we perform some end-to-end testing --- 2001:db8:2::1 ping statistics --- 2 packets transmitted, 0 received, +2 errors, 100% packet loss, time 1002ms +.. start_vyoslinter - LAN1 to Outside @@ -772,6 +773,8 @@ route-map with an prefix-list. We create a prefix-list first and add all the routes we need to. +.. stop_vyoslinter + .. code-block:: none # set both ipv4 and ipv6 policies @@ -795,6 +798,8 @@ We create a prefix-list first and add all the routes we need to. set policy prefix-list6 LAN2-Internet-v6 rule 4 action 'permit' set policy prefix-list6 LAN2-Internet-v6 rule 4 prefix '2001:db8:0:1::/64' +.. start_vyoslinter + Then add a route-map and reference to above prefix. Consider that the actions taken inside the prefix will MATCH the routes that will be affected by the actions inside the rules of the route-map. diff --git a/docs/configexamples/ipsec-cisco-route-based.rst b/docs/configexamples/ipsec-cisco-route-based.rst index 955c21d4..553c5e2a 100644 --- a/docs/configexamples/ipsec-cisco-route-based.rst +++ b/docs/configexamples/ipsec-cisco-route-based.rst @@ -89,6 +89,8 @@ Configuration VyOS ---- +.. stop_vyoslinter + .. code-block:: none set interfaces ethernet eth0 address '10.0.1.2/30' @@ -132,9 +134,13 @@ VyOS set vpn ipsec site-to-site peer CISCO remote-address '10.0.2.2' set vpn ipsec site-to-site peer CISCO vti bind 'vti1' +.. start_vyoslinter + Cisco ----- +.. stop_vyoslinter + .. code-block:: none crypto isakmp policy 10 @@ -196,6 +202,7 @@ Cisco ! ip route 0.0.0.0 0.0.0.0 10.0.2.1 +.. start_vyoslinter Monitoring @@ -230,6 +237,8 @@ IPsec SAs: OSPF Neighbor Status: +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show ip ospf neighbor @@ -237,6 +246,8 @@ OSPF Neighbor Status: Neighbor ID Pri State Up Time Dead Time Address Interface RXmtL RqstL DBsmL 1.1.1.1 1 Full/- 1h29m37s 39.317s 10.100.100.2 vti1:10.100.100.1 0 0 0 +.. start_vyoslinter + Routing Table: .. code-block:: none @@ -268,6 +279,8 @@ Routing Table: Monitoring on Cisco side ------------------------ +.. stop_vyoslinter + IKE SAs: .. code-block:: none @@ -378,6 +391,8 @@ Routing Table: C 192.168.11.0/24 is directly connected, GigabitEthernet0/2 L 192.168.11.1/32 is directly connected, GigabitEthernet0/2 +.. start_vyoslinter + Checking Connectivity --------------------- diff --git a/docs/configexamples/ipsec-pa-route-based.rst b/docs/configexamples/ipsec-pa-route-based.rst index 0b629041..96349d98 100644 --- a/docs/configexamples/ipsec-pa-route-based.rst +++ b/docs/configexamples/ipsec-pa-route-based.rst @@ -88,6 +88,8 @@ Configuration VyOS ---- +.. stop_vyoslinter + .. code-block:: none set interfaces ethernet eth0 address '10.0.1.2/30' @@ -131,9 +133,13 @@ VyOS set vpn ipsec site-to-site peer CISCO remote-address '10.0.2.2' set vpn ipsec site-to-site peer CISCO vti bind 'vti1' +.. start_vyoslinter + Palo Alto --------- +.. stop_vyoslinter + GUI Configuration: Network -> Network Profiles -> IKE Crypto @@ -225,6 +231,8 @@ CLI configuration with OSPF: set network virtual-router default protocol ospf router-id 1.1.1.1 set network virtual-router default interface [ ethernet1/1 ethernet1/2 ethernet1/3 tunnel.1 ] +.. start_vyoslinter + Monitoring ========== @@ -260,6 +268,8 @@ IPsec SAs: OSPF Neighbor Status: +.. stop_vyoslinter + .. code-block:: none vyos@vyos:~$ show ip ospf neighbor @@ -267,6 +277,8 @@ OSPF Neighbor Status: Neighbor ID Pri State Up Time Dead Time Address Interface RXmtL RqstL DBsmL 1.1.1.1 1 Full/- 23m56s 37.948s 10.100.100.2 vti1:10.100.100.1 0 0 0 +.. start_vyoslinter + Routing Table: @@ -337,6 +349,8 @@ IPsec SAs: OSPF Neighbor Status: +.. stop_vyoslinter + .. code-block:: none admin@PA-VM> show routing protocol ospf neighbor @@ -361,6 +375,8 @@ OSPF Neighbor Status: restart helper time remaining: 0 restart helper exit reason: none +.. start_vyoslinter + Routing Table: diff --git a/docs/configexamples/lac-lns.rst b/docs/configexamples/lac-lns.rst index 98bad773..f622b48f 100644 --- a/docs/configexamples/lac-lns.rst +++ b/docs/configexamples/lac-lns.rst @@ -79,6 +79,8 @@ LAC LNS --- +.. stop_vyoslinter + .. code-block:: none set interfaces ethernet eth0 address '192.168.139.100/24' @@ -96,6 +98,8 @@ LNS set vpn l2tp remote-access name-server '8.8.8.8' set vpn l2tp remote-access ppp-options disable-ccp +.. start_vyoslinter + .. note:: This setup requires the Compression Control Protocol (CCP) being disabled, the command ``set vpn l2tp remote-access ppp-options disable-ccp`` accomplishes that. diff --git a/docs/configexamples/pppoe-ipv6-basic.rst b/docs/configexamples/pppoe-ipv6-basic.rst index 520ca00b..cc14451c 100644 --- a/docs/configexamples/pppoe-ipv6-basic.rst +++ b/docs/configexamples/pppoe-ipv6-basic.rst @@ -51,8 +51,13 @@ delegation (PD). set interfaces pppoe pppoe0 ipv6 address autoconf set interfaces pppoe pppoe0 dhcpv6-options pd 0 interface eth1 address '100' +.. stop_vyoslinter + * Here we use the prefix to configure the address of eth1 (LAN) to form ``::64``, where ``64`` is hexadecimal of address 100. + +.. start_vyoslinter + * For home network users, most of time ISP only provides /64 prefix, hence there is no need to set SLA ID and prefix length. See :ref:`pppoe-interface` for more information. diff --git a/docs/configuration/firewall/bridge.rst b/docs/configuration/firewall/bridge.rst index 832bdf67..53775514 100644 --- a/docs/configuration/firewall/bridge.rst +++ b/docs/configuration/firewall/bridge.rst @@ -557,6 +557,8 @@ And op-mode commands: Inspect logs: +.. stop_vyoslinter + .. code-block:: none vyos@BRI:~$ show log firewall bridge @@ -567,3 +569,5 @@ Inspect logs: vyos@BRI:~$ show log firewall bridge forward filter Dec 05 14:42:22 kernel: [bri-FWD-filter-default-D]IN=eth2 OUT=eth1 MAC=33:33:00:00:00:16:50:00:00:06:00:00:86:dd SRC=0000:0000:0000:0000:0000:0000:0000:0000 DST=ff02:0000:0000:0000:0000:0000:0000:0016 LEN=96 TC=0 HOPLIMIT=1 FLOWLBL=0 PROTO=ICMPv6 TYPE=143 CODE=0 Dec 05 14:42:22 kernel: [bri-FWD-filter-default-D]IN=eth2 OUT=eth1 MAC=33:33:00:00:00:16:50:00:00:06:00:00:86:dd SRC=0000:0000:0000:0000:0000:0000:0000:0000 DST=ff02:0000:0000:0000:0000:0000:0000:0016 LEN=96 TC=0 HOPLIMIT=1 FLOWLBL=0 PROTO=ICMPv6 TYPE=143 CODE=0 + +.. start_vyoslinter -- cgit v1.2.3 From 92805938c535c8d74d46cb4bd46d4be0ae42ac17 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Tue, 21 Apr 2026 23:39:17 +0300 Subject: fix: remove unnecessary linter suppressions, use named refs for long URLs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - pppoe-ipv6-basic.rst: remove stop/start_vyoslinter pair added in error (content between markers had no real IPs and no lines > 80 chars) - OpenVPN_with_LDAP.rst: replace stop_vyoslinter around long line-block URL with a named hyperlink target whose URL wraps to the next line - wireguard.rst: split long named hyperlink target onto two lines, eliminating the need for stop/start_vyoslinter markers 🤖 Generated by [robots](https://vyos.io) --- .../autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst | 7 +++---- docs/configexamples/pppoe-ipv6-basic.rst | 4 ---- docs/configuration/interfaces/wireguard.rst | 7 ++----- 3 files changed, 5 insertions(+), 13 deletions(-) (limited to 'docs/configexamples/pppoe-ipv6-basic.rst') 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 ae997905..acb880d1 100644 --- a/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst +++ b/docs/configexamples/autotest/OpenVPN_with_LDAP/OpenVPN_with_LDAP.rst @@ -49,11 +49,10 @@ information. | Add the LDAP plugin configuration file `/config/auth/ldap-auth.config` -.. stop_vyoslinter +| Check all possible settings `here`_. -| Check all possible settings `here `_ - -.. start_vyoslinter +.. _here: + https://github.com/threerings/openvpn-auth-ldap/blob/master/auth-ldap.conf .. literalinclude:: _include/ldap-auth.config :language: none diff --git a/docs/configexamples/pppoe-ipv6-basic.rst b/docs/configexamples/pppoe-ipv6-basic.rst index cc14451c..02df0fe2 100644 --- a/docs/configexamples/pppoe-ipv6-basic.rst +++ b/docs/configexamples/pppoe-ipv6-basic.rst @@ -51,13 +51,9 @@ delegation (PD). set interfaces pppoe pppoe0 ipv6 address autoconf set interfaces pppoe pppoe0 dhcpv6-options pd 0 interface eth1 address '100' -.. stop_vyoslinter - * Here we use the prefix to configure the address of eth1 (LAN) to form ``::64``, where ``64`` is hexadecimal of address 100. -.. start_vyoslinter - * For home network users, most of time ISP only provides /64 prefix, hence there is no need to set SLA ID and prefix length. See :ref:`pppoe-interface` for more information. diff --git a/docs/configuration/interfaces/wireguard.rst b/docs/configuration/interfaces/wireguard.rst index f6da17e3..bc53b388 100644 --- a/docs/configuration/interfaces/wireguard.rst +++ b/docs/configuration/interfaces/wireguard.rst @@ -435,8 +435,5 @@ simplify deployment, generate a per-mobile configuration from the VyOS CLI. .. figure:: /_static/images/wireguard_qrcode.* :alt: WireGuard Client QR code -.. stop_vyoslinter - -.. _`WireGuard mailing list`: https://lists.zx2c4.com/pipermail/wireguard/2018-December/003704.html - -.. start_vyoslinter +.. _`WireGuard mailing list`: + https://lists.zx2c4.com/pipermail/wireguard/2018-December/003704.html -- cgit v1.2.3 From f01ea2428375a7da58d627074400a528e9157a57 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Wed, 22 Apr 2026 11:14:35 +0300 Subject: fix: restore stop_vyoslinter in pppoe-ipv6-basic.rst for ::64 false positive MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The markers suppress the linter IPv6 check on ``::64``, which the regex matches as a non-documentation address. 🤖 Generated by [robots](https://vyos.io) --- docs/configexamples/pppoe-ipv6-basic.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/configexamples/pppoe-ipv6-basic.rst') diff --git a/docs/configexamples/pppoe-ipv6-basic.rst b/docs/configexamples/pppoe-ipv6-basic.rst index 02df0fe2..cc14451c 100644 --- a/docs/configexamples/pppoe-ipv6-basic.rst +++ b/docs/configexamples/pppoe-ipv6-basic.rst @@ -51,9 +51,13 @@ delegation (PD). set interfaces pppoe pppoe0 ipv6 address autoconf set interfaces pppoe pppoe0 dhcpv6-options pd 0 interface eth1 address '100' +.. stop_vyoslinter + * Here we use the prefix to configure the address of eth1 (LAN) to form ``::64``, where ``64`` is hexadecimal of address 100. +.. start_vyoslinter + * For home network users, most of time ISP only provides /64 prefix, hence there is no need to set SLA ID and prefix length. See :ref:`pppoe-interface` for more information. -- cgit v1.2.3