| Age | Commit message (Collapse) | Author |
|---|
|
Throwaway change for an end-to-end check of the per-PR AI validation
workflow (reviewer-v1.1.0, claude-opus-5-5). Contains deliberately
invalid cfgcmd directives nested in a blockquote and a list item, plus
one inside an HTML comment that must not be flagged. Not for merge.
🤖 Generated by [robots](https://vyos.io)
|
|
* docs: T3871: describe how interface names are assigned
Names are no longer derived from the hw-id node. They are bound to the slot
the hardware occupies and recorded in a mapping file, so document what
decides a name, what happens when a card is replaced or added, and how to
rename an interface.
The troubleshooting page said to pin a MAC with hw-id when interfaces were
renamed after a VM migration or a clone. That node no longer exists and the
situation it describes no longer arises, so replace it with a pointer to the
new section and a note on where to look when an interface really is missing.
* docs: T3871: drop hw-id from the example output
The node is gone from the CLI, so example configuration dumps which still
show it no longer match what a reader sees on their own system. Remove it
from the shown output only; no prose changes. The comparison shown on the
testing page is rewritten rather than trimmed, as deleting the lines would
have left an edit level behind with nothing under it.
|
|
vpn: document disable-mobike, disable-uniqreqids, eap-id and L2TP IPs…
|
|
docs: Update Firewall groups page to VyOS 1.5 standards
|
|
|
|
|
|
* docs: Update Firewall global options page to VyOS 1.5 standards
* Update global-options.md
|
|
* docs: Update Firewall page to VyOS 1.5 standards
* Apply suggestion from @github-actions[bot]
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* Update docs/configuration/firewall/index.md
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* Update index.md
---------
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
|
ruben-herold/docs-openvpn-fix-pool-subnet-mask-hash
openvpn: fix client-ip-pool subnet-mask command name and list all has…
|
|
|
|
|
|
haproxy: T9097: document backend ssl checks-only option
|
|
container: T9453: explain migration to kernel overlayfs from fuse-overlayfs
|
|
haproxy: document backend http-server-close
|
|
T9354: document "reconnect interface" operational command
|
|
* docs: T8887: backfill Phase 1 commands from recent vyos-1x additions
Documents six CLI features added to vyos-1x between Nov 2025 and May 2026
that were missing from the docs (gap-audit T8886, Phase 1 / T8887):
- policy route-map match source-peer (vyos-1x#5149, T8588)
- high-availability vrrp snmp trap (vyos-1x#5108, T8448)
- protocols segment-routing traffic-engineering subtree (vyos-1x#4994, T6750)
- protocols bgp bmp target monitor pre-policy/post-policy/local-rib
(vyos-1x#4922, T8133)
- firewall global-options geoip provider/maxmind-* (vyos-1x#4949, T7926/T8049)
- vpn ipsec childless IKE SA option (vyos-1x#4930, T8136)
system frr watchfrr-timeout and service router-advert prefix
base-interface are now documented on rolling via the page rewrites in
vyos-documentation#2251 and vyos-documentation#2132. protocols bgp
parameters as-notation is deferred: rolling carries it commented out;
to be handled in a follow-up.
🤖 Generated by [robots](https://vyos.io)
* docs: T8887: wrap pre-existing overlong lines in touched files
- route-map, ipsec_general: wrap five pre-existing overlong lines so the
doc linter (which scans whole modified files) passes on touched files
🤖 Generated by [robots](https://vyos.io)
* docs: T8887: document BMP prerequisites and mandatory target address
- state that set system frr bmp needs a commit plus a router reboot (or
FRR restart) before BMP targets can be committed (protocols_bgp.py
verify)
- add target address (mandatory) and port (default 5000) commands and
include the address in the example
🤖 Generated by [robots](https://vyos.io)
* docs: T8887: state SR-TE segment-list commit requirements
Per protocols_segment-routing.py verify(): a segment list needs at least
one index; each index needs an MPLS label or a NAI; an adjacency NAI
needs both source- and destination-identifier; a prefix identifier
needs an algorithm; IS-IS/OSPF import, adjacency/prefix, IPv4/IPv6 and
spf/strict-spf are mutually exclusive. Add a complete example.
🤖 Generated by [robots](https://vyos.io)
* docs: T8887: escape placeholders in GeoIP and childless cfgcmd headers
🤖 Generated by [robots](https://vyos.io)
* Apply suggestions from Liydmyla
Co-authored-by: LiudmylaNad <235844477+LiudmylaNad@users.noreply.github.com>
---------
Co-authored-by: Daniil Baturin <daniil@vyos.io>
Co-authored-by: LiudmylaNad <235844477+LiudmylaNad@users.noreply.github.com>
|
|
|
|
algorithms
|
|
|
|
Note that "encryption data-ciphers-fallback" only takes CBC ciphers
together with "shared-secret-key".
|
|
The two nat64prefix examples use the well-known prefix 64:ff9b::/96,
which the doc linter reports as outside the documentation ranges. Wrap
them in stop/start_vyoslinter markers, as AGENTS.md describes for this
prefix, so the page passes the linter.
|
|
Document the three per-interface options added in vyos-1x for T9413,
which keep radvd from sending zero-lifetime router, RDNSS and DNSSL
advertisements on shutdown, and add an example of two routers sharing
fe80::1 as the RA source address through VRRP.
|
|
openvpn: T9370: document the chacha20poly1305 data cipher
|
|
* container: document remaining per-container options and network types
The container page covered 44 of the 53 nodes in container.xml.in. Add
the eight that were missing, grouped where they belong on the page:
- allow-host-cgroups, next to allow-host-pid
- network <net> mac, next to the network address option
- volume <vol> propagation, with all six modes
- stop-timeout, next to restart
- shared-memory, next to memory
- network <net> type bridge / type macvlan mode / type macvlan parent
The network type is the notable gap: MACVLAN was entirely undocumented,
although it is the way to put containers directly on a parent network
instead of behind the host bridge and NAT. The page now states that
parent and mode are both required, that the parent must exist, and that
MACVLAN networks cannot be assigned to a VRF - all three are enforced
by verify() in src/conf_mode/container.py.
Defaults and ranges are taken from container.xml.in; the "--cgroupns
host" note matches what the quadlet generator emits.
* container: describe volume propagation in terms of mount events
The six propagation modes were described in terms of sub-mount
visibility, taken from the <description> text in container.xml.in. That
is not what the modes do - mount(2)/umount(2) event propagation is.
Per mount_namespaces(7):
- MS_SHARED propagates events *both ways* between members of the peer
group, not only from the original mount to the replica
- MS_PRIVATE propagates no events out of or into the mount; it does not
hide sub-mounts within it
Also note the constraint the host side imposes, which is easy to trip
over: per docker-run(1)/podman, shared propagation requires the source
mount to be shared and slave requires it to be shared or slave, or the
requested mode silently does not take effect. Added the findmnt
invocation to check it.
Raised by CodeRabbit on #2244.
* container: document stop-timeout range and MACVLAN private mode precisely
|
|
* docs: T9200: note no-ipv6-auto-ra doesn't stop already-active RA
no-ipv6-auto-ra only prevents future RA initiation; it doesn't
retroactively silence router advertisements already sent on an
established session. Confirmed on VyOS 1.5.1: neither a soft nor a
hard clear/reset bgp on the neighbor stopped it. Per FRR's
bgp_zebra_terminate_radv()/upstream PR FRRouting/frr#19487, that only
runs when the neighbor's remote-as is removed and re-added.
* docs: T9200: distinguish blast radius of the two RA workarounds
remote-as re-add only affects the one neighbor; a bgpd/frr restart
clears every BGP session on the router. The note listed them as
equivalent options - reframe the restart as a maintenance-window
fallback instead.
Flagged by CodeRabbit review on PR #2195.
* Make the note less wordy
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
|
|
|
|
|
|
|
|
Add chacha20poly1305 to "encryption data-ciphers" and
"encryption data-ciphers-fallback".
|
|
Document "interfaces openvpn <interface> mtu", its 1420 bytes default
with DCO and its constraints.
|
|
|
|
|
|
Added documentation to correspond to the change to make several agent values configurable instead of hardcoded
|
|
(#2252)
|
|
* docs: Update FRR page to VyOS 1.5 standards
* Minor corrections
* Update frr.md
|
|
|
|
* docs: Update Serial console page to VyOS 1.5 standards
* Remove a passage with outdated information
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
|
|
* Cleaned up container document
Added more explicit explanation to some items
Added note on Global State Policies and container networks about
accept-invalid
* Update docs/configuration/container/index.md
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* Update docs/configuration/container/index.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
* Update docs/configuration/container/index.md
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* Update docs/configuration/container/index.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
* Added suggested fixes from coderabbit.
* Fixed opmode for Adguard Home
* Fix health-check retry command
* Fixed the adguard example add container image fence and changed the
wording around directories.
* Fixed line exceeds 80 char at volume mount
Fixed fences
* Update docs/configuration/container/index.md
No idea how that ended up in the file.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* Fix grammar for Zabbix example
* Remove a third-party service example
---------
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Daniil Baturin <daniil@baturin.org>
|
|
* docs: T9175: document dns forwarding options security-poll-suffix
Document the new opt-in `service dns forwarding options
security-poll-suffix` setting that controls the PowerDNS recursor's
periodic security status poll, disabled by default.
* docs: T9175: fix security-poll-suffix placement and clarify disable
The security-poll-suffix cfgcmd was placed under "Per-domain
forwarding" even though it's a global forwarding option, and used the
"forwarding options" convention (bold summary + Example block) used
by ecs-add-for/ecs-ipv4-bits/edns-subnet-allow-list right above it.
Also documents how to disable polling again (delete the option),
clarifies it only takes effect with a non-empty suffix, and that
secpoll.powerdns.com is PowerDNS' own poll domain rather than a VyOS
default. Switches secpoll.powerdns.com from double to single
backticks, matching MyST inline-code convention.
Flagged by CodeRabbit and the Claude review bot on PR #2193.
* docs: T9175: rename security-poll-suffix option to security-status-poll-domain
Follows vyos-1x PR #5389 rename per dmbaturin's review: the value is a
full FQDN, not a suffix, and the poll checks for known vulnerabilities.
|
|
PPPoE, SSTP client and WWAN interfaces can now be restarted with a single
command which survives the loss of the CLI session, so it can be issued over
the very interface being reconnected. The WWAN page gained the connect and
disconnect commands as well - they have always been available there, but were
only documented for PPPoE and SSTP.
The command is also exposed by the HTTP API through a dedicated endpoint,
which replaces the "reset connection" path that was previously used for this.
|
|
* docs: T9157: document firewall fib-type match
Companion doc entry for vyos/vyos-1x#5372, which adds
"fib-type" as a source/destination match option
(nftables' fib daddr/saddr type expression) for
forward/input/output/name rule sets, ipv4 and ipv6.
* docs: T9157: update fib match docs for fib-type -> fib type rename
Companion vyos-1x PR #5372 restructured the "fib-type" leaf into a
"fib" node with a "type" child (following feedback from l0crian1 and
sarthurdev to reserve the "fib" namespace for a possible future
lookup/match concatenation feature, tracked separately under T5119).
Update the CLI paths and examples here to match, and fix "prohibited"
to "prohibit" to match nftables' actual fib_addrtype token.
* docs: T9157: add prerouting raw fib type reference, fix backtick style
CodeRabbit feedback on #2186:
- the prose showed a "prerouting raw" example but the command
reference only listed forward/input/output/name filter forms, even
though fib.xml.i is also included from common-rule-ipv{4,6}-raw.xml.i
for that hook. Add the missing source/destination cfgcmd entries.
- MyST pages use single backticks for inline code, not double
(that's for embedded RST); fix the fib type prose accordingly.
* docs: T9157: update fib docs for rule-level lookup/match split
Companion vyos-1x PR #5372 moved "fib" from a leaf nested under
destination/source to a rule-level node with separate "lookup"
(source-address/destination-address) and "match route-type" children,
per l0crian1's review feedback - reserving room for mark/iif/oif
lookup keys and oif/oifname match results later (tracked under T5119)
without ever renaming what ships now. Update the CLI paths and
examples here to match.
|
|
* firewall/groups: document include option and remote-group interval
These CLI nodes existed in the XML definitions but were missing from
the docs entirely, per docs.vyos.io/en/1.5/coverage.html:
- include: lets one group nest another group of the same type
(address-group, ipv6-address-group, network-group,
ipv6-network-group, mac-group, port-group, interface-group)
- remote-group interval: overrides the global resolver-interval on a
per-group basis
* firewall/groups: clarify remote-group interval range applies post-conversion
CodeRabbit review on #2241 noted the range (60-2419200s) wasn't clearly
tied to suffixed values. Confirmed in vyos-1x conf_mode/firewall.py:
human_to_seconds() converts the value first, then the range check
runs on the converted seconds -- so e.g. "30s" is rejected same as "30".
|
|
* docs: T8045: document dont-query
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
|
|
* docs: Update sFlow page to VyOS 1.5 standards
|
|
|
|
* docs: Update Conntrack page to VyOS 1.5 standards
* Update conntrack.md
* Apply suggestion from @dmbaturin
* Apply suggestion from @dmbaturin
* Apply suggestion from @dmbaturin
* Apply suggestion from @dmbaturin
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
|
|
* docs: Update Acceleration page to VyOS 1.5 standards
* Apply batched suggestions from code review
Co-authored-by: Daniil Baturin <daniil@baturin.org>
* Update acceleration.md
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
|
|
docs: T9166: document IPv6 for HA peer link
|
|
* firewall: T9076: document remote-group update interval
Document the new 'set firewall group remote-group <name> interval'
command: per-group update interval from 60 seconds to 4 weeks, given
as plain seconds or with s/m/h/d/w suffixes (e.g. 4h), falling back
to the global resolver-interval when unset.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* firewall: T9076: note URL quoting and log redaction for remote-group
Warn that remote-group URLs with query strings must be quoted (unquoted
'&' silently truncates the value; literal '?' may need Ctrl-V, see
T9077) and that vyos-domain-resolver logs redact the query string on
download failures (T8829).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* firewall: T9076: note that remote-group interval suffixes may be combined
Address review feedback: document that s/m/h/d/w units can be stacked
(e.g. 1h30m), matching human_to_seconds and the CLI regex.
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
|
|
* docs: Update Monitoring page to VyOS 1.5 standards
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
|
