From 4d16809964a076d1cf3b1f4930d377a41c2f21eb Mon Sep 17 00:00:00 2001
From: naed3r <40650681+nate-moo@users.noreply.github.com>
Date: Fri, 26 Jul 2024 20:12:20 -0600
Subject: [PATCH] Add more information to the wireguard interface definition

When setting up Wireguard the provided reference documentation on it was incomplete in my opinion, and I believe this change would help make configuring it for new users easier

Signed-off-by: naed3r <40650681+nate-moo@users.noreply.github.com>
---
 .../configuration/v1alpha1/config.md          | 46 +++++++++++--------
 1 file changed, 26 insertions(+), 20 deletions(-)

diff --git a/website/content/v1.7/reference/configuration/v1alpha1/config.md b/website/content/v1.7/reference/configuration/v1alpha1/config.md
index dc3e97e896..b59b08b668 100644
--- a/website/content/v1.7/reference/configuration/v1alpha1/config.md
+++ b/website/content/v1.7/reference/configuration/v1alpha1/config.md
@@ -1558,32 +1558,38 @@ DeviceWireguardConfig contains settings for configuring Wireguard network interf
 machine:
     network:
         interfaces:
-            - wireguard:
-                privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
-                listenPort: 51111 # Specifies a device's listening port.
-                # Specifies a list of peer configurations to apply to a device.
-                peers:
-                    - publicKey: ABCDEF... # Specifies the public key of this peer.
-                      endpoint: 192.168.1.3 # Specifies the endpoint of this peer entry.
-                      # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
-                      allowedIPs:
-                        - 192.168.1.0/24
+          - interface: wg0 # Name of the wireguard interface
+            addresses:
+              - 192.168.2.1/24 # Address to assign to the interface
+            wireguard:
+              privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
+              listenPort: 51111 # Specifies a device's listening port.
+              # Specifies a list of peer configurations to apply to a device.
+              peers:
+              - publicKey: ABCDEF... # Specifies the public key of this peer.
+                endpoint: 192.168.1.3 # Specifies the endpoint of this peer entry.
+                # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
+                allowedIPs:
+                  - 192.168.1.0/24
 {{< /highlight >}}
 
 {{< highlight yaml >}}
 machine:
     network:
         interfaces:
-            - wireguard:
-                privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
-                # Specifies a list of peer configurations to apply to a device.
-                peers:
-                    - publicKey: ABCDEF... # Specifies the public key of this peer.
-                      endpoint: 192.168.1.2:51822 # Specifies the endpoint of this peer entry.
-                      persistentKeepaliveInterval: 10s # Specifies the persistent keepalive interval for this peer.
-                      # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
-                      allowedIPs:
-                        - 192.168.1.0/24
+        - interface: wg0 # Name of the wireguard interface
+          addresses:
+            - 192.168.2.1/24 # Address to assign to the interface
+          wireguard:
+            privateKey: ABCDEF... # Specifies a private key configuration (base64 encoded).
+            # Specifies a list of peer configurations to apply to a device.
+            peers:
+              - publicKey: ABCDEF... # Specifies the public key of this peer.
+                endpoint: 192.168.1.2:51822 # Specifies the endpoint of this peer entry.
+                persistentKeepaliveInterval: 10s # Specifies the persistent keepalive interval for this peer.
+                # AllowedIPs specifies a list of allowed IP addresses in CIDR notation for this peer.
+                allowedIPs:
+                  - 192.168.1.0/24
 {{< /highlight >}}