diff options
| author | Daniil Baturin <daniil@vyos.io> | 2024-07-08 12:06:11 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-07-08 12:06:11 +0100 |
| commit | f5b5fcf2b898ab023dda0c17bc823ebd865c7519 (patch) | |
| tree | 96c6562db0a27c21bac9db090908d3d039156b20 /docs/configuration/interfaces/wireguard.rst | |
| parent | 0dd8ce66227efad1735b9de71f4661d3d17f895c (diff) | |
| parent | 41a16e895114a622f3253f3950aa90fcd2adced6 (diff) | |
| download | vyos-documentation-f5b5fcf2b898ab023dda0c17bc823ebd865c7519.tar.gz vyos-documentation-f5b5fcf2b898ab023dda0c17bc823ebd865c7519.zip | |
Merge pull request #1501 from whyrlpool/patch-3
proofread interface documentation
Diffstat (limited to 'docs/configuration/interfaces/wireguard.rst')
| -rw-r--r-- | docs/configuration/interfaces/wireguard.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/configuration/interfaces/wireguard.rst b/docs/configuration/interfaces/wireguard.rst index 885720e1..db2ff2c7 100644 --- a/docs/configuration/interfaces/wireguard.rst +++ b/docs/configuration/interfaces/wireguard.rst @@ -1,4 +1,4 @@ -:lastproofread: 2023-01-26 +:lastproofread: 2024-07-04 .. _wireguard: @@ -30,7 +30,7 @@ Generate Keypair .. opcmd:: generate pki wireguard key-pair - It generates the keypair, which includes the public and private parts. + Generates the keypair, which includes the public and private parts. The key is not stored on the system - only a keypair is generated. .. code-block:: none @@ -41,7 +41,7 @@ Generate Keypair .. opcmd:: generate pki wireguard key-pair install interface <interface> - Generates a keypair, which includes the public and private parts, and build + Generates a keypair, which includes the public and private parts, and builds a configuration command to install this key to ``interface``. .. code-block:: none @@ -101,8 +101,8 @@ Optional .. opcmd:: generate pki wireguard preshared-key install interface <interface> peer <peer> An additional layer of symmetric-key crypto can be used on top of the - asymmetric crypto. This command automatically creates for you the required - CLI command to install this PSK for a given peer. + asymmetric crypto. This command automatically creates the required CLI + command to install this PSK for a given peer. This is optional. @@ -409,7 +409,7 @@ the VyOS CLI. connect to ``interface`` on this router. The public key from the specified interface is automatically extracted and embedded into the configuration. - The command also generates a configuration snipped which can be copy/pasted + The command also generates a configuration snippet which can be copy/pasted into the VyOS CLI if needed. The supplied ``<name>`` on the CLI will become the peer name in the snippet. |