docs: port is needed for wireguard endpoint

Example of `wireguard.peers[].endpoint` is wrong Signed-off-by: budimanjojo <budimanjojo@gmail.com> Signed-off-by: Noel Georgi <git@frezbo.dev>
siderolabs · Feb 13, 2023 · 34ab000 · 34ab000
1 parent 1e1aa84
commit 34ab000
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
@@ -461,7 +461,7 @@ var (
 		WireguardPeers: []*DeviceWireguardPeer{
 			{
 				WireguardPublicKey:                   "ABCDEF...",
-				WireguardEndpoint:                    "192.168.1.2",
+				WireguardEndpoint:                    "192.168.1.2:51822",
 				WireguardPersistentKeepaliveInterval: time.Second * 10,
 				WireguardAllowedIPs:                  []string{"192.168.1.0/24"},
 			},

diff --git a/website/content/v1.4/reference/configuration.md b/website/content/v1.4/reference/configuration.md
@@ -216,7 +216,7 @@ network:
           #     # 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 # Specifies the endpoint of this peer entry.
+          #           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:
@@ -915,7 +915,7 @@ interfaces:
       #     # 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 # Specifies the endpoint of this peer entry.
+      #           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:
@@ -1016,7 +1016,7 @@ interfaces:
       #     # 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 # Specifies the endpoint of this peer entry.
+      #           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:
@@ -2014,7 +2014,7 @@ Appears in:
   #     # 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 # Specifies the endpoint of this peer entry.
+  #           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:
@@ -2100,7 +2100,7 @@ wireguard:
     # 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 # Specifies the endpoint of this peer entry.
+          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:
@@ -2165,7 +2165,7 @@ 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 # Specifies the endpoint of this peer entry.
+      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: