Merge branch 'bugfix/block-follow-relationships' into 'develop'

[akkoma] / CONFIGURATION.md

diff --git a/CONFIGURATION.md b/CONFIGURATION.md
index 5d0a9a8842567537c411552fa3f7c34a5c5c7ec0..4174dd114500a72837aa9639d1671962214337b1 100644 (file)
--- a/CONFIGURATION.md
+++ b/CONFIGURATION.md
@@ -1,11 +1,15 @@
 # Configuring Pleroma
 
 In the `config/` directory, you will find the following relevant files:
+
 * `config.exs`: default base configuration
 * `dev.exs`: default additional configuration for `MIX_ENV=dev`
 * `prod.exs`: default additional configuration for `MIX_ENV=prod`
 
-Additionally, you can overload options in the following files:
+
+Do not modify files in the list above.
+Instead, overload the settings by editing the following files:
+
 * `dev.secret.exs`: custom additional configuration for `MIX_ENV=dev`
 * `prod.secret.exs`: custom additional configuration for `MIX_ENV=prod`
 
@@ -16,14 +20,17 @@ Modify incoming and outgoing posts.
     config :pleroma, :instance,
       rewrite_policy: Pleroma.Web.ActivityPub.MRF.NoOpPolicy
 
-`rewrite_policy` specifies which MRF policies to apply. It can either be a single policy or a list of policies.
+`rewrite_policy` specifies which MRF policies to apply.
+It can either be a single policy or a list of policies.
 Currently, MRFs availible by default are:
+
 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`
 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`
 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`
 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`
 
-Some policies, such as SimplePolicy and RejectNonPublic, can be additionally configured in their respective sections.
+Some policies, such as SimplePolicy and RejectNonPublic,
+can be additionally configured in their respective sections.
 
 ### NoOpPolicy
 
@@ -31,7 +38,8 @@ Does not modify posts (this is the default `rewrite_policy`)
 
 ### DropPolicy
 
-Drops all posts. It generally does not make sense to use this in production.
+Drops all posts.
+It generally does not make sense to use this in production.
 
 ### SimplePolicy
 
@@ -43,9 +51,12 @@ Restricts the visibility of posts from certain instances.
       federated_timeline_removal: [],
       reject: []
 
-* `media_removal`: posts from these instances will have attachments removed
-* `media_nsfw`: posts from these instances will have attachments marked as nsfw
-* `federated_timeline_removal`: posts from these instances will be marked as unlisted
+* `media_removal`: posts from these instances will have attachments 
+   removed
+* `media_nsfw`: posts from these instances will have attachments marked
+   as nsfw
+* `federated_timeline_removal`: posts from these instances will be 
+   marked as unlisted
 * `reject`: posts from these instances will be dropped
 
 ### RejectNonPublic
@@ -56,5 +67,6 @@ Drops posts with non-public visibility settings.
       allow_followersonly: false,
       allow_direct: false,
 
-* `allow_followersonly`: whether to allow follower-only posts through the filter
+* `allow_followersonly`: whether to allow follower-only posts through
+   the filter
 * `allow_direct`: whether to allow direct messages through the filter