2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
26 suggestions: [Pleroma.Uploaders.Local, Pleroma.Uploaders.S3]
30 type: {:list, :module},
32 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
34 Generator.list_modules_in_dir(
35 "lib/pleroma/upload/filter",
36 "Elixir.Pleroma.Upload.Filter."
43 "If enabled, a name parameter will be added to the url of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
48 description: "Base url for the uploads, needed if you use CDN",
50 "https://cdn-host.com"
57 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
62 description: "Options for Pleroma.ReverseProxy",
64 redirect_on_failure: false,
65 max_body_length: 25 * 1_048_576,
67 follow_redirect: true,
73 key: :redirect_on_failure,
76 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
77 "Any error during body processing will not be redirected as the response is chunked."
80 key: :max_body_length,
83 "Limits the content length to be approximately the " <>
84 "specified length. It is validated with the `content-length` header and also verified when proxying."
89 description: "HTTP options",
94 description: "Adapter specific options",
100 description: "SSL options for HTTP adapter",
104 type: {:list, :atom},
105 description: "List of TLS versions to use",
106 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
115 type: [:string, :tuple],
116 description: "Proxy URL",
117 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
127 key: Pleroma.Uploaders.Local,
129 description: "Local uploader-related settings",
134 description: "Path where user's uploads will be saved",
143 key: Pleroma.Uploaders.S3,
145 description: "S3 uploader-related settings",
150 description: "S3 bucket",
156 key: :bucket_namespace,
158 description: "S3 bucket namespace",
159 suggestions: ["pleroma"]
162 key: :public_endpoint,
164 description: "S3 endpoint",
165 suggestions: ["https://s3.amazonaws.com"]
168 key: :truncated_namespace,
171 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
172 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
175 key: :streaming_enabled,
178 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
184 key: Pleroma.Upload.Filter.Mogrify,
186 description: "Uploads mogrify filter settings",
190 type: [:string, {:list, :string}, {:list, :tuple}],
191 description: "List of actions for the mogrify command",
202 key: Pleroma.Upload.Filter.AnonymizeFilename,
204 description: "Filter replaces the filename of the upload",
210 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
211 " filename extension by using {extension}, for example custom-file-name.{extension}.",
213 "custom-file-name.{extension}"
220 key: Pleroma.Emails.Mailer,
222 description: "Mailer-related settings",
228 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
229 " or Swoosh.Adapters.Local for in-memory mailbox",
231 Swoosh.Adapters.SMTP,
232 Swoosh.Adapters.Sendgrid,
233 Swoosh.Adapters.Sendmail,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Mailgun,
236 Swoosh.Adapters.Mailjet,
237 Swoosh.Adapters.Postmark,
238 Swoosh.Adapters.SparkPost,
239 Swoosh.Adapters.AmazonSES,
241 Swoosh.Adapters.SocketLabs,
242 Swoosh.Adapters.Gmail,
243 Swoosh.Adapters.Local
249 description: "Allow/disallow send emails"
252 group: {:subgroup, Swoosh.Adapters.SMTP},
255 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
256 suggestions: ["smtp.gmail.com"]
259 group: {:subgroup, Swoosh.Adapters.SMTP},
262 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
263 suggestions: ["pleroma"]
266 group: {:subgroup, Swoosh.Adapters.SMTP},
269 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
270 suggestions: ["password"]
273 group: {:subgroup, Swoosh.Adapters.SMTP},
277 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
280 group: {:subgroup, Swoosh.Adapters.SMTP},
284 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
285 suggestions: [:always, :never, :if_available]
288 group: {:subgroup, Swoosh.Adapters.SMTP},
291 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
292 suggestions: [:always, :never, :if_available]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
302 group: {:subgroup, Swoosh.Adapters.SMTP},
305 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
309 group: {:subgroup, Swoosh.Adapters.SMTP},
311 label: "No MX lookups",
313 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
316 group: {:subgroup, Swoosh.Adapters.Sendgrid},
320 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
321 suggestions: ["my-api-key"]
324 group: {:subgroup, Swoosh.Adapters.Sendmail},
327 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
328 suggestions: ["/usr/bin/sendmail"]
331 group: {:subgroup, Swoosh.Adapters.Sendmail},
334 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
335 suggestions: ["-N delay,failure,success"]
338 group: {:subgroup, Swoosh.Adapters.Sendmail},
341 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
344 group: {:subgroup, Swoosh.Adapters.Mandrill},
348 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
349 suggestions: ["my-api-key"]
352 group: {:subgroup, Swoosh.Adapters.Mailgun},
356 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
357 suggestions: ["my-api-key"]
360 group: {:subgroup, Swoosh.Adapters.Mailgun},
363 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
364 suggestions: ["pleroma.com"]
367 group: {:subgroup, Swoosh.Adapters.Mailjet},
371 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
372 suggestions: ["my-api-key"]
375 group: {:subgroup, Swoosh.Adapters.Mailjet},
378 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
379 suggestions: ["my-secret-key"]
382 group: {:subgroup, Swoosh.Adapters.Postmark},
386 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
387 suggestions: ["my-api-key"]
390 group: {:subgroup, Swoosh.Adapters.SparkPost},
394 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
395 suggestions: ["my-api-key"]
398 group: {:subgroup, Swoosh.Adapters.SparkPost},
401 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
402 suggestions: ["https://api.sparkpost.com/api/v1"]
405 group: {:subgroup, Swoosh.Adapters.AmazonSES},
408 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
409 suggestions: ["us-east-1", "us-east-2"]
412 group: {:subgroup, Swoosh.Adapters.AmazonSES},
415 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
416 suggestions: ["aws-access-key"]
419 group: {:subgroup, Swoosh.Adapters.AmazonSES},
422 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
423 suggestions: ["aws-secret-key"]
426 group: {:subgroup, Swoosh.Adapters.Dyn},
430 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
431 suggestions: ["my-api-key"]
434 group: {:subgroup, Swoosh.Adapters.SocketLabs},
437 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
440 group: {:subgroup, Swoosh.Adapters.SocketLabs},
444 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
447 group: {:subgroup, Swoosh.Adapters.Gmail},
450 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
457 description: "`Swoosh.Adapters.Local` adapter specific settings",
460 group: {:subgroup, Swoosh.Adapters.Local},
463 description: "Run the preview server together as part of your app"
466 group: {:subgroup, Swoosh.Adapters.Local},
469 description: "The preview server port",
478 description: "URI schemes related settings",
482 type: {:list, :string},
483 description: "List of the scheme part that is considered valid to be an URL",
507 description: "Instance-related settings",
512 description: "Name of the instance",
519 label: "Admin Email Address",
521 description: "Email used to reach an Administrator/Moderator of the instance",
528 label: "Sender Email Address",
530 description: "Envelope FROM address for mail sent via Pleroma",
539 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
547 description: "Posts character limit (CW/Subject included in the counter)",
555 description: "Character limit of the instance chat messages",
563 description: "Hard character limit beyond which remote posts will be dropped",
571 description: "File size limit of uploads (except for avatar, background, banner)",
577 key: :avatar_upload_limit,
579 description: "File size limit of user's profile avatars",
585 key: :background_upload_limit,
587 description: "File size limit of user's profile backgrounds",
593 key: :banner_upload_limit,
595 description: "File size limit of user's profile banners",
603 description: "A map with poll limits for local polls",
607 max_option_chars: 200,
609 max_expiration: 31_536_000
616 description: "Maximum number of options",
620 key: :max_option_chars,
622 description: "Maximum number of characters per option",
626 key: :min_expiration,
628 description: "Minimum expiration time (in seconds)",
632 key: :max_expiration,
634 description: "Maximum expiration time (in seconds)",
640 key: :registrations_open,
643 "Enable registrations for anyone. Invitations require this setting to be disabled."
646 key: :invites_enabled,
649 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
652 key: :account_activation_required,
654 description: "Require users to confirm their emails before signing in."
659 description: "Enable federation with other instances."
662 key: :federation_incoming_replies_max_depth,
663 label: "Fed. incoming replies max depth",
666 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
667 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
673 key: :federation_reachability_timeout_days,
674 label: "Fed. reachability timeout days",
677 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
685 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
688 key: :rewrite_policy,
689 type: [:module, {:list, :module}],
691 "A list of enabled MRF policies. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
693 Generator.list_modules_in_dir(
694 "lib/pleroma/web/activity_pub/mrf",
695 "Elixir.Pleroma.Web.ActivityPub.MRF."
702 "Makes the client API in authentificated mode-only except for user-profiles." <>
703 " Useful for disabling the Local Timeline and The Whole Known Network."
706 key: :quarantined_instances,
707 type: {:list, :string},
709 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
716 key: :managed_config,
719 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
724 description: "Instance static directory",
730 key: :allowed_post_formats,
731 type: {:list, :string},
732 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
741 key: :mrf_transparency,
742 label: "MRF transparency",
745 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
748 key: :mrf_transparency_exclusions,
749 label: "MRF transparency exclusions",
750 type: {:list, :string},
752 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
758 key: :extended_nickname_format,
761 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
762 " This will break federation with older software for theses nicknames."
765 key: :cleanup_attachments,
768 Enable to remove associated attachments when status is removed.
769 This will not affect duplicates and attachments without status.
770 Enabling this will increase load to database when deleting statuses on larger instances.
774 key: :max_pinned_statuses,
776 description: "The maximum number of pinned statuses. 0 will disable the feature.",
784 key: :autofollowed_nicknames,
785 type: {:list, :string},
787 "Set to nicknames of (local) users that every new user should automatically follow",
796 key: :attachment_links,
798 description: "Enable to automatically add attachment link text to statuses"
801 key: :welcome_message,
804 "A message that will be sent to a newly registered users as a direct message",
806 "Hi, @username! Welcome on board!"
810 key: :welcome_user_nickname,
812 description: "The nickname of the local user that sends the welcome message",
818 key: :max_report_comment_size,
820 description: "The maximum size of the report comment. Default: 1000.",
826 key: :safe_dm_mentions,
829 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
830 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
836 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
839 key: :remote_post_retention_days,
842 "The default amount of days to retain remote posts when pruning the database",
848 key: :user_bio_length,
850 description: "A user bio maximum length. Default: 5000.",
856 key: :user_name_length,
858 description: "A user name maximum length. Default: 100.",
864 key: :skip_thread_containment,
866 description: "Skip filtering out broken threads. Default: enabled"
869 key: :limit_to_local_content,
870 type: {:dropdown, :atom},
872 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
880 key: :max_account_fields,
882 description: "The maximum number of custom fields in the user profile. Default: 10.",
888 key: :max_remote_account_fields,
891 "The maximum number of custom fields in the remote user profile. Default: 20.",
897 key: :account_field_name_length,
899 description: "An account field name maximum length. Default: 512.",
905 key: :account_field_value_length,
907 description: "An account field value maximum length. Default: 2048.",
913 key: :external_user_synchronization,
915 description: "Enabling following/followers counters synchronization for external users"
918 key: :multi_factor_authentication,
920 description: "Multi-factor authentication settings",
923 totp: [digits: 6, period: 30],
924 backup_codes: [number: 5, length: 16]
931 description: "TOTP settings",
932 suggestions: [digits: 6, period: 30],
939 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
946 "a period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
953 description: "MFA backup codes settings",
954 suggestions: [number: 5, length: 16],
960 description: "number of backup codes to generate."
967 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
978 description: "Logger-related settings",
982 type: [:atom, :tuple, :module],
984 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
985 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
993 description: "ExSyslogger-related settings",
997 type: {:dropdown, :atom},
998 description: "Log level",
999 suggestions: [:debug, :info, :warn, :error]
1005 "A string that's prepended to every message, and is typically set to the app name",
1006 suggestions: ["pleroma"]
1011 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1012 suggestions: ["$metadata[$level] $message"]
1016 type: {:list, :atom},
1017 suggestions: [:request_id]
1025 description: "Console logger settings",
1029 type: {:dropdown, :atom},
1030 description: "Log level",
1031 suggestions: [:debug, :info, :warn, :error]
1036 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1037 suggestions: ["$metadata[$level] $message"]
1041 type: {:list, :atom},
1042 suggestions: [:request_id]
1049 description: "Quack-related settings",
1053 type: {:dropdown, :atom},
1054 description: "Log level",
1055 suggestions: [:debug, :info, :warn, :error]
1059 type: {:list, :atom},
1060 description: "Configure which metadata you want to report on",
1078 description: "Configure the Slack incoming webhook",
1079 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1085 key: :frontend_configurations,
1088 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1089 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1090 "add your own configuration your settings all fields must be complete.",
1094 label: "Pleroma FE",
1096 description: "Settings for Pleroma FE",
1099 alwaysShowSubjectInput: true,
1100 background: "/static/aurora_borealis.jpg",
1101 collapseMessageWithSubject: false,
1104 hideFilteredStatuses: false,
1105 hideMutedPosts: false,
1106 hidePostStats: false,
1107 hideSitename: false,
1108 hideUserStats: false,
1109 loginMethod: "password",
1110 logo: "/static/logo.png",
1113 minimalScopesMode: false,
1114 noAttachmentLinks: false,
1115 nsfwCensorImage: "",
1116 postContentType: "text/plain",
1117 redirectRootLogin: "/main/friends",
1118 redirectRootNoLogin: "/main/all",
1120 showFeaturesPanel: true,
1121 showInstanceSpecificPanel: false,
1122 subjectLineBehavior: "email",
1123 theme: "pleroma-dark",
1124 webPushNotifications: false
1129 key: :alwaysShowSubjectInput,
1130 label: "Always show subject input",
1132 description: "When disabled, auto-hide the subject field if it's empty"
1138 "URL of the background, unless viewing a user profile with a background that is set",
1139 suggestions: ["/images/city.jpg"]
1142 key: :collapseMessageWithSubject,
1143 label: "Collapse message with subject",
1146 "When a message has a subject (aka Content Warning), collapse it by default"
1150 label: "PleromaFE Chat",
1152 description: "Disables PleromaFE Chat component"
1158 description: "Enables green text on lines prefixed with the > character."
1161 key: :hideFilteredStatuses,
1162 label: "Hide Filtered Statuses",
1164 description: "Hides filtered statuses from timelines."
1167 key: :hideMutedPosts,
1168 label: "Hide Muted Posts",
1170 description: "Hides muted statuses from timelines."
1173 key: :hidePostStats,
1174 label: "Hide post stats",
1176 description: "Hide notices statistics (repeats, favorites, ...)"
1180 label: "Hide Sitename",
1182 description: "Hides instance name from PleromaFE banner."
1185 key: :hideUserStats,
1186 label: "Hide user stats",
1189 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1194 description: "URL of the logo, defaults to Pleroma's logo",
1195 suggestions: ["/static/logo.png"]
1199 label: "Logo margin",
1202 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1203 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1204 suggestions: [".1em"]
1211 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1212 "If you want a colorful logo you must disable logoMask."
1215 key: :minimalScopesMode,
1216 label: "Minimal scopes mode",
1219 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1220 "Also prevents replying to a DM with a public post from PleromaFE."
1223 key: :nsfwCensorImage,
1224 label: "NSFW Censor Image",
1227 "URL of the image to use for hiding NSFW media attachments in the timeline.",
1228 suggestions: ["/static/img/nsfw.png"]
1231 key: :postContentType,
1232 label: "Post Content Type",
1233 type: {:dropdown, :atom},
1234 description: "Default post formatting option.",
1235 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1238 key: :redirectRootNoLogin,
1239 label: "Redirect root no login",
1242 "Relative URL which indicates where to redirect when a user isn't logged in",
1243 suggestions: ["/main/all"]
1246 key: :redirectRootLogin,
1247 label: "Redirect root login",
1250 "Relative URL which indicates where to redirect when a user is logged in",
1251 suggestions: ["/main/friends"]
1255 label: "Scope copy",
1257 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1260 key: :showFeaturesPanel,
1261 label: "Show instance features panel",
1264 "Enables panel displaying functionality of the instance on the About page."
1267 key: :showInstanceSpecificPanel,
1268 label: "Show instance specific panel",
1270 description: "Whether to show the instance's custom panel"
1273 key: :subjectLineBehavior,
1274 label: "Subject line behavior",
1276 description: "Allows changing the default behaviour of subject lines in replies.
1277 `email`: copy and preprend re:, as in email,
1278 `masto`: copy verbatim, as in Mastodon,
1279 `noop`: don't copy the subject.",
1280 suggestions: ["email", "masto", "noop"]
1285 description: "Which theme to use. Available themes are defined in styles.json",
1286 suggestions: ["pleroma-dark"]
1294 description: "Settings for Masto FE",
1297 showInstanceSpecificPanel: true
1302 key: :showInstanceSpecificPanel,
1303 label: "Show instance specific panel",
1305 description: "Whenether to show the instance's specific panel"
1316 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1320 type: {:keyword, :map},
1322 "Keyword of mascots, each element must contain both an url and a mime_type key",
1325 url: "/images/pleroma-fox-tan-smol.png",
1326 mime_type: "image/png"
1328 pleroma_fox_tan_shy: %{
1329 url: "/images/pleroma-fox-tan-shy.png",
1330 mime_type: "image/png"
1335 key: :default_mascot,
1338 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1350 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1354 type: {:list, :map},
1355 description: "Describe the icons of the app",
1358 src: "/static/logo.png"
1361 src: "/static/icon.png",
1365 src: "/static/icon.ico",
1366 sizes: "72x72 96x96 128x128 256x256"
1373 description: "Describe the theme color of the app",
1374 suggestions: ["#282c37", "mediumpurple"]
1377 key: :background_color,
1379 description: "Describe the background color of the app",
1380 suggestions: ["#191b22", "aliceblue"]
1387 label: "MRF simple",
1389 description: "Message Rewrite Facility",
1392 key: :media_removal,
1393 type: {:list, :string},
1394 description: "List of instances to strip media attachments from",
1395 suggestions: ["example.com", "*.example.com"]
1399 label: "Media NSFW",
1400 type: {:list, :string},
1401 description: "List of instances to tag all media as NSFW (sensitive) from",
1402 suggestions: ["example.com", "*.example.com"]
1405 key: :federated_timeline_removal,
1406 type: {:list, :string},
1408 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1409 suggestions: ["example.com", "*.example.com"]
1413 type: {:list, :string},
1414 description: "List of instances to reject activities from (except deletes)",
1415 suggestions: ["example.com", "*.example.com"]
1419 type: {:list, :string},
1420 description: "List of instances to only accept activities from (except deletes)",
1421 suggestions: ["example.com", "*.example.com"]
1424 key: :report_removal,
1425 type: {:list, :string},
1426 description: "List of instances to reject reports from",
1427 suggestions: ["example.com", "*.example.com"]
1430 key: :avatar_removal,
1431 type: {:list, :string},
1432 description: "List of instances to strip avatars from",
1433 suggestions: ["example.com", "*.example.com"]
1436 key: :banner_removal,
1437 type: {:list, :string},
1438 description: "List of instances to strip banners from",
1439 suggestions: ["example.com", "*.example.com"]
1442 key: :reject_deletes,
1443 type: {:list, :string},
1444 description: "List of instances to reject deletions from",
1445 suggestions: ["example.com", "*.example.com"]
1452 label: "MRF subchain",
1455 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1456 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1461 description: "Matches a series of regular expressions against the actor field",
1464 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1472 key: :mrf_rejectnonpublic,
1474 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1475 label: "MRF reject non public",
1479 key: :allow_followersonly,
1480 label: "Allow followers-only",
1482 description: "Whether to allow followers-only posts"
1487 description: "Whether to allow direct messages"
1493 key: :mrf_hellthread,
1494 label: "MRF hellthread",
1496 description: "Block messages with too much mentions",
1499 key: :delist_threshold,
1502 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1503 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1507 key: :reject_threshold,
1510 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1518 label: "MRF keyword",
1520 description: "Reject or Word-Replace messages with a keyword or regex",
1524 type: [:string, :regex],
1526 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1527 suggestions: ["foo", ~r/foo/iu]
1530 key: :federated_timeline_removal,
1531 type: [:string, :regex],
1533 "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.",
1534 suggestions: ["foo", ~r/foo/iu]
1538 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1540 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1541 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1548 label: "MRF mention",
1550 description: "Block messages which mention a user",
1554 type: {:list, :string},
1555 description: "A list of actors for which any post mentioning them will be dropped.",
1556 suggestions: ["actor1", "actor2"]
1562 key: :mrf_vocabulary,
1563 label: "MRF vocabulary",
1565 description: "Filter messages which belong to certain activity vocabularies",
1569 type: {:list, :string},
1571 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1572 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1576 type: {:list, :string},
1578 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1579 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1585 # key: :mrf_user_allowlist,
1588 # "The keys in this section are the domain names that the policy should apply to." <>
1589 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1591 # ["example.org": ["https://example.org/users/admin"]],
1593 # ["example.org": ["https://example.org/users/admin"]]
1601 description: "Media proxy",
1606 description: "Enables proxying of remote media to the instance's proxy"
1612 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1613 suggestions: ["https://example.com"]
1618 description: "Options for Pleroma.ReverseProxy",
1620 redirect_on_failure: false,
1621 max_body_length: 25 * 1_048_576,
1623 follow_redirect: true,
1629 key: :redirect_on_failure,
1632 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1633 "Any error during body processing will not be redirected as the response is chunked."
1636 key: :max_body_length,
1639 "Limits the content length to be approximately the " <>
1640 "specified length. It is validated with the `content-length` header and also verified when proxying."
1645 description: "HTTP options",
1650 description: "Adapter specific options",
1655 label: "SSL Options",
1656 description: "SSL options for HTTP adapter",
1660 type: {:list, :atom},
1661 description: "List of TLS version to use",
1662 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1671 type: [:string, :tuple],
1672 description: "Proxy URL",
1673 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1681 type: {:list, :string},
1682 description: "List of domains to bypass the mediaproxy",
1683 suggestions: ["example.com"]
1691 description: "Gopher settings",
1696 description: "Enables the gopher interface"
1701 description: "IP address to bind to",
1702 suggestions: [{0, 0, 0, 0}]
1707 description: "Port to bind to",
1713 description: "Port advertised in urls (optional, defaults to port)",
1722 description: "ActivityPub-related settings",
1725 key: :unfollow_blocked,
1727 description: "Whether blocks result in people getting unfollowed"
1730 key: :outgoing_blocks,
1732 description: "Whether to federate blocks to other instances"
1735 key: :sign_object_fetches,
1737 description: "Sign object fetches with HTTP signatures"
1740 key: :note_replies_output_limit,
1743 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1746 key: :follow_handshake_timeout,
1748 description: "Following handshake timeout",
1755 key: :http_security,
1757 description: "HTTP security settings",
1762 description: "Whether the managed content security policy is enabled"
1768 description: "Whether to additionally send a Strict-Transport-Security header"
1772 label: "STS max age",
1774 description: "The maximum age for the Strict-Transport-Security header if sent",
1775 suggestions: [31_536_000]
1779 label: "CT max age",
1781 description: "The maximum age for the Expect-CT header if sent",
1782 suggestions: [2_592_000]
1785 key: :referrer_policy,
1787 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1788 suggestions: ["same-origin", "no-referrer"]
1792 label: "Report URI",
1794 description: "Adds the specified url to report-uri and report-to group in CSP header",
1795 suggestions: ["https://example.com/report-uri"]
1800 group: :web_push_encryption,
1801 key: :vapid_details,
1804 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1810 "A mailto link for the administrative contact." <>
1811 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1812 suggestions: ["mailto:moderators@pleroma.com"]
1817 description: "VAPID public key",
1818 suggestions: ["Public key"]
1823 description: "VAPID private key",
1824 suggestions: ["Private key"]
1830 key: Pleroma.Captcha,
1832 description: "Captcha-related settings",
1837 description: "Whether the captcha should be shown on registration"
1842 description: "The method/service to use for captcha",
1843 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1846 key: :seconds_valid,
1848 description: "The time in seconds for which the captcha is valid",
1855 key: Pleroma.Captcha.Kocaptcha,
1858 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1859 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1864 description: "The kocaptcha endpoint to use",
1865 suggestions: ["https://captcha.kotobank.ch"]
1873 "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",
1878 description: "Token",
1879 suggestions: ["We recommend a secure random string or UUID"]
1888 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1890 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1891 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1892 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1893 (see https://github.com/sorentwo/oban/issues/52).
1898 type: {:dropdown, :atom},
1899 description: "Logs verbose mode",
1900 suggestions: [false, :error, :warn, :info, :debug]
1904 type: [:atom, :tuple],
1906 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1907 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1911 type: {:keyword, :integer},
1913 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1915 activity_expiration: 10,
1916 attachments_cleanup: 5,
1918 federator_incoming: 50,
1919 federator_outgoing: 50,
1921 scheduled_activities: 10,
1927 key: :activity_expiration,
1929 description: "Activity expiration queue",
1933 key: :attachments_cleanup,
1935 description: "Attachment deletion queue",
1941 description: "Background queue",
1945 key: :federator_incoming,
1947 description: "Incoming federation queue",
1951 key: :federator_outgoing,
1953 description: "Outgoing federation queue",
1959 description: "Email sender queue, see Pleroma.Emails.Mailer",
1963 key: :scheduled_activities,
1965 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1969 key: :transmogrifier,
1971 description: "Transmogrifier queue",
1977 description: "Web push notifications queue",
1984 type: {:list, :tuple},
1985 description: "Settings for cron background jobs",
1987 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1988 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1989 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1990 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1991 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2000 description: "Includes custom worker options not interpretable directly by `Oban`",
2004 type: {:keyword, :integer},
2005 description: "Max retry attempts for failed jobs, per `Oban` queue",
2007 federator_incoming: 5,
2008 federator_outgoing: 5
2015 key: Pleroma.Web.Metadata,
2017 description: "Metadata-related settings",
2021 type: {:list, :module},
2022 description: "List of metadata providers to enable",
2024 Pleroma.Web.Metadata.Providers.OpenGraph,
2025 Pleroma.Web.Metadata.Providers.TwitterCard,
2026 Pleroma.Web.Metadata.Providers.RelMe,
2027 Pleroma.Web.Metadata.Providers.Feed
2032 label: "Unfurl NSFW",
2034 description: "When enabled NSFW attachments will be shown in previews"
2043 "If enabled the instance will parse metadata from attached links to generate link previews.",
2048 description: "Enables RichMedia parsing of URLs."
2052 type: {:list, :string},
2053 description: "List of hosts which will be ignored by the metadata parser.",
2054 suggestions: ["accounts.google.com", "xss.website"]
2058 label: "Ignore TLD",
2059 type: {:list, :string},
2060 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2061 suggestions: ["local", "localdomain", "lan"]
2065 type: {:list, :module},
2067 "List of Rich Media parsers. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parsers.` part), but on adding custom module you need to use full name.",
2069 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2070 Pleroma.Web.RichMedia.Parsers.OEmbed,
2071 Pleroma.Web.RichMedia.Parsers.OGP,
2072 Pleroma.Web.RichMedia.Parsers.TwitterCard
2077 label: "TTL setters",
2078 type: {:list, :module},
2080 "List of rich media TTL setters. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parser.` part), but on adding custom module you need to use full name.",
2082 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2088 group: :auto_linker,
2091 description: "Configuration for the auto_linker library",
2095 type: [:string, false],
2096 description: "Specify the class to be added to the generated link. Disable to clear",
2097 suggestions: ["auto-linker", false]
2101 type: [:string, false],
2102 description: "Override the rel attribute. Disable to clear",
2103 suggestions: ["ugc", "noopener noreferrer", false]
2108 description: "Link urls will open in new window/tab"
2112 type: [:integer, false],
2114 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2115 suggestions: [15, false]
2120 description: "Strip the scheme prefix"
2125 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2131 key: Pleroma.ScheduledActivity,
2133 description: "Scheduled activities settings",
2136 key: :daily_user_limit,
2139 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2143 key: :total_user_limit,
2146 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2152 description: "Whether scheduled activities are sent to the job queue to be executed"
2158 key: Pleroma.ActivityExpiration,
2160 description: "Expired activity settings",
2165 description: "Whether expired activities will be sent to the job queue to be deleted"
2172 description: "Authenticator",
2175 key: Pleroma.Web.Auth.Authenticator,
2177 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2186 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2187 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2188 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2189 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2194 description: "Enables LDAP authentication"
2199 description: "LDAP server hostname",
2200 suggestions: ["localhosts"]
2205 description: "LDAP port, e.g. 389 or 636",
2206 suggestions: [389, 636]
2212 description: "Enable to use SSL, usually implies the port 636"
2216 label: "SSL options",
2218 description: "Additional SSL options",
2219 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2224 description: "Path to file with PEM encoded cacerts",
2225 suggestions: ["path/to/file/with/PEM/cacerts"]
2230 description: "Type of cert verification",
2231 suggestions: [:verify_peer]
2239 description: "Enable to use STARTTLS, usually implies the port 389"
2243 label: "TLS options",
2245 description: "Additional TLS options",
2246 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2251 description: "Path to file with PEM encoded cacerts",
2252 suggestions: ["path/to/file/with/PEM/cacerts"]
2257 description: "Type of cert verification",
2258 suggestions: [:verify_peer]
2265 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2266 suggestions: ["dc=example,dc=com"]
2272 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2281 description: "Authentication / authorization settings",
2284 key: :enforce_oauth_admin_scope_usage,
2287 "OAuth admin scope requirement toggle. " <>
2288 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2289 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2290 "`is_admin` user flag grants access to admin-specific actions."
2293 key: :auth_template,
2296 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2297 suggestions: ["show.html"]
2300 key: :oauth_consumer_template,
2303 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2304 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2305 suggestions: ["consumer.html"]
2308 key: :oauth_consumer_strategies,
2309 type: {:list, :string},
2311 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2312 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2313 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2314 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2320 key: :email_notifications,
2322 description: "Email notifications settings",
2328 "emails of \"what you've missed\" for users who have been inactive for a while",
2332 schedule: "0 0 * * 0",
2334 inactivity_threshold: 7
2342 description: "Globally enable or disable digest emails"
2348 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2349 suggestions: ["0 0 * * 0"]
2354 description: "Minimum interval between digest emails to one user",
2358 key: :inactivity_threshold,
2360 description: "Minimum user inactivity threshold",
2369 key: Pleroma.Emails.UserEmail,
2371 description: "Email template settings",
2376 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2377 suggestions: ["some/path/logo.png"]
2382 description: "a map with color settings for email templates.",
2385 link_color: "#d8a070",
2386 background_color: "#2C3645",
2387 content_background_color: "#1B2635",
2388 header_color: "#d8a070",
2389 text_color: "#b9b9ba",
2390 text_muted_color: "#b9b9ba"
2397 suggestions: ["#d8a070"]
2400 key: :background_color,
2402 suggestions: ["#2C3645"]
2405 key: :content_background_color,
2407 suggestions: ["#1B2635"]
2412 suggestions: ["#d8a070"]
2417 suggestions: ["#b9b9ba"]
2420 key: :text_muted_color,
2422 suggestions: ["#b9b9ba"]
2430 key: Pleroma.Emails.NewUsersDigestEmail,
2432 description: "New users admin email digest",
2437 description: "enables new users admin digest email when `true`",
2438 suggestions: [false]
2446 description: "Configure OAuth 2 provider capabilities",
2449 key: :token_expires_in,
2451 description: "The lifetime in seconds of the access token",
2455 key: :issue_new_refresh_token,
2458 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2461 key: :clean_expired_tokens,
2463 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2473 key: :shortcode_globs,
2474 type: {:list, :string},
2475 description: "Location of custom emoji files. * can be used as a wildcard.",
2476 suggestions: ["/emoji/custom/**/*.png"]
2479 key: :pack_extensions,
2480 type: {:list, :string},
2482 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2483 suggestions: [".png", ".gif"]
2487 type: {:keyword, :string, {:list, :string}},
2489 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2490 " and the value is the location or array of locations. * can be used as a wildcard.",
2492 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2496 key: :default_manifest,
2499 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2500 " Currently only one manifest can be added (no arrays).",
2501 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2504 key: :shared_pack_cache_seconds_per_file,
2505 label: "Shared pack cache s/file",
2508 "When an emoji pack is shared, the archive is created and cached in memory" <>
2509 " for this amount of seconds multiplied by the number of files.",
2519 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2523 type: [:tuple, {:list, :tuple}],
2524 description: "For the search requests (account & status search etc.)",
2525 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2529 type: [:tuple, {:list, :tuple}],
2530 description: "For requests to timelines (each timeline has it's own limiter)",
2531 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2534 key: :app_account_creation,
2535 type: [:tuple, {:list, :tuple}],
2536 description: "For registering user accounts from the same IP address",
2537 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2540 key: :relations_actions,
2541 type: [:tuple, {:list, :tuple}],
2542 description: "For actions on relationships with all users (follow, unfollow)",
2543 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2546 key: :relation_id_action,
2547 type: [:tuple, {:list, :tuple}],
2548 description: "For actions on relation with a specific user (follow, unfollow)",
2549 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2552 key: :statuses_actions,
2553 type: [:tuple, {:list, :tuple}],
2555 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2556 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2559 key: :status_id_action,
2560 type: [:tuple, {:list, :tuple}],
2562 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2563 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2566 key: :authentication,
2567 type: [:tuple, {:list, :tuple}],
2568 description: "For authentication create / password check / user existence check requests",
2569 suggestions: [{60_000, 15}]
2577 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2578 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2583 description: "Enables SSH"
2588 description: "Dir with SSH keys",
2589 suggestions: ["/some/path/ssh_keys"]
2594 description: "Handler module",
2595 suggestions: ["Pleroma.BBS.Handler"]
2600 description: "Port to connect",
2601 suggestions: [10_022]
2604 key: :password_authenticator,
2606 description: "Authenticator module",
2607 suggestions: ["Pleroma.BBS.Authenticator"]
2614 description: "Mime types",
2621 "application/xml" => ["xml"],
2622 "application/xrd+xml" => ["xrd+xml"],
2623 "application/jrd+json" => ["jrd+json"],
2624 "application/activity+json" => ["activity+json"],
2625 "application/ld+json" => ["activity+json"]
2630 key: "application/xml",
2631 type: {:list, :string},
2632 suggestions: ["xml"]
2635 key: "application/xrd+xml",
2636 type: {:list, :string},
2637 suggestions: ["xrd+xml"]
2640 key: "application/jrd+json",
2641 type: {:list, :string},
2642 suggestions: ["jrd+json"]
2645 key: "application/activity+json",
2646 type: {:list, :string},
2647 suggestions: ["activity+json"]
2650 key: "application/ld+json",
2651 type: {:list, :string},
2652 suggestions: ["activity+json"]
2662 description: "Pleroma chat settings",
2674 description: "HTTP settings",
2679 type: [:string, :tuple],
2680 description: "Proxy URL",
2681 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2684 key: :send_user_agent,
2689 type: [:string, :atom],
2691 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2692 suggestions: ["Pleroma", :default]
2697 description: "Adapter specific options",
2703 label: "SSL Options",
2704 description: "SSL options for HTTP adapter",
2708 type: {:list, :atom},
2709 description: "List of TLS version to use",
2710 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2724 key: :allow_inline_images,
2728 key: :allow_headings,
2741 type: {:list, :module},
2743 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2744 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2754 key: :deny_follow_blocked,
2761 key: :mrf_normalize_markup,
2762 label: "MRF normalize markup",
2763 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2769 suggestions: [Pleroma.HTML.Scrubber.Default]
2779 key: :restricted_nicknames,
2780 type: {:list, :string},
2799 "ostatus_subscribe",
2823 suggestions: [86_400]
2827 type: {:list, :string},
2828 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2832 type: {:list, :string},
2835 "X-RateLimit-Reset",
2836 "X-RateLimit-Limit",
2837 "X-RateLimit-Remaining",
2848 type: {:list, :string},
2849 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2855 key: Pleroma.Plugs.RemoteIp,
2858 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2859 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2865 description: "Enable/disable the plug. Default: disabled."
2869 type: {:list, :string},
2871 "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]`."
2875 type: {:list, :string},
2877 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2881 type: {:list, :string},
2883 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2889 key: :web_cache_ttl,
2892 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2898 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2899 suggestions: [30_000, nil]
2902 key: :activity_pub_question,
2904 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2905 suggestions: [30_000]
2914 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2919 description: "Enables the rendering of static HTML. Default: disabled."
2927 description: "Configure feed rendering",
2932 description: "Configure title rendering.",
2937 description: "Maximum number of characters before truncating title.",
2943 description: "Replacement which will be used after truncating string.",
2944 suggestions: ["..."]
2952 key: :mrf_object_age,
2954 description: "Rejects or delists posts based on their age when received.",
2959 description: "Required age (in seconds) of a post before actions are taken.",
2960 suggestions: [172_800]
2964 type: {:list, :atom},
2966 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2967 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2968 "`:reject` rejects the message entirely",
2969 suggestions: [:delist, :strip_followers, :reject]
2977 description: "Custom Runtime Modules",
2982 description: "A path to custom Elixir modules (such as MRF policies)."
2990 description: "Settings for notifications streamer",
2995 description: "Number of workers to send notifications.",
2999 key: :overflow_workers,
3001 description: "Maximum number of workers created if pool is empty.",
3008 key: :connections_pool,
3010 description: "Advanced settings for `gun` connections pool",
3013 key: :checkin_timeout,
3015 description: "Timeout to checkin connection from pool. Default: 250ms.",
3019 key: :max_connections,
3021 description: "Maximum number of connections in the pool. Default: 250 connections.",
3028 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3032 key: :retry_timeout,
3035 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3039 key: :await_up_timeout,
3041 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3050 description: "Advanced settings for `gun` workers pools",
3055 description: "Settings for federation pool.",
3060 description: "Number workers in the pool.",
3066 description: "Number of additional workers if pool is under load.",
3072 description: "Timeout while `gun` will wait for response.",
3073 suggestions: [150_000]
3080 description: "Settings for media pool.",
3085 description: "Number workers in the pool.",
3091 description: "Number of additional workers if pool is under load.",
3097 description: "Timeout while `gun` will wait for response.",
3098 suggestions: [150_000]
3105 description: "Settings for upload pool.",
3110 description: "Number workers in the pool.",
3116 description: "Number of additional workers if pool is under load.",
3122 description: "Timeout while `gun` will wait for response.",
3123 suggestions: [300_000]
3130 description: "Settings for default pool.",
3135 description: "Number workers in the pool.",
3141 description: "Number of additional workers if pool is under load.",
3147 description: "Timeout while `gun` will wait for response.",
3148 suggestions: [10_000]
3156 key: :hackney_pools,
3158 description: "Advanced settings for `hackney` connections pools",
3163 description: "Settings for federation pool.",
3166 key: :max_connections,
3168 description: "Number workers in the pool.",
3174 description: "Timeout while `hackney` will wait for response.",
3175 suggestions: [150_000]
3182 description: "Settings for media pool.",
3185 key: :max_connections,
3187 description: "Number workers in the pool.",
3193 description: "Timeout while `hackney` will wait for response.",
3194 suggestions: [150_000]
3201 description: "Settings for upload pool.",
3204 key: :max_connections,
3206 description: "Number workers in the pool.",
3212 description: "Timeout while `hackney` will wait for response.",
3213 suggestions: [300_000]
3221 key: :restrict_unauthenticated,
3224 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3229 description: "Settings for public and federated timelines.",
3234 description: "Disallow view public timeline."
3239 description: "Disallow view federated timeline."
3246 description: "Settings for user profiles.",
3251 description: "Disallow view local user profiles."
3256 description: "Disallow view remote user profiles."
3263 description: "Settings for statuses.",
3268 description: "Disallow view local statuses."
3273 description: "Disallow view remote statuses."
3281 key: Pleroma.Web.ApiSpec.CastAndValidate,
3288 "Enables strict input validation (useful in development, not recommended in production)",
3289 suggestions: [false]