diff options
| author |  tobi <31960611+tsmethurst@users.noreply.github.com> | 2024-10-05 12:09:58 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2024-10-05 12:09:58 +0200 |
| commit | 36abd568b187e54b7ad311179e07533de3eb5933 (patch) | |
| tree | 260d0a4ead70c5490d232215dc3aa6eff1dbd89d /example | |
| parent | [bugfix] Account for nil reply when serializing int req (#3389) (diff) | |
| download | gotosocial-36abd568b187e54b7ad311179e07533de3eb5933.tar.xz | |
[docs] Make `protocol` config option really explicit (#3391)
Diffstat (limited to 'example')
| -rw-r--r-- | example/config.yaml | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/example/config.yaml b/example/config.yaml index c3c53d6f6..d3de40791 100644 --- a/example/config.yaml +++ b/example/config.yaml @@ -88,10 +88,18 @@ host: "localhost" # Default: "" account-domain: "" -# String. Protocol to use for the server. Only change to http for local testing! -# This should be the protocol part of the URI that your server is actually reachable on. So even if you're -# running GoToSocial behind a reverse proxy that handles SSL certificates for you, instead of using built-in -# letsencrypt, it should still be https. +# String. Protocol over which the server is reachable from the outside world. +# +# ONLY CHANGE THIS TO HTTP FOR LOCAL TESTING! IN 99.99% OF CASES YOU SHOULD NOT CHANGE THIS! +# +# This should be the protocol part of the URI that your server is actually reachable on. +# So even if you're running GoToSocial behind a reverse proxy that handles SSL certificates +# for you, instead of using built-in letsencrypt, it should still be https, not http. +# +# Again, ONLY CHANGE THIS TO HTTP FOR LOCAL TESTING! If you set this to `http`, start your instance, +# and then later change it to `https`, you will have already broken URI generation for any created +# users on the instance. You should only touch this setting if you 100% know what you're doing. +# # Options: ["http","https"] # Default: "https" protocol: "https" |