diff options
author | Egor Kislitsyn <egor@kislitsyn.com> | 2020-11-17 18:34:04 +0400 |
---|---|---|
committer | Egor Kislitsyn <egor@kislitsyn.com> | 2020-11-17 18:34:04 +0400 |
commit | f69fe36ebfdb6fad4af853f002705f5ea3c697a1 (patch) | |
tree | 29f21b7c20369f23f444438e2b0c3fe2bf398a58 /docs/dev.md | |
parent | 81145ecdf52c74147c842ab6c099abf5e1ad1eff (diff) | |
parent | 61f86774d183b8ba130551999ea498e5f5c71681 (diff) | |
download | pleroma-f69fe36ebfdb6fad4af853f002705f5ea3c697a1.tar.gz |
Merge branch 'develop' into frontend-admin-api
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] + } + ] + } +``` |