config: document mrf_user_allowlist
authorWilliam Pitcock <nenolod@dereferenced.org>
Mon, 26 Nov 2018 23:54:46 +0000 (23:54 +0000)
committerWilliam Pitcock <nenolod@dereferenced.org>
Mon, 26 Nov 2018 23:54:46 +0000 (23:54 +0000)
config/config.md

index 5b4110646369c9526e052997f9015cb1ff856d0f..c843bca5d87b63c35ba68b696f24d7043563a9d7 100644 (file)
@@ -87,3 +87,16 @@ This section is used to configure Pleroma-FE, unless ``:managed_config`` in ``:i
 * ``sts_max_age``: The maximum age for the `Strict-Transport-Security` header if sent
 * ``ct_max_age``: The maximum age for the `Expect-CT` header if sent
 * ``referrer_policy``: The referrer policy to use, either `"same-origin"` or `"no-referrer"`.
+
+## :mrf_user_allowlist
+
+The keys in this section are the domain names that the policy should apply to.
+Each key should be assigned a list of users that should be allowed through by
+their ActivityPub ID.
+
+An example:
+
+```
+config :pleroma, :mrf_user_allowlist,
+  "example.org": ["https://example.org/users/admin"]
+```