summaryrefslogtreecommitdiff
path: root/docs/configexamples
AgeCommit message (Collapse)Author
2026-04-22fix: restore stop_vyoslinter in pppoe-ipv6-basic.rst for ::64 false positiveYuriy Andamasov
The markers suppress the linter IPv6 check on ``<prefix>::64``, which the regex matches as a non-documentation address. 🤖 Generated by [robots](https://vyos.io)
2026-04-21fix: remove unnecessary linter suppressions, use named refs for long URLsYuriy Andamasov
- 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)
2026-04-21fix: resolve all line-length lint warnings across 14 RST filesYuriy Andamasov
Wrap prose lines exceeding 80 chars and apply stop/start_vyoslinter markers around cfgcmd/opcmd directive lines that cannot be shortened (e.g. long option names with placeholder arguments). Affected files: bonding, wireguard, pim, conntrack-sync, dmvpn, ipsec_general, site2site_ipsec, vrf/index, bare-metal, inter-vrf-routing-vrf-lite, lac-lns, tunnelbroker, OpenVPN_with_LDAP, dmvpn-dualhub-dualcloud. 🤖 Generated by [robots](https://vyos.io)
2026-04-21fix: suppress linter for real/protocol IPs in config examplesYuriy Andamasov
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)
2026-04-21fix: suppress linter for real HE tunnel broker IPv6 addressesYuriy Andamasov
The tunnelbroker.net example intentionally uses real Hurricane Electric IPv6 addresses (2001:470:*) — needed for authenticity. Wrap all affected code blocks with stop/start_vyoslinter. 🤖 Generated by [robots](https://vyos.io)
2026-04-15merge: resolve CLAUDE.md conflict, keep current branch versionYuriy Andamasov
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-15perf: convert all images to WebP with PDF fallbackYuriy Andamasov
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) <noreply@anthropic.com>
2026-04-10docs: fix typos and prose in terraform, ansible, and config docs (#1829)Yuriy Andamasov
* docs: fix typos and improve prose in terraform, ansible, and config docs Fix typos (VyoS→VyOS, respresent→represents), rewrap long prose lines for readability, restore correct YAML indentation in Ansible examples, and standardize heading hierarchy in affected files. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: replace public DNS IP with RFC 5737 address in NMP example Use 198.51.100.1 (TEST-NET-2) instead of 8.8.8.8 to satisfy the documentation linter requirement for reserved addresses. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: restore linter markers around NMP code block with 8.8.8.8 Restore stop/start_vyoslinter markers that were incorrectly removed. The DNS server address is intentional and should not be changed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-10docs: standardize RST heading hierarchy to # overline across 21 files (#1827)Yuriy Andamasov
Normalize top-level page headings from = or * underline-only to # overline+underline format, following RST/Sphinx best practices for consistent heading hierarchy. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-10docs: fix code-block indentation (tabs to spaces) (#1825)Yuriy Andamasov
* docs: fix tab-to-space indentation in code blocks across 5 files Replace tab characters with spaces inside code-block and output directives for consistent rendering. Also rewrap long prose lines for readability. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * chore: remove accidentally committed settings file Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: fix inconsistent indentation in trafficpolicy and qos code blocks Normalize indentation within code blocks where tab-to-space conversion left some entries misaligned (tbit, gibps, tibps in trafficpolicy; egress command in qos). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-30Add TODO markers, fill placeholders, mark stub pages (#1802)Yuriy Andamasov
* chore: add TODO markers for 12 files needing cfgcmd/opcmd conversion Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: fill TBD placeholder in flow-accounting, remove TBD in static routes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: add stub admonitions to 3 minimal pages Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: replace non-RFC IP addresses and suppress false positives in linter Replace public IPs with RFC 5737 documentation addresses and add stop/start_vyoslinter markers for false positives (MAC addresses, OIDs, NAT64 well-known prefix). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: replace remaining non-RFC IPs and suppress MAC address false positive - Replace 8.8.8.8 (Google DNS) with 192.0.2.1 (RFC 5737) in: - docs/configexamples/ansible.rst (3 occurrences) - docs/configexamples/nmp.rst (1 occurrence) - docs/automation/terraform/terraformvSphere.rst (1 occurrence) - Wrap SHA-256 certificate fingerprint in openvpn-examples.rst with stop_vyoslinter/start_vyoslinter to suppress false-positive IPv6 flag Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: wrap long lines to comply with 80-char line length limit Wrapped prose content exceeding 80 characters in 9 documentation files. Only RST prose and directive content was modified; code block contents were left untouched as they are exempt from the linter. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: wrap 2 remaining long lines for linter compliance Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: suppress linter for long URL reference in terraformvSphere.rst * fix: address Copilot review suggestions — broken links, typos, YAML indentation - Fix broken inline RST links split across lines in sysctl.rst, eve-ng.rst, oracle.rst (stub notes with VyOS documentation repository link) - Fix YAML indentation in both playbook code blocks in ansible.rst - Fix typo "VyoS" -> "VyOS" in ansible.rst - Fix typo "desition" -> "decision" in terraformvSphere.rst - Fix 4 occurrences of "Terrafom" -> "Terraform" in terraformvSphere.rst - Fix :doc: role split across two lines in openvpn-examples.rst - Wrap long paragraph in openconnect.rst to <=80 chars and remove unnecessary stop/start_vyoslinter markers Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: resolve remaining linter failures — long lines and OID false positive Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: revert 8.8.8.8 replacements, use stop_vyoslinter instead --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-02-27firewall: fix inbound-interface name syntaxAlex Kudentsov
2026-01-22dmvpn: Fixed typos in networks (#1742)aapostoliuk
Fixed typos in networks
2025-12-09ipsec: T7594: Change connection-type to trap for all peers and ↵Alexandr K.
configurations (#1719) The previous 'connection-type respond' option in IPsec site-to-site peers was misleading - instead of passively waiting for peer initiation, it would initiate negotiation when matching traffic appeared, potentially causing SA duplication and renegotiation loops.
2025-11-14Fix zebra route-map filter config exampletuna2134
2025-10-17Add Virtual-Template1 configuration for LAC L2TPViacheslav Hletenko
Add missed `Virtual-Template1` for LAC L2TP Cisco config example
2025-09-29bgp: T7760: remove per vrf instance system-as node (#1675)Christian Breunig
2025-08-07Fixed typos of the ESP group name in the IPsec documentation (#1665)aapostoliuk
Fixed typos of the ESP group name in the IPsec documentation
2025-08-04Added IPSec blueprints with Cisco and PA (#1664)aapostoliuk
Added blueprint Policy-based Site-to-Site IPsec VPN with Cisco IOS. Added blueprint Route-based Site-to-Site IPsec VPN with Cisco IOS. Added blueprint Route-based Site-to-Site IPsec VPN with Palo Alto.
2025-06-26Correction of firewall syntax in multiple pages (#1651)srividya0208
2025-02-04DMVPN Dual Hub Dual Cloud blueprintaapostoliuk
DMVPN Dual Hub Dual Cloud blueprint
2024-09-20Firewall: add <ethernet-type> matcher for documentation ; add configuration ↵Nicolas Fort
blueprints for bridge and firewall configuration
2024-07-18Merge branch 'current' of github.com:vyos/vyos-documentation into currentrebortg
2024-06-14Configuration Blueprints: add new example for firewall+vrf. Also, add note ↵Nicolas Fort
about usage of inbound and outbound interface when interface is attached to a non-default vrf.
2024-05-28Merge branch 'current' of github.com:vyos/vyos-documentation into currentrebortg
2024-05-08Merge pull request #1428 from srividya0208/ldap_autoRobert Göhler
Corrected the grammar and added the vyos client configuration
2024-05-07Corrected the grammar and added the vyos client configurationsrividya0208
2024-05-07Merge pull request #1416 from Embezzle/spellingDaniil Baturin
Fix spelling mistakes across multiple files
2024-05-06Merge pull request #1422 from srividya0208/fw_logRobert Göhler
Modified old option from 'enable-default-log' to new one 'default-log'
2024-05-06Modified old option from 'enable-default-log' to new one 'default-log'srividya0208
2024-05-04config-examples: Corrected spelling mistakesAlex W
2024-05-03tunnelbroker: adds suggestion to source-address assignment for users with ↵Ginko
dynamic IPs (#1415)
2024-04-16fix several build warnings and errorsrebortg
2024-04-09Merge pull request #1368 from Chrisc-c-c/patch-3Robert Göhler
Ansible: rephrasing
2024-04-09Policy-based-ipsec-and-firewall: Fixed typos and capitalisation.Chrisc-c-c
2024-04-09Ansible: rephrasingChrisc-c-c
2024-02-22Rewritten the L2TP documentationaapostoliuk
Rewritten the L2TP documentation Added the example 'PPPoE over L2TP' to blueprints
2024-01-13Update autotest labs with 1.5-rolling-202401121239rebortg
2024-01-11dhcp: dhcpv6: T3316: Update documentation for inclusion of `subnet-id`sarthurdev
2024-01-10dhcp: T3316: Update documentation for Kea implementationsarthurdev
2024-01-02Fix firewall syntax for refactor in PPPoE IPv6 examplesarthurdev
2023-11-30fix build and ref warningsrebortg
2023-11-24Merge pull request #1128 from mkorobeinikov/masterRobert Göhler
Ansible example article
2023-11-17Update wireguard pki command syntaxgreenpsi
2023-11-16Nat updategreenpsi
Update some nat commands to new syntax
2023-11-10Ansible example articlemkorobeinikov
An example of how to set up Ansible and VyOS.
2023-10-26Added config example of vpn ipsec site-to-sitesrividya0208
2023-09-12Config blueprints: Add new example for policy-based ipsec site to site ↵Nicolas Fort
tunnel, plus firewall, using new firewall sintax
2023-09-08Firewall refactor: add visible note in firewall docs: zone, quick-start and ↵Nicolas Fort
config blueprint zone-policy
2023-09-06Merge pull request #1072 from srividya0208/zbfRobert Göhler
correction of ipsec compression syntax
generated by cgit v1.2.3 (git 2.39.1) at 2026-08-29 08:34:35 +0000