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. It 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,
641 "Enable registrations for anyone. Invitations require this setting to be disabled."
644 key: :invites_enabled,
647 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
650 key: :account_activation_required,
652 description: "Require users to confirm their emails before signing in."
657 description: "Enable federation with other instances."
660 key: :federation_incoming_replies_max_depth,
661 label: "Fed. incoming replies max depth",
664 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
665 " 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.",
671 key: :federation_reachability_timeout_days,
672 label: "Fed. reachability timeout days",
675 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
681 key: :federation_publisher_modules,
682 type: {:list, :module},
683 description: "List of modules for federation publishing",
685 Pleroma.Web.ActivityPub.Publisher
691 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
694 key: :rewrite_policy,
695 type: [:module, {:list, :module}],
696 description: "A list of MRF policies enabled",
698 Generator.list_modules_in_dir(
699 "lib/pleroma/web/activity_pub/mrf",
700 "Elixir.Pleroma.Web.ActivityPub.MRF."
707 "Makes the client API in authentificated mode-only except for user-profiles." <>
708 " Useful for disabling the Local Timeline and The Whole Known Network."
711 key: :quarantined_instances,
712 type: {:list, :string},
714 "List of ActivityPub instances where private (DMs, followers-only) activities will not be send",
721 key: :managed_config,
724 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
729 description: "Instance static directory",
735 key: :allowed_post_formats,
736 type: {:list, :string},
737 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
746 key: :mrf_transparency,
747 label: "MRF transparency",
750 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
753 key: :mrf_transparency_exclusions,
754 label: "MRF transparency exclusions",
755 type: {:list, :string},
757 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
763 key: :extended_nickname_format,
766 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
767 " This will break federation with older software for theses nicknames."
770 key: :cleanup_attachments,
773 Enable to remove associated attachments when status is removed.
774 This will not affect duplicates and attachments without status.
775 Enabling this will increase load to database when deleting statuses on larger instances.
779 key: :max_pinned_statuses,
781 description: "The maximum number of pinned statuses. 0 will disable the feature.",
789 key: :autofollowed_nicknames,
790 type: {:list, :string},
792 "Set to nicknames of (local) users that every new user should automatically follow",
801 key: :attachment_links,
803 description: "Enable to automatically add attachment link text to statuses"
806 key: :welcome_message,
809 "A message that will be sent to a newly registered users as a direct message",
811 "Hi, @username! Welcome on board!"
815 key: :welcome_user_nickname,
817 description: "The nickname of the local user that sends the welcome message",
823 key: :max_report_comment_size,
825 description: "The maximum size of the report comment. Default: 1000.",
831 key: :safe_dm_mentions,
834 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
835 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
841 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
844 key: :remote_post_retention_days,
847 "The default amount of days to retain remote posts when pruning the database",
853 key: :user_bio_length,
855 description: "A user bio maximum length. Default: 5000.",
861 key: :user_name_length,
863 description: "A user name maximum length. Default: 100.",
869 key: :skip_thread_containment,
871 description: "Skip filtering out broken threads. Default: enabled"
874 key: :limit_to_local_content,
875 type: {:dropdown, :atom},
877 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
885 key: :max_account_fields,
887 description: "The maximum number of custom fields in the user profile. Default: 10.",
893 key: :max_remote_account_fields,
896 "The maximum number of custom fields in the remote user profile. Default: 20.",
902 key: :account_field_name_length,
904 description: "An account field name maximum length. Default: 512.",
910 key: :account_field_value_length,
912 description: "An account field value maximum length. Default: 2048.",
918 key: :external_user_synchronization,
920 description: "Enabling following/followers counters synchronization for external users"
927 description: "Logger-related settings",
931 type: [:atom, :tuple, :module],
933 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
934 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
942 description: "ExSyslogger-related settings",
946 type: {:dropdown, :atom},
947 description: "Log level",
948 suggestions: [:debug, :info, :warn, :error]
954 "A string that's prepended to every message, and is typically set to the app name",
955 suggestions: ["pleroma"]
960 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
961 suggestions: ["$metadata[$level] $message"]
965 type: {:list, :atom},
966 suggestions: [:request_id]
974 description: "Console logger settings",
978 type: {:dropdown, :atom},
979 description: "Log level",
980 suggestions: [:debug, :info, :warn, :error]
985 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
986 suggestions: ["$metadata[$level] $message"]
990 type: {:list, :atom},
991 suggestions: [:request_id]
998 description: "Quack-related settings",
1002 type: {:dropdown, :atom},
1003 description: "Log level",
1004 suggestions: [:debug, :info, :warn, :error]
1008 type: {:list, :atom},
1009 description: "Configure which metadata you want to report on",
1027 description: "Configure the Slack incoming webhook",
1028 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1034 key: :frontend_configurations,
1037 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1038 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1039 "add your own configuration your settings all fields must be complete.",
1043 label: "Pleroma FE",
1045 description: "Settings for Pleroma FE",
1048 theme: "pleroma-dark",
1049 logo: "/static/logo.png",
1050 background: "/images/city.jpg",
1051 redirectRootNoLogin: "/main/all",
1052 redirectRootLogin: "/main/friends",
1053 showInstanceSpecificPanel: true,
1054 scopeOptionsEnabled: false,
1055 formattingOptionsEnabled: false,
1056 collapseMessageWithSubject: false,
1057 hidePostStats: false,
1058 hideUserStats: false,
1060 subjectLineBehavior: "email",
1061 alwaysShowSubjectInput: true,
1065 enableEmojiPicker: false
1072 description: "Which theme to use, they are defined in styles.json",
1073 suggestions: ["pleroma-dark"]
1078 description: "URL of the logo, defaults to Pleroma's logo",
1079 suggestions: ["/static/logo.png"]
1085 "URL of the background, unless viewing a user profile with a background that is set",
1086 suggestions: ["/images/city.jpg"]
1089 key: :redirectRootNoLogin,
1090 label: "Redirect root no login",
1093 "Relative URL which indicates where to redirect when a user isn't logged in",
1094 suggestions: ["/main/all"]
1097 key: :redirectRootLogin,
1098 label: "Redirect root login",
1101 "Relative URL which indicates where to redirect when a user is logged in",
1102 suggestions: ["/main/friends"]
1105 key: :showInstanceSpecificPanel,
1106 label: "Show instance specific panel",
1108 description: "Whenether to show the instance's specific panel"
1111 key: :scopeOptionsEnabled,
1112 label: "Scope options enabled",
1114 description: "Enable setting a notice visibility and subject/CW when posting"
1117 key: :formattingOptionsEnabled,
1118 label: "Formatting options enabled",
1121 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1124 key: :collapseMessageWithSubject,
1125 label: "Collapse message with subject",
1128 "When a message has a subject (aka Content Warning), collapse it by default"
1131 key: :hidePostStats,
1132 label: "Hide post stats",
1134 description: "Hide notices statistics (repeats, favorites, ...)"
1137 key: :hideUserStats,
1138 label: "Hide user stats",
1141 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1145 label: "Scope copy",
1147 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1150 key: :subjectLineBehavior,
1151 label: "Subject line behavior",
1153 description: "Allows changing the default behaviour of subject lines in replies.
1154 `email`: copy and preprend re:, as in email,
1155 `masto`: copy verbatim, as in Mastodon,
1156 `noop`: don't copy the subject.",
1157 suggestions: ["email", "masto", "noop"]
1160 key: :alwaysShowSubjectInput,
1161 label: "Always show subject input",
1163 description: "When disabled, auto-hide the subject field if it's empty"
1170 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1171 "If you want a colorful logo you must disable logoMask."
1175 label: "Logo margin",
1178 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1179 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1180 suggestions: [".1em"]
1185 description: "Enables stickers."
1188 key: :enableEmojiPicker,
1189 label: "Emoji picker",
1191 description: "Enables emoji picker."
1199 description: "Settings for Masto FE",
1202 showInstanceSpecificPanel: true
1207 key: :showInstanceSpecificPanel,
1208 label: "Show instance specific panel",
1210 description: "Whenether to show the instance's specific panel"
1221 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1225 type: {:keyword, :map},
1227 "Keyword of mascots, each element must contain both an url and a mime_type key",
1230 url: "/images/pleroma-fox-tan-smol.png",
1231 mime_type: "image/png"
1233 pleroma_fox_tan_shy: %{
1234 url: "/images/pleroma-fox-tan-shy.png",
1235 mime_type: "image/png"
1240 key: :default_mascot,
1243 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1255 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1259 type: {:list, :map},
1260 description: "Describe the icons of the app",
1263 src: "/static/logo.png"
1266 src: "/static/icon.png",
1270 src: "/static/icon.ico",
1271 sizes: "72x72 96x96 128x128 256x256"
1278 description: "Describe the theme color of the app",
1279 suggestions: ["#282c37", "mediumpurple"]
1282 key: :background_color,
1284 description: "Describe the background color of the app",
1285 suggestions: ["#191b22", "aliceblue"]
1292 label: "MRF simple",
1294 description: "Message Rewrite Facility",
1297 key: :media_removal,
1298 type: {:list, :string},
1299 description: "List of instances to remove medias from",
1300 suggestions: ["example.com", "*.example.com"]
1304 label: "Media NSFW",
1305 type: {:list, :string},
1306 description: "List of instances to put medias as NSFW (sensitive) from",
1307 suggestions: ["example.com", "*.example.com"]
1310 key: :federated_timeline_removal,
1311 type: {:list, :string},
1313 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1314 suggestions: ["example.com", "*.example.com"]
1318 type: {:list, :string},
1319 description: "List of instances to reject any activities from",
1320 suggestions: ["example.com", "*.example.com"]
1324 type: {:list, :string},
1325 description: "List of instances to accept any activities from",
1326 suggestions: ["example.com", "*.example.com"]
1329 key: :report_removal,
1330 type: {:list, :string},
1331 description: "List of instances to reject reports from",
1332 suggestions: ["example.com", "*.example.com"]
1335 key: :avatar_removal,
1336 type: {:list, :string},
1337 description: "List of instances to strip avatars from",
1338 suggestions: ["example.com", "*.example.com"]
1341 key: :banner_removal,
1342 type: {:list, :string},
1343 description: "List of instances to strip banners from",
1344 suggestions: ["example.com", "*.example.com"]
1351 label: "MRF subchain",
1354 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1355 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1360 description: "Matches a series of regular expressions against the actor field",
1363 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1371 key: :mrf_rejectnonpublic,
1373 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1374 label: "MRF reject non public",
1378 key: :allow_followersonly,
1379 label: "Allow followers-only",
1381 description: "Whether to allow followers-only posts"
1386 description: "Whether to allow direct messages"
1392 key: :mrf_hellthread,
1393 label: "MRF hellthread",
1395 description: "Block messages with too much mentions",
1398 key: :delist_threshold,
1401 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1402 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1406 key: :reject_threshold,
1409 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1417 label: "MRF keyword",
1419 description: "Reject or Word-Replace messages with a keyword or regex",
1423 type: [:string, :regex],
1425 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression.",
1426 suggestions: ["foo", ~r/foo/iu]
1429 key: :federated_timeline_removal,
1430 type: [:string, :regex],
1432 "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.",
1433 suggestions: ["foo", ~r/foo/iu]
1437 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1439 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1440 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1447 label: "MRF mention",
1449 description: "Block messages which mention a user",
1453 type: {:list, :string},
1454 description: "A list of actors, for which to drop any posts mentioning",
1455 suggestions: ["actor1", "actor2"]
1461 key: :mrf_vocabulary,
1462 label: "MRF vocabulary",
1464 description: "Filter messages which belong to certain activity vocabularies",
1468 type: {:list, :string},
1470 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1471 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1475 type: {:list, :string},
1477 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1478 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1484 # key: :mrf_user_allowlist,
1487 # "The keys in this section are the domain names that the policy should apply to." <>
1488 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1490 # ["example.org": ["https://example.org/users/admin"]],
1492 # ["example.org": ["https://example.org/users/admin"]]
1500 description: "Media proxy",
1505 description: "Enables proxying of remote media to the instance's proxy"
1511 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1512 suggestions: ["https://example.com"]
1517 description: "Options for Pleroma.ReverseProxy",
1519 redirect_on_failure: false,
1520 max_body_length: 25 * 1_048_576,
1522 follow_redirect: true,
1528 key: :redirect_on_failure,
1531 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1532 "Any error during body processing will not be redirected as the response is chunked."
1535 key: :max_body_length,
1538 "Limits the content length to be approximately the " <>
1539 "specified length. It is validated with the `content-length` header and also verified when proxying."
1544 description: "HTTP options",
1549 description: "Adapter specific options",
1554 label: "SSL Options",
1555 description: "SSL options for HTTP adapter",
1559 type: {:list, :atom},
1560 description: "List of TLS version to use",
1561 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1570 type: [:string, :tuple],
1571 description: "Proxy URL",
1572 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1580 type: {:list, :string},
1581 description: "List of domains to bypass the mediaproxy",
1582 suggestions: ["example.com"]
1590 description: "Gopher settings",
1595 description: "Enables the gopher interface"
1600 description: "IP address to bind to",
1601 suggestions: [{0, 0, 0, 0}]
1606 description: "Port to bind to",
1612 description: "Port advertised in urls (optional, defaults to port)",
1619 key: Pleroma.Web.Endpoint,
1621 description: "Phoenix endpoint configuration",
1626 type: {:keyword, :integer, :tuple},
1627 description: "http protocol configuration",
1635 type: {:list, :tuple},
1636 description: "dispatch settings",
1640 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1641 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1642 {Phoenix.Transports.WebSocket,
1643 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1644 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1646 # end copied from config.exs
1661 description: "port",
1671 type: {:keyword, :string, :integer},
1672 description: "configuration for generating urls",
1674 host: "example.com",
1682 description: "Host",
1690 description: "port",
1698 description: "Scheme",
1707 key: :instrumenters,
1708 type: {:list, :module},
1709 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1714 suggestions: ["https"]
1717 key: :secret_key_base,
1719 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1724 suggestions: ["CqaoopA2"]
1727 key: :render_errors,
1729 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1734 suggestions: [Pleroma.Web.ErrorView]
1738 type: {:list, :string},
1739 suggestions: ["json"]
1746 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1751 suggestions: [Pleroma.PubSub]
1756 suggestions: [Phoenix.PubSub.PG2]
1761 key: :secure_cookie_flag,
1765 key: :extra_cookie_attrs,
1766 type: {:list, :string},
1767 suggestions: ["SameSite=Lax"]
1775 description: "ActivityPub-related settings",
1778 key: :unfollow_blocked,
1780 description: "Whether blocks result in people getting unfollowed"
1783 key: :outgoing_blocks,
1785 description: "Whether to federate blocks to other instances"
1788 key: :sign_object_fetches,
1790 description: "Sign object fetches with HTTP signatures"
1793 key: :follow_handshake_timeout,
1795 description: "Following handshake timeout",
1802 key: :http_security,
1804 description: "HTTP security settings",
1809 description: "Whether the managed content security policy is enabled"
1815 description: "Whether to additionally send a Strict-Transport-Security header"
1819 label: "STS max age",
1821 description: "The maximum age for the Strict-Transport-Security header if sent",
1822 suggestions: [31_536_000]
1826 label: "CT max age",
1828 description: "The maximum age for the Expect-CT header if sent",
1829 suggestions: [2_592_000]
1832 key: :referrer_policy,
1834 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1835 suggestions: ["same-origin", "no-referrer"]
1839 label: "Report URI",
1841 description: "Adds the specified url to report-uri and report-to group in CSP header",
1842 suggestions: ["https://example.com/report-uri"]
1847 group: :web_push_encryption,
1848 key: :vapid_details,
1851 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1857 "A mailto link for the administrative contact." <>
1858 " 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," <>
1859 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can.",
1860 suggestions: ["Subject"]
1865 description: "VAPID public key",
1866 suggestions: ["Public key"]
1871 description: "VAPID private key",
1872 suggestions: ["Private key"]
1878 key: Pleroma.Captcha,
1880 description: "Captcha-related settings",
1885 description: "Whether the captcha should be shown on registration"
1890 description: "The method/service to use for captcha",
1891 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1894 key: :seconds_valid,
1896 description: "The time in seconds for which the captcha is valid",
1903 key: Pleroma.Captcha.Kocaptcha,
1906 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1907 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1912 description: "The kocaptcha endpoint to use",
1913 suggestions: ["https://captcha.kotobank.ch"]
1921 "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",
1926 description: "Token",
1927 suggestions: ["We recommend a secure random string or UUID"]
1932 group: :pleroma_job_queue,
1935 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1939 key: Pleroma.Web.Federator.RetryQueue,
1941 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1946 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1955 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1957 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1958 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1959 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1960 (see https://github.com/sorentwo/oban/issues/52).
1966 description: "Application's Ecto repo",
1967 suggestions: [Pleroma.Repo]
1971 type: {:dropdown, :atom},
1972 description: "Logs verbose mode",
1973 suggestions: [false, :error, :warn, :info, :debug]
1977 type: [:atom, :tuple],
1979 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1980 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1984 type: {:keyword, :integer},
1986 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1988 activity_expiration: 10,
1990 federator_incoming: 50,
1991 federator_outgoing: 50,
1993 scheduled_activities: 10,
1999 key: :activity_expiration,
2001 description: "Activity expiration queue",
2007 description: "Background queue",
2011 key: :federator_incoming,
2013 description: "Incoming federation queue",
2017 key: :federator_outgoing,
2019 description: "Outgoing federation queue",
2025 description: "Email sender queue, see Pleroma.Emails.Mailer",
2029 key: :scheduled_activities,
2031 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2035 key: :transmogrifier,
2037 description: "Transmogrifier queue",
2043 description: "Web push notifications queue",
2054 description: "Includes custom worker options not interpretable directly by `Oban`",
2058 type: {:keyword, :integer},
2059 description: "Max retry attempts for failed jobs, per `Oban` queue",
2061 federator_incoming: 5,
2062 federator_outgoing: 5
2069 key: Pleroma.Web.Metadata,
2071 description: "Metadata-related settings",
2075 type: {:list, :module},
2076 description: "List of metadata providers to enable",
2078 Pleroma.Web.Metadata.Providers.OpenGraph,
2079 Pleroma.Web.Metadata.Providers.TwitterCard,
2080 Pleroma.Web.Metadata.Providers.RelMe,
2081 Pleroma.Web.Metadata.Providers.Feed
2086 label: "Unfurl NSFW",
2088 description: "When enabled NSFW attachments will be shown in previews"
2097 "If enabled the instance will parse metadata from attached links to generate link previews.",
2102 description: "Enables/disables RichMedia."
2106 type: {:list, :string},
2107 description: "List of hosts which will be ignored by the metadata parser.",
2108 suggestions: ["accounts.google.com", "xss.website"]
2112 label: "Ignore TLD",
2113 type: {:list, :string},
2114 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2115 suggestions: ["local", "localdomain", "lan"]
2119 type: {:list, :module},
2120 description: "List of Rich Media parsers.",
2122 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2123 Pleroma.Web.RichMedia.Parsers.OEmbed,
2124 Pleroma.Web.RichMedia.Parsers.OGP,
2125 Pleroma.Web.RichMedia.Parsers.TwitterCard
2130 label: "TTL setters",
2131 type: {:list, :module},
2132 description: "List of rich media TTL setters.",
2134 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2141 key: :fetch_initial_posts,
2143 description: "Fetching initial posts settings",
2149 "Fetch posts when a new user is federated with"
2154 description: "The amount of pages to fetch",
2160 group: :auto_linker,
2163 description: "Configuration for the auto_linker library",
2167 type: [:string, false],
2168 description: "Specify the class to be added to the generated link. `False` to clear",
2169 suggestions: ["auto-linker", false]
2173 type: [:string, false],
2174 description: "Override the rel attribute. `False` to clear",
2175 suggestions: ["ugc", "noopener noreferrer", false]
2180 description: "Link urls will open in new window/tab"
2184 type: [:integer, false],
2186 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2187 suggestions: [15, false]
2192 description: "Strip the scheme prefix"
2197 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2203 key: Pleroma.ScheduledActivity,
2205 description: "Scheduled activities settings",
2208 key: :daily_user_limit,
2211 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2215 key: :total_user_limit,
2218 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2224 description: "Whether scheduled activities are sent to the job queue to be executed"
2230 key: Pleroma.ActivityExpiration,
2232 description: "Expired activity settings",
2237 description: "Whether expired activities will be sent to the job queue to be deleted"
2244 description: "Authenticator",
2247 key: Pleroma.Web.Auth.Authenticator,
2249 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2258 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2259 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2260 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2261 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2266 description: "Enables LDAP authentication"
2271 description: "LDAP server hostname",
2272 suggestions: ["localhosts"]
2277 description: "LDAP port, e.g. 389 or 636",
2278 suggestions: [389, 636]
2284 description: "`True` to use SSL, usually implies the port 636"
2288 label: "SSL options",
2290 description: "Additional SSL options",
2291 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2296 description: "Path to file with PEM encoded cacerts",
2297 suggestions: ["path/to/file/with/PEM/cacerts"]
2302 description: "Type of cert verification",
2303 suggestions: [:verify_peer]
2311 description: "`True` to start TLS, usually implies the port 389"
2315 label: "TLS options",
2317 description: "Additional TLS options",
2318 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2323 description: "Path to file with PEM encoded cacerts",
2324 suggestions: ["path/to/file/with/PEM/cacerts"]
2329 description: "Type of cert verification",
2330 suggestions: [:verify_peer]
2337 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2338 suggestions: ["dc=example,dc=com"]
2344 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2353 description: "Authentication / authorization settings",
2356 key: :enforce_oauth_admin_scope_usage,
2359 "OAuth admin scope requirement toggle. " <>
2360 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2361 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2362 "`is_admin` user flag grants access to admin-specific actions."
2365 key: :auth_template,
2368 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2369 suggestions: ["show.html"]
2372 key: :oauth_consumer_template,
2375 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2376 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2377 suggestions: ["consumer.html"]
2380 key: :oauth_consumer_strategies,
2381 type: {:list, :string},
2383 "The list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2384 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2385 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2386 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2392 key: :email_notifications,
2394 description: "Email notifications settings",
2400 "emails of \"what you've missed\" for users who have been inactive for a while",
2404 schedule: "0 0 * * 0",
2406 inactivity_threshold: 7
2413 description: "Globally enable or disable digest emails"
2419 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2420 suggestions: ["0 0 * * 0"]
2425 description: "Minimum interval between digest emails to one user",
2429 key: :inactivity_threshold,
2431 description: "Minimum user inactivity threshold",
2440 key: Pleroma.Emails.UserEmail,
2442 description: "Email template settings",
2447 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2448 suggestions: ["some/path/logo.png"]
2453 description: "a map with color settings for email templates.",
2456 link_color: "#d8a070",
2457 background_color: "#2C3645",
2458 content_background_color: "#1B2635",
2459 header_color: "#d8a070",
2460 text_color: "#b9b9ba",
2461 text_muted_color: "#b9b9ba"
2468 suggestions: ["#d8a070"]
2471 key: :background_color,
2473 suggestions: ["#2C3645"]
2476 key: :content_background_color,
2478 suggestions: ["#1B2635"]
2483 suggestions: ["#d8a070"]
2488 suggestions: ["#b9b9ba"]
2491 key: :text_muted_color,
2493 suggestions: ["#b9b9ba"]
2503 description: "Configure OAuth 2 provider capabilities",
2506 key: :token_expires_in,
2508 description: "The lifetime in seconds of the access token",
2512 key: :issue_new_refresh_token,
2515 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2518 key: :clean_expired_tokens,
2520 description: "Enable a background job to clean expired oauth tokens. Default: `false`."
2530 key: :shortcode_globs,
2531 type: {:list, :string},
2532 description: "Location of custom emoji files. * can be used as a wildcard.",
2533 suggestions: ["/emoji/custom/**/*.png"]
2536 key: :pack_extensions,
2537 type: {:list, :string},
2539 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2540 suggestions: [".png", ".gif"]
2544 type: {:keyword, :string, {:list, :string}},
2546 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2547 " and the value is the location or array of locations. * can be used as a wildcard.",
2549 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2553 key: :default_manifest,
2556 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2557 " Currently only one manifest can be added (no arrays).",
2558 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2561 key: :shared_pack_cache_seconds_per_file,
2562 label: "Shared pack cache s/file",
2565 "When an emoji pack is shared, the archive is created and cached in memory" <>
2566 " for this amount of seconds multiplied by the number of files.",
2575 description: "Database related settings",
2580 description: "If RUM indexes should be used. Default: `false`"
2589 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2593 type: [:tuple, {:list, :tuple}],
2594 description: "For the search requests (account & status search etc.)",
2595 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2598 key: :app_account_creation,
2599 type: [:tuple, {:list, :tuple}],
2600 description: "For registering user accounts from the same IP address",
2601 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2604 key: :relations_actions,
2605 type: [:tuple, {:list, :tuple}],
2606 description: "For actions on relations with all users (follow, unfollow)",
2607 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2610 key: :relation_id_action,
2611 type: [:tuple, {:list, :tuple}],
2612 description: "For actions on relation with a specific user (follow, unfollow)",
2613 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2616 key: :statuses_actions,
2617 type: [:tuple, {:list, :tuple}],
2619 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2620 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2623 key: :status_id_action,
2624 type: [:tuple, {:list, :tuple}],
2626 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2627 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2630 key: :authentication,
2631 type: [:tuple, {:list, :tuple}],
2632 description: "For authentication create / password check / user existence check requests",
2633 suggestions: [{60_000, 15}]
2641 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2642 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2647 description: "Enables SSH"
2652 description: "Dir with SSH keys",
2653 suggestions: ["/some/path/ssh_keys"]
2658 description: "Handler module",
2659 suggestions: ["Pleroma.BBS.Handler"]
2664 description: "Port to connect",
2665 suggestions: [10_022]
2668 key: :password_authenticator,
2670 description: "Authenticator module",
2671 suggestions: ["Pleroma.BBS.Authenticator"]
2678 description: "Mime types",
2685 "application/xml" => ["xml"],
2686 "application/xrd+xml" => ["xrd+xml"],
2687 "application/jrd+json" => ["jrd+json"],
2688 "application/activity+json" => ["activity+json"],
2689 "application/ld+json" => ["activity+json"]
2694 key: "application/xml",
2695 type: {:list, :string},
2696 suggestions: ["xml"]
2699 key: "application/xrd+xml",
2700 type: {:list, :string},
2701 suggestions: ["xrd+xml"]
2704 key: "application/jrd+json",
2705 type: {:list, :string},
2706 suggestions: ["jrd+json"]
2709 key: "application/activity+json",
2710 type: {:list, :string},
2711 suggestions: ["activity+json"]
2714 key: "application/ld+json",
2715 type: {:list, :string},
2716 suggestions: ["activity+json"]
2725 description: "Tesla settings",
2730 description: "Tesla adapter",
2731 suggestions: [Tesla.Adapter.Hackney]
2739 description: "Pleroma chat settings",
2749 key: Pleroma.Web.Endpoint.MetricsExporter,
2751 description: "Prometheus settings",
2756 description: "API endpoint with metrics",
2757 suggestions: ["/api/pleroma/app_metrics"]
2762 group: :http_signatures,
2764 description: "HTTP Signatures settings",
2769 suggestions: [Pleroma.Signature]
2777 description: "HTTP settings",
2782 type: [:string, :tuple],
2783 description: "Proxy URL",
2784 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2787 key: :send_user_agent,
2792 type: [:string, :atom],
2794 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2795 suggestions: ["Pleroma", :default]
2800 description: "Adapter specific options",
2806 label: "SSL Options",
2807 description: "SSL options for HTTP adapter",
2811 type: {:list, :atom},
2812 description: "List of TLS version to use",
2813 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2827 key: :allow_inline_images,
2831 key: :allow_headings,
2844 type: {:list, :module},
2845 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2855 key: :deny_follow_blocked,
2862 key: :mrf_normalize_markup,
2863 label: "MRF normalize markup",
2864 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2870 suggestions: [Pleroma.HTML.Scrubber.Default]
2880 key: :restricted_nicknames,
2881 type: {:list, :string},
2900 "ostatus_subscribe",
2924 suggestions: [86_400]
2928 type: {:list, :string},
2929 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2933 type: {:list, :string},
2936 "X-RateLimit-Reset",
2937 "X-RateLimit-Limit",
2938 "X-RateLimit-Remaining",
2949 type: {:list, :string},
2950 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2956 key: Pleroma.Plugs.RemoteIp,
2959 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2960 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2966 description: "Enable/disable the plug. Default: `false`."
2970 type: {:list, :string},
2972 "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]`."
2976 type: {:list, :string},
2978 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2982 type: {:list, :string},
2984 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2990 key: :web_cache_ttl,
2993 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2999 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3000 suggestions: [30_000, nil]
3003 key: :activity_pub_question,
3005 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3006 suggestions: [30_000]
3015 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3020 description: "Enables the rendering of static HTML. Defaults to `false`."
3028 description: "Configure feed rendering.",
3033 description: "Configure title rendering.",
3038 description: "Maximum number of characters before truncating title.",
3044 description: "Replacement which will be used after truncating string.",
3045 suggestions: ["..."]
3053 key: :mrf_object_age,
3055 description: "Rejects or delists posts based on their age when received.",
3060 description: "Required age (in seconds) of a post before actions are taken.",
3061 suggestions: [172_800]
3065 type: {:list, :atom},
3067 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3068 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3069 "`:reject` rejects the message entirely",
3070 suggestions: [:delist, :strip_followers, :reject]
3078 description: "Custom Runtime Modules.",
3083 description: "A path to custom Elixir modules (such as MRF policies)."
3090 description: "Allow instance configuration from database.",
3093 key: :configurable_from_database,
3096 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"