diff options
author | Alex Gleason <alex@alexgleason.me> | 2020-11-14 19:48:47 -0600 |
---|---|---|
committer | Alex Gleason <alex@alexgleason.me> | 2020-11-14 19:48:47 -0600 |
commit | 9546c1444c2c8c4abc9bcb35b6a8ff360ddc83af (patch) | |
tree | cc6b9add45f34878b1ce053b6a408e059768fa6a /docs/dev.md | |
parent | dc38dc847207e4724265fbeb111d0a236b75f93f (diff) | |
parent | 28da36975dc325bb577ee81fb791fbdc7ec3e7e2 (diff) | |
download | pleroma-9546c1444c2c8c4abc9bcb35b6a8ff360ddc83af.tar.gz |
Merge remote-tracking branch 'upstream/develop' into registration-workflow
Diffstat (limited to 'docs/dev.md')
-rw-r--r-- | docs/dev.md | 23 |
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] + } + ] + } +``` |