2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
26 suggestions: [Pleroma.Uploaders.Local, Pleroma.Uploaders.S3]
30 type: {:list, :module},
31 description: "List of filter modules for uploads",
33 Generator.list_modules_in_dir(
34 "lib/pleroma/upload/filter",
35 "Elixir.Pleroma.Upload.Filter."
42 "If enabled, a name parameter will be added to the url of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
47 description: "Base url for the uploads, needed if you use CDN",
49 "https://cdn-host.com"
56 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
61 description: "Options for Pleroma.ReverseProxy",
63 redirect_on_failure: false,
64 max_body_length: 25 * 1_048_576,
66 follow_redirect: true,
72 key: :redirect_on_failure,
75 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
76 "Any error during body processing will not be redirected as the response is chunked."
79 key: :max_body_length,
82 "Limits the content length to be approximately the " <>
83 "specified length. It is validated with the `content-length` header and also verified when proxying."
88 description: "HTTP options",
93 description: "Adapter specific options",
99 description: "SSL options for HTTP adapter",
103 type: {:list, :atom},
104 description: "List of TLS version to use",
105 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
114 type: [:string, :tuple],
115 description: "Proxy URL",
116 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
126 key: Pleroma.Uploaders.Local,
128 description: "Local uploader-related settings",
133 description: "Path where user's uploads will be saved",
142 key: Pleroma.Uploaders.S3,
144 description: "S3 uploader-related settings",
149 description: "S3 bucket",
155 key: :bucket_namespace,
157 description: "S3 bucket namespace",
158 suggestions: ["pleroma"]
161 key: :public_endpoint,
163 description: "S3 endpoint",
164 suggestions: ["https://s3.amazonaws.com"]
167 key: :truncated_namespace,
170 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
171 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
174 key: :streaming_enabled,
177 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
183 key: Pleroma.Upload.Filter.Mogrify,
185 description: "Uploads mogrify filter settings",
189 type: [:string, {:list, :string}, {:list, :tuple}],
190 description: "List of actions for the mogrify command",
201 key: Pleroma.Upload.Filter.AnonymizeFilename,
203 description: "Filter replaces the filename of the upload",
209 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
210 " filename extension by using {extension}, for example custom-file-name.{extension}.",
212 "custom-file-name.{extension}"
219 key: Pleroma.Emails.Mailer,
221 description: "Mailer-related settings",
227 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
228 " or Swoosh.Adapters.Local for in-memory mailbox",
230 Swoosh.Adapters.SMTP,
231 Swoosh.Adapters.Sendgrid,
232 Swoosh.Adapters.Sendmail,
233 Swoosh.Adapters.Mandrill,
234 Swoosh.Adapters.Mailgun,
235 Swoosh.Adapters.Mailjet,
236 Swoosh.Adapters.Postmark,
237 Swoosh.Adapters.SparkPost,
238 Swoosh.Adapters.AmazonSES,
240 Swoosh.Adapters.SocketLabs,
241 Swoosh.Adapters.Gmail,
242 Swoosh.Adapters.Local
248 description: "Allow/disallow send emails"
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
255 suggestions: ["smtp.gmail.com"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
262 suggestions: ["pleroma"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
283 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
284 suggestions: [:always, :never, :if_available]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
291 suggestions: [:always, :never, :if_available]
294 group: {:subgroup, Swoosh.Adapters.SMTP},
297 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
301 group: {:subgroup, Swoosh.Adapters.SMTP},
304 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
308 group: {:subgroup, Swoosh.Adapters.SMTP},
310 label: "No MX lookups",
312 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
315 group: {:subgroup, Swoosh.Adapters.Sendgrid},
319 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
320 suggestions: ["my-api-key"]
323 group: {:subgroup, Swoosh.Adapters.Sendmail},
326 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
327 suggestions: ["/usr/bin/sendmail"]
330 group: {:subgroup, Swoosh.Adapters.Sendmail},
333 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
334 suggestions: ["-N delay,failure,success"]
337 group: {:subgroup, Swoosh.Adapters.Sendmail},
340 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
343 group: {:subgroup, Swoosh.Adapters.Mandrill},
347 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
348 suggestions: ["my-api-key"]
351 group: {:subgroup, Swoosh.Adapters.Mailgun},
355 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
356 suggestions: ["my-api-key"]
359 group: {:subgroup, Swoosh.Adapters.Mailgun},
362 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
363 suggestions: ["pleroma.com"]
366 group: {:subgroup, Swoosh.Adapters.Mailjet},
370 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
371 suggestions: ["my-api-key"]
374 group: {:subgroup, Swoosh.Adapters.Mailjet},
377 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
378 suggestions: ["my-secret-key"]
381 group: {:subgroup, Swoosh.Adapters.Postmark},
385 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
386 suggestions: ["my-api-key"]
389 group: {:subgroup, Swoosh.Adapters.SparkPost},
393 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
394 suggestions: ["my-api-key"]
397 group: {:subgroup, Swoosh.Adapters.SparkPost},
400 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
401 suggestions: ["https://api.sparkpost.com/api/v1"]
404 group: {:subgroup, Swoosh.Adapters.AmazonSES},
407 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
408 suggestions: ["us-east-1", "us-east-2"]
411 group: {:subgroup, Swoosh.Adapters.AmazonSES},
414 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
415 suggestions: ["aws-access-key"]
418 group: {:subgroup, Swoosh.Adapters.AmazonSES},
421 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
422 suggestions: ["aws-secret-key"]
425 group: {:subgroup, Swoosh.Adapters.Dyn},
429 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
430 suggestions: ["my-api-key"]
433 group: {:subgroup, Swoosh.Adapters.SocketLabs},
436 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
439 group: {:subgroup, Swoosh.Adapters.SocketLabs},
443 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
446 group: {:subgroup, Swoosh.Adapters.Gmail},
449 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
456 description: "`Swoosh.Adapters.Local` adapter specific settings",
459 group: {:subgroup, Swoosh.Adapters.Local},
462 description: "Run the preview server together as part of your app"
465 group: {:subgroup, Swoosh.Adapters.Local},
468 description: "The preview server port",
477 description: "URI schemes related settings",
481 type: {:list, :string},
482 description: "List of the scheme part that is considered valid to be an URL",
506 description: "Instance-related settings",
511 description: "Name of the instance",
518 label: "Admin Email Address",
520 description: "Email used to reach an Administrator/Moderator of the instance",
527 label: "Sender Email Address",
529 description: "Envelope FROM address for mail sent via Pleroma",
537 description: "The instance's description, can be seen in nodeinfo and /api/v1/instance",
545 description: "Posts character limit (CW/Subject included in the counter)",
553 description: "Character limit of the instance chat messages",
561 description: "Hard character limit beyond which remote posts will be dropped",
569 description: "File size limit of uploads (except for avatar, background, banner)",
575 key: :avatar_upload_limit,
577 description: "File size limit of user's profile avatars",
583 key: :background_upload_limit,
585 description: "File size limit of user's profile backgrounds",
591 key: :banner_upload_limit,
593 description: "File size limit of user's profile banners",
601 description: "A map with poll limits for local polls",
605 max_option_chars: 200,
607 max_expiration: 31_536_000
614 description: "Maximum number of options",
618 key: :max_option_chars,
620 description: "Maximum number of characters per option",
624 key: :min_expiration,
626 description: "Minimum expiration time (in seconds)",
630 key: :max_expiration,
632 description: "Maximum expiration time (in seconds)",
638 key: :registrations_open,
640 description: "Enable registrations for anyone. Invitations require this setting to be disabled."
643 key: :invites_enabled,
645 description: "Enable user invitations for admins (depends on `registrations_open` being disabled)."
648 key: :account_activation_required,
650 description: "Require users to confirm their emails before signing in."
655 description: "Enable federation with other instances."
658 key: :federation_incoming_replies_max_depth,
659 label: "Fed. incoming replies max depth",
662 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
663 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
669 key: :federation_reachability_timeout_days,
670 label: "Fed. reachability timeout days",
673 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
679 key: :federation_publisher_modules,
680 type: {:list, :module},
681 description: "List of modules for federation publishing",
683 Pleroma.Web.ActivityPub.Publisher
689 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
692 key: :rewrite_policy,
693 type: [:module, {:list, :module}],
694 description: "A list of MRF policies enabled",
696 Generator.list_modules_in_dir(
697 "lib/pleroma/web/activity_pub/mrf",
698 "Elixir.Pleroma.Web.ActivityPub.MRF."
705 "Makes the client API in authentificated mode-only except for user-profiles." <>
706 " Useful for disabling the Local Timeline and The Whole Known Network."
709 key: :quarantined_instances,
710 type: {:list, :string},
712 "List of ActivityPub instances where private (DMs, followers-only) activities will not be send",
719 key: :managed_config,
722 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
727 description: "Instance static directory",
733 key: :allowed_post_formats,
734 type: {:list, :string},
735 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
744 key: :mrf_transparency,
745 label: "MRF transparency",
748 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
751 key: :mrf_transparency_exclusions,
752 label: "MRF transparency exclusions",
753 type: {:list, :string},
755 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
761 key: :extended_nickname_format,
764 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
765 " This will break federation with older software for theses nicknames."
768 key: :cleanup_attachments,
771 "Enable to remove associated attachments when status is removed.
772 This will not affect duplicates and attachments without status.
773 Enabling this will increase load to database when deleting statuses on larger instances.
777 key: :max_pinned_statuses,
779 description: "The maximum number of pinned statuses. 0 will disable the feature.",
787 key: :autofollowed_nicknames,
788 type: {:list, :string},
790 "Set to nicknames of (local) users that every new user should automatically follow",
799 key: :no_attachment_links,
802 "Enable to disable automatically adding attachment link text to statuses"
805 key: :welcome_message,
808 "A message that will be sent to a newly registered users as a direct message",
810 "Hi, @username! Welcome on board!"
814 key: :welcome_user_nickname,
816 description: "The nickname of the local user that sends the welcome message",
822 key: :max_report_comment_size,
824 description: "The maximum size of the report comment. Default: 1000.",
830 key: :safe_dm_mentions,
833 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
834 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
840 description: "If enabled, system data will be shown on /api/pleroma/healthcheck"
843 key: :remote_post_retention_days,
846 "The default amount of days to retain remote posts when pruning the database",
852 key: :user_bio_length,
854 description: "A user bio maximum length. Default: 5000.",
860 key: :user_name_length,
862 description: "A user name maximum length. Default: 100.",
868 key: :skip_thread_containment,
870 description: "Skip filtering out broken threads. Default: enabled"
873 key: :limit_to_local_content,
874 type: {:dropdown, :atom},
876 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
884 key: :max_account_fields,
886 description: "The maximum number of custom fields in the user profile. Default: 10.",
892 key: :max_remote_account_fields,
895 "The maximum number of custom fields in the remote user profile. Default: 20.",
901 key: :account_field_name_length,
903 description: "An account field name maximum length. Default: 512.",
909 key: :account_field_value_length,
911 description: "An account field value maximum length. Default: 2048.",
917 key: :external_user_synchronization,
919 description: "Enabling following/followers counters synchronization for external users"
926 description: "Logger-related settings",
930 type: [:atom, :tuple, :module],
932 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
933 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
941 description: "ExSyslogger-related settings",
945 type: {:dropdown, :atom},
946 description: "Log level",
947 suggestions: [:debug, :info, :warn, :error]
953 "A string that's prepended to every message, and is typically set to the app name",
954 suggestions: ["pleroma"]
959 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
960 suggestions: ["$metadata[$level] $message"]
964 type: {:list, :atom},
965 suggestions: [:request_id]
973 description: "Console logger settings",
977 type: {:dropdown, :atom},
978 description: "Log level",
979 suggestions: [:debug, :info, :warn, :error]
984 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
985 suggestions: ["$metadata[$level] $message"]
989 type: {:list, :atom},
990 suggestions: [:request_id]
997 description: "Quack-related settings",
1001 type: {:dropdown, :atom},
1002 description: "Log level",
1003 suggestions: [:debug, :info, :warn, :error]
1007 type: {:list, :atom},
1008 description: "Configure which metadata you want to report on",
1026 description: "Configure the Slack incoming webhook",
1027 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1033 key: :frontend_configurations,
1036 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1037 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1038 "add your own configuration your settings all fields must be complete.",
1042 label: "Pleroma FE",
1044 description: "Settings for Pleroma FE",
1047 theme: "pleroma-dark",
1048 logo: "/static/logo.png",
1049 background: "/images/city.jpg",
1050 redirectRootNoLogin: "/main/all",
1051 redirectRootLogin: "/main/friends",
1052 showInstanceSpecificPanel: true,
1053 scopeOptionsEnabled: false,
1054 formattingOptionsEnabled: false,
1055 collapseMessageWithSubject: false,
1056 hidePostStats: false,
1057 hideUserStats: false,
1059 subjectLineBehavior: "email",
1060 alwaysShowSubjectInput: true,
1064 enableEmojiPicker: false
1071 description: "Which theme to use, they are defined in styles.json",
1072 suggestions: ["pleroma-dark"]
1077 description: "URL of the logo, defaults to Pleroma's logo",
1078 suggestions: ["/static/logo.png"]
1084 "URL of the background, unless viewing a user profile with a background that is set",
1085 suggestions: ["/images/city.jpg"]
1088 key: :redirectRootNoLogin,
1089 label: "Redirect root no login",
1092 "Relative URL which indicates where to redirect when a user isn't logged in",
1093 suggestions: ["/main/all"]
1096 key: :redirectRootLogin,
1097 label: "Redirect root login",
1100 "Relative URL which indicates where to redirect when a user is logged in",
1101 suggestions: ["/main/friends"]
1104 key: :showInstanceSpecificPanel,
1105 label: "Show instance specific panel",
1107 description: "Whenether to show the instance's specific panel"
1110 key: :scopeOptionsEnabled,
1111 label: "Scope options enabled",
1113 description: "Enable setting a notice visibility and subject/CW when posting"
1116 key: :formattingOptionsEnabled,
1117 label: "Formatting options enabled",
1120 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1123 key: :collapseMessageWithSubject,
1124 label: "Collapse message with subject",
1127 "When a message has a subject (aka Content Warning), collapse it by default"
1130 key: :hidePostStats,
1131 label: "Hide post stats",
1133 description: "Hide notices statistics (repeats, favorites, ...)"
1136 key: :hideUserStats,
1137 label: "Hide user stats",
1140 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1144 label: "Scope copy",
1146 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1149 key: :subjectLineBehavior,
1150 label: "Subject line behavior",
1152 description: "Allows changing the default behaviour of subject lines in replies.
1153 `email`: copy and preprend re:, as in email,
1154 `masto`: copy verbatim, as in Mastodon,
1155 `noop`: don't copy the subject.",
1156 suggestions: ["email", "masto", "noop"]
1159 key: :alwaysShowSubjectInput,
1160 label: "Always show subject input",
1162 description: "When disabled, auto-hide the subject field if it's empty"
1169 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1170 "If you want a colorful logo you just disable logoMask."
1174 label: "Logo margin",
1177 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1178 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1179 suggestions: [".1em"]
1184 description: "Enables stickers."
1187 key: :enableEmojiPicker,
1188 label: "Emoji picker",
1190 description: "Enables emoji picker."
1198 description: "Settings for Masto FE",
1201 showInstanceSpecificPanel: true
1206 key: :showInstanceSpecificPanel,
1207 label: "Show instance specific panel",
1209 description: "Whenether to show the instance's specific panel"
1220 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1224 type: {:keyword, :map},
1226 "Keyword of mascots, each element must contain both an url and a mime_type key",
1229 url: "/images/pleroma-fox-tan-smol.png",
1230 mime_type: "image/png"
1232 pleroma_fox_tan_shy: %{
1233 url: "/images/pleroma-fox-tan-shy.png",
1234 mime_type: "image/png"
1239 key: :default_mascot,
1242 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1254 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1258 type: {:list, :map},
1259 description: "Describe the icons of the app",
1262 src: "/static/logo.png"
1265 src: "/static/icon.png",
1269 src: "/static/icon.ico",
1270 sizes: "72x72 96x96 128x128 256x256"
1277 description: "Describe the theme color of the app",
1278 suggestions: ["#282c37", "mediumpurple"]
1281 key: :background_color,
1283 description: "Describe the background color of the app",
1284 suggestions: ["#191b22", "aliceblue"]
1291 label: "MRF simple",
1293 description: "Message Rewrite Facility",
1296 key: :media_removal,
1297 type: {:list, :string},
1298 description: "List of instances to remove medias from",
1299 suggestions: ["example.com", "*.example.com"]
1303 label: "Media NSFW",
1304 type: {:list, :string},
1305 description: "List of instances to put medias as NSFW (sensitive) from",
1306 suggestions: ["example.com", "*.example.com"]
1309 key: :federated_timeline_removal,
1310 type: {:list, :string},
1312 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1313 suggestions: ["example.com", "*.example.com"]
1317 type: {:list, :string},
1318 description: "List of instances to reject any activities from",
1319 suggestions: ["example.com", "*.example.com"]
1323 type: {:list, :string},
1324 description: "List of instances to accept any activities from",
1325 suggestions: ["example.com", "*.example.com"]
1328 key: :report_removal,
1329 type: {:list, :string},
1330 description: "List of instances to reject reports from",
1331 suggestions: ["example.com", "*.example.com"]
1334 key: :avatar_removal,
1335 type: {:list, :string},
1336 description: "List of instances to strip avatars from",
1337 suggestions: ["example.com", "*.example.com"]
1340 key: :banner_removal,
1341 type: {:list, :string},
1342 description: "List of instances to strip banners from",
1343 suggestions: ["example.com", "*.example.com"]
1350 label: "MRF subchain",
1353 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1354 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1359 description: "Matches a series of regular expressions against the actor field",
1362 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1370 key: :mrf_rejectnonpublic,
1372 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1373 label: "MRF reject non public",
1377 key: :allow_followersonly,
1378 label: "Allow followers-only",
1380 description: "Whether to allow followers-only posts"
1385 description: "Whether to allow direct messages"
1391 key: :mrf_hellthread,
1392 label: "MRF hellthread",
1394 description: "Block messages with too much mentions",
1397 key: :delist_threshold,
1400 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1401 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1405 key: :reject_threshold,
1408 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1416 label: "MRF keyword",
1418 description: "Reject or Word-Replace messages with a keyword or regex",
1422 type: [:string, :regex],
1424 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression.",
1425 suggestions: ["foo", ~r/foo/iu]
1428 key: :federated_timeline_removal,
1429 type: [:string, :regex],
1431 "A list of patterns which result in message being removed from federated timelines (a.k.a unlisted), each pattern can be a string or a regular expression.",
1432 suggestions: ["foo", ~r/foo/iu]
1436 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1438 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1439 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1446 label: "MRF mention",
1448 description: "Block messages which mention a user",
1452 type: {:list, :string},
1453 description: "A list of actors, for which to drop any posts mentioning",
1454 suggestions: ["actor1", "actor2"]
1460 key: :mrf_vocabulary,
1461 label: "MRF vocabulary",
1463 description: "Filter messages which belong to certain activity vocabularies",
1467 type: {:list, :string},
1469 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1470 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1474 type: {:list, :string},
1476 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1477 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1483 # key: :mrf_user_allowlist,
1486 # "The keys in this section are the domain names that the policy should apply to." <>
1487 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1489 # ["example.org": ["https://example.org/users/admin"]],
1491 # ["example.org": ["https://example.org/users/admin"]]
1499 description: "Media proxy",
1504 description: "Enables proxying of remote media to the instance's proxy"
1510 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1511 suggestions: ["https://example.com"]
1516 description: "Options for Pleroma.ReverseProxy",
1518 redirect_on_failure: false,
1519 max_body_length: 25 * 1_048_576,
1521 follow_redirect: true,
1527 key: :redirect_on_failure,
1530 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1531 "Any error during body processing will not be redirected as the response is chunked."
1534 key: :max_body_length,
1537 "Limits the content length to be approximately the " <>
1538 "specified length. It is validated with the `content-length` header and also verified when proxying."
1543 description: "HTTP options",
1548 description: "Adapter specific options",
1553 label: "SSL Options",
1554 description: "SSL options for HTTP adapter",
1558 type: {:list, :atom},
1559 description: "List of TLS version to use",
1560 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1569 type: [:string, :tuple],
1570 description: "Proxy URL",
1571 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1579 type: {:list, :string},
1580 description: "List of domains to bypass the mediaproxy",
1581 suggestions: ["example.com"]
1589 description: "Gopher settings",
1594 description: "Enables the gopher interface"
1599 description: "IP address to bind to",
1600 suggestions: [{0, 0, 0, 0}]
1605 description: "Port to bind to",
1611 description: "Port advertised in urls (optional, defaults to port)",
1618 key: Pleroma.Web.Endpoint,
1620 description: "Phoenix endpoint configuration",
1625 type: {:keyword, :integer, :tuple},
1626 description: "http protocol configuration",
1634 type: {:list, :tuple},
1635 description: "dispatch settings",
1639 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1640 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1641 {Phoenix.Transports.WebSocket,
1642 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1643 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1645 # end copied from config.exs
1660 description: "port",
1670 type: {:keyword, :string, :integer},
1671 description: "configuration for generating urls",
1673 host: "example.com",
1681 description: "Host",
1689 description: "port",
1697 description: "Scheme",
1706 key: :instrumenters,
1707 type: {:list, :module},
1708 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1713 suggestions: ["https"]
1716 key: :secret_key_base,
1718 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1723 suggestions: ["CqaoopA2"]
1726 key: :render_errors,
1728 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1733 suggestions: [Pleroma.Web.ErrorView]
1737 type: {:list, :string},
1738 suggestions: ["json"]
1745 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1750 suggestions: [Pleroma.PubSub]
1755 suggestions: [Phoenix.PubSub.PG2]
1760 key: :secure_cookie_flag,
1764 key: :extra_cookie_attrs,
1765 type: {:list, :string},
1766 suggestions: ["SameSite=Lax"]
1774 description: "ActivityPub-related settings",
1777 key: :unfollow_blocked,
1779 description: "Whether blocks result in people getting unfollowed"
1782 key: :outgoing_blocks,
1784 description: "Whether to federate blocks to other instances"
1787 key: :sign_object_fetches,
1789 description: "Sign object fetches with HTTP signatures"
1792 key: :follow_handshake_timeout,
1794 description: "Following handshake timeout",
1801 key: :http_security,
1803 description: "HTTP security settings",
1808 description: "Whether the managed content security policy is enabled"
1814 description: "Whether to additionally send a Strict-Transport-Security header"
1818 label: "STS max age",
1820 description: "The maximum age for the Strict-Transport-Security header if sent",
1821 suggestions: [31_536_000]
1825 label: "CT max age",
1827 description: "The maximum age for the Expect-CT header if sent",
1828 suggestions: [2_592_000]
1831 key: :referrer_policy,
1833 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1834 suggestions: ["same-origin", "no-referrer"]
1838 label: "Report URI",
1840 description: "Adds the specified url to report-uri and report-to group in CSP header",
1841 suggestions: ["https://example.com/report-uri"]
1846 group: :web_push_encryption,
1847 key: :vapid_details,
1850 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1856 "A mailto link for the administrative contact." <>
1857 " It's best if this email is not a personal email address, but rather a group email so that if a person leaves an organization," <>
1858 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can.",
1859 suggestions: ["Subject"]
1864 description: "VAPID public key",
1865 suggestions: ["Public key"]
1870 description: "VAPID private key",
1871 suggestions: ["Private key"]
1877 key: Pleroma.Captcha,
1879 description: "Captcha-related settings",
1884 description: "Whether the captcha should be shown on registration"
1889 description: "The method/service to use for captcha",
1890 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1893 key: :seconds_valid,
1895 description: "The time in seconds for which the captcha is valid",
1902 key: Pleroma.Captcha.Kocaptcha,
1905 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1906 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1911 description: "The kocaptcha endpoint to use",
1912 suggestions: ["https://captcha.kotobank.ch"]
1920 "Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the `admin_token` parameter",
1925 description: "Token",
1926 suggestions: ["some_random_token"]
1931 group: :pleroma_job_queue,
1934 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1938 key: Pleroma.Web.Federator.RetryQueue,
1940 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1945 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1954 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1956 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1957 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1958 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1959 (see https://github.com/sorentwo/oban/issues/52).
1965 description: "Application's Ecto repo",
1966 suggestions: [Pleroma.Repo]
1970 type: {:dropdown, :atom},
1971 description: "Logs verbose mode",
1972 suggestions: [false, :error, :warn, :info, :debug]
1976 type: [:atom, :tuple],
1978 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1979 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1983 type: {:keyword, :integer},
1985 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1987 activity_expiration: 10,
1989 federator_incoming: 50,
1990 federator_outgoing: 50,
1992 scheduled_activities: 10,
1998 key: :activity_expiration,
2000 description: "Activity expiration queue",
2006 description: "Background queue",
2010 key: :federator_incoming,
2012 description: "Incoming federation queue",
2016 key: :federator_outgoing,
2018 description: "Outgoing federation queue",
2024 description: "Email sender queue, see Pleroma.Emails.Mailer",
2028 key: :scheduled_activities,
2030 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2034 key: :transmogrifier,
2036 description: "Transmogrifier queue",
2042 description: "Web push notifications queue",
2053 description: "Includes custom worker options not interpretable directly by `Oban`",
2057 type: {:keyword, :integer},
2058 description: "Max retry attempts for failed jobs, per `Oban` queue",
2060 federator_incoming: 5,
2061 federator_outgoing: 5
2068 key: Pleroma.Web.Metadata,
2070 description: "Metadata-related settings",
2074 type: {:list, :module},
2075 description: "List of metadata providers to enable",
2077 Pleroma.Web.Metadata.Providers.OpenGraph,
2078 Pleroma.Web.Metadata.Providers.TwitterCard,
2079 Pleroma.Web.Metadata.Providers.RelMe,
2080 Pleroma.Web.Metadata.Providers.Feed
2085 label: "Unfurl NSFW",
2087 description: "When enabled NSFW attachments will be shown in previews"
2096 "If enabled the instance will parse metadata from attached links to generate link previews.",
2101 description: "Enables/disables RichMedia."
2105 type: {:list, :string},
2106 description: "List of hosts which will be ignored by the metadata parser.",
2107 suggestions: ["accounts.google.com", "xss.website"]
2111 label: "Ignore TLD",
2112 type: {:list, :string},
2113 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2114 suggestions: ["local", "localdomain", "lan"]
2118 type: {:list, :module},
2119 description: "List of Rich Media parsers.",
2121 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2122 Pleroma.Web.RichMedia.Parsers.OEmbed,
2123 Pleroma.Web.RichMedia.Parsers.OGP,
2124 Pleroma.Web.RichMedia.Parsers.TwitterCard
2129 label: "TTL setters",
2130 type: {:list, :module},
2131 description: "List of rich media TTL setters.",
2133 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2140 key: :fetch_initial_posts,
2142 description: "Fetching initial posts settings",
2148 "If enabled, when a new user is federated with, fetch some of their latest posts"
2153 description: "The amount of pages to fetch",
2159 group: :auto_linker,
2162 description: "Configuration for the auto_linker library",
2166 type: [:string, false],
2167 description: "Specify the class to be added to the generated link. `False` to clear",
2168 suggestions: ["auto-linker", false]
2172 type: [:string, false],
2173 description: "Override the rel attribute. `False` to clear",
2174 suggestions: ["ugc", "noopener noreferrer", false]
2179 description: "Link urls will open in new window/tab"
2183 type: [:integer, false],
2185 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2186 suggestions: [15, false]
2191 description: "Strip the scheme prefix"
2196 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2202 key: Pleroma.ScheduledActivity,
2204 description: "Scheduled activities settings",
2207 key: :daily_user_limit,
2210 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2214 key: :total_user_limit,
2217 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2223 description: "Whether scheduled activities are sent to the job queue to be executed"
2229 key: Pleroma.ActivityExpiration,
2231 description: "Expired activity settings",
2236 description: "Whether expired activities will be sent to the job queue to be deleted"
2243 description: "Authenticator",
2246 key: Pleroma.Web.Auth.Authenticator,
2248 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2257 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2258 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2259 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2260 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2265 description: "Enables LDAP authentication"
2270 description: "LDAP server hostname",
2271 suggestions: ["localhosts"]
2276 description: "LDAP port, e.g. 389 or 636",
2277 suggestions: [389, 636]
2283 description: "`True` to use SSL, usually implies the port 636"
2287 label: "SSL options",
2289 description: "Additional SSL options",
2290 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2295 description: "Path to file with PEM encoded cacerts",
2296 suggestions: ["path/to/file/with/PEM/cacerts"]
2301 description: "Type of cert verification",
2302 suggestions: [:verify_peer]
2310 description: "`True` to start TLS, usually implies the port 389"
2314 label: "TLS options",
2316 description: "Additional TLS options",
2317 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2322 description: "Path to file with PEM encoded cacerts",
2323 suggestions: ["path/to/file/with/PEM/cacerts"]
2328 description: "Type of cert verification",
2329 suggestions: [:verify_peer]
2336 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2337 suggestions: ["dc=example,dc=com"]
2343 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2352 description: "Authentication / authorization settings",
2355 key: :enforce_oauth_admin_scope_usage,
2358 "OAuth admin scope requirement toggle. " <>
2359 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2360 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2361 "`is_admin` user flag grants access to admin-specific actions."
2364 key: :auth_template,
2367 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2368 suggestions: ["show.html"]
2371 key: :oauth_consumer_template,
2374 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2375 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2376 suggestions: ["consumer.html"]
2379 key: :oauth_consumer_strategies,
2380 type: {:list, :string},
2382 "The list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2383 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2384 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2385 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2391 key: :email_notifications,
2393 description: "Email notifications settings",
2399 "emails of \"what you've missed\" for users who have been inactive for a while",
2403 schedule: "0 0 * * 0",
2405 inactivity_threshold: 7
2412 description: "Globally enable or disable digest emails"
2418 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2419 suggestions: ["0 0 * * 0"]
2424 description: "Minimum interval between digest emails to one user",
2428 key: :inactivity_threshold,
2430 description: "Minimum user inactivity threshold",
2439 key: Pleroma.Emails.UserEmail,
2441 description: "Email template settings",
2446 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2447 suggestions: ["some/path/logo.png"]
2452 description: "a map with color settings for email templates.",
2455 link_color: "#d8a070",
2456 background_color: "#2C3645",
2457 content_background_color: "#1B2635",
2458 header_color: "#d8a070",
2459 text_color: "#b9b9ba",
2460 text_muted_color: "#b9b9ba"
2467 suggestions: ["#d8a070"]
2470 key: :background_color,
2472 suggestions: ["#2C3645"]
2475 key: :content_background_color,
2477 suggestions: ["#1B2635"]
2482 suggestions: ["#d8a070"]
2487 suggestions: ["#b9b9ba"]
2490 key: :text_muted_color,
2492 suggestions: ["#b9b9ba"]
2502 description: "Configure OAuth 2 provider capabilities",
2505 key: :token_expires_in,
2507 description: "The lifetime in seconds of the access token",
2511 key: :issue_new_refresh_token,
2514 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2517 key: :clean_expired_tokens,
2519 description: "Enable a background job to clean expired oauth tokens. Default: `false`."
2529 key: :shortcode_globs,
2530 type: {:list, :string},
2531 description: "Location of custom emoji files. * can be used as a wildcard.",
2532 suggestions: ["/emoji/custom/**/*.png"]
2535 key: :pack_extensions,
2536 type: {:list, :string},
2538 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2539 suggestions: [".png", ".gif"]
2543 type: {:keyword, :string, {:list, :string}},
2545 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2546 " and the value is the location or array of locations. * can be used as a wildcard.",
2548 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2552 key: :default_manifest,
2555 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2556 " Currently only one manifest can be added (no arrays).",
2557 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2560 key: :shared_pack_cache_seconds_per_file,
2561 label: "Shared pack cache s/file",
2564 "When an emoji pack is shared, the archive is created and cached in memory" <>
2565 " for this amount of seconds multiplied by the number of files.",
2574 description: "Database related settings",
2579 description: "If RUM indexes should be used. Default: `false`"
2588 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2592 type: [:tuple, {:list, :tuple}],
2593 description: "For the search requests (account & status search etc.)",
2594 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2597 key: :app_account_creation,
2598 type: [:tuple, {:list, :tuple}],
2599 description: "For registering user accounts from the same IP address",
2600 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2603 key: :relations_actions,
2604 type: [:tuple, {:list, :tuple}],
2605 description: "For actions on relations with all users (follow, unfollow)",
2606 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2609 key: :relation_id_action,
2610 type: [:tuple, {:list, :tuple}],
2611 description: "For actions on relation with a specific user (follow, unfollow)",
2612 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2615 key: :statuses_actions,
2616 type: [:tuple, {:list, :tuple}],
2618 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2619 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2622 key: :status_id_action,
2623 type: [:tuple, {:list, :tuple}],
2625 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2626 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2629 key: :authentication,
2630 type: [:tuple, {:list, :tuple}],
2631 description: "For authentication create / password check / user existence check requests",
2632 suggestions: [{60_000, 15}]
2640 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2641 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2646 description: "Enables SSH"
2651 description: "Dir with SSH keys",
2652 suggestions: ["/some/path/ssh_keys"]
2657 description: "Handler module",
2658 suggestions: ["Pleroma.BBS.Handler"]
2663 description: "Port to connect",
2664 suggestions: [10_022]
2667 key: :password_authenticator,
2669 description: "Authenticator module",
2670 suggestions: ["Pleroma.BBS.Authenticator"]
2677 description: "Mime types",
2684 "application/xml" => ["xml"],
2685 "application/xrd+xml" => ["xrd+xml"],
2686 "application/jrd+json" => ["jrd+json"],
2687 "application/activity+json" => ["activity+json"],
2688 "application/ld+json" => ["activity+json"]
2693 key: "application/xml",
2694 type: {:list, :string},
2695 suggestions: ["xml"]
2698 key: "application/xrd+xml",
2699 type: {:list, :string},
2700 suggestions: ["xrd+xml"]
2703 key: "application/jrd+json",
2704 type: {:list, :string},
2705 suggestions: ["jrd+json"]
2708 key: "application/activity+json",
2709 type: {:list, :string},
2710 suggestions: ["activity+json"]
2713 key: "application/ld+json",
2714 type: {:list, :string},
2715 suggestions: ["activity+json"]
2724 description: "Tesla settings",
2729 description: "Tesla adapter",
2730 suggestions: [Tesla.Adapter.Hackney]
2738 description: "Pleroma chat settings",
2748 key: Pleroma.Web.Endpoint.MetricsExporter,
2750 description: "Prometheus settings",
2755 description: "API endpoint with metrics",
2756 suggestions: ["/api/pleroma/app_metrics"]
2761 group: :http_signatures,
2763 description: "HTTP Signatures settings",
2768 suggestions: [Pleroma.Signature]
2776 description: "HTTP settings",
2781 type: [:string, :tuple],
2782 description: "Proxy URL",
2783 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2786 key: :send_user_agent,
2791 type: [:string, :atom],
2793 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2794 suggestions: ["Pleroma", :default]
2799 description: "Adapter specific options",
2805 label: "SSL Options",
2806 description: "SSL options for HTTP adapter",
2810 type: {:list, :atom},
2811 description: "List of TLS version to use",
2812 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2826 key: :allow_inline_images,
2830 key: :allow_headings,
2843 type: {:list, :module},
2844 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2854 key: :deny_follow_blocked,
2861 key: :mrf_normalize_markup,
2862 label: "MRF normalize markup",
2863 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2869 suggestions: [Pleroma.HTML.Scrubber.Default]
2879 key: :restricted_nicknames,
2880 type: {:list, :string},
2899 "ostatus_subscribe",
2923 suggestions: [86_400]
2927 type: {:list, :string},
2928 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2932 type: {:list, :string},
2935 "X-RateLimit-Reset",
2936 "X-RateLimit-Limit",
2937 "X-RateLimit-Remaining",
2948 type: {:list, :string},
2949 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2955 key: Pleroma.Plugs.RemoteIp,
2958 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2959 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2965 description: "Enable/disable the plug. Default: `false`."
2969 type: {:list, :string},
2971 "A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Default: `~w[forwarded x-forwarded-for x-client-ip x-real-ip]`."
2975 type: {:list, :string},
2977 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2981 type: {:list, :string},
2983 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2989 key: :web_cache_ttl,
2992 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2998 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2999 suggestions: [30_000, nil]
3002 key: :activity_pub_question,
3004 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3005 suggestions: [30_000]
3014 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3019 description: "Enables the rendering of static HTML. Defaults to `false`."
3027 description: "Configure feed rendering.",
3032 description: "Configure title rendering.",
3037 description: "Maximum number of characters before truncating title.",
3043 description: "Replacement which will be used after truncating string.",
3044 suggestions: ["..."]
3052 key: :mrf_object_age,
3054 description: "Rejects or delists posts based on their age when received.",
3059 description: "Required age (in seconds) of a post before actions are taken.",
3060 suggestions: [172_800]
3064 type: {:list, :atom},
3066 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3067 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3068 "`:reject` rejects the message entirely",
3069 suggestions: [:delist, :strip_followers, :reject]
3077 description: "Custom Runtime Modules.",
3082 description: "A path to custom Elixir modules (such as MRF policies)."
3089 description: "Allow instance configuration from database.",
3092 key: :configurable_from_database,
3095 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"