aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfeld <feld@feld.me>2021-06-02 16:53:37 +0000
committerfeld <feld@feld.me>2021-06-02 16:53:37 +0000
commit275af2930209c503c615f0ebaff9447d77cc7ef6 (patch)
treeb6becb224efdda927ae95c557de707d70131c7ba
parente8de1005f2318bef651a50630cb130f65dad8d06 (diff)
parent679d4c23e93f86f3e3fec70e0ac9bf2c9cdf8819 (diff)
downloadpleroma-275af2930209c503c615f0ebaff9447d77cc7ef6.tar.gz
Merge branch 'Snow-develop-patch-01683' into 'develop'
Update docs/description for allow_relay See merge request pleroma/pleroma!3438
-rw-r--r--config/description.exs3
-rw-r--r--docs/configuration/cheatsheet.md2
2 files changed, 3 insertions, 2 deletions
diff --git a/config/description.exs b/config/description.exs
index f00c53d28..bdde22f98 100644
--- a/config/description.exs
+++ b/config/description.exs
@@ -682,7 +682,8 @@ config :pleroma, :config_description, [
%{
key: :allow_relay,
type: :boolean,
- description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
+ description:
+ "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
},
%{
key: :public,
diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md
index 069421722..366c60c73 100644
--- a/docs/configuration/cheatsheet.md
+++ b/docs/configuration/cheatsheet.md
@@ -37,7 +37,7 @@ To add configuration to your config file, you can copy it from the base config.
* `federating`: Enable federation with other instances.
* `federation_incoming_replies_max_depth`: Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.
* `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.
-* `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance.
+* `allow_relay`: Permits remote instances to subscribe to all public posts of your instance. This may increase the visibility of your instance.
* `public`: Makes the client API in authenticated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network. Note that there is a dependent setting restricting or allowing unauthenticated access to specific resources, see `restrict_unauthenticated` for more details.
* `quarantined_instances`: List of ActivityPub instances where private (DMs, followers-only) activities will not be send.
* `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML).