diff options
| author |  Oliver Calder <oliver@calder.dev> | 2025-06-10 12:14:46 +0200 |
|---|---|---|
| committer |  kim <gruf@noreply.codeberg.org> | 2025-06-10 12:14:46 +0200 |
| commit | 153f6feecd333aec8b78f2a2547c6b6c7db26bec (patch) | |
| tree | 5feebfdd0871f63f851e61badacc64df478142ee | |
| parent | [chore] Upgrade to SQLite 3.50.1 (#4255) (diff) | |
| download | gotosocial-153f6feecd333aec8b78f2a2547c6b6c7db26bec.tar.xz | |
[docs] update `protocol` arg help text to reflect documentation (#4250)
The current documentation states that the `protocol` configuration
option should only be changed to `http` for local testing, and that even
if running behind a reverse proxy, `https` should be used.
https://docs.gotosocial.org/en/latest/configuration/general/
As such, update the `protocol` option help text so that it does not
suggest using `http` when running behind a reverse proxy.
Signed-off-by: Oliver Calder <oliver@calder.dev>
Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4250
Co-authored-by: Oliver Calder <oliver@calder.dev>
Co-committed-by: Oliver Calder <oliver@calder.dev>
| -rw-r--r-- | internal/config/config.go | 2 | ||||
| -rw-r--r-- | internal/config/helpers.gen.go | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/internal/config/config.go b/internal/config/config.go index 1e907e2cb..1892d5bca 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -65,7 +65,7 @@ type Configuration struct { LandingPageUser string `name:"landing-page-user" usage:"the user that should be shown on the instance's landing page"` Host string `name:"host" usage:"Hostname to use for the server (eg., example.org, gotosocial.whatever.com). DO NOT change this on a server that's already run!"` AccountDomain string `name:"account-domain" usage:"Domain to use in account names (eg., example.org, whatever.com). If not set, will default to the setting for host. DO NOT change this on a server that's already run!"` - Protocol string `name:"protocol" usage:"Protocol to use for the REST api of the server (only use http if you are debugging or behind a reverse proxy!)"` + Protocol string `name:"protocol" usage:"Protocol to use for the REST api of the server (only use http if you are debugging; https should be used even if running behind a reverse proxy!)"` BindAddress string `name:"bind-address" 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."` Port int `name:"port" usage:"Port to use for GoToSocial. Change this to 443 if you're running the binary directly on the host machine."` TrustedProxies []string `name:"trusted-proxies" usage:"Proxies to trust when parsing x-forwarded headers into real IPs."` diff --git a/internal/config/helpers.gen.go b/internal/config/helpers.gen.go index cee2c3ad2..d22d05d5e 100644 --- a/internal/config/helpers.gen.go +++ b/internal/config/helpers.gen.go @@ -39,7 +39,7 @@ func (cfg *Configuration) RegisterFlags(flags *pflag.FlagSet) { flags.String("landing-page-user", cfg.LandingPageUser, "the user that should be shown on the instance's landing page") flags.String("host", cfg.Host, "Hostname to use for the server (eg., example.org, gotosocial.whatever.com). DO NOT change this on a server that's already run!") flags.String("account-domain", cfg.AccountDomain, "Domain to use in account names (eg., example.org, whatever.com). If not set, will default to the setting for host. DO NOT change this on a server that's already run!") - flags.String("protocol", cfg.Protocol, "Protocol to use for the REST api of the server (only use http if you are debugging or behind a reverse proxy!)") + flags.String("protocol", cfg.Protocol, "Protocol to use for the REST api of the server (only use http if you are debugging; https should be used even if running behind a reverse proxy!)") flags.String("bind-address", cfg.BindAddress, "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.") flags.Int("port", cfg.Port, "Port to use for GoToSocial. Change this to 443 if you're running the binary directly on the host machine.") flags.StringSlice("trusted-proxies", cfg.TrustedProxies, "Proxies to trust when parsing x-forwarded headers into real IPs.") |