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 versions 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",
538 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
546 description: "Posts character limit (CW/Subject included in the counter)",
554 description: "Character limit of the instance chat messages",
562 description: "Hard character limit beyond which remote posts will be dropped",
570 description: "File size limit of uploads (except for avatar, background, banner)",
576 key: :avatar_upload_limit,
578 description: "File size limit of user's profile avatars",
584 key: :background_upload_limit,
586 description: "File size limit of user's profile backgrounds",
592 key: :banner_upload_limit,
594 description: "File size limit of user's profile banners",
602 description: "A map with poll limits for local polls",
606 max_option_chars: 200,
608 max_expiration: 31_536_000
615 description: "Maximum number of options",
619 key: :max_option_chars,
621 description: "Maximum number of characters per option",
625 key: :min_expiration,
627 description: "Minimum expiration time (in seconds)",
631 key: :max_expiration,
633 description: "Maximum expiration time (in seconds)",
639 key: :registrations_open,
642 "Enable registrations for anyone. Invitations require this setting to be disabled."
645 key: :invites_enabled,
648 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
651 key: :account_activation_required,
653 description: "Require users to confirm their emails before signing in."
658 description: "Enable federation with other instances."
661 key: :federation_incoming_replies_max_depth,
662 label: "Fed. incoming replies max depth",
665 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
666 " 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.",
672 key: :federation_reachability_timeout_days,
673 label: "Fed. reachability timeout days",
676 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
682 key: :federation_publisher_modules,
683 type: {:list, :module},
684 description: "List of modules for federation publishing",
686 Pleroma.Web.ActivityPub.Publisher
692 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
695 key: :rewrite_policy,
696 type: [:module, {:list, :module}],
697 description: "A list of MRF policies enabled",
699 Generator.list_modules_in_dir(
700 "lib/pleroma/web/activity_pub/mrf",
701 "Elixir.Pleroma.Web.ActivityPub.MRF."
708 "Makes the client API in authentificated mode-only except for user-profiles." <>
709 " Useful for disabling the Local Timeline and The Whole Known Network."
712 key: :quarantined_instances,
713 type: {:list, :string},
715 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
722 key: :managed_config,
725 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
730 description: "Instance static directory",
736 key: :allowed_post_formats,
737 type: {:list, :string},
738 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
747 key: :mrf_transparency,
748 label: "MRF transparency",
751 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
754 key: :mrf_transparency_exclusions,
755 label: "MRF transparency exclusions",
756 type: {:list, :string},
758 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
764 key: :extended_nickname_format,
767 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
768 " This will break federation with older software for theses nicknames."
771 key: :cleanup_attachments,
774 Enable to remove associated attachments when status is removed.
775 This will not affect duplicates and attachments without status.
776 Enabling this will increase load to database when deleting statuses on larger instances.
780 key: :max_pinned_statuses,
782 description: "The maximum number of pinned statuses. 0 will disable the feature.",
790 key: :autofollowed_nicknames,
791 type: {:list, :string},
793 "Set to nicknames of (local) users that every new user should automatically follow",
802 key: :attachment_links,
804 description: "Enable to automatically add attachment link text to statuses"
807 key: :welcome_message,
810 "A message that will be sent to a newly registered users as a direct message",
812 "Hi, @username! Welcome on board!"
816 key: :welcome_user_nickname,
818 description: "The nickname of the local user that sends the welcome message",
824 key: :max_report_comment_size,
826 description: "The maximum size of the report comment. Default: 1000.",
832 key: :safe_dm_mentions,
835 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
836 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
842 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
845 key: :remote_post_retention_days,
848 "The default amount of days to retain remote posts when pruning the database",
854 key: :user_bio_length,
856 description: "A user bio maximum length. Default: 5000.",
862 key: :user_name_length,
864 description: "A user name maximum length. Default: 100.",
870 key: :skip_thread_containment,
872 description: "Skip filtering out broken threads. Default: enabled"
875 key: :limit_to_local_content,
876 type: {:dropdown, :atom},
878 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
886 key: :max_account_fields,
888 description: "The maximum number of custom fields in the user profile. Default: 10.",
894 key: :max_remote_account_fields,
897 "The maximum number of custom fields in the remote user profile. Default: 20.",
903 key: :account_field_name_length,
905 description: "An account field name maximum length. Default: 512.",
911 key: :account_field_value_length,
913 description: "An account field value maximum length. Default: 2048.",
919 key: :external_user_synchronization,
921 description: "Enabling following/followers counters synchronization for external users"
924 key: :multi_factor_authentication,
926 description: "Multi-factor authentication settings",
929 totp: [digits: 6, period: 30],
930 backup_codes: [number: 5, length: 16]
937 description: "TOTP settings",
938 suggestions: [digits: 6, period: 30],
945 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
952 "a period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
959 description: "MFA backup codes settings",
960 suggestions: [number: 5, length: 16],
966 description: "number of backup codes to generate."
973 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
984 description: "Logger-related settings",
988 type: [:atom, :tuple, :module],
990 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
991 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
999 description: "ExSyslogger-related settings",
1003 type: {:dropdown, :atom},
1004 description: "Log level",
1005 suggestions: [:debug, :info, :warn, :error]
1011 "A string that's prepended to every message, and is typically set to the app name",
1012 suggestions: ["pleroma"]
1017 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1018 suggestions: ["$metadata[$level] $message"]
1022 type: {:list, :atom},
1023 suggestions: [:request_id]
1031 description: "Console logger settings",
1035 type: {:dropdown, :atom},
1036 description: "Log level",
1037 suggestions: [:debug, :info, :warn, :error]
1042 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1043 suggestions: ["$metadata[$level] $message"]
1047 type: {:list, :atom},
1048 suggestions: [:request_id]
1055 description: "Quack-related settings",
1059 type: {:dropdown, :atom},
1060 description: "Log level",
1061 suggestions: [:debug, :info, :warn, :error]
1065 type: {:list, :atom},
1066 description: "Configure which metadata you want to report on",
1084 description: "Configure the Slack incoming webhook",
1085 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1091 key: :frontend_configurations,
1094 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1095 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1096 "add your own configuration your settings all fields must be complete.",
1100 label: "Pleroma FE",
1102 description: "Settings for Pleroma FE",
1105 theme: "pleroma-dark",
1106 logo: "/static/logo.png",
1107 background: "/images/city.jpg",
1108 redirectRootNoLogin: "/main/all",
1109 redirectRootLogin: "/main/friends",
1110 showInstanceSpecificPanel: true,
1111 scopeOptionsEnabled: false,
1112 formattingOptionsEnabled: false,
1113 collapseMessageWithSubject: false,
1114 hidePostStats: false,
1115 hideUserStats: false,
1117 subjectLineBehavior: "email",
1118 alwaysShowSubjectInput: true,
1122 enableEmojiPicker: false
1129 description: "Which theme to use, they are defined in styles.json",
1130 suggestions: ["pleroma-dark"]
1135 description: "URL of the logo, defaults to Pleroma's logo",
1136 suggestions: ["/static/logo.png"]
1142 "URL of the background, unless viewing a user profile with a background that is set",
1143 suggestions: ["/images/city.jpg"]
1146 key: :redirectRootNoLogin,
1147 label: "Redirect root no login",
1150 "Relative URL which indicates where to redirect when a user isn't logged in",
1151 suggestions: ["/main/all"]
1154 key: :redirectRootLogin,
1155 label: "Redirect root login",
1158 "Relative URL which indicates where to redirect when a user is logged in",
1159 suggestions: ["/main/friends"]
1162 key: :showInstanceSpecificPanel,
1163 label: "Show instance specific panel",
1165 description: "Whenether to show the instance's specific panel"
1168 key: :scopeOptionsEnabled,
1169 label: "Scope options enabled",
1171 description: "Enable setting a notice visibility and subject/CW when posting"
1174 key: :formattingOptionsEnabled,
1175 label: "Formatting options enabled",
1178 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1181 key: :collapseMessageWithSubject,
1182 label: "Collapse message with subject",
1185 "When a message has a subject (aka Content Warning), collapse it by default"
1188 key: :hidePostStats,
1189 label: "Hide post stats",
1191 description: "Hide notices statistics (repeats, favorites, ...)"
1194 key: :hideUserStats,
1195 label: "Hide user stats",
1198 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1202 label: "Scope copy",
1204 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1207 key: :subjectLineBehavior,
1208 label: "Subject line behavior",
1210 description: "Allows changing the default behaviour of subject lines in replies.
1211 `email`: copy and preprend re:, as in email,
1212 `masto`: copy verbatim, as in Mastodon,
1213 `noop`: don't copy the subject.",
1214 suggestions: ["email", "masto", "noop"]
1217 key: :alwaysShowSubjectInput,
1218 label: "Always show subject input",
1220 description: "When disabled, auto-hide the subject field if it's empty"
1227 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1228 "If you want a colorful logo you must disable logoMask."
1232 label: "Logo margin",
1235 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1236 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1237 suggestions: [".1em"]
1242 description: "Enables stickers."
1245 key: :enableEmojiPicker,
1246 label: "Emoji picker",
1248 description: "Enables emoji picker."
1256 description: "Settings for Masto FE",
1259 showInstanceSpecificPanel: true
1264 key: :showInstanceSpecificPanel,
1265 label: "Show instance specific panel",
1267 description: "Whenether to show the instance's specific panel"
1278 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1282 type: {:keyword, :map},
1284 "Keyword of mascots, each element must contain both an url and a mime_type key",
1287 url: "/images/pleroma-fox-tan-smol.png",
1288 mime_type: "image/png"
1290 pleroma_fox_tan_shy: %{
1291 url: "/images/pleroma-fox-tan-shy.png",
1292 mime_type: "image/png"
1297 key: :default_mascot,
1300 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1312 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1316 type: {:list, :map},
1317 description: "Describe the icons of the app",
1320 src: "/static/logo.png"
1323 src: "/static/icon.png",
1327 src: "/static/icon.ico",
1328 sizes: "72x72 96x96 128x128 256x256"
1335 description: "Describe the theme color of the app",
1336 suggestions: ["#282c37", "mediumpurple"]
1339 key: :background_color,
1341 description: "Describe the background color of the app",
1342 suggestions: ["#191b22", "aliceblue"]
1349 label: "MRF simple",
1351 description: "Message Rewrite Facility",
1354 key: :media_removal,
1355 type: {:list, :string},
1356 description: "List of instances to strip media attachments from",
1357 suggestions: ["example.com", "*.example.com"]
1361 label: "Media NSFW",
1362 type: {:list, :string},
1363 description: "List of instances to tag all media as NSFW (sensitive) from",
1364 suggestions: ["example.com", "*.example.com"]
1367 key: :federated_timeline_removal,
1368 type: {:list, :string},
1370 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1371 suggestions: ["example.com", "*.example.com"]
1375 type: {:list, :string},
1376 description: "List of instances to reject activities from (except deletes)",
1377 suggestions: ["example.com", "*.example.com"]
1381 type: {:list, :string},
1382 description: "List of instances to only accept activities from (except deletes)",
1383 suggestions: ["example.com", "*.example.com"]
1386 key: :report_removal,
1387 type: {:list, :string},
1388 description: "List of instances to reject reports from",
1389 suggestions: ["example.com", "*.example.com"]
1392 key: :avatar_removal,
1393 type: {:list, :string},
1394 description: "List of instances to strip avatars from",
1395 suggestions: ["example.com", "*.example.com"]
1398 key: :banner_removal,
1399 type: {:list, :string},
1400 description: "List of instances to strip banners from",
1401 suggestions: ["example.com", "*.example.com"]
1404 key: :reject_deletes,
1405 type: {:list, :string},
1406 description: "List of instances to reject deletions from",
1407 suggestions: ["example.com", "*.example.com"]
1414 label: "MRF subchain",
1417 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1418 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1423 description: "Matches a series of regular expressions against the actor field",
1426 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1434 key: :mrf_rejectnonpublic,
1436 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1437 label: "MRF reject non public",
1441 key: :allow_followersonly,
1442 label: "Allow followers-only",
1444 description: "Whether to allow followers-only posts"
1449 description: "Whether to allow direct messages"
1455 key: :mrf_hellthread,
1456 label: "MRF hellthread",
1458 description: "Block messages with too much mentions",
1461 key: :delist_threshold,
1464 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1465 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1469 key: :reject_threshold,
1472 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1480 label: "MRF keyword",
1482 description: "Reject or Word-Replace messages with a keyword or regex",
1486 type: [:string, :regex],
1488 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1489 suggestions: ["foo", ~r/foo/iu]
1492 key: :federated_timeline_removal,
1493 type: [:string, :regex],
1495 "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.",
1496 suggestions: ["foo", ~r/foo/iu]
1500 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1502 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1503 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1510 label: "MRF mention",
1512 description: "Block messages which mention a user",
1516 type: {:list, :string},
1517 description: "A list of actors for which any post mentioning them will be dropped.",
1518 suggestions: ["actor1", "actor2"]
1524 key: :mrf_vocabulary,
1525 label: "MRF vocabulary",
1527 description: "Filter messages which belong to certain activity vocabularies",
1531 type: {:list, :string},
1533 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1534 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1538 type: {:list, :string},
1540 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1541 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1547 # key: :mrf_user_allowlist,
1550 # "The keys in this section are the domain names that the policy should apply to." <>
1551 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1553 # ["example.org": ["https://example.org/users/admin"]],
1555 # ["example.org": ["https://example.org/users/admin"]]
1563 description: "Media proxy",
1568 description: "Enables proxying of remote media to the instance's proxy"
1574 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1575 suggestions: ["https://example.com"]
1580 description: "Options for Pleroma.ReverseProxy",
1582 redirect_on_failure: false,
1583 max_body_length: 25 * 1_048_576,
1585 follow_redirect: true,
1591 key: :redirect_on_failure,
1594 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1595 "Any error during body processing will not be redirected as the response is chunked."
1598 key: :max_body_length,
1601 "Limits the content length to be approximately the " <>
1602 "specified length. It is validated with the `content-length` header and also verified when proxying."
1607 description: "HTTP options",
1612 description: "Adapter specific options",
1617 label: "SSL Options",
1618 description: "SSL options for HTTP adapter",
1622 type: {:list, :atom},
1623 description: "List of TLS version to use",
1624 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1633 type: [:string, :tuple],
1634 description: "Proxy URL",
1635 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1643 type: {:list, :string},
1644 description: "List of domains to bypass the mediaproxy",
1645 suggestions: ["example.com"]
1653 description: "Gopher settings",
1658 description: "Enables the gopher interface"
1663 description: "IP address to bind to",
1664 suggestions: [{0, 0, 0, 0}]
1669 description: "Port to bind to",
1675 description: "Port advertised in urls (optional, defaults to port)",
1684 description: "ActivityPub-related settings",
1687 key: :unfollow_blocked,
1689 description: "Whether blocks result in people getting unfollowed"
1692 key: :outgoing_blocks,
1694 description: "Whether to federate blocks to other instances"
1697 key: :sign_object_fetches,
1699 description: "Sign object fetches with HTTP signatures"
1702 key: :note_replies_output_limit,
1705 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1708 key: :follow_handshake_timeout,
1710 description: "Following handshake timeout",
1717 key: :http_security,
1719 description: "HTTP security settings",
1724 description: "Whether the managed content security policy is enabled"
1730 description: "Whether to additionally send a Strict-Transport-Security header"
1734 label: "STS max age",
1736 description: "The maximum age for the Strict-Transport-Security header if sent",
1737 suggestions: [31_536_000]
1741 label: "CT max age",
1743 description: "The maximum age for the Expect-CT header if sent",
1744 suggestions: [2_592_000]
1747 key: :referrer_policy,
1749 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1750 suggestions: ["same-origin", "no-referrer"]
1754 label: "Report URI",
1756 description: "Adds the specified url to report-uri and report-to group in CSP header",
1757 suggestions: ["https://example.com/report-uri"]
1762 group: :web_push_encryption,
1763 key: :vapid_details,
1766 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1772 "A mailto link for the administrative contact." <>
1773 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1774 suggestions: ["mailto:moderators@pleroma.com"]
1779 description: "VAPID public key",
1780 suggestions: ["Public key"]
1785 description: "VAPID private key",
1786 suggestions: ["Private key"]
1792 key: Pleroma.Captcha,
1794 description: "Captcha-related settings",
1799 description: "Whether the captcha should be shown on registration"
1804 description: "The method/service to use for captcha",
1805 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1808 key: :seconds_valid,
1810 description: "The time in seconds for which the captcha is valid",
1817 key: Pleroma.Captcha.Kocaptcha,
1820 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1821 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1826 description: "The kocaptcha endpoint to use",
1827 suggestions: ["https://captcha.kotobank.ch"]
1835 "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",
1840 description: "Token",
1841 suggestions: ["We recommend a secure random string or UUID"]
1850 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1852 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1853 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1854 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1855 (see https://github.com/sorentwo/oban/issues/52).
1861 description: "Application's Ecto repo",
1862 suggestions: [Pleroma.Repo]
1866 type: {:dropdown, :atom},
1867 description: "Logs verbose mode",
1868 suggestions: [false, :error, :warn, :info, :debug]
1872 type: [:atom, :tuple],
1874 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1875 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1879 type: {:keyword, :integer},
1881 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1883 activity_expiration: 10,
1884 attachments_cleanup: 5,
1886 federator_incoming: 50,
1887 federator_outgoing: 50,
1889 scheduled_activities: 10,
1895 key: :activity_expiration,
1897 description: "Activity expiration queue",
1901 key: :attachments_cleanup,
1903 description: "Attachment deletion queue",
1909 description: "Background queue",
1913 key: :federator_incoming,
1915 description: "Incoming federation queue",
1919 key: :federator_outgoing,
1921 description: "Outgoing federation queue",
1927 description: "Email sender queue, see Pleroma.Emails.Mailer",
1931 key: :scheduled_activities,
1933 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1937 key: :transmogrifier,
1939 description: "Transmogrifier queue",
1945 description: "Web push notifications queue",
1952 type: {:list, :tuple},
1953 description: "Settings for cron background jobs",
1955 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1956 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1957 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1958 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1959 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1968 description: "Includes custom worker options not interpretable directly by `Oban`",
1972 type: {:keyword, :integer},
1973 description: "Max retry attempts for failed jobs, per `Oban` queue",
1975 federator_incoming: 5,
1976 federator_outgoing: 5
1983 key: Pleroma.Web.Metadata,
1985 description: "Metadata-related settings",
1989 type: {:list, :module},
1990 description: "List of metadata providers to enable",
1992 Pleroma.Web.Metadata.Providers.OpenGraph,
1993 Pleroma.Web.Metadata.Providers.TwitterCard,
1994 Pleroma.Web.Metadata.Providers.RelMe,
1995 Pleroma.Web.Metadata.Providers.Feed
2000 label: "Unfurl NSFW",
2002 description: "When enabled NSFW attachments will be shown in previews"
2011 "If enabled the instance will parse metadata from attached links to generate link previews.",
2016 description: "Enables RichMedia parsing of URLs."
2020 type: {:list, :string},
2021 description: "List of hosts which will be ignored by the metadata parser.",
2022 suggestions: ["accounts.google.com", "xss.website"]
2026 label: "Ignore TLD",
2027 type: {:list, :string},
2028 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2029 suggestions: ["local", "localdomain", "lan"]
2033 type: {:list, :module},
2034 description: "List of Rich Media parsers.",
2036 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2037 Pleroma.Web.RichMedia.Parsers.OEmbed,
2038 Pleroma.Web.RichMedia.Parsers.OGP,
2039 Pleroma.Web.RichMedia.Parsers.TwitterCard
2044 label: "TTL setters",
2045 type: {:list, :module},
2046 description: "List of rich media TTL setters.",
2048 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2054 group: :auto_linker,
2057 description: "Configuration for the auto_linker library",
2061 type: [:string, false],
2062 description: "Specify the class to be added to the generated link. Disable to clear",
2063 suggestions: ["auto-linker", false]
2067 type: [:string, false],
2068 description: "Override the rel attribute. Disable to clear",
2069 suggestions: ["ugc", "noopener noreferrer", false]
2074 description: "Link urls will open in new window/tab"
2078 type: [:integer, false],
2080 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2081 suggestions: [15, false]
2086 description: "Strip the scheme prefix"
2091 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2097 key: Pleroma.ScheduledActivity,
2099 description: "Scheduled activities settings",
2102 key: :daily_user_limit,
2105 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2109 key: :total_user_limit,
2112 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2118 description: "Whether scheduled activities are sent to the job queue to be executed"
2124 key: Pleroma.ActivityExpiration,
2126 description: "Expired activity settings",
2131 description: "Whether expired activities will be sent to the job queue to be deleted"
2138 description: "Authenticator",
2141 key: Pleroma.Web.Auth.Authenticator,
2143 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2152 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2153 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2154 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2155 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2160 description: "Enables LDAP authentication"
2165 description: "LDAP server hostname",
2166 suggestions: ["localhosts"]
2171 description: "LDAP port, e.g. 389 or 636",
2172 suggestions: [389, 636]
2178 description: "Enable to use SSL, usually implies the port 636"
2182 label: "SSL options",
2184 description: "Additional SSL options",
2185 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2190 description: "Path to file with PEM encoded cacerts",
2191 suggestions: ["path/to/file/with/PEM/cacerts"]
2196 description: "Type of cert verification",
2197 suggestions: [:verify_peer]
2205 description: "Enable to use STARTTLS, usually implies the port 389"
2209 label: "TLS options",
2211 description: "Additional TLS options",
2212 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2217 description: "Path to file with PEM encoded cacerts",
2218 suggestions: ["path/to/file/with/PEM/cacerts"]
2223 description: "Type of cert verification",
2224 suggestions: [:verify_peer]
2231 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2232 suggestions: ["dc=example,dc=com"]
2238 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2247 description: "Authentication / authorization settings",
2250 key: :enforce_oauth_admin_scope_usage,
2253 "OAuth admin scope requirement toggle. " <>
2254 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2255 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2256 "`is_admin` user flag grants access to admin-specific actions."
2259 key: :auth_template,
2262 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2263 suggestions: ["show.html"]
2266 key: :oauth_consumer_template,
2269 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2270 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2271 suggestions: ["consumer.html"]
2274 key: :oauth_consumer_strategies,
2275 type: {:list, :string},
2277 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2278 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2279 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2280 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2286 key: :email_notifications,
2288 description: "Email notifications settings",
2294 "emails of \"what you've missed\" for users who have been inactive for a while",
2298 schedule: "0 0 * * 0",
2300 inactivity_threshold: 7
2308 description: "Globally enable or disable digest emails"
2314 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2315 suggestions: ["0 0 * * 0"]
2320 description: "Minimum interval between digest emails to one user",
2324 key: :inactivity_threshold,
2326 description: "Minimum user inactivity threshold",
2335 key: Pleroma.Emails.UserEmail,
2337 description: "Email template settings",
2342 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2343 suggestions: ["some/path/logo.png"]
2348 description: "a map with color settings for email templates.",
2351 link_color: "#d8a070",
2352 background_color: "#2C3645",
2353 content_background_color: "#1B2635",
2354 header_color: "#d8a070",
2355 text_color: "#b9b9ba",
2356 text_muted_color: "#b9b9ba"
2363 suggestions: ["#d8a070"]
2366 key: :background_color,
2368 suggestions: ["#2C3645"]
2371 key: :content_background_color,
2373 suggestions: ["#1B2635"]
2378 suggestions: ["#d8a070"]
2383 suggestions: ["#b9b9ba"]
2386 key: :text_muted_color,
2388 suggestions: ["#b9b9ba"]
2396 key: Pleroma.Emails.NewUsersDigestEmail,
2398 description: "New users admin email digest",
2403 description: "enables new users admin digest email when `true`",
2404 suggestions: [false]
2412 description: "Configure OAuth 2 provider capabilities",
2415 key: :token_expires_in,
2417 description: "The lifetime in seconds of the access token",
2421 key: :issue_new_refresh_token,
2424 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2427 key: :clean_expired_tokens,
2429 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2439 key: :shortcode_globs,
2440 type: {:list, :string},
2441 description: "Location of custom emoji files. * can be used as a wildcard.",
2442 suggestions: ["/emoji/custom/**/*.png"]
2445 key: :pack_extensions,
2446 type: {:list, :string},
2448 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2449 suggestions: [".png", ".gif"]
2453 type: {:keyword, :string, {:list, :string}},
2455 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2456 " and the value is the location or array of locations. * can be used as a wildcard.",
2458 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2462 key: :default_manifest,
2465 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2466 " Currently only one manifest can be added (no arrays).",
2467 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2470 key: :shared_pack_cache_seconds_per_file,
2471 label: "Shared pack cache s/file",
2474 "When an emoji pack is shared, the archive is created and cached in memory" <>
2475 " for this amount of seconds multiplied by the number of files.",
2485 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2489 type: [:tuple, {:list, :tuple}],
2490 description: "For the search requests (account & status search etc.)",
2491 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2495 type: [:tuple, {:list, :tuple}],
2496 description: "For requests to timelines (each timeline has it's own limiter)",
2497 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2500 key: :app_account_creation,
2501 type: [:tuple, {:list, :tuple}],
2502 description: "For registering user accounts from the same IP address",
2503 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2506 key: :relations_actions,
2507 type: [:tuple, {:list, :tuple}],
2508 description: "For actions on relationships with all users (follow, unfollow)",
2509 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2512 key: :relation_id_action,
2513 type: [:tuple, {:list, :tuple}],
2514 description: "For actions on relation with a specific user (follow, unfollow)",
2515 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2518 key: :statuses_actions,
2519 type: [:tuple, {:list, :tuple}],
2521 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2522 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2525 key: :status_id_action,
2526 type: [:tuple, {:list, :tuple}],
2528 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2529 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2532 key: :authentication,
2533 type: [:tuple, {:list, :tuple}],
2534 description: "For authentication create / password check / user existence check requests",
2535 suggestions: [{60_000, 15}]
2543 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2544 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2549 description: "Enables SSH"
2554 description: "Dir with SSH keys",
2555 suggestions: ["/some/path/ssh_keys"]
2560 description: "Handler module",
2561 suggestions: ["Pleroma.BBS.Handler"]
2566 description: "Port to connect",
2567 suggestions: [10_022]
2570 key: :password_authenticator,
2572 description: "Authenticator module",
2573 suggestions: ["Pleroma.BBS.Authenticator"]
2580 description: "Mime types",
2587 "application/xml" => ["xml"],
2588 "application/xrd+xml" => ["xrd+xml"],
2589 "application/jrd+json" => ["jrd+json"],
2590 "application/activity+json" => ["activity+json"],
2591 "application/ld+json" => ["activity+json"]
2596 key: "application/xml",
2597 type: {:list, :string},
2598 suggestions: ["xml"]
2601 key: "application/xrd+xml",
2602 type: {:list, :string},
2603 suggestions: ["xrd+xml"]
2606 key: "application/jrd+json",
2607 type: {:list, :string},
2608 suggestions: ["jrd+json"]
2611 key: "application/activity+json",
2612 type: {:list, :string},
2613 suggestions: ["activity+json"]
2616 key: "application/ld+json",
2617 type: {:list, :string},
2618 suggestions: ["activity+json"]
2628 description: "Pleroma chat settings",
2637 group: :http_signatures,
2639 description: "HTTP Signatures settings",
2644 suggestions: [Pleroma.Signature]
2652 description: "HTTP settings",
2657 type: [:string, :tuple],
2658 description: "Proxy URL",
2659 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2662 key: :send_user_agent,
2667 type: [:string, :atom],
2669 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2670 suggestions: ["Pleroma", :default]
2675 description: "Adapter specific options",
2681 label: "SSL Options",
2682 description: "SSL options for HTTP adapter",
2686 type: {:list, :atom},
2687 description: "List of TLS version to use",
2688 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2702 key: :allow_inline_images,
2706 key: :allow_headings,
2719 type: {:list, :module},
2720 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2730 key: :deny_follow_blocked,
2737 key: :mrf_normalize_markup,
2738 label: "MRF normalize markup",
2739 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2745 suggestions: [Pleroma.HTML.Scrubber.Default]
2755 key: :restricted_nicknames,
2756 type: {:list, :string},
2775 "ostatus_subscribe",
2799 suggestions: [86_400]
2803 type: {:list, :string},
2804 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2808 type: {:list, :string},
2811 "X-RateLimit-Reset",
2812 "X-RateLimit-Limit",
2813 "X-RateLimit-Remaining",
2824 type: {:list, :string},
2825 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2831 key: Pleroma.Plugs.RemoteIp,
2834 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2835 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2841 description: "Enable/disable the plug. Default: disabled."
2845 type: {:list, :string},
2847 "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]`."
2851 type: {:list, :string},
2853 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2857 type: {:list, :string},
2859 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2865 key: :web_cache_ttl,
2868 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2874 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2875 suggestions: [30_000, nil]
2878 key: :activity_pub_question,
2880 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2881 suggestions: [30_000]
2890 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2895 description: "Enables the rendering of static HTML. Default: disabled."
2903 description: "Configure feed rendering",
2908 description: "Configure title rendering.",
2913 description: "Maximum number of characters before truncating title.",
2919 description: "Replacement which will be used after truncating string.",
2920 suggestions: ["..."]
2928 key: :mrf_object_age,
2930 description: "Rejects or delists posts based on their age when received.",
2935 description: "Required age (in seconds) of a post before actions are taken.",
2936 suggestions: [172_800]
2940 type: {:list, :atom},
2942 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2943 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2944 "`:reject` rejects the message entirely",
2945 suggestions: [:delist, :strip_followers, :reject]
2953 description: "Custom Runtime Modules",
2958 description: "A path to custom Elixir modules (such as MRF policies)."
2966 description: "Settings for notifications streamer",
2971 description: "Number of workers to send notifications.",
2975 key: :overflow_workers,
2977 description: "Maximum number of workers created if pool is empty.",
2984 key: :connections_pool,
2986 description: "Advanced settings for `gun` connections pool",
2989 key: :checkin_timeout,
2991 description: "Timeout to checkin connection from pool. Default: 250ms.",
2995 key: :max_connections,
2997 description: "Maximum number of connections in the pool. Default: 250 connections.",
3004 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3008 key: :retry_timeout,
3011 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3015 key: :await_up_timeout,
3017 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3026 description: "Advanced settings for `gun` workers pools",
3031 description: "Settings for federation pool.",
3036 description: "Number workers in the pool.",
3042 description: "Number of additional workers if pool is under load.",
3048 description: "Timeout while `gun` will wait for response.",
3049 suggestions: [150_000]
3056 description: "Settings for media pool.",
3061 description: "Number workers in the pool.",
3067 description: "Number of additional workers if pool is under load.",
3073 description: "Timeout while `gun` will wait for response.",
3074 suggestions: [150_000]
3081 description: "Settings for upload pool.",
3086 description: "Number workers in the pool.",
3092 description: "Number of additional workers if pool is under load.",
3098 description: "Timeout while `gun` will wait for response.",
3099 suggestions: [300_000]
3106 description: "Settings for default pool.",
3111 description: "Number workers in the pool.",
3117 description: "Number of additional workers if pool is under load.",
3123 description: "Timeout while `gun` will wait for response.",
3124 suggestions: [10_000]
3132 key: :hackney_pools,
3134 description: "Advanced settings for `hackney` connections pools",
3139 description: "Settings for federation pool.",
3142 key: :max_connections,
3144 description: "Number workers in the pool.",
3150 description: "Timeout while `hackney` will wait for response.",
3151 suggestions: [150_000]
3158 description: "Settings for media pool.",
3161 key: :max_connections,
3163 description: "Number workers in the pool.",
3169 description: "Timeout while `hackney` will wait for response.",
3170 suggestions: [150_000]
3177 description: "Settings for upload pool.",
3180 key: :max_connections,
3182 description: "Number workers in the pool.",
3188 description: "Timeout while `hackney` will wait for response.",
3189 suggestions: [300_000]
3197 key: :restrict_unauthenticated,
3200 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3205 description: "Settings for public and federated timelines.",
3210 description: "Disallow view public timeline."
3215 description: "Disallow view federated timeline."
3222 description: "Settings for user profiles.",
3227 description: "Disallow view local user profiles."
3232 description: "Disallow view remote user profiles."
3239 description: "Settings for statuses.",
3244 description: "Disallow view local statuses."
3249 description: "Disallow view remote statuses."
3257 key: Pleroma.Web.ApiSpec.CastAndValidate,
3264 "Enables strict input validation (useful in development, not recommended in production)",
3265 suggestions: [false]