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 MRF 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.",
683 key: :federation_publisher_modules,
684 type: {:list, :module},
686 "List of modules for federation publishing. Module names are shortened (removed leading `Pleroma.Web.` part), but on adding custom MRF module you need to use full name.",
688 Pleroma.Web.ActivityPub.Publisher
694 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
697 key: :rewrite_policy,
698 type: [:module, {:list, :module}],
700 "A list of enabled MRF policies. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom MRF module you need to use full name.",
702 Generator.list_modules_in_dir(
703 "lib/pleroma/web/activity_pub/mrf",
704 "Elixir.Pleroma.Web.ActivityPub.MRF."
711 "Makes the client API in authentificated mode-only except for user-profiles." <>
712 " Useful for disabling the Local Timeline and The Whole Known Network."
715 key: :quarantined_instances,
716 type: {:list, :string},
718 "List of ActivityPub instances where private (DMs, followers-only) activities will not be send",
725 key: :managed_config,
728 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
733 description: "Instance static directory",
739 key: :allowed_post_formats,
740 type: {:list, :string},
741 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
750 key: :mrf_transparency,
751 label: "MRF transparency",
754 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
757 key: :mrf_transparency_exclusions,
758 label: "MRF transparency exclusions",
759 type: {:list, :string},
761 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
767 key: :extended_nickname_format,
770 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
771 " This will break federation with older software for theses nicknames."
774 key: :cleanup_attachments,
777 Enable to remove associated attachments when status is removed.
778 This will not affect duplicates and attachments without status.
779 Enabling this will increase load to database when deleting statuses on larger instances.
783 key: :max_pinned_statuses,
785 description: "The maximum number of pinned statuses. 0 will disable the feature.",
793 key: :autofollowed_nicknames,
794 type: {:list, :string},
796 "Set to nicknames of (local) users that every new user should automatically follow",
805 key: :attachment_links,
807 description: "Enable to automatically add attachment link text to statuses"
810 key: :welcome_message,
813 "A message that will be sent to a newly registered users as a direct message",
815 "Hi, @username! Welcome on board!"
819 key: :welcome_user_nickname,
821 description: "The nickname of the local user that sends the welcome message",
827 key: :max_report_comment_size,
829 description: "The maximum size of the report comment. Default: 1000.",
835 key: :safe_dm_mentions,
838 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
839 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
845 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
848 key: :remote_post_retention_days,
851 "The default amount of days to retain remote posts when pruning the database",
857 key: :user_bio_length,
859 description: "A user bio maximum length. Default: 5000.",
865 key: :user_name_length,
867 description: "A user name maximum length. Default: 100.",
873 key: :skip_thread_containment,
875 description: "Skip filtering out broken threads. Default: enabled"
878 key: :limit_to_local_content,
879 type: {:dropdown, :atom},
881 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
889 key: :max_account_fields,
891 description: "The maximum number of custom fields in the user profile. Default: 10.",
897 key: :max_remote_account_fields,
900 "The maximum number of custom fields in the remote user profile. Default: 20.",
906 key: :account_field_name_length,
908 description: "An account field name maximum length. Default: 512.",
914 key: :account_field_value_length,
916 description: "An account field value maximum length. Default: 2048.",
922 key: :external_user_synchronization,
924 description: "Enabling following/followers counters synchronization for external users"
931 description: "Logger-related settings",
935 type: [:atom, :tuple, :module],
937 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
938 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
946 description: "ExSyslogger-related settings",
950 type: {:dropdown, :atom},
951 description: "Log level",
952 suggestions: [:debug, :info, :warn, :error]
958 "A string that's prepended to every message, and is typically set to the app name",
959 suggestions: ["pleroma"]
964 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
965 suggestions: ["$metadata[$level] $message"]
969 type: {:list, :atom},
970 suggestions: [:request_id]
978 description: "Console logger settings",
982 type: {:dropdown, :atom},
983 description: "Log level",
984 suggestions: [:debug, :info, :warn, :error]
989 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
990 suggestions: ["$metadata[$level] $message"]
994 type: {:list, :atom},
995 suggestions: [:request_id]
1002 description: "Quack-related settings",
1006 type: {:dropdown, :atom},
1007 description: "Log level",
1008 suggestions: [:debug, :info, :warn, :error]
1012 type: {:list, :atom},
1013 description: "Configure which metadata you want to report on",
1031 description: "Configure the Slack incoming webhook",
1032 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1038 key: :frontend_configurations,
1041 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1042 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1043 "add your own configuration your settings all fields must be complete.",
1047 label: "Pleroma FE",
1049 description: "Settings for Pleroma FE",
1052 theme: "pleroma-dark",
1053 logo: "/static/logo.png",
1054 background: "/images/city.jpg",
1055 redirectRootNoLogin: "/main/all",
1056 redirectRootLogin: "/main/friends",
1057 showInstanceSpecificPanel: true,
1058 scopeOptionsEnabled: false,
1059 formattingOptionsEnabled: false,
1060 collapseMessageWithSubject: false,
1061 hidePostStats: false,
1062 hideUserStats: false,
1064 subjectLineBehavior: "email",
1065 alwaysShowSubjectInput: true,
1069 enableEmojiPicker: false
1076 description: "Which theme to use, they are defined in styles.json",
1077 suggestions: ["pleroma-dark"]
1082 description: "URL of the logo, defaults to Pleroma's logo",
1083 suggestions: ["/static/logo.png"]
1089 "URL of the background, unless viewing a user profile with a background that is set",
1090 suggestions: ["/images/city.jpg"]
1093 key: :redirectRootNoLogin,
1094 label: "Redirect root no login",
1097 "Relative URL which indicates where to redirect when a user isn't logged in",
1098 suggestions: ["/main/all"]
1101 key: :redirectRootLogin,
1102 label: "Redirect root login",
1105 "Relative URL which indicates where to redirect when a user is logged in",
1106 suggestions: ["/main/friends"]
1109 key: :showInstanceSpecificPanel,
1110 label: "Show instance specific panel",
1112 description: "Whenether to show the instance's specific panel"
1115 key: :scopeOptionsEnabled,
1116 label: "Scope options enabled",
1118 description: "Enable setting a notice visibility and subject/CW when posting"
1121 key: :formattingOptionsEnabled,
1122 label: "Formatting options enabled",
1125 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1128 key: :collapseMessageWithSubject,
1129 label: "Collapse message with subject",
1132 "When a message has a subject (aka Content Warning), collapse it by default"
1135 key: :hidePostStats,
1136 label: "Hide post stats",
1138 description: "Hide notices statistics (repeats, favorites, ...)"
1141 key: :hideUserStats,
1142 label: "Hide user stats",
1145 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1149 label: "Scope copy",
1151 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1154 key: :subjectLineBehavior,
1155 label: "Subject line behavior",
1157 description: "Allows changing the default behaviour of subject lines in replies.
1158 `email`: copy and preprend re:, as in email,
1159 `masto`: copy verbatim, as in Mastodon,
1160 `noop`: don't copy the subject.",
1161 suggestions: ["email", "masto", "noop"]
1164 key: :alwaysShowSubjectInput,
1165 label: "Always show subject input",
1167 description: "When disabled, auto-hide the subject field if it's empty"
1174 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1175 "If you want a colorful logo you must disable logoMask."
1179 label: "Logo margin",
1182 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1183 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1184 suggestions: [".1em"]
1189 description: "Enables stickers."
1192 key: :enableEmojiPicker,
1193 label: "Emoji picker",
1195 description: "Enables emoji picker."
1203 description: "Settings for Masto FE",
1206 showInstanceSpecificPanel: true
1211 key: :showInstanceSpecificPanel,
1212 label: "Show instance specific panel",
1214 description: "Whenether to show the instance's specific panel"
1225 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1229 type: {:keyword, :map},
1231 "Keyword of mascots, each element must contain both an url and a mime_type key",
1234 url: "/images/pleroma-fox-tan-smol.png",
1235 mime_type: "image/png"
1237 pleroma_fox_tan_shy: %{
1238 url: "/images/pleroma-fox-tan-shy.png",
1239 mime_type: "image/png"
1244 key: :default_mascot,
1247 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1259 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1263 type: {:list, :map},
1264 description: "Describe the icons of the app",
1267 src: "/static/logo.png"
1270 src: "/static/icon.png",
1274 src: "/static/icon.ico",
1275 sizes: "72x72 96x96 128x128 256x256"
1282 description: "Describe the theme color of the app",
1283 suggestions: ["#282c37", "mediumpurple"]
1286 key: :background_color,
1288 description: "Describe the background color of the app",
1289 suggestions: ["#191b22", "aliceblue"]
1296 label: "MRF simple",
1298 description: "Message Rewrite Facility",
1301 key: :media_removal,
1302 type: {:list, :string},
1303 description: "List of instances to strip media attachments from",
1304 suggestions: ["example.com", "*.example.com"]
1308 label: "Media NSFW",
1309 type: {:list, :string},
1310 description: "List of instances to tag all media as NSFW (sensitive) from",
1311 suggestions: ["example.com", "*.example.com"]
1314 key: :federated_timeline_removal,
1315 type: {:list, :string},
1317 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1318 suggestions: ["example.com", "*.example.com"]
1322 type: {:list, :string},
1323 description: "List of instances to reject activities from (except deletes)",
1324 suggestions: ["example.com", "*.example.com"]
1328 type: {:list, :string},
1329 description: "List of instances to only accept activities from (except deletes)",
1330 suggestions: ["example.com", "*.example.com"]
1333 key: :report_removal,
1334 type: {:list, :string},
1335 description: "List of instances to reject reports from",
1336 suggestions: ["example.com", "*.example.com"]
1339 key: :avatar_removal,
1340 type: {:list, :string},
1341 description: "List of instances to strip avatars from",
1342 suggestions: ["example.com", "*.example.com"]
1345 key: :banner_removal,
1346 type: {:list, :string},
1347 description: "List of instances to strip banners from",
1348 suggestions: ["example.com", "*.example.com"]
1351 key: :reject_deletes,
1352 type: {:list, :string},
1353 description: "List of instances to reject deletions from",
1354 suggestions: ["example.com", "*.example.com"]
1361 label: "MRF subchain",
1364 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1365 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1370 description: "Matches a series of regular expressions against the actor field",
1373 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1381 key: :mrf_rejectnonpublic,
1383 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1384 label: "MRF reject non public",
1388 key: :allow_followersonly,
1389 label: "Allow followers-only",
1391 description: "Whether to allow followers-only posts"
1396 description: "Whether to allow direct messages"
1402 key: :mrf_hellthread,
1403 label: "MRF hellthread",
1405 description: "Block messages with too much mentions",
1408 key: :delist_threshold,
1411 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1412 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1416 key: :reject_threshold,
1419 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1427 label: "MRF keyword",
1429 description: "Reject or Word-Replace messages with a keyword or regex",
1433 type: [:string, :regex],
1435 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1436 suggestions: ["foo", ~r/foo/iu]
1439 key: :federated_timeline_removal,
1440 type: [:string, :regex],
1442 "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.",
1443 suggestions: ["foo", ~r/foo/iu]
1447 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1449 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1450 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1457 label: "MRF mention",
1459 description: "Block messages which mention a user",
1463 type: {:list, :string},
1464 description: "A list of actors for which any post mentioning them will be dropped.",
1465 suggestions: ["actor1", "actor2"]
1471 key: :mrf_vocabulary,
1472 label: "MRF vocabulary",
1474 description: "Filter messages which belong to certain activity vocabularies",
1478 type: {:list, :string},
1480 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1481 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1485 type: {:list, :string},
1487 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1488 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1494 # key: :mrf_user_allowlist,
1497 # "The keys in this section are the domain names that the policy should apply to." <>
1498 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1500 # ["example.org": ["https://example.org/users/admin"]],
1502 # ["example.org": ["https://example.org/users/admin"]]
1510 description: "Media proxy",
1515 description: "Enables proxying of remote media to the instance's proxy"
1521 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1522 suggestions: ["https://example.com"]
1527 description: "Options for Pleroma.ReverseProxy",
1529 redirect_on_failure: false,
1530 max_body_length: 25 * 1_048_576,
1532 follow_redirect: true,
1538 key: :redirect_on_failure,
1541 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1542 "Any error during body processing will not be redirected as the response is chunked."
1545 key: :max_body_length,
1548 "Limits the content length to be approximately the " <>
1549 "specified length. It is validated with the `content-length` header and also verified when proxying."
1554 description: "HTTP options",
1559 description: "Adapter specific options",
1564 label: "SSL Options",
1565 description: "SSL options for HTTP adapter",
1569 type: {:list, :atom},
1570 description: "List of TLS version to use",
1571 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1580 type: [:string, :tuple],
1581 description: "Proxy URL",
1582 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1590 type: {:list, :string},
1591 description: "List of domains to bypass the mediaproxy",
1592 suggestions: ["example.com"]
1600 description: "Gopher settings",
1605 description: "Enables the gopher interface"
1610 description: "IP address to bind to",
1611 suggestions: [{0, 0, 0, 0}]
1616 description: "Port to bind to",
1622 description: "Port advertised in urls (optional, defaults to port)",
1631 description: "ActivityPub-related settings",
1634 key: :unfollow_blocked,
1636 description: "Whether blocks result in people getting unfollowed"
1639 key: :outgoing_blocks,
1641 description: "Whether to federate blocks to other instances"
1644 key: :sign_object_fetches,
1646 description: "Sign object fetches with HTTP signatures"
1649 key: :note_replies_output_limit,
1652 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1655 key: :follow_handshake_timeout,
1657 description: "Following handshake timeout",
1664 key: :http_security,
1666 description: "HTTP security settings",
1671 description: "Whether the managed content security policy is enabled"
1677 description: "Whether to additionally send a Strict-Transport-Security header"
1681 label: "STS max age",
1683 description: "The maximum age for the Strict-Transport-Security header if sent",
1684 suggestions: [31_536_000]
1688 label: "CT max age",
1690 description: "The maximum age for the Expect-CT header if sent",
1691 suggestions: [2_592_000]
1694 key: :referrer_policy,
1696 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1697 suggestions: ["same-origin", "no-referrer"]
1701 label: "Report URI",
1703 description: "Adds the specified url to report-uri and report-to group in CSP header",
1704 suggestions: ["https://example.com/report-uri"]
1709 group: :web_push_encryption,
1710 key: :vapid_details,
1713 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1719 "A mailto link for the administrative contact." <>
1720 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1721 suggestions: ["mailto:moderators@pleroma.com"]
1726 description: "VAPID public key",
1727 suggestions: ["Public key"]
1732 description: "VAPID private key",
1733 suggestions: ["Private key"]
1739 key: Pleroma.Captcha,
1741 description: "Captcha-related settings",
1746 description: "Whether the captcha should be shown on registration"
1751 description: "The method/service to use for captcha",
1752 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1755 key: :seconds_valid,
1757 description: "The time in seconds for which the captcha is valid",
1764 key: Pleroma.Captcha.Kocaptcha,
1767 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1768 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1773 description: "The kocaptcha endpoint to use",
1774 suggestions: ["https://captcha.kotobank.ch"]
1782 "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",
1787 description: "Token",
1788 suggestions: ["We recommend a secure random string or UUID"]
1797 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1799 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1800 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1801 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1802 (see https://github.com/sorentwo/oban/issues/52).
1808 description: "Application's Ecto repo",
1809 suggestions: [Pleroma.Repo]
1813 type: {:dropdown, :atom},
1814 description: "Logs verbose mode",
1815 suggestions: [false, :error, :warn, :info, :debug]
1819 type: [:atom, :tuple],
1821 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1822 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1826 type: {:keyword, :integer},
1828 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1830 activity_expiration: 10,
1831 attachments_cleanup: 5,
1833 federator_incoming: 50,
1834 federator_outgoing: 50,
1836 scheduled_activities: 10,
1842 key: :activity_expiration,
1844 description: "Activity expiration queue",
1848 key: :attachments_cleanup,
1850 description: "Attachment deletion queue",
1856 description: "Background queue",
1860 key: :federator_incoming,
1862 description: "Incoming federation queue",
1866 key: :federator_outgoing,
1868 description: "Outgoing federation queue",
1874 description: "Email sender queue, see Pleroma.Emails.Mailer",
1878 key: :scheduled_activities,
1880 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1884 key: :transmogrifier,
1886 description: "Transmogrifier queue",
1892 description: "Web push notifications queue",
1899 type: {:list, :tuple},
1900 description: "Settings for cron background jobs",
1902 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1903 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1904 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1905 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1906 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1915 description: "Includes custom worker options not interpretable directly by `Oban`",
1919 type: {:keyword, :integer},
1920 description: "Max retry attempts for failed jobs, per `Oban` queue",
1922 federator_incoming: 5,
1923 federator_outgoing: 5
1930 key: Pleroma.Web.Metadata,
1932 description: "Metadata-related settings",
1936 type: {:list, :module},
1937 description: "List of metadata providers to enable",
1939 Pleroma.Web.Metadata.Providers.OpenGraph,
1940 Pleroma.Web.Metadata.Providers.TwitterCard,
1941 Pleroma.Web.Metadata.Providers.RelMe,
1942 Pleroma.Web.Metadata.Providers.Feed
1947 label: "Unfurl NSFW",
1949 description: "When enabled NSFW attachments will be shown in previews"
1958 "If enabled the instance will parse metadata from attached links to generate link previews.",
1963 description: "Enables RichMedia parsing of URLs."
1967 type: {:list, :string},
1968 description: "List of hosts which will be ignored by the metadata parser.",
1969 suggestions: ["accounts.google.com", "xss.website"]
1973 label: "Ignore TLD",
1974 type: {:list, :string},
1975 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
1976 suggestions: ["local", "localdomain", "lan"]
1980 type: {:list, :module},
1982 "List of Rich Media parsers. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parsers.` part), but on adding custom MRF module you need to use full name.",
1984 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
1985 Pleroma.Web.RichMedia.Parsers.OEmbed,
1986 Pleroma.Web.RichMedia.Parsers.OGP,
1987 Pleroma.Web.RichMedia.Parsers.TwitterCard
1992 label: "TTL setters",
1993 type: {:list, :module},
1995 "List of rich media TTL setters. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parser.` part), but on adding custom MRF module you need to use full name.",
1997 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2003 group: :auto_linker,
2006 description: "Configuration for the auto_linker library",
2010 type: [:string, false],
2011 description: "Specify the class to be added to the generated link. Disable to clear",
2012 suggestions: ["auto-linker", false]
2016 type: [:string, false],
2017 description: "Override the rel attribute. Disable to clear",
2018 suggestions: ["ugc", "noopener noreferrer", false]
2023 description: "Link urls will open in new window/tab"
2027 type: [:integer, false],
2029 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2030 suggestions: [15, false]
2035 description: "Strip the scheme prefix"
2040 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2046 key: Pleroma.ScheduledActivity,
2048 description: "Scheduled activities settings",
2051 key: :daily_user_limit,
2054 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2058 key: :total_user_limit,
2061 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2067 description: "Whether scheduled activities are sent to the job queue to be executed"
2073 key: Pleroma.ActivityExpiration,
2075 description: "Expired activity settings",
2080 description: "Whether expired activities will be sent to the job queue to be deleted"
2087 description: "Authenticator",
2090 key: Pleroma.Web.Auth.Authenticator,
2092 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2101 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2102 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2103 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2104 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2109 description: "Enables LDAP authentication"
2114 description: "LDAP server hostname",
2115 suggestions: ["localhosts"]
2120 description: "LDAP port, e.g. 389 or 636",
2121 suggestions: [389, 636]
2127 description: "Enable to use SSL, usually implies the port 636"
2131 label: "SSL options",
2133 description: "Additional SSL options",
2134 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2139 description: "Path to file with PEM encoded cacerts",
2140 suggestions: ["path/to/file/with/PEM/cacerts"]
2145 description: "Type of cert verification",
2146 suggestions: [:verify_peer]
2154 description: "Enable to use STARTTLS, usually implies the port 389"
2158 label: "TLS options",
2160 description: "Additional TLS options",
2161 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2166 description: "Path to file with PEM encoded cacerts",
2167 suggestions: ["path/to/file/with/PEM/cacerts"]
2172 description: "Type of cert verification",
2173 suggestions: [:verify_peer]
2180 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2181 suggestions: ["dc=example,dc=com"]
2187 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2196 description: "Authentication / authorization settings",
2199 key: :enforce_oauth_admin_scope_usage,
2202 "OAuth admin scope requirement toggle. " <>
2203 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2204 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2205 "`is_admin` user flag grants access to admin-specific actions."
2208 key: :auth_template,
2211 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2212 suggestions: ["show.html"]
2215 key: :oauth_consumer_template,
2218 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2219 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2220 suggestions: ["consumer.html"]
2223 key: :oauth_consumer_strategies,
2224 type: {:list, :string},
2226 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2227 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2228 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2229 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2235 key: :email_notifications,
2237 description: "Email notifications settings",
2243 "emails of \"what you've missed\" for users who have been inactive for a while",
2247 schedule: "0 0 * * 0",
2249 inactivity_threshold: 7
2256 description: "Globally enable or disable digest emails"
2262 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2263 suggestions: ["0 0 * * 0"]
2268 description: "Minimum interval between digest emails to one user",
2272 key: :inactivity_threshold,
2274 description: "Minimum user inactivity threshold",
2283 key: :notifications,
2285 description: "Notification settings",
2288 key: :enable_follow_request_notifications,
2291 "Enables notifications on new follow requests (causes issues with older PleromaFE versions)."
2297 key: Pleroma.Emails.UserEmail,
2299 description: "Email template settings",
2304 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2305 suggestions: ["some/path/logo.png"]
2310 description: "a map with color settings for email templates.",
2313 link_color: "#d8a070",
2314 background_color: "#2C3645",
2315 content_background_color: "#1B2635",
2316 header_color: "#d8a070",
2317 text_color: "#b9b9ba",
2318 text_muted_color: "#b9b9ba"
2325 suggestions: ["#d8a070"]
2328 key: :background_color,
2330 suggestions: ["#2C3645"]
2333 key: :content_background_color,
2335 suggestions: ["#1B2635"]
2340 suggestions: ["#d8a070"]
2345 suggestions: ["#b9b9ba"]
2348 key: :text_muted_color,
2350 suggestions: ["#b9b9ba"]
2358 key: Pleroma.Emails.NewUsersDigestEmail,
2360 description: "New users admin email digest",
2365 description: "enables new users admin digest email when `true`",
2366 suggestions: [false]
2374 description: "Configure OAuth 2 provider capabilities",
2377 key: :token_expires_in,
2379 description: "The lifetime in seconds of the access token",
2383 key: :issue_new_refresh_token,
2386 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2389 key: :clean_expired_tokens,
2391 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2401 key: :shortcode_globs,
2402 type: {:list, :string},
2403 description: "Location of custom emoji files. * can be used as a wildcard.",
2404 suggestions: ["/emoji/custom/**/*.png"]
2407 key: :pack_extensions,
2408 type: {:list, :string},
2410 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2411 suggestions: [".png", ".gif"]
2415 type: {:keyword, :string, {:list, :string}},
2417 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2418 " and the value is the location or array of locations. * can be used as a wildcard.",
2420 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2424 key: :default_manifest,
2427 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2428 " Currently only one manifest can be added (no arrays).",
2429 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2432 key: :shared_pack_cache_seconds_per_file,
2433 label: "Shared pack cache s/file",
2436 "When an emoji pack is shared, the archive is created and cached in memory" <>
2437 " for this amount of seconds multiplied by the number of files.",
2447 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2451 type: [:tuple, {:list, :tuple}],
2452 description: "For the search requests (account & status search etc.)",
2453 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2457 type: [:tuple, {:list, :tuple}],
2458 description: "For requests to timelines (each timeline has it's own limiter)",
2459 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2462 key: :app_account_creation,
2463 type: [:tuple, {:list, :tuple}],
2464 description: "For registering user accounts from the same IP address",
2465 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2468 key: :relations_actions,
2469 type: [:tuple, {:list, :tuple}],
2470 description: "For actions on relationships with all users (follow, unfollow)",
2471 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2474 key: :relation_id_action,
2475 type: [:tuple, {:list, :tuple}],
2476 description: "For actions on relation with a specific user (follow, unfollow)",
2477 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2480 key: :statuses_actions,
2481 type: [:tuple, {:list, :tuple}],
2483 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2484 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2487 key: :status_id_action,
2488 type: [:tuple, {:list, :tuple}],
2490 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2491 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2494 key: :authentication,
2495 type: [:tuple, {:list, :tuple}],
2496 description: "For authentication create / password check / user existence check requests",
2497 suggestions: [{60_000, 15}]
2505 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2506 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2511 description: "Enables SSH"
2516 description: "Dir with SSH keys",
2517 suggestions: ["/some/path/ssh_keys"]
2522 description: "Handler module",
2523 suggestions: ["Pleroma.BBS.Handler"]
2528 description: "Port to connect",
2529 suggestions: [10_022]
2532 key: :password_authenticator,
2534 description: "Authenticator module",
2535 suggestions: ["Pleroma.BBS.Authenticator"]
2542 description: "Mime types",
2549 "application/xml" => ["xml"],
2550 "application/xrd+xml" => ["xrd+xml"],
2551 "application/jrd+json" => ["jrd+json"],
2552 "application/activity+json" => ["activity+json"],
2553 "application/ld+json" => ["activity+json"]
2558 key: "application/xml",
2559 type: {:list, :string},
2560 suggestions: ["xml"]
2563 key: "application/xrd+xml",
2564 type: {:list, :string},
2565 suggestions: ["xrd+xml"]
2568 key: "application/jrd+json",
2569 type: {:list, :string},
2570 suggestions: ["jrd+json"]
2573 key: "application/activity+json",
2574 type: {:list, :string},
2575 suggestions: ["activity+json"]
2578 key: "application/ld+json",
2579 type: {:list, :string},
2580 suggestions: ["activity+json"]
2590 description: "Pleroma chat settings",
2599 group: :http_signatures,
2601 description: "HTTP Signatures settings",
2606 suggestions: [Pleroma.Signature]
2614 description: "HTTP settings",
2619 type: [:string, :tuple],
2620 description: "Proxy URL",
2621 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2624 key: :send_user_agent,
2629 type: [:string, :atom],
2631 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2632 suggestions: ["Pleroma", :default]
2637 description: "Adapter specific options",
2643 label: "SSL Options",
2644 description: "SSL options for HTTP adapter",
2648 type: {:list, :atom},
2649 description: "List of TLS version to use",
2650 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2664 key: :allow_inline_images,
2668 key: :allow_headings,
2681 type: {:list, :module},
2683 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom MRF module you need to use full name.",
2684 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2694 key: :deny_follow_blocked,
2701 key: :mrf_normalize_markup,
2702 label: "MRF normalize markup",
2703 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2709 suggestions: [Pleroma.HTML.Scrubber.Default]
2719 key: :restricted_nicknames,
2720 type: {:list, :string},
2739 "ostatus_subscribe",
2763 suggestions: [86_400]
2767 type: {:list, :string},
2768 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2772 type: {:list, :string},
2775 "X-RateLimit-Reset",
2776 "X-RateLimit-Limit",
2777 "X-RateLimit-Remaining",
2788 type: {:list, :string},
2789 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2795 key: Pleroma.Plugs.RemoteIp,
2798 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2799 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2805 description: "Enable/disable the plug. Default: disabled."
2809 type: {:list, :string},
2811 "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]`."
2815 type: {:list, :string},
2817 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2821 type: {:list, :string},
2823 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2829 key: :web_cache_ttl,
2832 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2838 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2839 suggestions: [30_000, nil]
2842 key: :activity_pub_question,
2844 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2845 suggestions: [30_000]
2854 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2859 description: "Enables the rendering of static HTML. Default: disabled."
2867 description: "Configure feed rendering",
2872 description: "Configure title rendering.",
2877 description: "Maximum number of characters before truncating title.",
2883 description: "Replacement which will be used after truncating string.",
2884 suggestions: ["..."]
2892 key: :mrf_object_age,
2894 description: "Rejects or delists posts based on their age when received.",
2899 description: "Required age (in seconds) of a post before actions are taken.",
2900 suggestions: [172_800]
2904 type: {:list, :atom},
2906 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2907 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2908 "`:reject` rejects the message entirely",
2909 suggestions: [:delist, :strip_followers, :reject]
2917 description: "Custom Runtime Modules",
2922 description: "A path to custom Elixir modules (such as MRF policies)."
2930 description: "Settings for notifications streamer",
2935 description: "Number of workers to send notifications.",
2939 key: :overflow_workers,
2941 description: "Maximum number of workers created if pool is empty.",
2948 key: :connections_pool,
2950 description: "Advanced settings for `gun` connections pool",
2953 key: :checkin_timeout,
2955 description: "Timeout to checkin connection from pool. Default: 250ms.",
2959 key: :max_connections,
2961 description: "Maximum number of connections in the pool. Default: 250 connections.",
2968 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
2972 key: :retry_timeout,
2975 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
2979 key: :await_up_timeout,
2981 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
2990 description: "Advanced settings for `gun` workers pools",
2995 description: "Settings for federation pool.",
3000 description: "Number workers in the pool.",
3006 description: "Number of additional workers if pool is under load.",
3012 description: "Timeout while `gun` will wait for response.",
3013 suggestions: [150_000]
3020 description: "Settings for media pool.",
3025 description: "Number workers in the pool.",
3031 description: "Number of additional workers if pool is under load.",
3037 description: "Timeout while `gun` will wait for response.",
3038 suggestions: [150_000]
3045 description: "Settings for upload pool.",
3050 description: "Number workers in the pool.",
3056 description: "Number of additional workers if pool is under load.",
3062 description: "Timeout while `gun` will wait for response.",
3063 suggestions: [300_000]
3070 description: "Settings for default pool.",
3075 description: "Number workers in the pool.",
3081 description: "Number of additional workers if pool is under load.",
3087 description: "Timeout while `gun` will wait for response.",
3088 suggestions: [10_000]
3096 key: :hackney_pools,
3098 description: "Advanced settings for `hackney` connections pools",
3103 description: "Settings for federation pool.",
3106 key: :max_connections,
3108 description: "Number workers in the pool.",
3114 description: "Timeout while `hackney` will wait for response.",
3115 suggestions: [150_000]
3122 description: "Settings for media pool.",
3125 key: :max_connections,
3127 description: "Number workers in the pool.",
3133 description: "Timeout while `hackney` will wait for response.",
3134 suggestions: [150_000]
3141 description: "Settings for upload pool.",
3144 key: :max_connections,
3146 description: "Number workers in the pool.",
3152 description: "Timeout while `hackney` will wait for response.",
3153 suggestions: [300_000]
3161 key: :restrict_unauthenticated,
3164 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3169 description: "Settings for public and federated timelines.",
3174 description: "Disallow view public timeline."
3179 description: "Disallow view federated timeline."
3186 description: "Settings for user profiles.",
3191 description: "Disallow view local user profiles."
3196 description: "Disallow view remote user profiles."
3203 description: "Settings for statuses.",
3208 description: "Disallow view local statuses."
3213 description: "Disallow view remote statuses."