From 69aed310de48ccd80326c7b639d8e179dfd21ba8 Mon Sep 17 00:00:00 2001 From: Snow Date: Sat, 29 May 2021 02:22:33 +0000 Subject: [PATCH 1/3] Adding description --- config/description.exs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/description.exs b/config/description.exs index f00c53d28..1c3e3f900 100644 --- a/config/description.exs +++ b/config/description.exs @@ -682,7 +682,7 @@ %{ key: :allow_relay, type: :boolean, - description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance" + description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance. (Important!) This will increase the visibility of your instance." }, %{ key: :public, From 297feb73f4ea2de59cf3fc8f4beabe18e72a6311 Mon Sep 17 00:00:00 2001 From: Mark Felder Date: Wed, 2 Jun 2021 11:21:04 -0500 Subject: [PATCH 2/3] Formatting --- config/description.exs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/config/description.exs b/config/description.exs index 1c3e3f900..abd802ac0 100644 --- a/config/description.exs +++ b/config/description.exs @@ -682,7 +682,8 @@ %{ key: :allow_relay, type: :boolean, - description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance. (Important!) This will increase the visibility of your instance." + description: + "Enable Pleroma's Relay, which makes it possible to follow a whole instance. (Important!) This will increase the visibility of your instance." }, %{ key: :public, From 679d4c23e93f86f3e3fec70e0ac9bf2c9cdf8819 Mon Sep 17 00:00:00 2001 From: Mark Felder Date: Wed, 2 Jun 2021 11:26:26 -0500 Subject: [PATCH 3/3] Update wording for relays in docs and config description --- config/description.exs | 2 +- docs/configuration/cheatsheet.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/config/description.exs b/config/description.exs index abd802ac0..bdde22f98 100644 --- a/config/description.exs +++ b/config/description.exs @@ -683,7 +683,7 @@ key: :allow_relay, type: :boolean, description: - "Enable Pleroma's Relay, which makes it possible to follow a whole instance. (Important!) This will increase the visibility of your instance." + "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).