1
0
Fork 0
forked from mirrors/akkoma
akkoma/CONFIGURATION.md
William Pitcock 60d6038be5 mrf simple: add accept lists
accept lists supplement reject lists by requiring that any message accepted by contained
by the accept list.

in other words, this functionality can be used to implement instances similar to
awoo.space.
2018-06-19 21:28:24 +00:00

2.2 KiB

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

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

Message Rewrite Filters (MRFs)

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. 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.

NoOpPolicy

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.

SimplePolicy

Restricts the visibility of posts from certain instances.

config :pleroma, :mrf_simple,
  media_removal: [],
  media_nsfw: [],
  federated_timeline_removal: [],
  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

Drops posts with non-public visibility settings.

config :pleroma :mrf_rejectnonpublic
  allow_followersonly: false,
  allow_direct: false,
  • allow_followersonly: whether to allow follower-only posts through the filter
  • allow_direct: whether to allow direct messages through the filter