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 sent",
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"
927 key: :multi_factor_authentication,
929 description: "Multi-factor authentication settings",
932 totp: [digits: 6, period: 30],
933 backup_codes: [number: 5, length: 16]
940 description: "TOTP settings",
941 suggestions: [digits: 6, period: 30],
948 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
955 "a period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
962 description: "MFA backup codes settings",
963 suggestions: [number: 5, length: 16],
969 description: "number of backup codes to generate."
976 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
987 description: "Logger-related settings",
991 type: [:atom, :tuple, :module],
993 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
994 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1002 description: "ExSyslogger-related settings",
1006 type: {:dropdown, :atom},
1007 description: "Log level",
1008 suggestions: [:debug, :info, :warn, :error]
1014 "A string that's prepended to every message, and is typically set to the app name",
1015 suggestions: ["pleroma"]
1020 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1021 suggestions: ["$metadata[$level] $message"]
1025 type: {:list, :atom},
1026 suggestions: [:request_id]
1034 description: "Console logger settings",
1038 type: {:dropdown, :atom},
1039 description: "Log level",
1040 suggestions: [:debug, :info, :warn, :error]
1045 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1046 suggestions: ["$metadata[$level] $message"]
1050 type: {:list, :atom},
1051 suggestions: [:request_id]
1058 description: "Quack-related settings",
1062 type: {:dropdown, :atom},
1063 description: "Log level",
1064 suggestions: [:debug, :info, :warn, :error]
1068 type: {:list, :atom},
1069 description: "Configure which metadata you want to report on",
1087 description: "Configure the Slack incoming webhook",
1088 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1094 key: :frontend_configurations,
1097 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1098 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1099 "add your own configuration your settings all fields must be complete.",
1103 label: "Pleroma FE",
1105 description: "Settings for Pleroma FE",
1108 theme: "pleroma-dark",
1109 logo: "/static/logo.png",
1110 background: "/images/city.jpg",
1111 redirectRootNoLogin: "/main/all",
1112 redirectRootLogin: "/main/friends",
1113 showInstanceSpecificPanel: true,
1114 scopeOptionsEnabled: false,
1115 formattingOptionsEnabled: false,
1116 collapseMessageWithSubject: false,
1117 hidePostStats: false,
1118 hideUserStats: false,
1120 subjectLineBehavior: "email",
1121 alwaysShowSubjectInput: true,
1125 enableEmojiPicker: false
1132 description: "Which theme to use, they are defined in styles.json",
1133 suggestions: ["pleroma-dark"]
1138 description: "URL of the logo, defaults to Pleroma's logo",
1139 suggestions: ["/static/logo.png"]
1145 "URL of the background, unless viewing a user profile with a background that is set",
1146 suggestions: ["/images/city.jpg"]
1149 key: :redirectRootNoLogin,
1150 label: "Redirect root no login",
1153 "Relative URL which indicates where to redirect when a user isn't logged in",
1154 suggestions: ["/main/all"]
1157 key: :redirectRootLogin,
1158 label: "Redirect root login",
1161 "Relative URL which indicates where to redirect when a user is logged in",
1162 suggestions: ["/main/friends"]
1165 key: :showInstanceSpecificPanel,
1166 label: "Show instance specific panel",
1168 description: "Whenether to show the instance's specific panel"
1171 key: :scopeOptionsEnabled,
1172 label: "Scope options enabled",
1174 description: "Enable setting a notice visibility and subject/CW when posting"
1177 key: :formattingOptionsEnabled,
1178 label: "Formatting options enabled",
1181 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1184 key: :collapseMessageWithSubject,
1185 label: "Collapse message with subject",
1188 "When a message has a subject (aka Content Warning), collapse it by default"
1191 key: :hidePostStats,
1192 label: "Hide post stats",
1194 description: "Hide notices statistics (repeats, favorites, ...)"
1197 key: :hideUserStats,
1198 label: "Hide user stats",
1201 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1205 label: "Scope copy",
1207 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1210 key: :subjectLineBehavior,
1211 label: "Subject line behavior",
1213 description: "Allows changing the default behaviour of subject lines in replies.
1214 `email`: copy and preprend re:, as in email,
1215 `masto`: copy verbatim, as in Mastodon,
1216 `noop`: don't copy the subject.",
1217 suggestions: ["email", "masto", "noop"]
1220 key: :alwaysShowSubjectInput,
1221 label: "Always show subject input",
1223 description: "When disabled, auto-hide the subject field if it's empty"
1230 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1231 "If you want a colorful logo you must disable logoMask."
1235 label: "Logo margin",
1238 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1239 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1240 suggestions: [".1em"]
1245 description: "Enables stickers."
1248 key: :enableEmojiPicker,
1249 label: "Emoji picker",
1251 description: "Enables emoji picker."
1259 description: "Settings for Masto FE",
1262 showInstanceSpecificPanel: true
1267 key: :showInstanceSpecificPanel,
1268 label: "Show instance specific panel",
1270 description: "Whenether to show the instance's specific panel"
1281 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1285 type: {:keyword, :map},
1287 "Keyword of mascots, each element must contain both an url and a mime_type key",
1290 url: "/images/pleroma-fox-tan-smol.png",
1291 mime_type: "image/png"
1293 pleroma_fox_tan_shy: %{
1294 url: "/images/pleroma-fox-tan-shy.png",
1295 mime_type: "image/png"
1300 key: :default_mascot,
1303 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1315 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1319 type: {:list, :map},
1320 description: "Describe the icons of the app",
1323 src: "/static/logo.png"
1326 src: "/static/icon.png",
1330 src: "/static/icon.ico",
1331 sizes: "72x72 96x96 128x128 256x256"
1338 description: "Describe the theme color of the app",
1339 suggestions: ["#282c37", "mediumpurple"]
1342 key: :background_color,
1344 description: "Describe the background color of the app",
1345 suggestions: ["#191b22", "aliceblue"]
1352 label: "MRF simple",
1354 description: "Message Rewrite Facility",
1357 key: :media_removal,
1358 type: {:list, :string},
1359 description: "List of instances to strip media attachments from",
1360 suggestions: ["example.com", "*.example.com"]
1364 label: "Media NSFW",
1365 type: {:list, :string},
1366 description: "List of instances to tag all media as NSFW (sensitive) from",
1367 suggestions: ["example.com", "*.example.com"]
1370 key: :federated_timeline_removal,
1371 type: {:list, :string},
1373 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1374 suggestions: ["example.com", "*.example.com"]
1378 type: {:list, :string},
1379 description: "List of instances to reject activities from (except deletes)",
1380 suggestions: ["example.com", "*.example.com"]
1384 type: {:list, :string},
1385 description: "List of instances to only accept activities from (except deletes)",
1386 suggestions: ["example.com", "*.example.com"]
1389 key: :report_removal,
1390 type: {:list, :string},
1391 description: "List of instances to reject reports from",
1392 suggestions: ["example.com", "*.example.com"]
1395 key: :avatar_removal,
1396 type: {:list, :string},
1397 description: "List of instances to strip avatars from",
1398 suggestions: ["example.com", "*.example.com"]
1401 key: :banner_removal,
1402 type: {:list, :string},
1403 description: "List of instances to strip banners from",
1404 suggestions: ["example.com", "*.example.com"]
1407 key: :reject_deletes,
1408 type: {:list, :string},
1409 description: "List of instances to reject deletions from",
1410 suggestions: ["example.com", "*.example.com"]
1417 label: "MRF subchain",
1420 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1421 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1426 description: "Matches a series of regular expressions against the actor field",
1429 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1437 key: :mrf_rejectnonpublic,
1439 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1440 label: "MRF reject non public",
1444 key: :allow_followersonly,
1445 label: "Allow followers-only",
1447 description: "Whether to allow followers-only posts"
1452 description: "Whether to allow direct messages"
1458 key: :mrf_hellthread,
1459 label: "MRF hellthread",
1461 description: "Block messages with too much mentions",
1464 key: :delist_threshold,
1467 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1468 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1472 key: :reject_threshold,
1475 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1483 label: "MRF keyword",
1485 description: "Reject or Word-Replace messages with a keyword or regex",
1489 type: [:string, :regex],
1491 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1492 suggestions: ["foo", ~r/foo/iu]
1495 key: :federated_timeline_removal,
1496 type: [:string, :regex],
1498 "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.",
1499 suggestions: ["foo", ~r/foo/iu]
1503 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1505 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1506 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1513 label: "MRF mention",
1515 description: "Block messages which mention a user",
1519 type: {:list, :string},
1520 description: "A list of actors for which any post mentioning them will be dropped.",
1521 suggestions: ["actor1", "actor2"]
1527 key: :mrf_vocabulary,
1528 label: "MRF vocabulary",
1530 description: "Filter messages which belong to certain activity vocabularies",
1534 type: {:list, :string},
1536 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1537 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1541 type: {:list, :string},
1543 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1544 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1550 # key: :mrf_user_allowlist,
1553 # "The keys in this section are the domain names that the policy should apply to." <>
1554 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1556 # ["example.org": ["https://example.org/users/admin"]],
1558 # ["example.org": ["https://example.org/users/admin"]]
1566 description: "Media proxy",
1571 description: "Enables proxying of remote media to the instance's proxy"
1577 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1578 suggestions: ["https://example.com"]
1583 description: "Options for Pleroma.ReverseProxy",
1585 redirect_on_failure: false,
1586 max_body_length: 25 * 1_048_576,
1588 follow_redirect: true,
1594 key: :redirect_on_failure,
1597 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1598 "Any error during body processing will not be redirected as the response is chunked."
1601 key: :max_body_length,
1604 "Limits the content length to be approximately the " <>
1605 "specified length. It is validated with the `content-length` header and also verified when proxying."
1610 description: "HTTP options",
1615 description: "Adapter specific options",
1620 label: "SSL Options",
1621 description: "SSL options for HTTP adapter",
1625 type: {:list, :atom},
1626 description: "List of TLS version to use",
1627 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1636 type: [:string, :tuple],
1637 description: "Proxy URL",
1638 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1646 type: {:list, :string},
1647 description: "List of domains to bypass the mediaproxy",
1648 suggestions: ["example.com"]
1656 description: "Gopher settings",
1661 description: "Enables the gopher interface"
1666 description: "IP address to bind to",
1667 suggestions: [{0, 0, 0, 0}]
1672 description: "Port to bind to",
1678 description: "Port advertised in urls (optional, defaults to port)",
1687 description: "ActivityPub-related settings",
1690 key: :unfollow_blocked,
1692 description: "Whether blocks result in people getting unfollowed"
1695 key: :outgoing_blocks,
1697 description: "Whether to federate blocks to other instances"
1700 key: :sign_object_fetches,
1702 description: "Sign object fetches with HTTP signatures"
1705 key: :note_replies_output_limit,
1708 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1711 key: :follow_handshake_timeout,
1713 description: "Following handshake timeout",
1720 key: :http_security,
1722 description: "HTTP security settings",
1727 description: "Whether the managed content security policy is enabled"
1733 description: "Whether to additionally send a Strict-Transport-Security header"
1737 label: "STS max age",
1739 description: "The maximum age for the Strict-Transport-Security header if sent",
1740 suggestions: [31_536_000]
1744 label: "CT max age",
1746 description: "The maximum age for the Expect-CT header if sent",
1747 suggestions: [2_592_000]
1750 key: :referrer_policy,
1752 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1753 suggestions: ["same-origin", "no-referrer"]
1757 label: "Report URI",
1759 description: "Adds the specified url to report-uri and report-to group in CSP header",
1760 suggestions: ["https://example.com/report-uri"]
1765 group: :web_push_encryption,
1766 key: :vapid_details,
1769 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1775 "A mailto link for the administrative contact." <>
1776 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1777 suggestions: ["mailto:moderators@pleroma.com"]
1782 description: "VAPID public key",
1783 suggestions: ["Public key"]
1788 description: "VAPID private key",
1789 suggestions: ["Private key"]
1795 key: Pleroma.Captcha,
1797 description: "Captcha-related settings",
1802 description: "Whether the captcha should be shown on registration"
1807 description: "The method/service to use for captcha",
1808 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1811 key: :seconds_valid,
1813 description: "The time in seconds for which the captcha is valid",
1820 key: Pleroma.Captcha.Kocaptcha,
1823 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1824 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1829 description: "The kocaptcha endpoint to use",
1830 suggestions: ["https://captcha.kotobank.ch"]
1838 "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",
1843 description: "Token",
1844 suggestions: ["We recommend a secure random string or UUID"]
1853 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1855 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1856 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1857 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1858 (see https://github.com/sorentwo/oban/issues/52).
1864 description: "Application's Ecto repo",
1865 suggestions: [Pleroma.Repo]
1869 type: {:dropdown, :atom},
1870 description: "Logs verbose mode",
1871 suggestions: [false, :error, :warn, :info, :debug]
1875 type: [:atom, :tuple],
1877 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1878 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1882 type: {:keyword, :integer},
1884 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1886 activity_expiration: 10,
1887 attachments_cleanup: 5,
1889 federator_incoming: 50,
1890 federator_outgoing: 50,
1892 scheduled_activities: 10,
1898 key: :activity_expiration,
1900 description: "Activity expiration queue",
1904 key: :attachments_cleanup,
1906 description: "Attachment deletion queue",
1912 description: "Background queue",
1916 key: :federator_incoming,
1918 description: "Incoming federation queue",
1922 key: :federator_outgoing,
1924 description: "Outgoing federation queue",
1930 description: "Email sender queue, see Pleroma.Emails.Mailer",
1934 key: :scheduled_activities,
1936 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1940 key: :transmogrifier,
1942 description: "Transmogrifier queue",
1948 description: "Web push notifications queue",
1955 type: {:list, :tuple},
1956 description: "Settings for cron background jobs",
1958 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1959 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1960 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1961 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1962 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1971 description: "Includes custom worker options not interpretable directly by `Oban`",
1975 type: {:keyword, :integer},
1976 description: "Max retry attempts for failed jobs, per `Oban` queue",
1978 federator_incoming: 5,
1979 federator_outgoing: 5
1986 key: Pleroma.Web.Metadata,
1988 description: "Metadata-related settings",
1992 type: {:list, :module},
1993 description: "List of metadata providers to enable",
1995 Pleroma.Web.Metadata.Providers.OpenGraph,
1996 Pleroma.Web.Metadata.Providers.TwitterCard,
1997 Pleroma.Web.Metadata.Providers.RelMe,
1998 Pleroma.Web.Metadata.Providers.Feed
2003 label: "Unfurl NSFW",
2005 description: "When enabled NSFW attachments will be shown in previews"
2014 "If enabled the instance will parse metadata from attached links to generate link previews.",
2019 description: "Enables RichMedia parsing of URLs."
2023 type: {:list, :string},
2024 description: "List of hosts which will be ignored by the metadata parser.",
2025 suggestions: ["accounts.google.com", "xss.website"]
2029 label: "Ignore TLD",
2030 type: {:list, :string},
2031 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2032 suggestions: ["local", "localdomain", "lan"]
2036 type: {:list, :module},
2038 "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.",
2040 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2041 Pleroma.Web.RichMedia.Parsers.OEmbed,
2042 Pleroma.Web.RichMedia.Parsers.OGP,
2043 Pleroma.Web.RichMedia.Parsers.TwitterCard
2048 label: "TTL setters",
2049 type: {:list, :module},
2051 "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.",
2053 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2059 group: :auto_linker,
2062 description: "Configuration for the auto_linker library",
2066 type: [:string, false],
2067 description: "Specify the class to be added to the generated link. Disable to clear",
2068 suggestions: ["auto-linker", false]
2072 type: [:string, false],
2073 description: "Override the rel attribute. Disable to clear",
2074 suggestions: ["ugc", "noopener noreferrer", false]
2079 description: "Link urls will open in new window/tab"
2083 type: [:integer, false],
2085 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2086 suggestions: [15, false]
2091 description: "Strip the scheme prefix"
2096 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2102 key: Pleroma.ScheduledActivity,
2104 description: "Scheduled activities settings",
2107 key: :daily_user_limit,
2110 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2114 key: :total_user_limit,
2117 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2123 description: "Whether scheduled activities are sent to the job queue to be executed"
2129 key: Pleroma.ActivityExpiration,
2131 description: "Expired activity settings",
2136 description: "Whether expired activities will be sent to the job queue to be deleted"
2143 description: "Authenticator",
2146 key: Pleroma.Web.Auth.Authenticator,
2148 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2157 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2158 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2159 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2160 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2165 description: "Enables LDAP authentication"
2170 description: "LDAP server hostname",
2171 suggestions: ["localhosts"]
2176 description: "LDAP port, e.g. 389 or 636",
2177 suggestions: [389, 636]
2183 description: "Enable to use SSL, usually implies the port 636"
2187 label: "SSL options",
2189 description: "Additional SSL options",
2190 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2195 description: "Path to file with PEM encoded cacerts",
2196 suggestions: ["path/to/file/with/PEM/cacerts"]
2201 description: "Type of cert verification",
2202 suggestions: [:verify_peer]
2210 description: "Enable to use STARTTLS, usually implies the port 389"
2214 label: "TLS options",
2216 description: "Additional TLS options",
2217 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2222 description: "Path to file with PEM encoded cacerts",
2223 suggestions: ["path/to/file/with/PEM/cacerts"]
2228 description: "Type of cert verification",
2229 suggestions: [:verify_peer]
2236 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2237 suggestions: ["dc=example,dc=com"]
2243 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2252 description: "Authentication / authorization settings",
2255 key: :enforce_oauth_admin_scope_usage,
2258 "OAuth admin scope requirement toggle. " <>
2259 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2260 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2261 "`is_admin` user flag grants access to admin-specific actions."
2264 key: :auth_template,
2267 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2268 suggestions: ["show.html"]
2271 key: :oauth_consumer_template,
2274 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2275 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2276 suggestions: ["consumer.html"]
2279 key: :oauth_consumer_strategies,
2280 type: {:list, :string},
2282 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2283 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2284 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2285 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2291 key: :email_notifications,
2293 description: "Email notifications settings",
2299 "emails of \"what you've missed\" for users who have been inactive for a while",
2303 schedule: "0 0 * * 0",
2305 inactivity_threshold: 7
2313 description: "Globally enable or disable digest emails"
2319 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2320 suggestions: ["0 0 * * 0"]
2325 description: "Minimum interval between digest emails to one user",
2329 key: :inactivity_threshold,
2331 description: "Minimum user inactivity threshold",
2340 key: Pleroma.Emails.UserEmail,
2342 description: "Email template settings",
2347 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2348 suggestions: ["some/path/logo.png"]
2353 description: "a map with color settings for email templates.",
2356 link_color: "#d8a070",
2357 background_color: "#2C3645",
2358 content_background_color: "#1B2635",
2359 header_color: "#d8a070",
2360 text_color: "#b9b9ba",
2361 text_muted_color: "#b9b9ba"
2368 suggestions: ["#d8a070"]
2371 key: :background_color,
2373 suggestions: ["#2C3645"]
2376 key: :content_background_color,
2378 suggestions: ["#1B2635"]
2383 suggestions: ["#d8a070"]
2388 suggestions: ["#b9b9ba"]
2391 key: :text_muted_color,
2393 suggestions: ["#b9b9ba"]
2401 key: Pleroma.Emails.NewUsersDigestEmail,
2403 description: "New users admin email digest",
2408 description: "enables new users admin digest email when `true`",
2409 suggestions: [false]
2417 description: "Configure OAuth 2 provider capabilities",
2420 key: :token_expires_in,
2422 description: "The lifetime in seconds of the access token",
2426 key: :issue_new_refresh_token,
2429 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2432 key: :clean_expired_tokens,
2434 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2444 key: :shortcode_globs,
2445 type: {:list, :string},
2446 description: "Location of custom emoji files. * can be used as a wildcard.",
2447 suggestions: ["/emoji/custom/**/*.png"]
2450 key: :pack_extensions,
2451 type: {:list, :string},
2453 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2454 suggestions: [".png", ".gif"]
2458 type: {:keyword, :string, {:list, :string}},
2460 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2461 " and the value is the location or array of locations. * can be used as a wildcard.",
2463 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2467 key: :default_manifest,
2470 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2471 " Currently only one manifest can be added (no arrays).",
2472 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2475 key: :shared_pack_cache_seconds_per_file,
2476 label: "Shared pack cache s/file",
2479 "When an emoji pack is shared, the archive is created and cached in memory" <>
2480 " for this amount of seconds multiplied by the number of files.",
2490 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2494 type: [:tuple, {:list, :tuple}],
2495 description: "For the search requests (account & status search etc.)",
2496 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2500 type: [:tuple, {:list, :tuple}],
2501 description: "For requests to timelines (each timeline has it's own limiter)",
2502 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2505 key: :app_account_creation,
2506 type: [:tuple, {:list, :tuple}],
2507 description: "For registering user accounts from the same IP address",
2508 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2511 key: :relations_actions,
2512 type: [:tuple, {:list, :tuple}],
2513 description: "For actions on relationships with all users (follow, unfollow)",
2514 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2517 key: :relation_id_action,
2518 type: [:tuple, {:list, :tuple}],
2519 description: "For actions on relation with a specific user (follow, unfollow)",
2520 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2523 key: :statuses_actions,
2524 type: [:tuple, {:list, :tuple}],
2526 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2527 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2530 key: :status_id_action,
2531 type: [:tuple, {:list, :tuple}],
2533 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2534 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2537 key: :authentication,
2538 type: [:tuple, {:list, :tuple}],
2539 description: "For authentication create / password check / user existence check requests",
2540 suggestions: [{60_000, 15}]
2548 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2549 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2554 description: "Enables SSH"
2559 description: "Dir with SSH keys",
2560 suggestions: ["/some/path/ssh_keys"]
2565 description: "Handler module",
2566 suggestions: ["Pleroma.BBS.Handler"]
2571 description: "Port to connect",
2572 suggestions: [10_022]
2575 key: :password_authenticator,
2577 description: "Authenticator module",
2578 suggestions: ["Pleroma.BBS.Authenticator"]
2585 description: "Mime types",
2592 "application/xml" => ["xml"],
2593 "application/xrd+xml" => ["xrd+xml"],
2594 "application/jrd+json" => ["jrd+json"],
2595 "application/activity+json" => ["activity+json"],
2596 "application/ld+json" => ["activity+json"]
2601 key: "application/xml",
2602 type: {:list, :string},
2603 suggestions: ["xml"]
2606 key: "application/xrd+xml",
2607 type: {:list, :string},
2608 suggestions: ["xrd+xml"]
2611 key: "application/jrd+json",
2612 type: {:list, :string},
2613 suggestions: ["jrd+json"]
2616 key: "application/activity+json",
2617 type: {:list, :string},
2618 suggestions: ["activity+json"]
2621 key: "application/ld+json",
2622 type: {:list, :string},
2623 suggestions: ["activity+json"]
2633 description: "Pleroma chat settings",
2642 group: :http_signatures,
2644 description: "HTTP Signatures settings",
2649 suggestions: [Pleroma.Signature]
2657 description: "HTTP settings",
2662 type: [:string, :tuple],
2663 description: "Proxy URL",
2664 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2667 key: :send_user_agent,
2672 type: [:string, :atom],
2674 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2675 suggestions: ["Pleroma", :default]
2680 description: "Adapter specific options",
2686 label: "SSL Options",
2687 description: "SSL options for HTTP adapter",
2691 type: {:list, :atom},
2692 description: "List of TLS version to use",
2693 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2707 key: :allow_inline_images,
2711 key: :allow_headings,
2724 type: {:list, :module},
2726 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom MRF module you need to use full name.",
2727 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2737 key: :deny_follow_blocked,
2744 key: :mrf_normalize_markup,
2745 label: "MRF normalize markup",
2746 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2752 suggestions: [Pleroma.HTML.Scrubber.Default]
2762 key: :restricted_nicknames,
2763 type: {:list, :string},
2782 "ostatus_subscribe",
2806 suggestions: [86_400]
2810 type: {:list, :string},
2811 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2815 type: {:list, :string},
2818 "X-RateLimit-Reset",
2819 "X-RateLimit-Limit",
2820 "X-RateLimit-Remaining",
2831 type: {:list, :string},
2832 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2838 key: Pleroma.Plugs.RemoteIp,
2841 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2842 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2848 description: "Enable/disable the plug. Default: disabled."
2852 type: {:list, :string},
2854 "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]`."
2858 type: {:list, :string},
2860 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2864 type: {:list, :string},
2866 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2872 key: :web_cache_ttl,
2875 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2881 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2882 suggestions: [30_000, nil]
2885 key: :activity_pub_question,
2887 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2888 suggestions: [30_000]
2897 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2902 description: "Enables the rendering of static HTML. Default: disabled."
2910 description: "Configure feed rendering",
2915 description: "Configure title rendering.",
2920 description: "Maximum number of characters before truncating title.",
2926 description: "Replacement which will be used after truncating string.",
2927 suggestions: ["..."]
2935 key: :mrf_object_age,
2937 description: "Rejects or delists posts based on their age when received.",
2942 description: "Required age (in seconds) of a post before actions are taken.",
2943 suggestions: [172_800]
2947 type: {:list, :atom},
2949 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2950 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2951 "`:reject` rejects the message entirely",
2952 suggestions: [:delist, :strip_followers, :reject]
2960 description: "Custom Runtime Modules",
2965 description: "A path to custom Elixir modules (such as MRF policies)."
2973 description: "Settings for notifications streamer",
2978 description: "Number of workers to send notifications.",
2982 key: :overflow_workers,
2984 description: "Maximum number of workers created if pool is empty.",
2991 key: :connections_pool,
2993 description: "Advanced settings for `gun` connections pool",
2996 key: :checkin_timeout,
2998 description: "Timeout to checkin connection from pool. Default: 250ms.",
3002 key: :max_connections,
3004 description: "Maximum number of connections in the pool. Default: 250 connections.",
3011 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3015 key: :retry_timeout,
3018 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3022 key: :await_up_timeout,
3024 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3033 description: "Advanced settings for `gun` workers pools",
3038 description: "Settings for federation pool.",
3043 description: "Number workers in the pool.",
3049 description: "Number of additional workers if pool is under load.",
3055 description: "Timeout while `gun` will wait for response.",
3056 suggestions: [150_000]
3063 description: "Settings for media pool.",
3068 description: "Number workers in the pool.",
3074 description: "Number of additional workers if pool is under load.",
3080 description: "Timeout while `gun` will wait for response.",
3081 suggestions: [150_000]
3088 description: "Settings for upload pool.",
3093 description: "Number workers in the pool.",
3099 description: "Number of additional workers if pool is under load.",
3105 description: "Timeout while `gun` will wait for response.",
3106 suggestions: [300_000]
3113 description: "Settings for default pool.",
3118 description: "Number workers in the pool.",
3124 description: "Number of additional workers if pool is under load.",
3130 description: "Timeout while `gun` will wait for response.",
3131 suggestions: [10_000]
3139 key: :hackney_pools,
3141 description: "Advanced settings for `hackney` connections pools",
3146 description: "Settings for federation pool.",
3149 key: :max_connections,
3151 description: "Number workers in the pool.",
3157 description: "Timeout while `hackney` will wait for response.",
3158 suggestions: [150_000]
3165 description: "Settings for media pool.",
3168 key: :max_connections,
3170 description: "Number workers in the pool.",
3176 description: "Timeout while `hackney` will wait for response.",
3177 suggestions: [150_000]
3184 description: "Settings for upload pool.",
3187 key: :max_connections,
3189 description: "Number workers in the pool.",
3195 description: "Timeout while `hackney` will wait for response.",
3196 suggestions: [300_000]
3204 key: :restrict_unauthenticated,
3207 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3212 description: "Settings for public and federated timelines.",
3217 description: "Disallow view public timeline."
3222 description: "Disallow view federated timeline."
3229 description: "Settings for user profiles.",
3234 description: "Disallow view local user profiles."
3239 description: "Disallow view remote user profiles."
3246 description: "Settings for statuses.",
3251 description: "Disallow view local statuses."
3256 description: "Disallow view remote statuses."
3264 key: Pleroma.Web.ApiSpec.CastAndValidate,
3271 "Enables strict input validation (useful in development, not recommended in production)",
3272 suggestions: [false]