summaryrefslogtreecommitdiff
path: root/docs/configuration
diff options
context:
space:
mode:
authorLibravatar Rob Sargant <robert@sargant.com>2022-11-14 09:30:01 +0000
committerLibravatar GitHub <noreply@github.com>2022-11-14 10:30:01 +0100
commitd120743e8bee74bbb6381a6ec017d7fa62b3f13e (patch)
tree166ab39f161b77cf6055abcc26de370c932c474f /docs/configuration
parent[chore]: Bump codeberg.org/gruf/go-cache/v3 from 3.1.7 to 3.1.8 (#1043) (diff)
downloadgotosocial-d120743e8bee74bbb6381a6ec017d7fa62b3f13e.tar.xz
[feature] add instance-expose-public-timeline flag (#1039)
* Add instance-expose-public-timeline flag Adds a config flag that allows unauthenticated access to /api/v1/timelines/public. Defaults to false to replicate existing behaviour. * Update structure following review * Add comment * Fix linting
Diffstat (limited to 'docs/configuration')
-rw-r--r--docs/configuration/instance.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/configuration/instance.md b/docs/configuration/instance.md
index 45146f859..7eb3611b1 100644
--- a/docs/configuration/instance.md
+++ b/docs/configuration/instance.md
@@ -24,6 +24,13 @@ instance-expose-peers: false
# Default: false
instance-expose-suspended: false
+# Bool. Allow unauthenticated users to make queries to /api/v1/timelines/public in order
+# to see a list of public posts on this server. Even if set to 'false', then authenticated
+# users (members of the instance) will still be able to query the endpoint.
+# Options: [true, false]
+# Default: false
+instance-expose-public-timeline: false
+
# Bool. This flag tweaks whether GoToSocial will deliver ActivityPub messages
# to the shared inbox of a recipient, if one is available, instead of delivering
# each message to each actor who should receive a message individually.