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},
32 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
34 Generator.list_modules_in_dir(
35 "lib/pleroma/upload/filter",
36 "Elixir.Pleroma.Upload.Filter."
43 "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`."
48 description: "Base url for the uploads, needed if you use CDN",
50 "https://cdn-host.com"
57 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
62 description: "Options for Pleroma.ReverseProxy",
64 redirect_on_failure: false,
65 max_body_length: 25 * 1_048_576,
67 follow_redirect: true,
73 key: :redirect_on_failure,
76 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
77 "Any error during body processing will not be redirected as the response is chunked."
80 key: :max_body_length,
83 "Limits the content length to be approximately the " <>
84 "specified length. It is validated with the `content-length` header and also verified when proxying."
89 description: "HTTP options",
94 description: "Adapter specific options",
100 description: "SSL options for HTTP adapter",
104 type: {:list, :atom},
105 description: "List of TLS versions to use",
106 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
115 type: [:string, :tuple],
116 description: "Proxy URL",
117 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
127 key: Pleroma.Uploaders.Local,
129 description: "Local uploader-related settings",
134 description: "Path where user's uploads will be saved",
143 key: Pleroma.Uploaders.S3,
145 description: "S3 uploader-related settings",
150 description: "S3 bucket",
156 key: :bucket_namespace,
158 description: "S3 bucket namespace",
159 suggestions: ["pleroma"]
162 key: :public_endpoint,
164 description: "S3 endpoint",
165 suggestions: ["https://s3.amazonaws.com"]
168 key: :truncated_namespace,
171 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
172 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
175 key: :streaming_enabled,
178 "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."
184 key: Pleroma.Upload.Filter.Mogrify,
186 description: "Uploads mogrify filter settings",
190 type: [:string, {:list, :string}, {:list, :tuple}],
191 description: "List of actions for the mogrify command",
202 key: Pleroma.Upload.Filter.AnonymizeFilename,
204 description: "Filter replaces the filename of the upload",
210 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
211 " filename extension by using {extension}, for example custom-file-name.{extension}.",
213 "custom-file-name.{extension}"
220 key: Pleroma.Emails.Mailer,
222 description: "Mailer-related settings",
228 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
229 " or Swoosh.Adapters.Local for in-memory mailbox",
231 Swoosh.Adapters.SMTP,
232 Swoosh.Adapters.Sendgrid,
233 Swoosh.Adapters.Sendmail,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Mailgun,
236 Swoosh.Adapters.Mailjet,
237 Swoosh.Adapters.Postmark,
238 Swoosh.Adapters.SparkPost,
239 Swoosh.Adapters.AmazonSES,
241 Swoosh.Adapters.SocketLabs,
242 Swoosh.Adapters.Gmail,
243 Swoosh.Adapters.Local
249 description: "Allow/disallow send emails"
252 group: {:subgroup, Swoosh.Adapters.SMTP},
255 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
256 suggestions: ["smtp.gmail.com"]
259 group: {:subgroup, Swoosh.Adapters.SMTP},
262 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
263 suggestions: ["pleroma"]
266 group: {:subgroup, Swoosh.Adapters.SMTP},
269 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
270 suggestions: ["password"]
273 group: {:subgroup, Swoosh.Adapters.SMTP},
277 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
280 group: {:subgroup, Swoosh.Adapters.SMTP},
284 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
285 suggestions: [:always, :never, :if_available]
288 group: {:subgroup, Swoosh.Adapters.SMTP},
291 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
292 suggestions: [:always, :never, :if_available]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
302 group: {:subgroup, Swoosh.Adapters.SMTP},
305 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
309 group: {:subgroup, Swoosh.Adapters.SMTP},
311 label: "No MX lookups",
313 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
316 group: {:subgroup, Swoosh.Adapters.Sendgrid},
320 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
321 suggestions: ["my-api-key"]
324 group: {:subgroup, Swoosh.Adapters.Sendmail},
327 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
328 suggestions: ["/usr/bin/sendmail"]
331 group: {:subgroup, Swoosh.Adapters.Sendmail},
334 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
335 suggestions: ["-N delay,failure,success"]
338 group: {:subgroup, Swoosh.Adapters.Sendmail},
341 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
344 group: {:subgroup, Swoosh.Adapters.Mandrill},
348 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
349 suggestions: ["my-api-key"]
352 group: {:subgroup, Swoosh.Adapters.Mailgun},
356 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
357 suggestions: ["my-api-key"]
360 group: {:subgroup, Swoosh.Adapters.Mailgun},
363 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
364 suggestions: ["pleroma.com"]
367 group: {:subgroup, Swoosh.Adapters.Mailjet},
371 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
372 suggestions: ["my-api-key"]
375 group: {:subgroup, Swoosh.Adapters.Mailjet},
378 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
379 suggestions: ["my-secret-key"]
382 group: {:subgroup, Swoosh.Adapters.Postmark},
386 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
387 suggestions: ["my-api-key"]
390 group: {:subgroup, Swoosh.Adapters.SparkPost},
394 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
395 suggestions: ["my-api-key"]
398 group: {:subgroup, Swoosh.Adapters.SparkPost},
401 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
402 suggestions: ["https://api.sparkpost.com/api/v1"]
405 group: {:subgroup, Swoosh.Adapters.AmazonSES},
408 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
409 suggestions: ["us-east-1", "us-east-2"]
412 group: {:subgroup, Swoosh.Adapters.AmazonSES},
415 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
416 suggestions: ["aws-access-key"]
419 group: {:subgroup, Swoosh.Adapters.AmazonSES},
422 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
423 suggestions: ["aws-secret-key"]
426 group: {:subgroup, Swoosh.Adapters.Dyn},
430 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
431 suggestions: ["my-api-key"]
434 group: {:subgroup, Swoosh.Adapters.SocketLabs},
437 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
440 group: {:subgroup, Swoosh.Adapters.SocketLabs},
444 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
447 group: {:subgroup, Swoosh.Adapters.Gmail},
450 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
457 description: "`Swoosh.Adapters.Local` adapter specific settings",
460 group: {:subgroup, Swoosh.Adapters.Local},
463 description: "Run the preview server together as part of your app"
466 group: {:subgroup, Swoosh.Adapters.Local},
469 description: "The preview server port",
478 description: "URI schemes related settings",
482 type: {:list, :string},
483 description: "List of the scheme part that is considered valid to be an URL",
507 description: "Instance-related settings",
512 description: "Name of the instance",
519 label: "Admin Email Address",
521 description: "Email used to reach an Administrator/Moderator of the instance",
528 label: "Sender Email Address",
530 description: "Envelope FROM address for mail sent via Pleroma",
539 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
547 description: "Posts character limit (CW/Subject included in the counter)",
555 description: "Character limit of the instance chat messages",
563 description: "Hard character limit beyond which remote posts will be dropped",
571 description: "File size limit of uploads (except for avatar, background, banner)",
577 key: :avatar_upload_limit,
579 description: "File size limit of user's profile avatars",
585 key: :background_upload_limit,
587 description: "File size limit of user's profile backgrounds",
593 key: :banner_upload_limit,
595 description: "File size limit of user's profile banners",
603 description: "A map with poll limits for local polls",
607 max_option_chars: 200,
609 max_expiration: 31_536_000
616 description: "Maximum number of options",
620 key: :max_option_chars,
622 description: "Maximum number of characters per option",
626 key: :min_expiration,
628 description: "Minimum expiration time (in seconds)",
632 key: :max_expiration,
634 description: "Maximum expiration time (in seconds)",
640 key: :registrations_open,
643 "Enable registrations for anyone. Invitations require this setting to be disabled."
646 key: :invites_enabled,
649 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
652 key: :account_activation_required,
654 description: "Require users to confirm their emails before signing in."
659 description: "Enable federation with other instances."
662 key: :federation_incoming_replies_max_depth,
663 label: "Fed. incoming replies max depth",
666 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
667 " 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.",
673 key: :federation_reachability_timeout_days,
674 label: "Fed. reachability timeout days",
677 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
685 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
688 key: :rewrite_policy,
689 type: [:module, {:list, :module}],
691 "A list of enabled MRF policies. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
693 Generator.list_modules_in_dir(
694 "lib/pleroma/web/activity_pub/mrf",
695 "Elixir.Pleroma.Web.ActivityPub.MRF."
702 "Makes the client API in authentificated mode-only except for user-profiles." <>
703 " Useful for disabling the Local Timeline and The Whole Known Network."
706 key: :quarantined_instances,
707 type: {:list, :string},
709 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
716 key: :managed_config,
719 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
724 description: "Instance static directory",
730 key: :allowed_post_formats,
731 type: {:list, :string},
732 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
741 key: :mrf_transparency,
742 label: "MRF transparency",
745 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
748 key: :mrf_transparency_exclusions,
749 label: "MRF transparency exclusions",
750 type: {:list, :string},
752 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
758 key: :extended_nickname_format,
761 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
762 " This will break federation with older software for theses nicknames."
765 key: :cleanup_attachments,
768 Enable to remove associated attachments when status is removed.
769 This will not affect duplicates and attachments without status.
770 Enabling this will increase load to database when deleting statuses on larger instances.
774 key: :max_pinned_statuses,
776 description: "The maximum number of pinned statuses. 0 will disable the feature.",
784 key: :autofollowed_nicknames,
785 type: {:list, :string},
787 "Set to nicknames of (local) users that every new user should automatically follow",
796 key: :attachment_links,
798 description: "Enable to automatically add attachment link text to statuses"
801 key: :welcome_message,
804 "A message that will be sent to a newly registered users as a direct message",
806 "Hi, @username! Welcome on board!"
810 key: :welcome_user_nickname,
812 description: "The nickname of the local user that sends the welcome message",
818 key: :max_report_comment_size,
820 description: "The maximum size of the report comment. Default: 1000.",
826 key: :safe_dm_mentions,
829 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
830 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
836 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
839 key: :remote_post_retention_days,
842 "The default amount of days to retain remote posts when pruning the database",
848 key: :user_bio_length,
850 description: "A user bio maximum length. Default: 5000.",
856 key: :user_name_length,
858 description: "A user name maximum length. Default: 100.",
864 key: :skip_thread_containment,
866 description: "Skip filtering out broken threads. Default: enabled"
869 key: :limit_to_local_content,
870 type: {:dropdown, :atom},
872 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
880 key: :max_account_fields,
882 description: "The maximum number of custom fields in the user profile. Default: 10.",
888 key: :max_remote_account_fields,
891 "The maximum number of custom fields in the remote user profile. Default: 20.",
897 key: :account_field_name_length,
899 description: "An account field name maximum length. Default: 512.",
905 key: :account_field_value_length,
907 description: "An account field value maximum length. Default: 2048.",
913 key: :external_user_synchronization,
915 description: "Enabling following/followers counters synchronization for external users"
918 key: :multi_factor_authentication,
920 description: "Multi-factor authentication settings",
923 totp: [digits: 6, period: 30],
924 backup_codes: [number: 5, length: 16]
931 description: "TOTP settings",
932 suggestions: [digits: 6, period: 30],
939 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
946 "a period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
953 description: "MFA backup codes settings",
954 suggestions: [number: 5, length: 16],
960 description: "number of backup codes to generate."
967 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
978 description: "Logger-related settings",
982 type: [:atom, :tuple, :module],
984 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
985 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
993 description: "ExSyslogger-related settings",
997 type: {:dropdown, :atom},
998 description: "Log level",
999 suggestions: [:debug, :info, :warn, :error]
1005 "A string that's prepended to every message, and is typically set to the app name",
1006 suggestions: ["pleroma"]
1011 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1012 suggestions: ["$metadata[$level] $message"]
1016 type: {:list, :atom},
1017 suggestions: [:request_id]
1025 description: "Console logger settings",
1029 type: {:dropdown, :atom},
1030 description: "Log level",
1031 suggestions: [:debug, :info, :warn, :error]
1036 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1037 suggestions: ["$metadata[$level] $message"]
1041 type: {:list, :atom},
1042 suggestions: [:request_id]
1049 description: "Quack-related settings",
1053 type: {:dropdown, :atom},
1054 description: "Log level",
1055 suggestions: [:debug, :info, :warn, :error]
1059 type: {:list, :atom},
1060 description: "Configure which metadata you want to report on",
1078 description: "Configure the Slack incoming webhook",
1079 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1085 key: :frontend_configurations,
1088 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1089 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1090 "add your own configuration your settings all fields must be complete.",
1094 label: "Pleroma FE",
1096 description: "Settings for Pleroma FE",
1099 theme: "pleroma-dark",
1100 logo: "/static/logo.png",
1101 background: "/images/city.jpg",
1102 redirectRootNoLogin: "/main/all",
1103 redirectRootLogin: "/main/friends",
1104 showInstanceSpecificPanel: true,
1105 scopeOptionsEnabled: false,
1106 formattingOptionsEnabled: false,
1107 collapseMessageWithSubject: false,
1108 hidePostStats: false,
1109 hideUserStats: false,
1111 subjectLineBehavior: "email",
1112 alwaysShowSubjectInput: true,
1116 enableEmojiPicker: false
1123 description: "Which theme to use, they are defined in styles.json",
1124 suggestions: ["pleroma-dark"]
1129 description: "URL of the logo, defaults to Pleroma's logo",
1130 suggestions: ["/static/logo.png"]
1136 "URL of the background, unless viewing a user profile with a background that is set",
1137 suggestions: ["/images/city.jpg"]
1140 key: :redirectRootNoLogin,
1141 label: "Redirect root no login",
1144 "Relative URL which indicates where to redirect when a user isn't logged in",
1145 suggestions: ["/main/all"]
1148 key: :redirectRootLogin,
1149 label: "Redirect root login",
1152 "Relative URL which indicates where to redirect when a user is logged in",
1153 suggestions: ["/main/friends"]
1156 key: :showInstanceSpecificPanel,
1157 label: "Show instance specific panel",
1159 description: "Whenether to show the instance's specific panel"
1162 key: :scopeOptionsEnabled,
1163 label: "Scope options enabled",
1165 description: "Enable setting a notice visibility and subject/CW when posting"
1168 key: :formattingOptionsEnabled,
1169 label: "Formatting options enabled",
1172 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1175 key: :collapseMessageWithSubject,
1176 label: "Collapse message with subject",
1179 "When a message has a subject (aka Content Warning), collapse it by default"
1182 key: :hidePostStats,
1183 label: "Hide post stats",
1185 description: "Hide notices statistics (repeats, favorites, ...)"
1188 key: :hideUserStats,
1189 label: "Hide user stats",
1192 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1196 label: "Scope copy",
1198 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1201 key: :subjectLineBehavior,
1202 label: "Subject line behavior",
1204 description: "Allows changing the default behaviour of subject lines in replies.
1205 `email`: copy and preprend re:, as in email,
1206 `masto`: copy verbatim, as in Mastodon,
1207 `noop`: don't copy the subject.",
1208 suggestions: ["email", "masto", "noop"]
1211 key: :alwaysShowSubjectInput,
1212 label: "Always show subject input",
1214 description: "When disabled, auto-hide the subject field if it's empty"
1221 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1222 "If you want a colorful logo you must disable logoMask."
1226 label: "Logo margin",
1229 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1230 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1231 suggestions: [".1em"]
1236 description: "Enables stickers."
1239 key: :enableEmojiPicker,
1240 label: "Emoji picker",
1242 description: "Enables emoji picker."
1250 description: "Settings for Masto FE",
1253 showInstanceSpecificPanel: true
1258 key: :showInstanceSpecificPanel,
1259 label: "Show instance specific panel",
1261 description: "Whenether to show the instance's specific panel"
1272 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1276 type: {:keyword, :map},
1278 "Keyword of mascots, each element must contain both an url and a mime_type key",
1281 url: "/images/pleroma-fox-tan-smol.png",
1282 mime_type: "image/png"
1284 pleroma_fox_tan_shy: %{
1285 url: "/images/pleroma-fox-tan-shy.png",
1286 mime_type: "image/png"
1291 key: :default_mascot,
1294 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1306 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1310 type: {:list, :map},
1311 description: "Describe the icons of the app",
1314 src: "/static/logo.png"
1317 src: "/static/icon.png",
1321 src: "/static/icon.ico",
1322 sizes: "72x72 96x96 128x128 256x256"
1329 description: "Describe the theme color of the app",
1330 suggestions: ["#282c37", "mediumpurple"]
1333 key: :background_color,
1335 description: "Describe the background color of the app",
1336 suggestions: ["#191b22", "aliceblue"]
1343 label: "MRF simple",
1345 description: "Message Rewrite Facility",
1348 key: :media_removal,
1349 type: {:list, :string},
1350 description: "List of instances to strip media attachments from",
1351 suggestions: ["example.com", "*.example.com"]
1355 label: "Media NSFW",
1356 type: {:list, :string},
1357 description: "List of instances to tag all media as NSFW (sensitive) from",
1358 suggestions: ["example.com", "*.example.com"]
1361 key: :federated_timeline_removal,
1362 type: {:list, :string},
1364 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1365 suggestions: ["example.com", "*.example.com"]
1369 type: {:list, :string},
1370 description: "List of instances to reject activities from (except deletes)",
1371 suggestions: ["example.com", "*.example.com"]
1375 type: {:list, :string},
1376 description: "List of instances to only accept activities from (except deletes)",
1377 suggestions: ["example.com", "*.example.com"]
1380 key: :report_removal,
1381 type: {:list, :string},
1382 description: "List of instances to reject reports from",
1383 suggestions: ["example.com", "*.example.com"]
1386 key: :avatar_removal,
1387 type: {:list, :string},
1388 description: "List of instances to strip avatars from",
1389 suggestions: ["example.com", "*.example.com"]
1392 key: :banner_removal,
1393 type: {:list, :string},
1394 description: "List of instances to strip banners from",
1395 suggestions: ["example.com", "*.example.com"]
1398 key: :reject_deletes,
1399 type: {:list, :string},
1400 description: "List of instances to reject deletions from",
1401 suggestions: ["example.com", "*.example.com"]
1408 label: "MRF subchain",
1411 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1412 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1417 description: "Matches a series of regular expressions against the actor field",
1420 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1428 key: :mrf_rejectnonpublic,
1430 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1431 label: "MRF reject non public",
1435 key: :allow_followersonly,
1436 label: "Allow followers-only",
1438 description: "Whether to allow followers-only posts"
1443 description: "Whether to allow direct messages"
1449 key: :mrf_hellthread,
1450 label: "MRF hellthread",
1452 description: "Block messages with too much mentions",
1455 key: :delist_threshold,
1458 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1459 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1463 key: :reject_threshold,
1466 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1474 label: "MRF keyword",
1476 description: "Reject or Word-Replace messages with a keyword or regex",
1480 type: [:string, :regex],
1482 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1483 suggestions: ["foo", ~r/foo/iu]
1486 key: :federated_timeline_removal,
1487 type: [:string, :regex],
1489 "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.",
1490 suggestions: ["foo", ~r/foo/iu]
1494 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1496 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1497 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1504 label: "MRF mention",
1506 description: "Block messages which mention a user",
1510 type: {:list, :string},
1511 description: "A list of actors for which any post mentioning them will be dropped.",
1512 suggestions: ["actor1", "actor2"]
1518 key: :mrf_vocabulary,
1519 label: "MRF vocabulary",
1521 description: "Filter messages which belong to certain activity vocabularies",
1525 type: {:list, :string},
1527 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1528 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1532 type: {:list, :string},
1534 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1535 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1541 # key: :mrf_user_allowlist,
1544 # "The keys in this section are the domain names that the policy should apply to." <>
1545 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1547 # ["example.org": ["https://example.org/users/admin"]],
1549 # ["example.org": ["https://example.org/users/admin"]]
1557 description: "Media proxy",
1562 description: "Enables proxying of remote media to the instance's proxy"
1568 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1569 suggestions: ["https://example.com"]
1574 description: "Options for Pleroma.ReverseProxy",
1576 redirect_on_failure: false,
1577 max_body_length: 25 * 1_048_576,
1579 follow_redirect: true,
1585 key: :redirect_on_failure,
1588 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1589 "Any error during body processing will not be redirected as the response is chunked."
1592 key: :max_body_length,
1595 "Limits the content length to be approximately the " <>
1596 "specified length. It is validated with the `content-length` header and also verified when proxying."
1601 description: "HTTP options",
1606 description: "Adapter specific options",
1611 label: "SSL Options",
1612 description: "SSL options for HTTP adapter",
1616 type: {:list, :atom},
1617 description: "List of TLS version to use",
1618 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1627 type: [:string, :tuple],
1628 description: "Proxy URL",
1629 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1637 type: {:list, :string},
1638 description: "List of domains to bypass the mediaproxy",
1639 suggestions: ["example.com"]
1647 description: "Gopher settings",
1652 description: "Enables the gopher interface"
1657 description: "IP address to bind to",
1658 suggestions: [{0, 0, 0, 0}]
1663 description: "Port to bind to",
1669 description: "Port advertised in urls (optional, defaults to port)",
1678 description: "ActivityPub-related settings",
1681 key: :unfollow_blocked,
1683 description: "Whether blocks result in people getting unfollowed"
1686 key: :outgoing_blocks,
1688 description: "Whether to federate blocks to other instances"
1691 key: :sign_object_fetches,
1693 description: "Sign object fetches with HTTP signatures"
1696 key: :note_replies_output_limit,
1699 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1702 key: :follow_handshake_timeout,
1704 description: "Following handshake timeout",
1711 key: :http_security,
1713 description: "HTTP security settings",
1718 description: "Whether the managed content security policy is enabled"
1724 description: "Whether to additionally send a Strict-Transport-Security header"
1728 label: "STS max age",
1730 description: "The maximum age for the Strict-Transport-Security header if sent",
1731 suggestions: [31_536_000]
1735 label: "CT max age",
1737 description: "The maximum age for the Expect-CT header if sent",
1738 suggestions: [2_592_000]
1741 key: :referrer_policy,
1743 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1744 suggestions: ["same-origin", "no-referrer"]
1748 label: "Report URI",
1750 description: "Adds the specified url to report-uri and report-to group in CSP header",
1751 suggestions: ["https://example.com/report-uri"]
1756 group: :web_push_encryption,
1757 key: :vapid_details,
1760 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1766 "A mailto link for the administrative contact." <>
1767 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1768 suggestions: ["mailto:moderators@pleroma.com"]
1773 description: "VAPID public key",
1774 suggestions: ["Public key"]
1779 description: "VAPID private key",
1780 suggestions: ["Private key"]
1786 key: Pleroma.Captcha,
1788 description: "Captcha-related settings",
1793 description: "Whether the captcha should be shown on registration"
1798 description: "The method/service to use for captcha",
1799 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1802 key: :seconds_valid,
1804 description: "The time in seconds for which the captcha is valid",
1811 key: Pleroma.Captcha.Kocaptcha,
1814 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1815 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1820 description: "The kocaptcha endpoint to use",
1821 suggestions: ["https://captcha.kotobank.ch"]
1829 "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",
1834 description: "Token",
1835 suggestions: ["We recommend a secure random string or UUID"]
1844 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1846 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1847 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1848 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1849 (see https://github.com/sorentwo/oban/issues/52).
1854 type: {:dropdown, :atom},
1855 description: "Logs verbose mode",
1856 suggestions: [false, :error, :warn, :info, :debug]
1860 type: [:atom, :tuple],
1862 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1863 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1867 type: {:keyword, :integer},
1869 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1871 activity_expiration: 10,
1872 attachments_cleanup: 5,
1874 federator_incoming: 50,
1875 federator_outgoing: 50,
1877 scheduled_activities: 10,
1883 key: :activity_expiration,
1885 description: "Activity expiration queue",
1889 key: :attachments_cleanup,
1891 description: "Attachment deletion queue",
1897 description: "Background queue",
1901 key: :federator_incoming,
1903 description: "Incoming federation queue",
1907 key: :federator_outgoing,
1909 description: "Outgoing federation queue",
1915 description: "Email sender queue, see Pleroma.Emails.Mailer",
1919 key: :scheduled_activities,
1921 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1925 key: :transmogrifier,
1927 description: "Transmogrifier queue",
1933 description: "Web push notifications queue",
1940 type: {:list, :tuple},
1941 description: "Settings for cron background jobs",
1943 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1944 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1945 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1946 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1947 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1956 description: "Includes custom worker options not interpretable directly by `Oban`",
1960 type: {:keyword, :integer},
1961 description: "Max retry attempts for failed jobs, per `Oban` queue",
1963 federator_incoming: 5,
1964 federator_outgoing: 5
1971 key: Pleroma.Web.Metadata,
1973 description: "Metadata-related settings",
1977 type: {:list, :module},
1978 description: "List of metadata providers to enable",
1980 Pleroma.Web.Metadata.Providers.OpenGraph,
1981 Pleroma.Web.Metadata.Providers.TwitterCard,
1982 Pleroma.Web.Metadata.Providers.RelMe,
1983 Pleroma.Web.Metadata.Providers.Feed
1988 label: "Unfurl NSFW",
1990 description: "When enabled NSFW attachments will be shown in previews"
1999 "If enabled the instance will parse metadata from attached links to generate link previews.",
2004 description: "Enables RichMedia parsing of URLs."
2008 type: {:list, :string},
2009 description: "List of hosts which will be ignored by the metadata parser.",
2010 suggestions: ["accounts.google.com", "xss.website"]
2014 label: "Ignore TLD",
2015 type: {:list, :string},
2016 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2017 suggestions: ["local", "localdomain", "lan"]
2021 type: {:list, :module},
2023 "List of Rich Media parsers. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parsers.` part), but on adding custom module you need to use full name.",
2025 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2026 Pleroma.Web.RichMedia.Parsers.OEmbed,
2027 Pleroma.Web.RichMedia.Parsers.OGP,
2028 Pleroma.Web.RichMedia.Parsers.TwitterCard
2033 label: "TTL setters",
2034 type: {:list, :module},
2036 "List of rich media TTL setters. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parser.` part), but on adding custom module you need to use full name.",
2038 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2044 group: :auto_linker,
2047 description: "Configuration for the auto_linker library",
2051 type: [:string, false],
2052 description: "Specify the class to be added to the generated link. Disable to clear",
2053 suggestions: ["auto-linker", false]
2057 type: [:string, false],
2058 description: "Override the rel attribute. Disable to clear",
2059 suggestions: ["ugc", "noopener noreferrer", false]
2064 description: "Link urls will open in new window/tab"
2068 type: [:integer, false],
2070 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2071 suggestions: [15, false]
2076 description: "Strip the scheme prefix"
2081 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2087 key: Pleroma.ScheduledActivity,
2089 description: "Scheduled activities settings",
2092 key: :daily_user_limit,
2095 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2099 key: :total_user_limit,
2102 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2108 description: "Whether scheduled activities are sent to the job queue to be executed"
2114 key: Pleroma.ActivityExpiration,
2116 description: "Expired activity settings",
2121 description: "Whether expired activities will be sent to the job queue to be deleted"
2128 description: "Authenticator",
2131 key: Pleroma.Web.Auth.Authenticator,
2133 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2142 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2143 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2144 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2145 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2150 description: "Enables LDAP authentication"
2155 description: "LDAP server hostname",
2156 suggestions: ["localhosts"]
2161 description: "LDAP port, e.g. 389 or 636",
2162 suggestions: [389, 636]
2168 description: "Enable to use SSL, usually implies the port 636"
2172 label: "SSL options",
2174 description: "Additional SSL options",
2175 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2180 description: "Path to file with PEM encoded cacerts",
2181 suggestions: ["path/to/file/with/PEM/cacerts"]
2186 description: "Type of cert verification",
2187 suggestions: [:verify_peer]
2195 description: "Enable to use STARTTLS, usually implies the port 389"
2199 label: "TLS options",
2201 description: "Additional TLS options",
2202 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2207 description: "Path to file with PEM encoded cacerts",
2208 suggestions: ["path/to/file/with/PEM/cacerts"]
2213 description: "Type of cert verification",
2214 suggestions: [:verify_peer]
2221 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2222 suggestions: ["dc=example,dc=com"]
2228 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2237 description: "Authentication / authorization settings",
2240 key: :enforce_oauth_admin_scope_usage,
2243 "OAuth admin scope requirement toggle. " <>
2244 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2245 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2246 "`is_admin` user flag grants access to admin-specific actions."
2249 key: :auth_template,
2252 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2253 suggestions: ["show.html"]
2256 key: :oauth_consumer_template,
2259 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2260 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2261 suggestions: ["consumer.html"]
2264 key: :oauth_consumer_strategies,
2265 type: {:list, :string},
2267 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2268 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2269 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2270 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2276 key: :email_notifications,
2278 description: "Email notifications settings",
2284 "emails of \"what you've missed\" for users who have been inactive for a while",
2288 schedule: "0 0 * * 0",
2290 inactivity_threshold: 7
2298 description: "Globally enable or disable digest emails"
2304 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2305 suggestions: ["0 0 * * 0"]
2310 description: "Minimum interval between digest emails to one user",
2314 key: :inactivity_threshold,
2316 description: "Minimum user inactivity threshold",
2325 key: Pleroma.Emails.UserEmail,
2327 description: "Email template settings",
2332 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2333 suggestions: ["some/path/logo.png"]
2338 description: "a map with color settings for email templates.",
2341 link_color: "#d8a070",
2342 background_color: "#2C3645",
2343 content_background_color: "#1B2635",
2344 header_color: "#d8a070",
2345 text_color: "#b9b9ba",
2346 text_muted_color: "#b9b9ba"
2353 suggestions: ["#d8a070"]
2356 key: :background_color,
2358 suggestions: ["#2C3645"]
2361 key: :content_background_color,
2363 suggestions: ["#1B2635"]
2368 suggestions: ["#d8a070"]
2373 suggestions: ["#b9b9ba"]
2376 key: :text_muted_color,
2378 suggestions: ["#b9b9ba"]
2386 key: Pleroma.Emails.NewUsersDigestEmail,
2388 description: "New users admin email digest",
2393 description: "enables new users admin digest email when `true`",
2394 suggestions: [false]
2402 description: "Configure OAuth 2 provider capabilities",
2405 key: :token_expires_in,
2407 description: "The lifetime in seconds of the access token",
2411 key: :issue_new_refresh_token,
2414 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2417 key: :clean_expired_tokens,
2419 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2429 key: :shortcode_globs,
2430 type: {:list, :string},
2431 description: "Location of custom emoji files. * can be used as a wildcard.",
2432 suggestions: ["/emoji/custom/**/*.png"]
2435 key: :pack_extensions,
2436 type: {:list, :string},
2438 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2439 suggestions: [".png", ".gif"]
2443 type: {:keyword, :string, {:list, :string}},
2445 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2446 " and the value is the location or array of locations. * can be used as a wildcard.",
2448 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2452 key: :default_manifest,
2455 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2456 " Currently only one manifest can be added (no arrays).",
2457 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2460 key: :shared_pack_cache_seconds_per_file,
2461 label: "Shared pack cache s/file",
2464 "When an emoji pack is shared, the archive is created and cached in memory" <>
2465 " for this amount of seconds multiplied by the number of files.",
2475 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2479 type: [:tuple, {:list, :tuple}],
2480 description: "For the search requests (account & status search etc.)",
2481 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2485 type: [:tuple, {:list, :tuple}],
2486 description: "For requests to timelines (each timeline has it's own limiter)",
2487 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2490 key: :app_account_creation,
2491 type: [:tuple, {:list, :tuple}],
2492 description: "For registering user accounts from the same IP address",
2493 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2496 key: :relations_actions,
2497 type: [:tuple, {:list, :tuple}],
2498 description: "For actions on relationships with all users (follow, unfollow)",
2499 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2502 key: :relation_id_action,
2503 type: [:tuple, {:list, :tuple}],
2504 description: "For actions on relation with a specific user (follow, unfollow)",
2505 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2508 key: :statuses_actions,
2509 type: [:tuple, {:list, :tuple}],
2511 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2512 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2515 key: :status_id_action,
2516 type: [:tuple, {:list, :tuple}],
2518 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2519 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2522 key: :authentication,
2523 type: [:tuple, {:list, :tuple}],
2524 description: "For authentication create / password check / user existence check requests",
2525 suggestions: [{60_000, 15}]
2533 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2534 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2539 description: "Enables SSH"
2544 description: "Dir with SSH keys",
2545 suggestions: ["/some/path/ssh_keys"]
2550 description: "Handler module",
2551 suggestions: ["Pleroma.BBS.Handler"]
2556 description: "Port to connect",
2557 suggestions: [10_022]
2560 key: :password_authenticator,
2562 description: "Authenticator module",
2563 suggestions: ["Pleroma.BBS.Authenticator"]
2570 description: "Mime types",
2577 "application/xml" => ["xml"],
2578 "application/xrd+xml" => ["xrd+xml"],
2579 "application/jrd+json" => ["jrd+json"],
2580 "application/activity+json" => ["activity+json"],
2581 "application/ld+json" => ["activity+json"]
2586 key: "application/xml",
2587 type: {:list, :string},
2588 suggestions: ["xml"]
2591 key: "application/xrd+xml",
2592 type: {:list, :string},
2593 suggestions: ["xrd+xml"]
2596 key: "application/jrd+json",
2597 type: {:list, :string},
2598 suggestions: ["jrd+json"]
2601 key: "application/activity+json",
2602 type: {:list, :string},
2603 suggestions: ["activity+json"]
2606 key: "application/ld+json",
2607 type: {:list, :string},
2608 suggestions: ["activity+json"]
2618 description: "Pleroma chat settings",
2630 description: "HTTP settings",
2635 type: [:string, :tuple],
2636 description: "Proxy URL",
2637 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2640 key: :send_user_agent,
2645 type: [:string, :atom],
2647 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2648 suggestions: ["Pleroma", :default]
2653 description: "Adapter specific options",
2659 label: "SSL Options",
2660 description: "SSL options for HTTP adapter",
2664 type: {:list, :atom},
2665 description: "List of TLS version to use",
2666 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2680 key: :allow_inline_images,
2684 key: :allow_headings,
2697 type: {:list, :module},
2699 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2700 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2710 key: :deny_follow_blocked,
2717 key: :mrf_normalize_markup,
2718 label: "MRF normalize markup",
2719 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2725 suggestions: [Pleroma.HTML.Scrubber.Default]
2735 key: :restricted_nicknames,
2736 type: {:list, :string},
2755 "ostatus_subscribe",
2779 suggestions: [86_400]
2783 type: {:list, :string},
2784 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2788 type: {:list, :string},
2791 "X-RateLimit-Reset",
2792 "X-RateLimit-Limit",
2793 "X-RateLimit-Remaining",
2804 type: {:list, :string},
2805 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2811 key: Pleroma.Plugs.RemoteIp,
2814 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2815 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2821 description: "Enable/disable the plug. Default: disabled."
2825 type: {:list, :string},
2827 "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]`."
2831 type: {:list, :string},
2833 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2837 type: {:list, :string},
2839 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2845 key: :web_cache_ttl,
2848 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2854 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2855 suggestions: [30_000, nil]
2858 key: :activity_pub_question,
2860 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2861 suggestions: [30_000]
2870 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2875 description: "Enables the rendering of static HTML. Default: disabled."
2883 description: "Configure feed rendering",
2888 description: "Configure title rendering.",
2893 description: "Maximum number of characters before truncating title.",
2899 description: "Replacement which will be used after truncating string.",
2900 suggestions: ["..."]
2908 key: :mrf_object_age,
2910 description: "Rejects or delists posts based on their age when received.",
2915 description: "Required age (in seconds) of a post before actions are taken.",
2916 suggestions: [172_800]
2920 type: {:list, :atom},
2922 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2923 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2924 "`:reject` rejects the message entirely",
2925 suggestions: [:delist, :strip_followers, :reject]
2933 description: "Custom Runtime Modules",
2938 description: "A path to custom Elixir modules (such as MRF policies)."
2946 description: "Settings for notifications streamer",
2951 description: "Number of workers to send notifications.",
2955 key: :overflow_workers,
2957 description: "Maximum number of workers created if pool is empty.",
2964 key: :connections_pool,
2966 description: "Advanced settings for `gun` connections pool",
2969 key: :checkin_timeout,
2971 description: "Timeout to checkin connection from pool. Default: 250ms.",
2975 key: :max_connections,
2977 description: "Maximum number of connections in the pool. Default: 250 connections.",
2984 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
2988 key: :retry_timeout,
2991 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
2995 key: :await_up_timeout,
2997 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3006 description: "Advanced settings for `gun` workers pools",
3011 description: "Settings for federation pool.",
3016 description: "Number workers in the pool.",
3022 description: "Number of additional workers if pool is under load.",
3028 description: "Timeout while `gun` will wait for response.",
3029 suggestions: [150_000]
3036 description: "Settings for media pool.",
3041 description: "Number workers in the pool.",
3047 description: "Number of additional workers if pool is under load.",
3053 description: "Timeout while `gun` will wait for response.",
3054 suggestions: [150_000]
3061 description: "Settings for upload pool.",
3066 description: "Number workers in the pool.",
3072 description: "Number of additional workers if pool is under load.",
3078 description: "Timeout while `gun` will wait for response.",
3079 suggestions: [300_000]
3086 description: "Settings for default pool.",
3091 description: "Number workers in the pool.",
3097 description: "Number of additional workers if pool is under load.",
3103 description: "Timeout while `gun` will wait for response.",
3104 suggestions: [10_000]
3112 key: :hackney_pools,
3114 description: "Advanced settings for `hackney` connections pools",
3119 description: "Settings for federation pool.",
3122 key: :max_connections,
3124 description: "Number workers in the pool.",
3130 description: "Timeout while `hackney` will wait for response.",
3131 suggestions: [150_000]
3138 description: "Settings for media pool.",
3141 key: :max_connections,
3143 description: "Number workers in the pool.",
3149 description: "Timeout while `hackney` will wait for response.",
3150 suggestions: [150_000]
3157 description: "Settings for upload pool.",
3160 key: :max_connections,
3162 description: "Number workers in the pool.",
3168 description: "Timeout while `hackney` will wait for response.",
3169 suggestions: [300_000]
3177 key: :restrict_unauthenticated,
3180 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3185 description: "Settings for public and federated timelines.",
3190 description: "Disallow view public timeline."
3195 description: "Disallow view federated timeline."
3202 description: "Settings for user profiles.",
3207 description: "Disallow view local user profiles."
3212 description: "Disallow view remote user profiles."
3219 description: "Settings for statuses.",
3224 description: "Disallow view local statuses."
3229 description: "Disallow view remote statuses."
3237 key: Pleroma.Web.ApiSpec.CastAndValidate,
3244 "Enables strict input validation (useful in development, not recommended in production)",
3245 suggestions: [false]