summaryrefslogtreecommitdiff
path: root/docs/_static/images
AgeCommit message (Collapse)Author
2026-05-06feat: import MyST swap mechanism, llms.txt feature, and content from currentYuriy Andamasov
Replaces the broken #1885/#1869/#1875 trio with a single PR for circinus. This PR: - Imports 254 md-*.md files from currents working MyST conversion (the broken converter that produced #1885s md-*.md files is not used here; currents files are correct as verified on /en/rolling/). - Adds the per-page RST-to-MyST swap mechanism: scripts/swap_sources.py, scripts/import_myst.py, tests, _swap.txt, _ext/vyos.py and Makefile swap-wrapped targets, .readthedocs.yml pre/post hooks. - Replaces 175 .jpg/.png with 187 .webp images for swapped pages. - Adds the llms.txt + sitemap feature (sphinx_llms_txt, sphinx_sitemap) with circinus-tailored html_baseurl https://docs.vyos.io/en/1.5/ and curated docs/_html_extra/llms.txt for 1.5.x. - Updates docs/_html_extra/robots.txt with AI crawler Allow rules and the /en/1.5/sitemap.xml reference. - Drops configuration/service/suricata from the swap set (no matching RST sibling on circinus; suricata is a current-only feature). Supersedes: - #1885 (broken md-*.md converter output) - #1869 (LLM doc adaptation backport, bundled here) - #1875 (llms.txt circinus, bundled here) Generated by robots https://vyos.io
2026-05-06Revert "docs: fix typos and grammar (ported from #1852 RST → MyST)"Yuriy Andamasov
2026-05-06feat(swap-circinus): add incremental RST-to-MyST swap mechanismYuriy Andamasov
Backport of the swap mechanism from feat/incremental-myst-swap onto the circinus release branch. Built directly on top of origin/circinus, so the underlying RST tree is circinus's (not current's). Mechanism: - scripts/import_myst.py — import md from myst/* with md- prefix - scripts/swap_sources.py — rename md-{name}.md → {name}.md before Sphinx builds, restore after; writes _build/_swap_state.json and _build/_swap_exclude.txt - docs/Makefile — html/dirhtml/pdf/livehtml all run swap → build → trap restore; explicit `swap` and `restore` targets too - docs/conf.py — MyST extensions enabled; swap exclude_patterns loader; _prefer_webp builder hook so html prefers webp over png Content (all from origin/myst/circinus): - 253 md-prefixed pages alongside each {name}.rst counterpart - 1 plain MyST-only page kept at canonical name (docs/copyright.md, no .rst counterpart) - 182 .webp images added (circinus release previously had only PNG/JPG; this PR brings webp into circinus alongside the originals) - docs/_swap.txt populated with all 253 stems → MyST is served by default; revert a page by removing its stem from _swap.txt 🤖 Generated by [robots](https://vyos.io)
2026-05-06Revert "Add incremental RST-to-MyST swap mechanism (circinus) (#1867)" (#1893)Daniil Baturin
This reverts commit 5eb383a10ec92c65eed525bc174785a6852e997f.
2026-05-06Add incremental RST-to-MyST swap mechanism (circinus) (#1867)Yuriy Andamasov
* feat(swap-circinus): add incremental RST-to-MyST swap mechanism Backport of the swap mechanism from feat/incremental-myst-swap onto the circinus release branch. Built directly on top of origin/circinus, so the underlying RST tree is circinus's (not current's). Mechanism: - scripts/import_myst.py — import md from myst/* with md- prefix - scripts/swap_sources.py — rename md-{name}.md → {name}.md before Sphinx builds, restore after; writes _build/_swap_state.json and _build/_swap_exclude.txt - docs/Makefile — html/dirhtml/pdf/livehtml all run swap → build → trap restore; explicit `swap` and `restore` targets too - docs/conf.py — MyST extensions enabled; swap exclude_patterns loader; _prefer_webp builder hook so html prefers webp over png Content (all from origin/myst/circinus): - 253 md-prefixed pages alongside each {name}.rst counterpart - 1 plain MyST-only page kept at canonical name (docs/copyright.md, no .rst counterpart) - 182 .webp images added (circinus release previously had only PNG/JPG; this PR brings webp into circinus alongside the originals) - docs/_swap.txt populated with all 253 stems → MyST is served by default; revert a page by removing its stem from _swap.txt 🤖 Generated by [robots](https://vyos.io) * fix(ext): handle RST fallback in CmdInclude when _renderer absent `cmdincludemd` is in `myst_fence_as_directive`, so MyST routes fence blocks through `render_fence → render_restructuredtext → MockRSTParser`. In that path `self.state` is a plain docutils Body with no `_renderer`, crashing the RTD build. Fall back to `nested_parse` when `_renderer` is unavailable so the directive works in both MyST and RST/MockRSTParser contexts. 🤖 Generated by [robots](https://vyos.io) * feat(conf): copy .md sources into HTML output for plain-text serving Adds a build-finished hook that mirrors every .md file from the Sphinx source tree into the HTML output directory verbatim, making unrendered MyST sources accessible alongside HTML renders at the same URL path. 🤖 Generated by [robots](https://vyos.io) * docs: address review feedback (backport from PR #1857) 🤖 Generated by [robots](https://vyos.io) * docs: port .readthedocs.yml jobs and swap-script tests from PR #1857 Parity backport from PR #1857 (current) — was missing on circinus. - .readthedocs.yml: add build.jobs.pre_build / post_build hooks that run scripts/swap_sources.py --swap before the Sphinx build and --restore after. Without this, the swap mechanism ships but never runs on RTD builds for this branch — the swap is a silent no-op. - tests/test_import_myst.py, tests/test_swap_sources.py: tests for the swap scripts. The scripts are identical to current's, so the same tests apply. Travels with the branch so CI catches per-branch regressions if the scripts ever drift. 🤖 Generated by [robots](https://vyos.io) * fix(review): add conftest, filter md- from copy, fix _prefer_webp builder list, trailing newline Agent-Logs-Url: https://github.com/vyos/vyos-documentation/sessions/64b17346-8739-4346-b619-84438cddef21 Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com>
2026-02-17T8081: Update password recovery flow documentation (#1756)Quill
2025-09-29intallation: made modifications to install & update page (#1688)srividya0208
2025-09-04VPP: Add comprehensive VPP documentationzdc
This commit introduces extensive documentation for VyOS VPP (Vector Packet Processing) Dataplane interfaces and features, including examples. Features documented: * VPP integration description, base requirements and limitations * VPP dataplane core settings * Features enabled in the dataplane: ACL, IPsec, NAT, sFlow * VPP interface types: bonding, bridge, GRE, IPIP, kernel, loopback, VXLAN, XConnect Note: This is an initial documentation version that will require ongoing improvements based on user feedback and questions, real-world deployment testing and validation, additional use cases and configuration scenarios discovered in production. Therefore, all pages are marked as "need improvement".
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-07-03Updated site-to-site IPsec VPN documentation (#1653)aapostoliuk
Added general theoretical IPsec documentation. Changed site-to-site IPsec VPN documentation. Added steps for configuration. Added documentation for troubleshooting site-to-site IPsec VPN.
2025-02-04DMVPN Dual Hub Dual Cloud blueprintaapostoliuk
DMVPN Dual Hub Dual Cloud blueprint
2025-01-16dmvpn: T2326: DMVPN Documentation for FRR NHRP implementationaapostoliuk
DMVPN Documentation for FRR NHRP implementation.
2024-10-08Add initial secure boot documentationChristian Breunig
2024-08-05Update lastproofread of modified files during previous PR for bridge ↵Nicolas Fort
firewall documenttion; update image which had an error; minor change on documenation
2024-08-02Extend firewall bridge documentationNicolas Fort
2024-07-21Add initial hardware platform Gowin GW-FN-1UR1-10GChristian Breunig
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-06-12Firewall: Add prerouting informationNicolas Fort
2024-03-29Article about terraform and google.mkorobeinikov
How to deploy the Google Cloud instance using Terraform and Ansible for the latest version.
2024-03-01Update the article Terraformmkorobeinikov
Update to the article about terraform. I made changes to the structure and divided the article into three parts AWS AZ vSPhere. Made changes to the table of contents of the article. Added links to resources in git. Added troubleshooting as well as a detailed description of the files.
2024-02-22Rewritten the L2TP documentationaapostoliuk
Rewritten the L2TP documentation Added the example 'PPPoE over L2TP' to blueprints
2024-02-19Styles refactoring (#1278)bogdankol
2024-01-25Merge pull request #1241 from mkorobeinikov/masterRobert Göhler
the article about Terraform
2024-01-25the article about Terraformmkorobeinikov
the article about Terraform+AWS+Azure+Ansible+VMware
2024-01-19Updated DPD and close-action values in IPSECaapostoliuk
Changed from 'hold' to 'trap' and from 'restart' to 'start' in close-action. Changed from 'hold' to 'trap' in DPD action.
2024-01-10added new NPTv6/DHCPv6 exampleTrae Santiago
2023-12-06Firewall: update firewall bridge docs, and general diagram. Add minor fix to ↵Nicolas Fort
ipv4 firewall doc, and update ipv6
2023-11-24Merge pull request #1128 from mkorobeinikov/masterRobert Göhler
Ansible example article
2023-11-10Ansible example articlemkorobeinikov
An example of how to set up Ansible and VyOS.
2023-11-08Firewall Update: improve documentation and split file for better experience ↵Nicolas Fort
while reading. Add brief notes regarding Flowtables and Bridge firewall, leaving a note that those documents are still under development. New explanation for Netfilter based firewall, which includes new diagrams.
2023-09-18Added new section about the different firewallsNephiaust
Updated labels for the pages Added new pictures. Signed-off-by: Nephiaust <29741794+Nephiaust@users.noreply.github.com>
2023-09-12Config blueprints: Add new example for policy-based ipsec site to site ↵Nicolas Fort
tunnel, plus firewall, using new firewall sintax
2023-04-11Merge pull request #986 from josenj/masterRobert Göhler
Swapped LAN/DMZ
2023-04-11Merge branch 'master' into sr-mpls-correctionRobert Göhler
2023-04-11Swapped LAN/DMZJose Negron
2023-03-28Segment-rounting : Add documentation about segment-routing mpls on VyOSfett0
2023-03-27NMP and VyOS example articlemkorobeinikov
An example of how to set up NMP and VyOS using the 'snmp'
2023-02-24QoS example articlemkorobeinikov
An example of how to set up QOS.
2023-01-30Merge pull request #936 from mkorobeinikov/masterRobert Göhler
OpenVPN with LDAP example
2023-01-29OpenVPN with LDAP examplemkorobeinikov
An example of how to set up authorization in the OpenVPN client using LDAP and Active Directory.
2022-12-26ipsec_closeaction: added recommendation for closeaction optionssrividya0208
Added VPN IPSec connection-type recommendation for the close-action and dpd settings. For example close-action restart should not be added on both peers
2022-10-01Password recovery proceduregoodNETnick
2022-04-20add apendix-b and topology imageL. Repetto
2021-12-01L3VPN hub and spoke topoekhudiyev
2021-07-31added diagram & annotated commands for openvpn serverusman-umer
2021-07-13Merge pull request #566 from usman-umer/update-wireguardRobert Göhler
Wireguard Docs Update
2021-07-12updated diagram, updated sudo wg, fixed heading sizes, replaced pub IPsusman-umer
2021-07-11vrf: add example for route-leakingChristian Poessinger
2021-07-10 Moved wireguard from the interfaces to vpn directory, as it is a VPN.usman-umer
Modified the index files to reflect this. Added Diagram of the VPN Topology Modified the weird IP subnets for local& remote sites. This Included: Changing the Interface Address for the wg01 tunnel Chaning the WAN addresses to addrs not in the RFC1918 range (1.1.1.1 & 2.2.2.2) Modifing the allowed IPs and static route to reflect this. Modified the ping test to reflect this. Added an annotated verison of the wireguard local&remote config. Added an example of a firewall exception for wirguard (OUTSIDE_IN) Modified the explanation for the behavior of AllowedIPs for remote clients. Added an example of "sudo wg" to the operational commands. Fixed typo
2021-06-30configuration page: corrected spelling and grammatical mistakessrividya0208
There were minimal grammatical and spelling mistakes in the files which I corrected as documentation proof reading. Also added information about few ipsec vpn parameters.
generated by cgit v1.2.3 (git 2.39.1) at 2026-07-15 03:11:36 +0000