gtsocial-umbx

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

instance.md (2099B)


      1 # Instance
      2 
      3 ## Settings
      4 
      5 ```yaml
      6 ###########################
      7 ##### INSTANCE CONFIG #####
      8 ###########################
      9 
     10 # Config pertaining to instance federation settings, pages to hide/expose, etc.
     11 
     12 # Bool. Allow unauthenticated users to make queries to /api/v1/instance/peers?filter=open in order
     13 # to see a list of instances that this instance 'peers' with. Even if set to 'false', then authenticated
     14 # users (members of the instance) will still be able to query the endpoint.
     15 # Options: [true, false]
     16 # Default: false
     17 instance-expose-peers: false
     18 
     19 # Bool. Allow unauthenticated users to make queries to /api/v1/instance/peers?filter=suspended in order
     20 # to see a list of instances that this instance blocks/suspends. This will also allow unauthenticated
     21 # users to see the list through the web UI. Even if set to 'false', then authenticated users (members
     22 # of the instance) will still be able to query the endpoint.
     23 # Options: [true, false]
     24 # Default: false
     25 instance-expose-suspended: false
     26 
     27 # Bool. Allow unauthenticated users to view /about/suspended,
     28 # showing the HTML rendered list of instances that this instance blocks/suspends.
     29 # Options: [true, false]
     30 # Default: false
     31 instance-expose-suspended-web: false
     32 
     33 # Bool. Allow unauthenticated users to make queries to /api/v1/timelines/public in order
     34 # to see a list of public posts on this server. Even if set to 'false', then authenticated
     35 # users (members of the instance) will still be able to query the endpoint.
     36 # Options: [true, false]
     37 # Default: false
     38 instance-expose-public-timeline: false
     39 
     40 # Bool. This flag tweaks whether GoToSocial will deliver ActivityPub messages
     41 # to the shared inbox of a recipient, if one is available, instead of delivering
     42 # each message to each actor who should receive a message individually.
     43 #
     44 # Shared inbox delivery can significantly reduce network load when delivering
     45 # to multiple recipients share an inbox (eg., on large Mastodon instances).
     46 #
     47 # See: https://www.w3.org/TR/activitypub/#shared-inbox-delivery
     48 #
     49 # Options: [true, false]
     50 # Default: true
     51 instance-deliver-to-shared-inboxes: true
     52 ```