Procházet zdrojové kódy

Merge branch 'mrf-config-descriptions' into 'develop'

little changes for MRF config descriptions

See merge request pleroma/pleroma!3131
2298-weird-follow-issue
feld před 3 roky
rodič
revize
911fc3c523
2 změnil soubory, kde provedl 24 přidání a 1 odebrání
  1. +23
    -0
      docs/dev.md
  2. +1
    -1
      lib/pleroma/web/activity_pub/mrf.ex

+ 23
- 0
docs/dev.md Zobrazit soubor

@@ -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]
}
]
}
```

+ 1
- 1
lib/pleroma/web/activity_pub/mrf.ex Zobrazit soubor

@@ -164,7 +164,7 @@ defmodule Pleroma.Web.ActivityPub.MRF do
acc
end
else
Logger.info(
Logger.debug(
"#{policy} is excluded from config descriptions, because does not implement `config_description/0` method."
)



Načítá se…
Zrušit
Uložit