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.",
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 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 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 alwaysShowSubjectInput: true,
1109 background: "/static/aurora_borealis.jpg",
1110 collapseMessageWithSubject: false,
1113 hideFilteredStatuses: false,
1114 hideMutedPosts: false,
1115 hidePostStats: false,
1116 hideSitename: false,
1117 hideUserStats: false,
1118 loginMethod: "password",
1119 logo: "/static/logo.png",
1122 minimalScopesMode: false,
1123 noAttachmentLinks: false,
1124 nsfwCensorImage: "",
1125 postContentType: "text/plain",
1126 redirectRootLogin: "/main/friends",
1127 redirectRootNoLogin: "/main/all",
1129 showFeaturesPanel: true,
1130 showInstanceSpecificPanel: false,
1131 subjectLineBehavior: "email",
1132 theme: "pleroma-dark",
1133 webPushNotifications: false
1138 key: :alwaysShowSubjectInput,
1139 label: "Always show subject input",
1141 description: "When disabled, auto-hide the subject field if it's empty"
1147 "URL of the background, unless viewing a user profile with a background that is set",
1148 suggestions: ["/images/city.jpg"]
1151 key: :collapseMessageWithSubject,
1152 label: "Collapse message with subject",
1155 "When a message has a subject (aka Content Warning), collapse it by default"
1159 label: "PleromaFE Chat",
1161 description: "Disables PleromaFE Chat component"
1164 key: :formattingOptionsEnabled,
1165 label: "Formatting options enabled",
1168 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1171 key: :hidePostStats,
1172 label: "Hide post stats",
1174 description: "Hide notices statistics (repeats, favorites, ...)"
1177 key: :hideUserStats,
1178 label: "Hide user stats",
1181 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1186 description: "URL of the logo, defaults to Pleroma's logo",
1187 suggestions: ["/static/logo.png"]
1191 label: "Logo margin",
1194 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1195 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1196 suggestions: [".1em"]
1203 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1204 "If you want a colorful logo you must disable logoMask."
1207 key: :minimalScopesMode,
1208 label: "Minimal scopes mode",
1210 description: "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1211 "Also prevents replying to a DM with a public post from PleromaFE."
1214 key: :redirectRootNoLogin,
1215 label: "Redirect root no login",
1218 "Relative URL which indicates where to redirect when a user isn't logged in",
1219 suggestions: ["/main/all"]
1222 key: :redirectRootLogin,
1223 label: "Redirect root login",
1226 "Relative URL which indicates where to redirect when a user is logged in",
1227 suggestions: ["/main/friends"]
1231 label: "Scope copy",
1233 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1236 key: :showInstanceSpecificPanel,
1237 label: "Show instance specific panel",
1239 description: "Whether to show the instance's custom panel"
1242 key: :subjectLineBehavior,
1243 label: "Subject line behavior",
1245 description: "Allows changing the default behaviour of subject lines in replies.
1246 `email`: copy and preprend re:, as in email,
1247 `masto`: copy verbatim, as in Mastodon,
1248 `noop`: don't copy the subject.",
1249 suggestions: ["email", "masto", "noop"]
1254 description: "Which theme to use. Available themes are defined in styles.json",
1255 suggestions: ["pleroma-dark"]
1263 description: "Settings for Masto FE",
1266 showInstanceSpecificPanel: true
1271 key: :showInstanceSpecificPanel,
1272 label: "Show instance specific panel",
1274 description: "Whenether to show the instance's specific panel"
1285 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1289 type: {:keyword, :map},
1291 "Keyword of mascots, each element must contain both an url and a mime_type key",
1294 url: "/images/pleroma-fox-tan-smol.png",
1295 mime_type: "image/png"
1297 pleroma_fox_tan_shy: %{
1298 url: "/images/pleroma-fox-tan-shy.png",
1299 mime_type: "image/png"
1304 key: :default_mascot,
1307 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1319 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1323 type: {:list, :map},
1324 description: "Describe the icons of the app",
1327 src: "/static/logo.png"
1330 src: "/static/icon.png",
1334 src: "/static/icon.ico",
1335 sizes: "72x72 96x96 128x128 256x256"
1342 description: "Describe the theme color of the app",
1343 suggestions: ["#282c37", "mediumpurple"]
1346 key: :background_color,
1348 description: "Describe the background color of the app",
1349 suggestions: ["#191b22", "aliceblue"]
1356 label: "MRF simple",
1358 description: "Message Rewrite Facility",
1361 key: :media_removal,
1362 type: {:list, :string},
1363 description: "List of instances to strip media attachments from",
1364 suggestions: ["example.com", "*.example.com"]
1368 label: "Media NSFW",
1369 type: {:list, :string},
1370 description: "List of instances to tag all media as NSFW (sensitive) from",
1371 suggestions: ["example.com", "*.example.com"]
1374 key: :federated_timeline_removal,
1375 type: {:list, :string},
1377 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1378 suggestions: ["example.com", "*.example.com"]
1382 type: {:list, :string},
1383 description: "List of instances to reject activities from (except deletes)",
1384 suggestions: ["example.com", "*.example.com"]
1388 type: {:list, :string},
1389 description: "List of instances to only accept activities from (except deletes)",
1390 suggestions: ["example.com", "*.example.com"]
1393 key: :report_removal,
1394 type: {:list, :string},
1395 description: "List of instances to reject reports from",
1396 suggestions: ["example.com", "*.example.com"]
1399 key: :avatar_removal,
1400 type: {:list, :string},
1401 description: "List of instances to strip avatars from",
1402 suggestions: ["example.com", "*.example.com"]
1405 key: :banner_removal,
1406 type: {:list, :string},
1407 description: "List of instances to strip banners from",
1408 suggestions: ["example.com", "*.example.com"]
1411 key: :reject_deletes,
1412 type: {:list, :string},
1413 description: "List of instances to reject deletions from",
1414 suggestions: ["example.com", "*.example.com"]
1421 label: "MRF subchain",
1424 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1425 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1430 description: "Matches a series of regular expressions against the actor field",
1433 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1441 key: :mrf_rejectnonpublic,
1443 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1444 label: "MRF reject non public",
1448 key: :allow_followersonly,
1449 label: "Allow followers-only",
1451 description: "Whether to allow followers-only posts"
1456 description: "Whether to allow direct messages"
1462 key: :mrf_hellthread,
1463 label: "MRF hellthread",
1465 description: "Block messages with too much mentions",
1468 key: :delist_threshold,
1471 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1472 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1476 key: :reject_threshold,
1479 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1487 label: "MRF keyword",
1489 description: "Reject or Word-Replace messages with a keyword or regex",
1493 type: [:string, :regex],
1495 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1496 suggestions: ["foo", ~r/foo/iu]
1499 key: :federated_timeline_removal,
1500 type: [:string, :regex],
1502 "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.",
1503 suggestions: ["foo", ~r/foo/iu]
1507 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1509 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1510 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1517 label: "MRF mention",
1519 description: "Block messages which mention a user",
1523 type: {:list, :string},
1524 description: "A list of actors for which any post mentioning them will be dropped.",
1525 suggestions: ["actor1", "actor2"]
1531 key: :mrf_vocabulary,
1532 label: "MRF vocabulary",
1534 description: "Filter messages which belong to certain activity vocabularies",
1538 type: {:list, :string},
1540 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1541 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1545 type: {:list, :string},
1547 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1548 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1554 # key: :mrf_user_allowlist,
1557 # "The keys in this section are the domain names that the policy should apply to." <>
1558 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1560 # ["example.org": ["https://example.org/users/admin"]],
1562 # ["example.org": ["https://example.org/users/admin"]]
1570 description: "Media proxy",
1575 description: "Enables proxying of remote media to the instance's proxy"
1581 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1582 suggestions: ["https://example.com"]
1587 description: "Options for Pleroma.ReverseProxy",
1589 redirect_on_failure: false,
1590 max_body_length: 25 * 1_048_576,
1592 follow_redirect: true,
1598 key: :redirect_on_failure,
1601 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1602 "Any error during body processing will not be redirected as the response is chunked."
1605 key: :max_body_length,
1608 "Limits the content length to be approximately the " <>
1609 "specified length. It is validated with the `content-length` header and also verified when proxying."
1614 description: "HTTP options",
1619 description: "Adapter specific options",
1624 label: "SSL Options",
1625 description: "SSL options for HTTP adapter",
1629 type: {:list, :atom},
1630 description: "List of TLS version to use",
1631 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1640 type: [:string, :tuple],
1641 description: "Proxy URL",
1642 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1650 type: {:list, :string},
1651 description: "List of domains to bypass the mediaproxy",
1652 suggestions: ["example.com"]
1660 description: "Gopher settings",
1665 description: "Enables the gopher interface"
1670 description: "IP address to bind to",
1671 suggestions: [{0, 0, 0, 0}]
1676 description: "Port to bind to",
1682 description: "Port advertised in urls (optional, defaults to port)",
1691 description: "ActivityPub-related settings",
1694 key: :unfollow_blocked,
1696 description: "Whether blocks result in people getting unfollowed"
1699 key: :outgoing_blocks,
1701 description: "Whether to federate blocks to other instances"
1704 key: :sign_object_fetches,
1706 description: "Sign object fetches with HTTP signatures"
1709 key: :note_replies_output_limit,
1712 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1715 key: :follow_handshake_timeout,
1717 description: "Following handshake timeout",
1724 key: :http_security,
1726 description: "HTTP security settings",
1731 description: "Whether the managed content security policy is enabled"
1737 description: "Whether to additionally send a Strict-Transport-Security header"
1741 label: "STS max age",
1743 description: "The maximum age for the Strict-Transport-Security header if sent",
1744 suggestions: [31_536_000]
1748 label: "CT max age",
1750 description: "The maximum age for the Expect-CT header if sent",
1751 suggestions: [2_592_000]
1754 key: :referrer_policy,
1756 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1757 suggestions: ["same-origin", "no-referrer"]
1761 label: "Report URI",
1763 description: "Adds the specified url to report-uri and report-to group in CSP header",
1764 suggestions: ["https://example.com/report-uri"]
1769 group: :web_push_encryption,
1770 key: :vapid_details,
1773 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1779 "A mailto link for the administrative contact." <>
1780 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1781 suggestions: ["mailto:moderators@pleroma.com"]
1786 description: "VAPID public key",
1787 suggestions: ["Public key"]
1792 description: "VAPID private key",
1793 suggestions: ["Private key"]
1799 key: Pleroma.Captcha,
1801 description: "Captcha-related settings",
1806 description: "Whether the captcha should be shown on registration"
1811 description: "The method/service to use for captcha",
1812 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1815 key: :seconds_valid,
1817 description: "The time in seconds for which the captcha is valid",
1824 key: Pleroma.Captcha.Kocaptcha,
1827 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1828 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1833 description: "The kocaptcha endpoint to use",
1834 suggestions: ["https://captcha.kotobank.ch"]
1842 "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",
1847 description: "Token",
1848 suggestions: ["We recommend a secure random string or UUID"]
1857 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1859 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1860 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1861 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1862 (see https://github.com/sorentwo/oban/issues/52).
1868 description: "Application's Ecto repo",
1869 suggestions: [Pleroma.Repo]
1873 type: {:dropdown, :atom},
1874 description: "Logs verbose mode",
1875 suggestions: [false, :error, :warn, :info, :debug]
1879 type: [:atom, :tuple],
1881 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1882 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1886 type: {:keyword, :integer},
1888 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1890 activity_expiration: 10,
1891 attachments_cleanup: 5,
1893 federator_incoming: 50,
1894 federator_outgoing: 50,
1896 scheduled_activities: 10,
1902 key: :activity_expiration,
1904 description: "Activity expiration queue",
1908 key: :attachments_cleanup,
1910 description: "Attachment deletion queue",
1916 description: "Background queue",
1920 key: :federator_incoming,
1922 description: "Incoming federation queue",
1926 key: :federator_outgoing,
1928 description: "Outgoing federation queue",
1934 description: "Email sender queue, see Pleroma.Emails.Mailer",
1938 key: :scheduled_activities,
1940 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1944 key: :transmogrifier,
1946 description: "Transmogrifier queue",
1952 description: "Web push notifications queue",
1959 type: {:list, :tuple},
1960 description: "Settings for cron background jobs",
1962 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1963 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1964 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1965 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1966 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1975 description: "Includes custom worker options not interpretable directly by `Oban`",
1979 type: {:keyword, :integer},
1980 description: "Max retry attempts for failed jobs, per `Oban` queue",
1982 federator_incoming: 5,
1983 federator_outgoing: 5
1990 key: Pleroma.Web.Metadata,
1992 description: "Metadata-related settings",
1996 type: {:list, :module},
1997 description: "List of metadata providers to enable",
1999 Pleroma.Web.Metadata.Providers.OpenGraph,
2000 Pleroma.Web.Metadata.Providers.TwitterCard,
2001 Pleroma.Web.Metadata.Providers.RelMe,
2002 Pleroma.Web.Metadata.Providers.Feed
2007 label: "Unfurl NSFW",
2009 description: "When enabled NSFW attachments will be shown in previews"
2018 "If enabled the instance will parse metadata from attached links to generate link previews.",
2023 description: "Enables RichMedia parsing of URLs."
2027 type: {:list, :string},
2028 description: "List of hosts which will be ignored by the metadata parser.",
2029 suggestions: ["accounts.google.com", "xss.website"]
2033 label: "Ignore TLD",
2034 type: {:list, :string},
2035 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2036 suggestions: ["local", "localdomain", "lan"]
2040 type: {:list, :module},
2042 "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.",
2044 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2045 Pleroma.Web.RichMedia.Parsers.OEmbed,
2046 Pleroma.Web.RichMedia.Parsers.OGP,
2047 Pleroma.Web.RichMedia.Parsers.TwitterCard
2052 label: "TTL setters",
2053 type: {:list, :module},
2055 "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.",
2057 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2063 group: :auto_linker,
2066 description: "Configuration for the auto_linker library",
2070 type: [:string, false],
2071 description: "Specify the class to be added to the generated link. Disable to clear",
2072 suggestions: ["auto-linker", false]
2076 type: [:string, false],
2077 description: "Override the rel attribute. Disable to clear",
2078 suggestions: ["ugc", "noopener noreferrer", false]
2083 description: "Link urls will open in new window/tab"
2087 type: [:integer, false],
2089 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2090 suggestions: [15, false]
2095 description: "Strip the scheme prefix"
2100 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2106 key: Pleroma.ScheduledActivity,
2108 description: "Scheduled activities settings",
2111 key: :daily_user_limit,
2114 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2118 key: :total_user_limit,
2121 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2127 description: "Whether scheduled activities are sent to the job queue to be executed"
2133 key: Pleroma.ActivityExpiration,
2135 description: "Expired activity settings",
2140 description: "Whether expired activities will be sent to the job queue to be deleted"
2147 description: "Authenticator",
2150 key: Pleroma.Web.Auth.Authenticator,
2152 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2161 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2162 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2163 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2164 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2169 description: "Enables LDAP authentication"
2174 description: "LDAP server hostname",
2175 suggestions: ["localhosts"]
2180 description: "LDAP port, e.g. 389 or 636",
2181 suggestions: [389, 636]
2187 description: "Enable to use SSL, usually implies the port 636"
2191 label: "SSL options",
2193 description: "Additional SSL options",
2194 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2199 description: "Path to file with PEM encoded cacerts",
2200 suggestions: ["path/to/file/with/PEM/cacerts"]
2205 description: "Type of cert verification",
2206 suggestions: [:verify_peer]
2214 description: "Enable to use STARTTLS, usually implies the port 389"
2218 label: "TLS options",
2220 description: "Additional TLS options",
2221 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2226 description: "Path to file with PEM encoded cacerts",
2227 suggestions: ["path/to/file/with/PEM/cacerts"]
2232 description: "Type of cert verification",
2233 suggestions: [:verify_peer]
2240 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2241 suggestions: ["dc=example,dc=com"]
2247 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2256 description: "Authentication / authorization settings",
2259 key: :enforce_oauth_admin_scope_usage,
2262 "OAuth admin scope requirement toggle. " <>
2263 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2264 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2265 "`is_admin` user flag grants access to admin-specific actions."
2268 key: :auth_template,
2271 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2272 suggestions: ["show.html"]
2275 key: :oauth_consumer_template,
2278 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2279 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2280 suggestions: ["consumer.html"]
2283 key: :oauth_consumer_strategies,
2284 type: {:list, :string},
2286 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2287 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2288 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2289 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2295 key: :email_notifications,
2297 description: "Email notifications settings",
2303 "emails of \"what you've missed\" for users who have been inactive for a while",
2307 schedule: "0 0 * * 0",
2309 inactivity_threshold: 7
2317 description: "Globally enable or disable digest emails"
2323 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2324 suggestions: ["0 0 * * 0"]
2329 description: "Minimum interval between digest emails to one user",
2333 key: :inactivity_threshold,
2335 description: "Minimum user inactivity threshold",
2344 key: Pleroma.Emails.UserEmail,
2346 description: "Email template settings",
2351 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2352 suggestions: ["some/path/logo.png"]
2357 description: "a map with color settings for email templates.",
2360 link_color: "#d8a070",
2361 background_color: "#2C3645",
2362 content_background_color: "#1B2635",
2363 header_color: "#d8a070",
2364 text_color: "#b9b9ba",
2365 text_muted_color: "#b9b9ba"
2372 suggestions: ["#d8a070"]
2375 key: :background_color,
2377 suggestions: ["#2C3645"]
2380 key: :content_background_color,
2382 suggestions: ["#1B2635"]
2387 suggestions: ["#d8a070"]
2392 suggestions: ["#b9b9ba"]
2395 key: :text_muted_color,
2397 suggestions: ["#b9b9ba"]
2405 key: Pleroma.Emails.NewUsersDigestEmail,
2407 description: "New users admin email digest",
2412 description: "enables new users admin digest email when `true`",
2413 suggestions: [false]
2421 description: "Configure OAuth 2 provider capabilities",
2424 key: :token_expires_in,
2426 description: "The lifetime in seconds of the access token",
2430 key: :issue_new_refresh_token,
2433 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2436 key: :clean_expired_tokens,
2438 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2448 key: :shortcode_globs,
2449 type: {:list, :string},
2450 description: "Location of custom emoji files. * can be used as a wildcard.",
2451 suggestions: ["/emoji/custom/**/*.png"]
2454 key: :pack_extensions,
2455 type: {:list, :string},
2457 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2458 suggestions: [".png", ".gif"]
2462 type: {:keyword, :string, {:list, :string}},
2464 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2465 " and the value is the location or array of locations. * can be used as a wildcard.",
2467 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2471 key: :default_manifest,
2474 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2475 " Currently only one manifest can be added (no arrays).",
2476 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2479 key: :shared_pack_cache_seconds_per_file,
2480 label: "Shared pack cache s/file",
2483 "When an emoji pack is shared, the archive is created and cached in memory" <>
2484 " for this amount of seconds multiplied by the number of files.",
2494 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2498 type: [:tuple, {:list, :tuple}],
2499 description: "For the search requests (account & status search etc.)",
2500 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2504 type: [:tuple, {:list, :tuple}],
2505 description: "For requests to timelines (each timeline has it's own limiter)",
2506 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2509 key: :app_account_creation,
2510 type: [:tuple, {:list, :tuple}],
2511 description: "For registering user accounts from the same IP address",
2512 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2515 key: :relations_actions,
2516 type: [:tuple, {:list, :tuple}],
2517 description: "For actions on relationships with all users (follow, unfollow)",
2518 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2521 key: :relation_id_action,
2522 type: [:tuple, {:list, :tuple}],
2523 description: "For actions on relation with a specific user (follow, unfollow)",
2524 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2527 key: :statuses_actions,
2528 type: [:tuple, {:list, :tuple}],
2530 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2531 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2534 key: :status_id_action,
2535 type: [:tuple, {:list, :tuple}],
2537 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2538 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2541 key: :authentication,
2542 type: [:tuple, {:list, :tuple}],
2543 description: "For authentication create / password check / user existence check requests",
2544 suggestions: [{60_000, 15}]
2552 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2553 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2558 description: "Enables SSH"
2563 description: "Dir with SSH keys",
2564 suggestions: ["/some/path/ssh_keys"]
2569 description: "Handler module",
2570 suggestions: ["Pleroma.BBS.Handler"]
2575 description: "Port to connect",
2576 suggestions: [10_022]
2579 key: :password_authenticator,
2581 description: "Authenticator module",
2582 suggestions: ["Pleroma.BBS.Authenticator"]
2589 description: "Mime types",
2596 "application/xml" => ["xml"],
2597 "application/xrd+xml" => ["xrd+xml"],
2598 "application/jrd+json" => ["jrd+json"],
2599 "application/activity+json" => ["activity+json"],
2600 "application/ld+json" => ["activity+json"]
2605 key: "application/xml",
2606 type: {:list, :string},
2607 suggestions: ["xml"]
2610 key: "application/xrd+xml",
2611 type: {:list, :string},
2612 suggestions: ["xrd+xml"]
2615 key: "application/jrd+json",
2616 type: {:list, :string},
2617 suggestions: ["jrd+json"]
2620 key: "application/activity+json",
2621 type: {:list, :string},
2622 suggestions: ["activity+json"]
2625 key: "application/ld+json",
2626 type: {:list, :string},
2627 suggestions: ["activity+json"]
2637 description: "Pleroma chat settings",
2646 group: :http_signatures,
2648 description: "HTTP Signatures settings",
2653 suggestions: [Pleroma.Signature]
2661 description: "HTTP settings",
2666 type: [:string, :tuple],
2667 description: "Proxy URL",
2668 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2671 key: :send_user_agent,
2676 type: [:string, :atom],
2678 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2679 suggestions: ["Pleroma", :default]
2684 description: "Adapter specific options",
2690 label: "SSL Options",
2691 description: "SSL options for HTTP adapter",
2695 type: {:list, :atom},
2696 description: "List of TLS version to use",
2697 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2711 key: :allow_inline_images,
2715 key: :allow_headings,
2728 type: {:list, :module},
2730 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2731 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2741 key: :deny_follow_blocked,
2748 key: :mrf_normalize_markup,
2749 label: "MRF normalize markup",
2750 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2756 suggestions: [Pleroma.HTML.Scrubber.Default]
2766 key: :restricted_nicknames,
2767 type: {:list, :string},
2786 "ostatus_subscribe",
2810 suggestions: [86_400]
2814 type: {:list, :string},
2815 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2819 type: {:list, :string},
2822 "X-RateLimit-Reset",
2823 "X-RateLimit-Limit",
2824 "X-RateLimit-Remaining",
2835 type: {:list, :string},
2836 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2842 key: Pleroma.Plugs.RemoteIp,
2845 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2846 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2852 description: "Enable/disable the plug. Default: disabled."
2856 type: {:list, :string},
2858 "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]`."
2862 type: {:list, :string},
2864 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2868 type: {:list, :string},
2870 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2876 key: :web_cache_ttl,
2879 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2885 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2886 suggestions: [30_000, nil]
2889 key: :activity_pub_question,
2891 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2892 suggestions: [30_000]
2901 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2906 description: "Enables the rendering of static HTML. Default: disabled."
2914 description: "Configure feed rendering",
2919 description: "Configure title rendering.",
2924 description: "Maximum number of characters before truncating title.",
2930 description: "Replacement which will be used after truncating string.",
2931 suggestions: ["..."]
2939 key: :mrf_object_age,
2941 description: "Rejects or delists posts based on their age when received.",
2946 description: "Required age (in seconds) of a post before actions are taken.",
2947 suggestions: [172_800]
2951 type: {:list, :atom},
2953 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2954 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2955 "`:reject` rejects the message entirely",
2956 suggestions: [:delist, :strip_followers, :reject]
2964 description: "Custom Runtime Modules",
2969 description: "A path to custom Elixir modules (such as MRF policies)."
2977 description: "Settings for notifications streamer",
2982 description: "Number of workers to send notifications.",
2986 key: :overflow_workers,
2988 description: "Maximum number of workers created if pool is empty.",
2995 key: :connections_pool,
2997 description: "Advanced settings for `gun` connections pool",
3000 key: :checkin_timeout,
3002 description: "Timeout to checkin connection from pool. Default: 250ms.",
3006 key: :max_connections,
3008 description: "Maximum number of connections in the pool. Default: 250 connections.",
3015 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3019 key: :retry_timeout,
3022 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3026 key: :await_up_timeout,
3028 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3037 description: "Advanced settings for `gun` workers pools",
3042 description: "Settings for federation pool.",
3047 description: "Number workers in the pool.",
3053 description: "Number of additional workers if pool is under load.",
3059 description: "Timeout while `gun` will wait for response.",
3060 suggestions: [150_000]
3067 description: "Settings for media pool.",
3072 description: "Number workers in the pool.",
3078 description: "Number of additional workers if pool is under load.",
3084 description: "Timeout while `gun` will wait for response.",
3085 suggestions: [150_000]
3092 description: "Settings for upload pool.",
3097 description: "Number workers in the pool.",
3103 description: "Number of additional workers if pool is under load.",
3109 description: "Timeout while `gun` will wait for response.",
3110 suggestions: [300_000]
3117 description: "Settings for default pool.",
3122 description: "Number workers in the pool.",
3128 description: "Number of additional workers if pool is under load.",
3134 description: "Timeout while `gun` will wait for response.",
3135 suggestions: [10_000]
3143 key: :hackney_pools,
3145 description: "Advanced settings for `hackney` connections pools",
3150 description: "Settings for federation pool.",
3153 key: :max_connections,
3155 description: "Number workers in the pool.",
3161 description: "Timeout while `hackney` will wait for response.",
3162 suggestions: [150_000]
3169 description: "Settings for media pool.",
3172 key: :max_connections,
3174 description: "Number workers in the pool.",
3180 description: "Timeout while `hackney` will wait for response.",
3181 suggestions: [150_000]
3188 description: "Settings for upload pool.",
3191 key: :max_connections,
3193 description: "Number workers in the pool.",
3199 description: "Timeout while `hackney` will wait for response.",
3200 suggestions: [300_000]
3208 key: :restrict_unauthenticated,
3211 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3216 description: "Settings for public and federated timelines.",
3221 description: "Disallow view public timeline."
3226 description: "Disallow view federated timeline."
3233 description: "Settings for user profiles.",
3238 description: "Disallow view local user profiles."
3243 description: "Disallow view remote user profiles."
3250 description: "Settings for statuses.",
3255 description: "Disallow view local statuses."
3260 description: "Disallow view remote statuses."
3268 key: Pleroma.Web.ApiSpec.CastAndValidate,
3275 "Enables strict input validation (useful in development, not recommended in production)",
3276 suggestions: [false]