Add web push support
[akkoma] / CONFIGURATION.md
index 0b5dd54198f84dc483d9c0c08b94c2e2ebaeaf13..51a76d1b7afac9af6da2d6b8918e8ce77310bd2f 100644 (file)
@@ -1,6 +1,7 @@
 # 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`
@@ -8,9 +9,42 @@ In the `config/` directory, you will find the following relevant 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`
 
+## 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)
 
 Modify incoming and outgoing posts.
@@ -21,6 +55,7 @@ Modify incoming and outgoing posts.
 `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`
@@ -46,7 +81,8 @@ Restricts the visibility of posts from certain instances.
       media_removal: [],
       media_nsfw: [],
       federated_timeline_removal: [],
-      reject: []
+      reject: [],
+      accept: []
 
 * `media_removal`: posts from these instances will have attachments 
    removed
@@ -55,6 +91,7 @@ Restricts the visibility of posts from certain instances.
 * `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