summaryrefslogtreecommitdiff
path: root/docs/configuration
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2021-11-22 10:55:52 +0100
committerLibravatar GitHub <noreply@github.com>2021-11-22 10:55:52 +0100
commit1ded58b34b72c8e6862c5614882fd5a3bb430aaa (patch)
treea57350333cf51100fca3ecb21152626a03e0bed3 /docs/configuration
parentproperly initialize user client module (#319) (diff)
downloadgotosocial-1ded58b34b72c8e6862c5614882fd5a3bb430aaa.tar.xz
add bindAddress configuration option (#320)
* add bindAddress configuration option * clarify that bindAddress can be a hostname
Diffstat (limited to 'docs/configuration')
-rw-r--r--docs/configuration/general.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/configuration/general.md b/docs/configuration/general.md
index 4bb5f76d1..df9eaa4b0 100644
--- a/docs/configuration/general.md
+++ b/docs/configuration/general.md
@@ -1,6 +1,6 @@
# General
-The top-level configuration for GoToSocial, including basic things like host and transport protocol.
+The top-level configuration for GoToSocial, including basic things like host, port, bind address and transport protocol.
The only things you *really* need to set here are `host`, which should be the hostname where your instance is reachable, and probably `port`.
@@ -48,6 +48,15 @@ accountDomain: ""
# Default: "https"
protocol: "https"
+# String. Address to bind the GoToSocial server to.
+# This can be an IPv4 address or an IPv6 address (surrounded in square brackets), or a hostname.
+# 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]"]
+# Default: "0.0.0.0"
+bindAddress: "0.0.0.0"
+
# Int. Listen port for the GoToSocial webserver + API. If you're running behind a reverse proxy and/or in a docker,
# container, just set this to whatever you like (or leave the default), and make sure it's forwarded properly.
# If you are running with built-in letsencrypt enabled, and running GoToSocial directly on a host machine, you will