git.squeep.com Git - akkoma/blob - CONFIGURATION.md

   1 # Configuring Pleroma
   2
   3 In the `config/` directory, you will find the following relevant files:
   4 * `config.exs`: default base configuration
   5 * `dev.exs`: default additional configuration for `MIX_ENV=dev`
   6 * `prod.exs`: default additional configuration for `MIX_ENV=prod`
   7
   8 Additionally, you can overload options in the following files:
   9 * `dev.secret.exs`: custom additional configuration for `MIX_ENV=dev`
  10 * `prod.secret.exs`: custom additional configuration for `MIX_ENV=prod`
  11
  12 ## Message Rewrite Filters (MRFs)
  13
  14 Modify incoming and outgoing posts.
  15
  16     config :pleroma, :instance,
  17       rewrite_policy: Pleroma.Web.ActivityPub.MRF.NoOpPolicy
  18
  19 `rewrite_policy` specifies which MRF policies to apply. It can either be a single policy or a list of policies.
  20 Currently, MRFs availible by default are:
  21 * `Pleroma.Web.ActivityPub.MRF.NoOpPolicy`
  22 * `Pleroma.Web.ActivityPub.MRF.DropPolicy`
  23 * `Pleroma.Web.ActivityPub.MRF.SimplePolicy`
  24 * `Pleroma.Web.ActivityPub.MRF.RejectNonPublic`
  25
  26 Some policies, such as SimplePolicy and RejectNonPublic, can be additionally configured in their respective sections.
  27
  28 ### NoOpPolicy
  29
  30 Does not modify posts (this is the default `rewrite_policy`)
  31
  32 ### DropPolicy
  33
  34 Drops all posts. It generally does not make sense to use this in production.
  35
  36 ### SimplePolicy
  37
  38 Versatile policy for applying effects to posts from certain instances.
  39
  40     config :pleroma, :mrf_simple,
  41       media_removal: [],
  42       media_nsfw: [],
  43       federated_timeline_removal: [],
  44       reject: []
  45
  46 * `media_removal`: posts from these instances will have attachments removed
  47 * `media_nsfw`: posts from these instances will have attachments marked as nsfw
  48 * `federated_timeline_removal`: posts from these instances will be marked as unlisted
  49 * `reject`: posts from these instances will be dropped
  50
  51 ### RejectNonPublic
  52
  53 Drops posts with non-public visibility settings.
  54
  55     config :pleroma :mrf_rejectnonpublic
  56       allow_followersonly: false,
  57       allow_direct: false,
  58
  59 * `allow_followersonly`: whether to allow follower-only posts through the filter
  60 * `allow_direct`: whether to allow direct messages through the filter