From a7882fabc7831c7e43e1611b886eb3d3a1daa1b1 Mon Sep 17 00:00:00 2001 From: Mara Sophie Grosch Date: Mon, 22 Nov 2021 17:58:19 +0100 Subject: [PATCH] Use IPv6 doc prefix for docs (#324) IPv6 has a dedicated prefix for documentation and examples, this commit makes use of it for BindAddress config flag docs and examples. --- cmd/gotosocial/generalflags.go | 2 +- docs/configuration/general.md | 2 +- example/config.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/gotosocial/generalflags.go b/cmd/gotosocial/generalflags.go index 9f321b760..b7e15ab20 100644 --- a/cmd/gotosocial/generalflags.go +++ b/cmd/gotosocial/generalflags.go @@ -64,7 +64,7 @@ func generalFlags(flagNames, envNames config.Flags, defaults config.Defaults) [] }, &cli.StringFlag{ Name: flagNames.BindAddress, - Usage: "Bind address to use for the GoToSocial server (eg., 0.0.0.0, 172.138.0.9, [::], localhost). For ipv6, enclose the address in square brackets, eg [2a02:1807:1430:500:13f5:5efb:3f3a:1191]. Default binds to all interfaces.", + Usage: "Bind address to use for the GoToSocial server (eg., 0.0.0.0, 172.138.0.9, [::], localhost). For ipv6, enclose the address in square brackets, eg [2001:db8::fed1]. Default binds to all interfaces.", Value: defaults.BindAddress, EnvVars: []string{envNames.BindAddress}, }, diff --git a/docs/configuration/general.md b/docs/configuration/general.md index df9eaa4b0..be27095d1 100644 --- a/docs/configuration/general.md +++ b/docs/configuration/general.md @@ -53,7 +53,7 @@ protocol: "https" # Default value will bind to all interfaces. # You probably won't need to change this unless you're setting GoToSocial up in some fancy way or # you have specific networking requirements. -# Examples: ["0.0.0.0", "172.128.0.16", "localhost", "[::]", "[2a02:1807:1430:500:13f5:5efb:3f3a:1191]"] +# Examples: ["0.0.0.0", "172.128.0.16", "localhost", "[::]", "[2001:db8::fed1]"] # Default: "0.0.0.0" bindAddress: "0.0.0.0" diff --git a/example/config.yaml b/example/config.yaml index 7e7bd3a35..2295acf91 100644 --- a/example/config.yaml +++ b/example/config.yaml @@ -60,7 +60,7 @@ protocol: "https" # Default value will bind to all interfaces. # You probably won't need to change this unless you're setting GoToSocial up in some fancy way or # you have specific networking requirements. -# Examples: ["0.0.0.0", "172.128.0.16", "localhost", "[::]", "[2a02:1807:1430:500:13f5:5efb:3f3a:1191]"] +# Examples: ["0.0.0.0", "172.128.0.16", "localhost", "[::]", "[2001:db8::fed1]"] # Default: "0.0.0.0" bindAddress: "0.0.0.0"