diff options
| author |  tobi <31960611+tsmethurst@users.noreply.github.com> | 2023-09-21 12:12:04 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2023-09-21 12:12:04 +0200 |
| commit | 183eaa5b298235acb8f25ba8f18b98e31471d965 (patch) | |
| tree | 55f42887edeb5206122d92eb30e0eedf145a3615 /docs/configuration/instance.md | |
| parent | [docs] Add a note on cluster support (#2214) (diff) | |
| download | gotosocial-183eaa5b298235acb8f25ba8f18b98e31471d965.tar.xz | |
[feature] Implement explicit domain allows + allowlist federation mode (#2200)
* love like winter! wohoah, wohoah
* domain allow side effects
* tests! logging! unallow!
* document federation modes
* linty linterson
* test
* further adventures in documentation
* finish up domain block documentation (i think)
* change wording a wee little bit
* docs, example
* consolidate shared domainPermission code
* call mode once
* fetch federation mode within domain blocked func
* read domain perm import in streaming manner
* don't use pointer to slice for domain perms
* don't bother copying blocks + allows before deleting
* admonish!
* change wording just a scooch
* update docs
Diffstat (limited to 'docs/configuration/instance.md')
| -rw-r--r-- | docs/configuration/instance.md | 33 |
1 files changed, 30 insertions, 3 deletions
diff --git a/docs/configuration/instance.md b/docs/configuration/instance.md index 66e44e078..61f58c9a3 100644 --- a/docs/configuration/instance.md +++ b/docs/configuration/instance.md @@ -9,6 +9,21 @@ # Config pertaining to instance federation settings, pages to hide/expose, etc. +# String. Federation mode to use for this instance. +# +# "blocklist" -- open federation by default. Only instances that are explicitly +# blocked will be denied (unless they are also explicitly allowed). +# +# "allowlist" -- closed federation by default. Only instances that are explicitly +# allowed will be able to interact with this instance. +# +# For more details on blocklist and allowlist modes, check the documentation at: +# https://docs.gotosocial.org/en/latest/admin/federation_modes +# +# Options: ["blocklist", "allowlist"] +# Default: "blocklist" +instance-federation-mode: "blocklist" + # 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. @@ -17,9 +32,12 @@ 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. +# to see a list of instances that this instance blocks/suspends. Even if set to 'false', then authenticated +# users (members of the instance) will still be able to query the endpoint. +# +# WARNING: Setting this variable to 'true' may result in your instance being scraped by blocklist scrapers. +# See: https://docs.gotosocial.org/en/latest/admin/domain_blocks/#block-announce-bots +# # Options: [true, false] # Default: false instance-expose-suspended: false @@ -49,4 +67,13 @@ instance-expose-public-timeline: false # Options: [true, false] # Default: true instance-deliver-to-shared-inboxes: true + +# Bool. This flag will inject a Mastodon version into the version field that +# is included in /api/v1/instance. This version is often used by Mastodon clients +# to do API feature detection. By injecting a Mastodon compatible version, it is +# possible to cajole those clients to behave correctly with GoToSocial. +# +# Options: [true, false] +# Default: false +instance-inject-mastodon-version: false ``` |