Add web push support

[akkoma] / CONFIGURATION.md

diff --git a/CONFIGURATION.md b/CONFIGURATION.md
index ead5cd934aeeaf25a612302a6cd60bb7553e9de1..51a76d1b7afac9af6da2d6b8918e8ce77310bd2f 100644 (file)
--- a/CONFIGURATION.md
+++ b/CONFIGURATION.md
@@ -1,13 +1,49 @@
 # 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:
-* `dev.secret.exs`: additional custom configuration for `MIX_ENV=dev`
-* `prod.secret.exs`: additional custom configuration for `MIX_ENV=prod`
+
+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`
+
+## Uploads configuration
+
+To configure where to upload files, and wether or not 
+you want to remove automatically EXIF data from pictures
+being uploaded.
+
+    config :pleroma, Pleroma.Upload,
+      uploads: "uploads",
+      strip_exif: false
+
+* `uploads`: where to put the uploaded files, relative to pleroma's main directory.
+* `strip_exif`: whether or not to remove EXIF data from uploaded pics automatically. 
+   This needs Imagemagick installed on the system ( apt install imagemagick ).
+
+
+## Block functionality
+
+    config :pleroma, :activitypub,
+      accept_blocks: true,
+      unfollow_blocked: true,
+      outgoing_blocks: true
+
+    config :pleroma, :user, deny_follow_blocked: true
+
+* `accept_blocks`: whether to accept incoming block activities from
+   other instances
+* `unfollow_blocked`: whether blocks result in people getting
+   unfollowed
+* `outgoing_blocks`: whether to federate blocks to other instances
+* `deny_follow_blocked`: whether to disallow following an account that
+   has blocked the user in question
 
 ## Message Rewrite Filters (MRFs)
 
@@ -16,14 +52,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,22 +70,28 @@ 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
 
-Versatile policy for applying effects to posts from certain instances.
+Restricts the visibility of posts from certain instances.
 
     config :pleroma, :mrf_simple,
       media_removal: [],
       media_nsfw: [],
       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
+      reject: [],
+      accept: []
+
+* `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
+* `accept`: if not empty, only posts from these instances will be accepted
 
 ### RejectNonPublic
 
@@ -56,5 +101,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