summaryrefslogtreecommitdiff
path: root/docs/configuration/instance.md
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2022-06-23 16:54:54 +0200
committerLibravatar GitHub <noreply@github.com>2022-06-23 16:54:54 +0200
commit5f00d4980bdc55bce8d23e38392b345d525dbf4a (patch)
tree5300f3bbe38d7fcbf5ba07eda2c8c2142c573040 /docs/configuration/instance.md
parent[bugfix] Don't remove jpeg orientation metadata (#663) (diff)
downloadgotosocial-5f00d4980bdc55bce8d23e38392b345d525dbf4a.tar.xz
[feature] Implement `/api/v1/instance/peers` endpoint (#660)
* add missing license headers * start adding instance peers get * rename domainblock.go * embed domain in domainblock so it can be reused * update swagger docs * add test instances to db * update tests * add/update instancepeersget * update domain model * add getinstancepeers to db * instance-expose-peers, instance-expose-suspended * add auth checks for both current filters * attach endpoint to router * include public comment * obfuscate domain if required * go mod tidy * update swagger docs * remove unnecessary comment * return 'flat' peerlist if no query params provided
Diffstat (limited to 'docs/configuration/instance.md')
-rw-r--r--docs/configuration/instance.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/configuration/instance.md b/docs/configuration/instance.md
new file mode 100644
index 000000000..2451b9903
--- /dev/null
+++ b/docs/configuration/instance.md
@@ -0,0 +1,26 @@
+# Instance
+
+## Settings
+
+```yaml
+###########################
+##### INSTANCE CONFIG #####
+###########################
+
+# Config pertaining to instance federation settings, pages to hide/expose, etc.
+
+# Bool. Allow unauthenticated users to make queries to /api/v1/instance/peers?filter=open in order
+# to see a list of instances that this instance 'peers' with. 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-peers: false
+
+# Bool. Allow unauthenticated users to make queries to /api/v1/instance/peers?filter=suspended in order
+# to see a list of instances that this instance blocks/suspends. This will also allow unauthenticated
+# users to see the list through the web UI. 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-suspended: false
+```