summaryrefslogtreecommitdiff
path: root/docs/configuration/service
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-05 23:21:35 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 16:18:03 +0300
commitd72e213cc7c2dd0099f305cda4a6ba527b27d1da (patch)
tree783b5f504e1a8d367148f2c140a403dc35cb6868 /docs/configuration/service
parent80c5ca4aebb666932f681d2be0e7712e22d97f47 (diff)
downloadvyos-documentation-d72e213cc7c2dd0099f305cda4a6ba527b27d1da.tar.gz
vyos-documentation-d72e213cc7c2dd0099f305cda4a6ba527b27d1da.zip
docs: fix typos and a few grammar issues (ported from #1852 RST → MyST)
Ports the typo/grammar sweep originally captured in PR #1852 from .rst files to their .md equivalents, plus the eventhandler grammar fix that Copilot flagged in #1852's review (which the RST PR explicitly skipped as scope-stretch). Sources: - 73 typo/grammar substitutions from PR #1852 (rebased from #1801) - "Using environments is more preferable" → "Using environment variables is preferable" (Copilot review comment on #1852) #1852 itself is being discarded since it targets RST and we are phasing out the RST tree in favor of MyST. The 4 RST-linter line-wrap comments and 1 RST section-underline comment from Copilot's #1852 review are RST-specific and do not apply to .md. 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/configuration/service')
-rw-r--r--docs/configuration/service/md-conntrack-sync.md8
-rw-r--r--docs/configuration/service/md-console-server.md2
-rw-r--r--docs/configuration/service/md-dhcp-server.md12
-rw-r--r--docs/configuration/service/md-eventhandler.md3
-rw-r--r--docs/configuration/service/md-ipoe-server.md10
-rw-r--r--docs/configuration/service/md-monitoring.md2
-rw-r--r--docs/configuration/service/md-pppoe-server.md8
-rw-r--r--docs/configuration/service/md-salt-minion.md2
8 files changed, 23 insertions, 24 deletions
diff --git a/docs/configuration/service/md-conntrack-sync.md b/docs/configuration/service/md-conntrack-sync.md
index 47a0ae2f..4aad6283 100644
--- a/docs/configuration/service/md-conntrack-sync.md
+++ b/docs/configuration/service/md-conntrack-sync.md
@@ -27,7 +27,7 @@ will be mandatorily defragmented.
It is possible to use either Multicast or Unicast to sync conntrack traffic.
Most examples below show Multicast, but unicast can be specified by using the
-"peer" keywork after the specified interface, as in the following example:
+"peer" keyword after the specified interface, as in the following example:
{cfgcmd}`set service conntrack-sync interface eth0 peer 192.168.0.250`
@@ -100,8 +100,8 @@ Defaults to 225.0.0.50.
```{cfgcmd} set service conntrack-sync interface \<name\> peer \<address\>
-Peer to send unicast UDP conntrack sync entires to, if not using Multicast
-configuration from above above.
+Peer to send unicast UDP conntrack sync entries to, if not using Multicast
+configuration from above.
```
@@ -113,7 +113,7 @@ Queue size for syncing conntrack entries in MB.
```{cfgcmd} set service conntrack-sync disable-external-cache
-This diable the external cache and directly injects the flow-states into the
+This disables the external cache and directly injects the flow-states into the
in-kernel Connection Tracking System of the backup firewall.
```
diff --git a/docs/configuration/service/md-console-server.md b/docs/configuration/service/md-console-server.md
index 9402e935..f0556652 100644
--- a/docs/configuration/service/md-console-server.md
+++ b/docs/configuration/service/md-console-server.md
@@ -75,7 +75,7 @@ port.
```{cfgcmd} set service console-server device \<device\> ssh port \<port\>
Accept SSH connections for the given `<device>` on TCP port `<port>`.
-After successfull authentication the user will be directly dropped to
+After successful authentication the user will be directly dropped to
the connected serial device.
:::{hint}
diff --git a/docs/configuration/service/md-dhcp-server.md b/docs/configuration/service/md-dhcp-server.md
index 96c375da..721d6d4a 100644
--- a/docs/configuration/service/md-dhcp-server.md
+++ b/docs/configuration/service/md-dhcp-server.md
@@ -209,7 +209,7 @@ level, i.e. for individual shared networks or subnets. See examples below.
If set to ``enable`` on global level, updates for all scopes will be enabled,
except if explicitly set to ``disable`` on the scope level. If set to ``disable``,
-updates will only be sent for scopes, where ``send-updates`` is explicity
+updates will only be sent for scopes, where ``send-updates`` is explicitly
set to ``enable``.
This model is followed for a few behavioral settings below: if the option is
@@ -579,7 +579,7 @@ NB: Kea (the DHCP server used by VyOS) is programmed to offer as many
alternatives as it can to repeated DHCP Discover requests. Some operating
systems (Notably Microsoft Windows) make multiple DHCP Discover requests before
settling on an address. This particularly seems to happen when the DHCP server
-isn't set to authorative. This may explain why the address you espect isn't
+isn't set to authoritative. This may explain why the address you expect isn't
being chosen. Wireshark is helpful in these situations.
@@ -1010,14 +1010,14 @@ A SNTP server address can be specified for DHCPv6 clients.
To hand out individual prefixes to your clients the following configuration is
used:
-```{cfgcmd} set service dhcpv6-server shared-network-name \<name\> subnet \<prefix\> prefix-delegation prefix \<pd-prefix\> prefix-length \<lenght\>
+```{cfgcmd} set service dhcpv6-server shared-network-name \<name\> subnet \<prefix\> prefix-delegation prefix \<pd-prefix\> prefix-length \<length\>
Delegate prefixes from `<pd-prefix>` to clients in subnet `<prefix>`. Range
-is defined by `<lenght>` in bits, 32 to 64.
+is defined by `<length>` in bits, 32 to 64.
```
-```{cfgcmd} set service dhcpv6-server shared-network-name \<name\> subnet \<prefix\> prefix-delegation prefix \<pd-prefix\> delegated-length \<lenght\>
+```{cfgcmd} set service dhcpv6-server shared-network-name \<name\> subnet \<prefix\> prefix-delegation prefix \<pd-prefix\> delegated-length \<length\>
Hand out prefixes of size `<length>` in bits from `<pd-prefix>` to clients
in subnet `<prefix>` when the request for prefix delegation.
@@ -1030,7 +1030,7 @@ Exclude `<exclude-prefix>` from `<pd-prefix>`.
```
```{cfgcmd} set service dhcpv6-server shared-network-name \<name\> subnet \<prefix\> prefix-delegation prefix \<pd-prefix\> excluded-prefix-length \<length\>
-Define lenght of exclude prefix in `<pd-prefix>`.
+Define length of exclude prefix in `<pd-prefix>`.
```
**Example:**
diff --git a/docs/configuration/service/md-eventhandler.md b/docs/configuration/service/md-eventhandler.md
index 48031909..6413c24d 100644
--- a/docs/configuration/service/md-eventhandler.md
+++ b/docs/configuration/service/md-eventhandler.md
@@ -76,8 +76,7 @@ This is an optional command. Adds arguments to the script.
Arguments must be separated by spaces.
:::{note}
-We don't recommend to use arguments. Using environments
-is more preferable.
+We don't recommend using arguments. Using environment variables is preferable.
:::
```
diff --git a/docs/configuration/service/md-ipoe-server.md b/docs/configuration/service/md-ipoe-server.md
index 88ec4f51..f1ef2a63 100644
--- a/docs/configuration/service/md-ipoe-server.md
+++ b/docs/configuration/service/md-ipoe-server.md
@@ -162,7 +162,7 @@ to a single source IP e.g. the loopback interface.
```{cfgcmd} set service ipoe-server authentication radius source-address \<address\>
-Source IPv4 address used in all RADIUS server queires.
+Source IPv4 address used in all RADIUS server queries.
```
:::{note}
@@ -244,7 +244,7 @@ in DM/CoA requests. Also DM/CoA server will bind to that address.
```{cfgcmd} set service ipoe-server authentication radius source-address \<address\>
-Source IPv4 address used in all RADIUS server queires.
+Source IPv4 address used in all RADIUS server queries.
```
@@ -292,7 +292,7 @@ will be allocated from a predefined IPv6 pool ``prefix`` whose name equals the a
If the RADIUS server sends the attribute ``Delegated-IPv6-Prefix-Pool``, IPv6
-delegation pefix will be allocated from a predefined IPv6 pool ``delegate``
+delegation prefix will be allocated from a predefined IPv6 pool ``delegate``
whose name equals the attribute value.
@@ -311,7 +311,7 @@ Define it in your RADIUS server.
```{cfgcmd} set service ipoe-server client-ipv6-pool \<IPv6-POOL-NAME\> prefix \<address\> mask \<number-of-bits\>
-Use this comand to set the IPv6 address pool from which an IPoE client
+Use this command to set the IPv6 address pool from which an IPoE client
will get an IPv6 prefix of your defined length (mask) to terminate the
IPoE endpoint at their side. The mask length can be set from 48 to 128
bit long, the default value is 64.
@@ -492,7 +492,7 @@ ipoe:
delayed: 0
```
-## Toubleshooting
+## Troubleshooting
```none
vyos@vyos:~$ show log ipoe-server
diff --git a/docs/configuration/service/md-monitoring.md b/docs/configuration/service/md-monitoring.md
index a6bf2605..93bd40e6 100644
--- a/docs/configuration/service/md-monitoring.md
+++ b/docs/configuration/service/md-monitoring.md
@@ -98,7 +98,7 @@ Local IP addresses to listen on
```{cfgcmd} set service monitoring telegraf prometheus-client metric-version \<1 | 2\>
-Metris version, the default is ``2``
+Metrics version, the default is ``2``
```
diff --git a/docs/configuration/service/md-pppoe-server.md b/docs/configuration/service/md-pppoe-server.md
index 32881845..805740e4 100644
--- a/docs/configuration/service/md-pppoe-server.md
+++ b/docs/configuration/service/md-pppoe-server.md
@@ -123,7 +123,7 @@ to a single source IP e.g. the loopback interface.
```{cfgcmd} set service pppoe-server authentication radius source-address \<address\>
-Source IPv4 address used in all RADIUS server queires.
+Source IPv4 address used in all RADIUS server queries.
```
:::{note}
@@ -205,7 +205,7 @@ in DM/CoA requests. Also DM/CoA server will bind to that address.
```{cfgcmd} set service pppoe-server authentication radius source-address \<address\>
-Source IPv4 address used in all RADIUS server queires.
+Source IPv4 address used in all RADIUS server queries.
```
@@ -254,7 +254,7 @@ whose name equals the attribute value.
If the RADIUS server sends the attribute `Delegated-IPv6-Prefix-Pool`,
-IPv6 delegation pefix will be allocated from a predefined IPv6 pool `delegate`
+IPv6 delegation prefix will be allocated from a predefined IPv6 pool `delegate`
whose name equals the attribute value.
@@ -407,7 +407,7 @@ Specifies IPv6 negotiation preference.
```{cfgcmd} set service pppoe-server client-ipv6-pool \<IPv6-POOL-NAME\> prefix \<address\> mask \<number-of-bits\>
-Use this comand to set the IPv6 address pool from which an PPPoE client
+Use this command to set the IPv6 address pool from which a PPPoE client
will get an IPv6 prefix of your defined length (mask) to terminate the
PPPoE endpoint at their side. The mask length can be set from 48 to 128
bit long, the default value is 64.
diff --git a/docs/configuration/service/md-salt-minion.md b/docs/configuration/service/md-salt-minion.md
index e6f99752..e430f4fc 100644
--- a/docs/configuration/service/md-salt-minion.md
+++ b/docs/configuration/service/md-salt-minion.md
@@ -45,7 +45,7 @@ The hostname or IP address of the master
URL with signature of master for auth reply verification
```
-Please take a look in the Automation section to find some usefull
+Please take a look in the Automation section to find some useful
Examples.
[saltstack]: https://saltproject.io/