summaryrefslogtreecommitdiff
path: root/docs/dev.md
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2020-11-17 15:01:38 +0100
committerlain <lain@soykaf.club>2020-11-17 15:01:38 +0100
commitfec1ed802ef44a700df27aa132146f79e9e4cd6d (patch)
tree6bbb39b647305521209bebbd7bdea3e4be012d1c /docs/dev.md
parent81293e5aadd5f1dfe7f90f6a71f625ef86cf3359 (diff)
parent9b9afe6b3fde77ef005629fe2d198160c8f465a1 (diff)
downloadpleroma-fec1ed802ef44a700df27aa132146f79e9e4cd6d.tar.gz
pleroma-fec1ed802ef44a700df27aa132146f79e9e4cd6d.zip
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into feature/local-only-scope
Diffstat (limited to 'docs/dev.md')
-rw-r--r--docs/dev.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/dev.md b/docs/dev.md
index 22e0691f1..aa89a941f 100644
--- a/docs/dev.md
+++ b/docs/dev.md
@@ -21,3 +21,26 @@ This document contains notes and guidelines for Pleroma developers.
## Auth-related configuration, OAuth consumer mode etc.
See `Authentication` section of [the configuration cheatsheet](configuration/cheatsheet.md#authentication).
+
+## MRF policies descriptions
+
+If MRF policy depends on config, it can be added into MRF tab to adminFE by adding `config_description/0` method, which returns map with special structure.
+
+Example:
+
+```elixir
+%{
+ key: :mrf_activity_expiration,
+ related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
+ label: "MRF Activity Expiration Policy",
+ description: "Adds automatic expiration to all local activities",
+ children: [
+ %{
+ key: :days,
+ type: :integer,
+ description: "Default global expiration time for all local activities (in days)",
+ suggestions: [90, 365]
+ }
+ ]
+ }
+```