docs: make it clear --wg-endpoint doesn't change addr/port WG listens on

This commit is contained in:
Pasha Sviderski
2026-05-04 16:01:55 +10:00
parent dd68079005
commit 34560470ce
3 changed files with 14 additions and 11 deletions
+5 -4
View File
@@ -96,11 +96,12 @@ Connection methods:
) )
cmd.Flags().StringSliceVar( cmd.Flags().StringSliceVar(
&opts.wgEndpoints, "wg-endpoint", nil, &opts.wgEndpoints, "wg-endpoint", nil,
fmt.Sprintf("WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. "+ fmt.Sprintf("WireGuard endpoint address that other machines in the cluster should use to establish "+
"Default port %d is used if omitted.\n", network.WireGuardPort)+ "WireGuard connections\n"+
"Other machines in the cluster will use this endpoint to establish a WireGuard connection to this machine.\n"+ "to this machine. This doesn't change the address/port WireGuard listens on the machine.\n"+
"Format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port is %d if omitted.\n", network.WireGuardPort)+
"Multiple endpoints can be specified by repeating the flag or using a comma-separated list.\n"+ "Multiple endpoints can be specified by repeating the flag or using a comma-separated list.\n"+
"If not specified, the machine's routable IPs and public IP are auto-detected and used as endpoints.", "Defaults to the auto-detected public and routable machine IPs.",
) )
cmd.Flags().BoolVarP(&opts.yes, "yes", "y", false, cmd.Flags().BoolVarP(&opts.yes, "yes", "y", false,
"Auto-confirm prompts (e.g., resetting an already initialised machine).\n"+ "Auto-confirm prompts (e.g., resetting an already initialised machine).\n"+
+5 -4
View File
@@ -135,11 +135,12 @@ Connection methods:
) )
cmd.Flags().StringSliceVar( cmd.Flags().StringSliceVar(
&opts.wgEndpoints, "wg-endpoint", nil, &opts.wgEndpoints, "wg-endpoint", nil,
fmt.Sprintf("WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. "+ fmt.Sprintf("WireGuard endpoint address that other machines in the cluster should use to establish "+
"Default port %d is used if omitted.\n", network.WireGuardPort)+ "WireGuard connections\n"+
"Other machines in the cluster will use this endpoint to establish a WireGuard connection to this machine.\n"+ "to this machine. This doesn't change the address/port WireGuard listens on the machine.\n"+
"Format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port is %d if omitted.\n", network.WireGuardPort)+
"Multiple endpoints can be specified by repeating the flag or using a comma-separated list.\n"+ "Multiple endpoints can be specified by repeating the flag or using a comma-separated list.\n"+
"If not specified, the machine's routable IPs and public IP are auto-detected and used as endpoints.", "Defaults to the auto-detected public and routable machine IPs.",
) )
cmd.Flags().BoolVarP(&opts.yes, "yes", "y", false, cmd.Flags().BoolVarP(&opts.yes, "yes", "y", false,
"Auto-confirm prompts (e.g., resetting an already initialised machine).\n"+ "Auto-confirm prompts (e.g., resetting an already initialised machine).\n"+
+4 -3
View File
@@ -67,9 +67,10 @@ At least one flag must be specified to perform an update.`,
) )
cmd.Flags().StringSliceVar( cmd.Flags().StringSliceVar(
&opts.wgEndpoints, "wg-endpoint", nil, &opts.wgEndpoints, "wg-endpoint", nil,
fmt.Sprintf("WireGuard endpoint address in format: IP, IP:PORT, IPv6, or [IPv6]:PORT. "+ fmt.Sprintf("WireGuard endpoint address that other machines in the cluster should use to establish "+
"Default port %d is used if omitted.\n", network.WireGuardPort)+ "WireGuard connections\n"+
"Other machines in the cluster will use this endpoint to establish a WireGuard connection to this machine.\n"+ "to this machine. This doesn't change the address/port WireGuard listens on the machine.\n"+
"Format: IP, IP:PORT, IPv6, or [IPv6]:PORT. Default port is %d if omitted.\n", network.WireGuardPort)+
"Multiple endpoints can be specified by repeating the flag or using a comma-separated list.", "Multiple endpoints can be specified by repeating the flag or using a comma-separated list.",
) )