summaryrefslogtreecommitdiff
path: root/docs/configuration
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-05 01:42:07 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 16:18:03 +0300
commit80c5ca4aebb666932f681d2be0e7712e22d97f47 (patch)
tree21b93597e7df6cb62c7d42b0db4a37f2cbdbb954 /docs/configuration
parentce48fd34ef9347947206c23f13332e6e32fe0be0 (diff)
downloadvyos-documentation-80c5ca4aebb666932f681d2be0e7712e22d97f47.tar.gz
vyos-documentation-80c5ca4aebb666932f681d2be0e7712e22d97f47.zip
docs: address review feedback from PR #1857
Fix conversion artifacts, typos, grammar errors, and technical inaccuracies flagged by automated code review (Copilot + CodeRabbit). Infrastructure: add root-level md-*.md exclusion to conf.py, fix sphinx-autobuild ignore globs in Makefile. Content: fix curly quotes, invalid Go panic() calls, shell quoting in cURL examples, incorrect firewall command paths, typos across 22 documentation files, remove duplicate sections. 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/configuration')
-rw-r--r--docs/configuration/container/md-index.md10
-rw-r--r--docs/configuration/firewall/md-bridge.md4
-rw-r--r--docs/configuration/firewall/md-index.md4
-rw-r--r--docs/configuration/firewall/md-ipv4.md29
-rw-r--r--docs/configuration/firewall/md-ipv6.md2
5 files changed, 11 insertions, 38 deletions
diff --git a/docs/configuration/container/md-index.md b/docs/configuration/container/md-index.md
index 6cb64225..db46db38 100644
--- a/docs/configuration/container/md-index.md
+++ b/docs/configuration/container/md-index.md
@@ -5,7 +5,7 @@ lastproofread: '2024-07-03'
# Container
The VyOS container implementation is based on [Podman](https://podman.io/) as
-a deamonless container engine.
+a daemonless container engine.
## Configuration
@@ -270,17 +270,17 @@ Default health check is run for the container if defined by the image.
Override the default health check command from the image for a container.
```
-```{cfgcmd} set container name \<name\> health check interval \<interval\>
+```{cfgcmd} set container name \<name\> health-check interval \<interval\>
Override the default health-check interval. For example: `60`
```
-```{cfgcmd} set container name \<name\> health check timeout \<timeout\>
+```{cfgcmd} set container name \<name\> health-check timeout \<timeout\>
Override the default health-check timeout. For example: `10`
```
-```{cfgcmd} set container name \<name\> health check retries \<retries\>
+```{cfgcmd} set container name \<name\> health-check retries \<retries\>
Number of health check retries before container is considered unhealthy. For example: `1`
```
@@ -314,7 +314,7 @@ is the size (in bytes) of the largest ethernet frame sent on this link.
Disable Domain Name System (DNS) plugin for this network.
```
-```{cfgcmd} set container network \<name\> vrf \<nme\>
+```{cfgcmd} set container network \<name\> vrf \<name\>
Bind container network to a given VRF instance.
```
diff --git a/docs/configuration/firewall/md-bridge.md b/docs/configuration/firewall/md-bridge.md
index 58acd531..f0e94f9e 100644
--- a/docs/configuration/firewall/md-bridge.md
+++ b/docs/configuration/firewall/md-bridge.md
@@ -146,10 +146,10 @@ set to jump, then jump-target is also needed.
```
```{cfgcmd} set firewall bridge name \<name\> rule \<1-999999\> jump-target \<text\>
+```
If action is set to ``queue``, use next command to specify the queue
target. Range is also supported:
-```
```{cfgcmd} set firewall bridge forward filter rule \<1-999999\> queue \<0-65535\>
```
@@ -489,7 +489,7 @@ supported.
Starting from **VyOS-1.5-rolling-202410060007**, the firewall can modify
-packets before they are sent out. This feaure provides more flexibility in
+packets before they are sent out. This feature provides more flexibility in
packet handling.
```{cfgcmd} set firewall bridge [prerouting | forward | output] filter rule \<1-999999\> set dscp \<0-63\>
diff --git a/docs/configuration/firewall/md-index.md b/docs/configuration/firewall/md-index.md
index 81699154..9108a800 100644
--- a/docs/configuration/firewall/md-index.md
+++ b/docs/configuration/firewall/md-index.md
@@ -83,7 +83,7 @@ packet is processed at the **IP Layer**:
IPv4 and IPv6 rules, and two different sections apply:
* **Output Prerouting**: ``set firewall [ipv4 | ipv6] output
- filter ...``. As described in **Prerouting**, the system processes
+ raw ...``. As described in **Prerouting**, the system processes
rules in this section before the connection tracking subsystem.
* **Output Filter**: ``set firewall [ipv4 | ipv6] output filter ...``.
@@ -93,7 +93,7 @@ packet is processed at the **IP Layer**:
includes:
* **Source NAT**: Rules you define under ``set [nat | nat66]
- destination...``.
+ source...``.
```
If the interface where the packet was received is part of a bridge, the
diff --git a/docs/configuration/firewall/md-ipv4.md b/docs/configuration/firewall/md-ipv4.md
index 04c4fc70..2107065d 100644
--- a/docs/configuration/firewall/md-ipv4.md
+++ b/docs/configuration/firewall/md-ipv4.md
@@ -452,7 +452,7 @@ addresses.
:::{code-block} none
set firewall ipv4 name FOO rule 50 source address 192.0.2.10-192.0.2.11
# with a '!' the rule match everything except the specified subnet
-set firewall ipv4 input filter FOO rule 51 source address !203.0.113.0/24
+set firewall ipv4 name FOO rule 51 source address !203.0.113.0/24
:::
```
@@ -1160,33 +1160,6 @@ Match the time to live parameter, where 'eq' means 'equal', 'gt' means
'greater than', and 'lt' means 'less than'.
```
-```{cfgcmd} set firewall ipv4 forward filter rule \<1-999999\> recent count \<1-255\>
-```
-
-```{cfgcmd} set firewall ipv4 input filter rule \<1-999999\> recent count \<1-255\>
-```
-
-```{cfgcmd} set firewall ipv4 output filter rule \<1-999999\> recent count \<1-255\>
-```
-
-```{cfgcmd} set firewall ipv4 name \<name\> rule \<1-999999\> recent count \<1-255\>
-```
-
-```{cfgcmd} set firewall ipv4 forward filter rule \<1-999999\> recent time \<second | minute | hour\>
-```
-
-```{cfgcmd} set firewall ipv4 input filter rule \<1-999999\> recent time \<second | minute | hour\>
-```
-
-```{cfgcmd} set firewall ipv4 output filter rule \<1-999999\> recent time \<second | minute | hour\>
-```
-
-```{cfgcmd} set firewall ipv4 name \<name\> rule \<1-999999\> recent time \<second | minute | hour\>
-
-Match when 'count' amount of connections appear within 'time'. Use these
-matching criteria to block brute-force attempts.
-```
-
### Packet Modifications
Starting from **VyOS-1.5-rolling-202410060007**, the firewall can modify
diff --git a/docs/configuration/firewall/md-ipv6.md b/docs/configuration/firewall/md-ipv6.md
index 0ba30110..770cb146 100644
--- a/docs/configuration/firewall/md-ipv6.md
+++ b/docs/configuration/firewall/md-ipv6.md
@@ -1247,7 +1247,7 @@ Set hop limit value.
```{cfgcmd} set firewall ipv6 forward filter rule \<1-999999\> set connection-mark \<0-2147483647\>
```
-```{cfgcmd} set firewall ipv4 output [filter | raw] rule \<1-999999\> set connection-mark \<0-2147483647\>
+```{cfgcmd} set firewall ipv6 output [filter | raw] rule \<1-999999\> set connection-mark \<0-2147483647\>
Set connection mark value.
```