summaryrefslogtreecommitdiff
path: root/docs/dev.md
diff options
context:
space:
mode:
authorIvan Tashkinov <ivantashkinov@gmail.com>2020-11-21 19:47:46 +0300
committerIvan Tashkinov <ivantashkinov@gmail.com>2020-11-21 19:47:46 +0300
commit489b12cde48d0ed6b16914c5a831b1e992d0d059 (patch)
tree2928b5b9111339f16a5642c4ec07c82851c4f7ed /docs/dev.md
parentccc2cf0e87f47618163da588ead76846c64cba7a (diff)
parentecd1ef8cb5afa16dba5158e9e278a18c0856ca3e (diff)
downloadpleroma-489b12cde48d0ed6b16914c5a831b1e992d0d059.tar.gz
pleroma-489b12cde48d0ed6b16914c5a831b1e992d0d059.zip
Merge remote-tracking branch 'remotes/origin/develop' into auth-improvements
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 ba2718673..765380a58 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]
+ }
+ ]
+ }
+```