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}]
124 key: :filename_display_max_length,
126 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
132 key: Pleroma.Uploaders.Local,
134 description: "Local uploader-related settings",
139 description: "Path where user's uploads will be saved",
148 key: Pleroma.Uploaders.S3,
150 description: "S3 uploader-related settings",
155 description: "S3 bucket",
161 key: :bucket_namespace,
163 description: "S3 bucket namespace",
164 suggestions: ["pleroma"]
167 key: :public_endpoint,
169 description: "S3 endpoint",
170 suggestions: ["https://s3.amazonaws.com"]
173 key: :truncated_namespace,
176 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
177 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
180 key: :streaming_enabled,
183 "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."
189 key: Pleroma.Upload.Filter.Mogrify,
191 description: "Uploads mogrify filter settings",
195 type: [:string, {:list, :string}, {:list, :tuple}],
196 description: "List of actions for the mogrify command",
207 key: Pleroma.Upload.Filter.AnonymizeFilename,
209 description: "Filter replaces the filename of the upload",
215 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
216 " filename extension by using {extension}, for example custom-file-name.{extension}.",
218 "custom-file-name.{extension}"
225 key: Pleroma.Emails.Mailer,
227 description: "Mailer-related settings",
233 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
234 " or Swoosh.Adapters.Local for in-memory mailbox",
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.Mandrill,
240 Swoosh.Adapters.Mailgun,
241 Swoosh.Adapters.Mailjet,
242 Swoosh.Adapters.Postmark,
243 Swoosh.Adapters.SparkPost,
244 Swoosh.Adapters.AmazonSES,
246 Swoosh.Adapters.SocketLabs,
247 Swoosh.Adapters.Gmail,
248 Swoosh.Adapters.Local
254 description: "Allow/disallow send emails"
257 group: {:subgroup, Swoosh.Adapters.SMTP},
260 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
261 suggestions: ["smtp.gmail.com"]
264 group: {:subgroup, Swoosh.Adapters.SMTP},
267 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
268 suggestions: ["pleroma"]
271 group: {:subgroup, Swoosh.Adapters.SMTP},
274 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
275 suggestions: ["password"]
278 group: {:subgroup, Swoosh.Adapters.SMTP},
282 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
285 group: {:subgroup, Swoosh.Adapters.SMTP},
289 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
290 suggestions: [:always, :never, :if_available]
293 group: {:subgroup, Swoosh.Adapters.SMTP},
296 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
297 suggestions: [:always, :never, :if_available]
300 group: {:subgroup, Swoosh.Adapters.SMTP},
303 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
307 group: {:subgroup, Swoosh.Adapters.SMTP},
310 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
314 group: {:subgroup, Swoosh.Adapters.SMTP},
316 label: "No MX lookups",
318 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
321 group: {:subgroup, Swoosh.Adapters.Sendgrid},
325 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
326 suggestions: ["my-api-key"]
329 group: {:subgroup, Swoosh.Adapters.Sendmail},
332 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
333 suggestions: ["/usr/bin/sendmail"]
336 group: {:subgroup, Swoosh.Adapters.Sendmail},
339 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
340 suggestions: ["-N delay,failure,success"]
343 group: {:subgroup, Swoosh.Adapters.Sendmail},
346 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
349 group: {:subgroup, Swoosh.Adapters.Mandrill},
353 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
354 suggestions: ["my-api-key"]
357 group: {:subgroup, Swoosh.Adapters.Mailgun},
361 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
362 suggestions: ["my-api-key"]
365 group: {:subgroup, Swoosh.Adapters.Mailgun},
368 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
369 suggestions: ["pleroma.com"]
372 group: {:subgroup, Swoosh.Adapters.Mailjet},
376 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
377 suggestions: ["my-api-key"]
380 group: {:subgroup, Swoosh.Adapters.Mailjet},
383 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
384 suggestions: ["my-secret-key"]
387 group: {:subgroup, Swoosh.Adapters.Postmark},
391 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
392 suggestions: ["my-api-key"]
395 group: {:subgroup, Swoosh.Adapters.SparkPost},
399 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
400 suggestions: ["my-api-key"]
403 group: {:subgroup, Swoosh.Adapters.SparkPost},
406 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
407 suggestions: ["https://api.sparkpost.com/api/v1"]
410 group: {:subgroup, Swoosh.Adapters.AmazonSES},
413 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
414 suggestions: ["us-east-1", "us-east-2"]
417 group: {:subgroup, Swoosh.Adapters.AmazonSES},
420 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
421 suggestions: ["aws-access-key"]
424 group: {:subgroup, Swoosh.Adapters.AmazonSES},
427 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
428 suggestions: ["aws-secret-key"]
431 group: {:subgroup, Swoosh.Adapters.Dyn},
435 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
436 suggestions: ["my-api-key"]
439 group: {:subgroup, Swoosh.Adapters.SocketLabs},
442 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
445 group: {:subgroup, Swoosh.Adapters.SocketLabs},
449 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
452 group: {:subgroup, Swoosh.Adapters.Gmail},
455 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
462 description: "`Swoosh.Adapters.Local` adapter specific settings",
465 group: {:subgroup, Swoosh.Adapters.Local},
468 description: "Run the preview server together as part of your app"
471 group: {:subgroup, Swoosh.Adapters.Local},
474 description: "The preview server port",
483 description: "URI schemes related settings",
487 type: {:list, :string},
488 description: "List of the scheme part that is considered valid to be an URL",
512 description: "Instance-related settings",
517 description: "Name of the instance",
524 label: "Admin Email Address",
526 description: "Email used to reach an Administrator/Moderator of the instance",
533 label: "Sender Email Address",
535 description: "Envelope FROM address for mail sent via Pleroma",
544 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
552 description: "Posts character limit (CW/Subject included in the counter)",
560 description: "Character limit of the instance chat messages",
568 description: "Hard character limit beyond which remote posts will be dropped",
576 description: "File size limit of uploads (except for avatar, background, banner)",
582 key: :avatar_upload_limit,
584 description: "File size limit of user's profile avatars",
590 key: :background_upload_limit,
592 description: "File size limit of user's profile backgrounds",
598 key: :banner_upload_limit,
600 description: "File size limit of user's profile banners",
608 description: "A map with poll limits for local polls",
612 max_option_chars: 200,
614 max_expiration: 31_536_000
621 description: "Maximum number of options",
625 key: :max_option_chars,
627 description: "Maximum number of characters per option",
631 key: :min_expiration,
633 description: "Minimum expiration time (in seconds)",
637 key: :max_expiration,
639 description: "Maximum expiration time (in seconds)",
645 key: :registrations_open,
648 "Enable registrations for anyone. Invitations require this setting to be disabled."
651 key: :invites_enabled,
654 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
657 key: :account_activation_required,
659 description: "Require users to confirm their emails before signing in."
664 description: "Enable federation with other instances."
667 key: :federation_incoming_replies_max_depth,
668 label: "Fed. incoming replies max depth",
671 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
672 " 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.",
678 key: :federation_reachability_timeout_days,
679 label: "Fed. reachability timeout days",
682 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
690 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
696 "Makes the client API in authentificated mode-only except for user-profiles." <>
697 " Useful for disabling the Local Timeline and The Whole Known Network."
700 key: :quarantined_instances,
701 type: {:list, :string},
703 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
710 key: :managed_config,
713 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
718 description: "Instance static directory",
724 key: :allowed_post_formats,
725 type: {:list, :string},
726 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
735 key: :extended_nickname_format,
738 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
739 " This will break federation with older software for theses nicknames."
742 key: :cleanup_attachments,
745 Enable to remove associated attachments when status is removed.
746 This will not affect duplicates and attachments without status.
747 Enabling this will increase load to database when deleting statuses on larger instances.
751 key: :max_pinned_statuses,
753 description: "The maximum number of pinned statuses. 0 will disable the feature.",
761 key: :autofollowed_nicknames,
762 type: {:list, :string},
764 "Set to nicknames of (local) users that every new user should automatically follow",
773 key: :attachment_links,
775 description: "Enable to automatically add attachment link text to statuses"
778 key: :welcome_message,
781 "A message that will be sent to a newly registered users as a direct message",
783 "Hi, @username! Welcome on board!"
787 key: :welcome_user_nickname,
789 description: "The nickname of the local user that sends the welcome message",
795 key: :max_report_comment_size,
797 description: "The maximum size of the report comment. Default: 1000.",
803 key: :safe_dm_mentions,
806 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
807 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
813 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
816 key: :remote_post_retention_days,
819 "The default amount of days to retain remote posts when pruning the database",
825 key: :user_bio_length,
827 description: "A user bio maximum length. Default: 5000.",
833 key: :user_name_length,
835 description: "A user name maximum length. Default: 100.",
841 key: :skip_thread_containment,
843 description: "Skip filtering out broken threads. Default: enabled"
846 key: :limit_to_local_content,
847 type: {:dropdown, :atom},
849 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
857 key: :max_account_fields,
859 description: "The maximum number of custom fields in the user profile. Default: 10.",
865 key: :max_remote_account_fields,
868 "The maximum number of custom fields in the remote user profile. Default: 20.",
874 key: :account_field_name_length,
876 description: "An account field name maximum length. Default: 512.",
882 key: :account_field_value_length,
884 description: "An account field value maximum length. Default: 2048.",
890 key: :external_user_synchronization,
892 description: "Enabling following/followers counters synchronization for external users"
895 key: :multi_factor_authentication,
897 description: "Multi-factor authentication settings",
900 totp: [digits: 6, period: 30],
901 backup_codes: [number: 5, length: 16]
908 description: "TOTP settings",
909 suggestions: [digits: 6, period: 30],
916 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
923 "a period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
930 description: "MFA backup codes settings",
931 suggestions: [number: 5, length: 16],
937 description: "number of backup codes to generate."
944 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
951 key: :instance_thumbnail,
954 "The instance thumbnail image. It will appear in [Pleroma Instances](http://distsn.org/pleroma-instances.html)",
955 suggestions: ["/instance/thumbnail.jpeg"]
962 description: "Logger-related settings",
966 type: [:atom, :tuple, :module],
968 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
969 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
977 description: "ExSyslogger-related settings",
981 type: {:dropdown, :atom},
982 description: "Log level",
983 suggestions: [:debug, :info, :warn, :error]
989 "A string that's prepended to every message, and is typically set to the app name",
990 suggestions: ["pleroma"]
995 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
996 suggestions: ["$metadata[$level] $message"]
1000 type: {:list, :atom},
1001 suggestions: [:request_id]
1009 description: "Console logger settings",
1013 type: {:dropdown, :atom},
1014 description: "Log level",
1015 suggestions: [:debug, :info, :warn, :error]
1020 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1021 suggestions: ["$metadata[$level] $message"]
1025 type: {:list, :atom},
1026 suggestions: [:request_id]
1033 description: "Quack-related settings",
1037 type: {:dropdown, :atom},
1038 description: "Log level",
1039 suggestions: [:debug, :info, :warn, :error]
1043 type: {:list, :atom},
1044 description: "Configure which metadata you want to report on",
1062 description: "Configure the Slack incoming webhook",
1063 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1069 key: :frontend_configurations,
1072 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1073 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1074 "add your own configuration your settings all fields must be complete.",
1078 label: "Pleroma FE",
1080 description: "Settings for Pleroma FE",
1083 alwaysShowSubjectInput: true,
1084 background: "/static/aurora_borealis.jpg",
1085 collapseMessageWithSubject: false,
1088 hideFilteredStatuses: false,
1089 hideMutedPosts: false,
1090 hidePostStats: false,
1091 hideSitename: false,
1092 hideUserStats: false,
1093 loginMethod: "password",
1094 logo: "/static/logo.png",
1097 minimalScopesMode: false,
1098 noAttachmentLinks: false,
1099 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1100 postContentType: "text/plain",
1101 redirectRootLogin: "/main/friends",
1102 redirectRootNoLogin: "/main/all",
1104 sidebarRight: false,
1105 showFeaturesPanel: true,
1106 showInstanceSpecificPanel: false,
1107 subjectLineBehavior: "email",
1108 theme: "pleroma-dark",
1109 webPushNotifications: false
1114 key: :alwaysShowSubjectInput,
1115 label: "Always show subject input",
1117 description: "When disabled, auto-hide the subject field if it's empty"
1123 "URL of the background, unless viewing a user profile with a background that is set",
1124 suggestions: ["/images/city.jpg"]
1127 key: :collapseMessageWithSubject,
1128 label: "Collapse message with subject",
1131 "When a message has a subject (aka Content Warning), collapse it by default"
1135 label: "PleromaFE Chat",
1137 description: "Disables PleromaFE Chat component"
1143 description: "Enables green text on lines prefixed with the > character."
1146 key: :hideFilteredStatuses,
1147 label: "Hide Filtered Statuses",
1149 description: "Hides filtered statuses from timelines."
1152 key: :hideMutedPosts,
1153 label: "Hide Muted Posts",
1155 description: "Hides muted statuses from timelines."
1158 key: :hidePostStats,
1159 label: "Hide post stats",
1161 description: "Hide notices statistics (repeats, favorites, ...)"
1165 label: "Hide Sitename",
1167 description: "Hides instance name from PleromaFE banner."
1170 key: :hideUserStats,
1171 label: "Hide user stats",
1174 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1179 description: "URL of the logo, defaults to Pleroma's logo",
1180 suggestions: ["/static/logo.png"]
1184 label: "Logo margin",
1187 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1188 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1189 suggestions: [".1em"]
1196 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1197 "If you want a colorful logo you must disable logoMask."
1200 key: :minimalScopesMode,
1201 label: "Minimal scopes mode",
1204 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1205 "Also prevents replying to a DM with a public post from PleromaFE."
1208 key: :nsfwCensorImage,
1209 label: "NSFW Censor Image",
1212 "URL of the image to use for hiding NSFW media attachments in the timeline.",
1213 suggestions: ["/static/img/nsfw.74818f9.png"]
1216 key: :postContentType,
1217 label: "Post Content Type",
1218 type: {:dropdown, :atom},
1219 description: "Default post formatting option.",
1220 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1223 key: :redirectRootNoLogin,
1224 label: "Redirect root no login",
1227 "Relative URL which indicates where to redirect when a user isn't logged in",
1228 suggestions: ["/main/all"]
1231 key: :redirectRootLogin,
1232 label: "Redirect root login",
1235 "Relative URL which indicates where to redirect when a user is logged in",
1236 suggestions: ["/main/friends"]
1240 label: "Scope copy",
1242 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1246 label: "Sidebar on Right",
1248 description: "Change alignment of sidebar and panels to the right."
1251 key: :showFeaturesPanel,
1252 label: "Show instance features panel",
1255 "Enables panel displaying functionality of the instance on the About page."
1258 key: :showInstanceSpecificPanel,
1259 label: "Show instance specific panel",
1261 description: "Whether to show the instance's custom panel"
1264 key: :subjectLineBehavior,
1265 label: "Subject line behavior",
1267 description: "Allows changing the default behaviour of subject lines in replies.
1268 `email`: copy and preprend re:, as in email,
1269 `masto`: copy verbatim, as in Mastodon,
1270 `noop`: don't copy the subject.",
1271 suggestions: ["email", "masto", "noop"]
1276 description: "Which theme to use. Available themes are defined in styles.json",
1277 suggestions: ["pleroma-dark"]
1285 description: "Settings for Masto FE",
1288 showInstanceSpecificPanel: true
1293 key: :showInstanceSpecificPanel,
1294 label: "Show instance specific panel",
1296 description: "Whenether to show the instance's specific panel"
1307 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1311 type: {:keyword, :map},
1313 "Keyword of mascots, each element must contain both an url and a mime_type key",
1316 url: "/images/pleroma-fox-tan-smol.png",
1317 mime_type: "image/png"
1319 pleroma_fox_tan_shy: %{
1320 url: "/images/pleroma-fox-tan-shy.png",
1321 mime_type: "image/png"
1326 key: :default_mascot,
1329 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1335 key: :default_user_avatar,
1337 description: "URL of the default user avatar.",
1338 suggestions: ["/images/avi.png"]
1347 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1351 type: {:list, :map},
1352 description: "Describe the icons of the app",
1355 src: "/static/logo.png"
1358 src: "/static/icon.png",
1362 src: "/static/icon.ico",
1363 sizes: "72x72 96x96 128x128 256x256"
1370 description: "Describe the theme color of the app",
1371 suggestions: ["#282c37", "mediumpurple"]
1374 key: :background_color,
1376 description: "Describe the background color of the app",
1377 suggestions: ["#191b22", "aliceblue"]
1384 label: "MRF simple",
1386 description: "Message Rewrite Facility",
1389 key: :media_removal,
1390 type: {:list, :string},
1391 description: "List of instances to strip media attachments from",
1392 suggestions: ["example.com", "*.example.com"]
1396 label: "Media NSFW",
1397 type: {:list, :string},
1398 description: "List of instances to tag all media as NSFW (sensitive) from",
1399 suggestions: ["example.com", "*.example.com"]
1402 key: :federated_timeline_removal,
1403 type: {:list, :string},
1405 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1406 suggestions: ["example.com", "*.example.com"]
1410 type: {:list, :string},
1411 description: "List of instances to reject activities from (except deletes)",
1412 suggestions: ["example.com", "*.example.com"]
1416 type: {:list, :string},
1417 description: "List of instances to only accept activities from (except deletes)",
1418 suggestions: ["example.com", "*.example.com"]
1421 key: :report_removal,
1422 type: {:list, :string},
1423 description: "List of instances to reject reports from",
1424 suggestions: ["example.com", "*.example.com"]
1427 key: :avatar_removal,
1428 type: {:list, :string},
1429 description: "List of instances to strip avatars from",
1430 suggestions: ["example.com", "*.example.com"]
1433 key: :banner_removal,
1434 type: {:list, :string},
1435 description: "List of instances to strip banners from",
1436 suggestions: ["example.com", "*.example.com"]
1439 key: :reject_deletes,
1440 type: {:list, :string},
1441 description: "List of instances to reject deletions from",
1442 suggestions: ["example.com", "*.example.com"]
1448 key: :mrf_activity_expiration,
1449 label: "MRF Activity Expiration Policy",
1451 description: "Adds expiration to all local Create Note activities",
1456 description: "Default global expiration time for all local Create activities (in days)",
1457 suggestions: [90, 365]
1464 label: "MRF subchain",
1467 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1468 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1473 description: "Matches a series of regular expressions against the actor field",
1476 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1484 key: :mrf_rejectnonpublic,
1486 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1487 label: "MRF reject non public",
1491 key: :allow_followersonly,
1492 label: "Allow followers-only",
1494 description: "Whether to allow followers-only posts"
1499 description: "Whether to allow direct messages"
1505 key: :mrf_hellthread,
1506 label: "MRF hellthread",
1508 description: "Block messages with too much mentions",
1511 key: :delist_threshold,
1514 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1515 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1519 key: :reject_threshold,
1522 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1530 label: "MRF keyword",
1532 description: "Reject or Word-Replace messages with a keyword or regex",
1536 type: [:string, :regex],
1538 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1539 suggestions: ["foo", ~r/foo/iu]
1542 key: :federated_timeline_removal,
1543 type: [:string, :regex],
1545 "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.",
1546 suggestions: ["foo", ~r/foo/iu]
1550 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1552 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1553 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1560 label: "MRF mention",
1562 description: "Block messages which mention a user",
1566 type: {:list, :string},
1567 description: "A list of actors for which any post mentioning them will be dropped.",
1568 suggestions: ["actor1", "actor2"]
1574 key: :mrf_vocabulary,
1575 label: "MRF vocabulary",
1577 description: "Filter messages which belong to certain activity vocabularies",
1581 type: {:list, :string},
1583 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1584 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1588 type: {:list, :string},
1590 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1591 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1597 # key: :mrf_user_allowlist,
1600 # "The keys in this section are the domain names that the policy should apply to." <>
1601 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1603 # %{"example.org" => ["https://example.org/users/admin"]}
1611 description: "Media proxy",
1616 description: "Enables proxying of remote media to the instance's proxy"
1622 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1623 suggestions: ["https://example.com"]
1628 description: "Options for Pleroma.ReverseProxy",
1630 redirect_on_failure: false,
1631 max_body_length: 25 * 1_048_576,
1633 follow_redirect: true,
1639 key: :redirect_on_failure,
1642 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1643 "Any error during body processing will not be redirected as the response is chunked."
1646 key: :max_body_length,
1649 "Limits the content length to be approximately the " <>
1650 "specified length. It is validated with the `content-length` header and also verified when proxying."
1655 description: "HTTP options",
1660 description: "Adapter specific options",
1665 label: "SSL Options",
1666 description: "SSL options for HTTP adapter",
1670 type: {:list, :atom},
1671 description: "List of TLS version to use",
1672 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1681 type: [:string, :tuple],
1682 description: "Proxy URL",
1683 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1691 type: {:list, :string},
1692 description: "List of domains to bypass the mediaproxy",
1693 suggestions: ["example.com"]
1701 description: "Gopher settings",
1706 description: "Enables the gopher interface"
1711 description: "IP address to bind to",
1712 suggestions: [{0, 0, 0, 0}]
1717 description: "Port to bind to",
1723 description: "Port advertised in urls (optional, defaults to port)",
1732 description: "ActivityPub-related settings",
1735 key: :unfollow_blocked,
1737 description: "Whether blocks result in people getting unfollowed"
1740 key: :outgoing_blocks,
1742 description: "Whether to federate blocks to other instances"
1745 key: :sign_object_fetches,
1747 description: "Sign object fetches with HTTP signatures"
1750 key: :note_replies_output_limit,
1753 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1756 key: :follow_handshake_timeout,
1758 description: "Following handshake timeout",
1765 key: :http_security,
1767 description: "HTTP security settings",
1772 description: "Whether the managed content security policy is enabled"
1778 description: "Whether to additionally send a Strict-Transport-Security header"
1782 label: "STS max age",
1784 description: "The maximum age for the Strict-Transport-Security header if sent",
1785 suggestions: [31_536_000]
1789 label: "CT max age",
1791 description: "The maximum age for the Expect-CT header if sent",
1792 suggestions: [2_592_000]
1795 key: :referrer_policy,
1797 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1798 suggestions: ["same-origin", "no-referrer"]
1802 label: "Report URI",
1804 description: "Adds the specified url to report-uri and report-to group in CSP header",
1805 suggestions: ["https://example.com/report-uri"]
1810 group: :web_push_encryption,
1811 key: :vapid_details,
1814 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1820 "A mailto link for the administrative contact." <>
1821 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1822 suggestions: ["mailto:moderators@pleroma.com"]
1827 description: "VAPID public key",
1828 suggestions: ["Public key"]
1833 description: "VAPID private key",
1834 suggestions: ["Private key"]
1840 key: Pleroma.Captcha,
1842 description: "Captcha-related settings",
1847 description: "Whether the captcha should be shown on registration"
1852 description: "The method/service to use for captcha",
1853 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1856 key: :seconds_valid,
1858 description: "The time in seconds for which the captcha is valid",
1865 key: Pleroma.Captcha.Kocaptcha,
1868 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1869 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1874 description: "The kocaptcha endpoint to use",
1875 suggestions: ["https://captcha.kotobank.ch"]
1883 "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",
1888 description: "Token",
1889 suggestions: ["We recommend a secure random string or UUID"]
1898 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1900 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1901 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1902 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1903 (see https://github.com/sorentwo/oban/issues/52).
1908 type: {:dropdown, :atom},
1909 description: "Logs verbose mode",
1910 suggestions: [false, :error, :warn, :info, :debug]
1914 type: [:atom, :tuple],
1916 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1917 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1921 type: {:keyword, :integer},
1923 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1925 activity_expiration: 10,
1926 attachments_cleanup: 5,
1928 federator_incoming: 50,
1929 federator_outgoing: 50,
1931 scheduled_activities: 10,
1937 key: :activity_expiration,
1939 description: "Activity expiration queue",
1943 key: :attachments_cleanup,
1945 description: "Attachment deletion queue",
1951 description: "Background queue",
1955 key: :federator_incoming,
1957 description: "Incoming federation queue",
1961 key: :federator_outgoing,
1963 description: "Outgoing federation queue",
1969 description: "Email sender queue, see Pleroma.Emails.Mailer",
1973 key: :scheduled_activities,
1975 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1979 key: :transmogrifier,
1981 description: "Transmogrifier queue",
1987 description: "Web push notifications queue",
1994 type: {:list, :tuple},
1995 description: "Settings for cron background jobs",
1997 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1998 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1999 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2000 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2001 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2010 description: "Includes custom worker options not interpretable directly by `Oban`",
2014 type: {:keyword, :integer},
2015 description: "Max retry attempts for failed jobs, per `Oban` queue",
2017 federator_incoming: 5,
2018 federator_outgoing: 5
2025 key: Pleroma.Web.Metadata,
2027 description: "Metadata-related settings",
2031 type: {:list, :module},
2032 description: "List of metadata providers to enable",
2034 Pleroma.Web.Metadata.Providers.OpenGraph,
2035 Pleroma.Web.Metadata.Providers.TwitterCard,
2036 Pleroma.Web.Metadata.Providers.RelMe,
2037 Pleroma.Web.Metadata.Providers.Feed
2042 label: "Unfurl NSFW",
2044 description: "When enabled NSFW attachments will be shown in previews"
2053 "If enabled the instance will parse metadata from attached links to generate link previews.",
2058 description: "Enables RichMedia parsing of URLs."
2062 type: {:list, :string},
2063 description: "List of hosts which will be ignored by the metadata parser.",
2064 suggestions: ["accounts.google.com", "xss.website"]
2068 label: "Ignore TLD",
2069 type: {:list, :string},
2070 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2071 suggestions: ["local", "localdomain", "lan"]
2075 type: {:list, :module},
2077 "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.",
2079 Pleroma.Web.RichMedia.Parsers.OEmbed,
2080 Pleroma.Web.RichMedia.Parsers.TwitterCard
2085 label: "TTL setters",
2086 type: {:list, :module},
2088 "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.",
2090 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2096 group: :auto_linker,
2099 description: "Configuration for the auto_linker library",
2103 type: [:string, false],
2104 description: "Specify the class to be added to the generated link. Disable to clear",
2105 suggestions: ["auto-linker", false]
2109 type: [:string, false],
2110 description: "Override the rel attribute. Disable to clear",
2111 suggestions: ["ugc", "noopener noreferrer", false]
2116 description: "Link urls will open in new window/tab"
2120 type: [:integer, false],
2122 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2123 suggestions: [15, false]
2128 description: "Strip the scheme prefix"
2133 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2139 key: Pleroma.ScheduledActivity,
2141 description: "Scheduled activities settings",
2144 key: :daily_user_limit,
2147 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2151 key: :total_user_limit,
2154 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2160 description: "Whether scheduled activities are sent to the job queue to be executed"
2166 key: Pleroma.ActivityExpiration,
2168 description: "Expired activity settings",
2173 description: "Whether expired activities will be sent to the job queue to be deleted"
2180 description: "Authenticator",
2183 key: Pleroma.Web.Auth.Authenticator,
2185 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2194 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2195 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2196 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2197 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2202 description: "Enables LDAP authentication"
2207 description: "LDAP server hostname",
2208 suggestions: ["localhosts"]
2213 description: "LDAP port, e.g. 389 or 636",
2214 suggestions: [389, 636]
2220 description: "Enable to use SSL, usually implies the port 636"
2224 label: "SSL options",
2226 description: "Additional SSL options",
2227 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2232 description: "Path to file with PEM encoded cacerts",
2233 suggestions: ["path/to/file/with/PEM/cacerts"]
2238 description: "Type of cert verification",
2239 suggestions: [:verify_peer]
2247 description: "Enable to use STARTTLS, usually implies the port 389"
2251 label: "TLS options",
2253 description: "Additional TLS options",
2254 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2259 description: "Path to file with PEM encoded cacerts",
2260 suggestions: ["path/to/file/with/PEM/cacerts"]
2265 description: "Type of cert verification",
2266 suggestions: [:verify_peer]
2273 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2274 suggestions: ["dc=example,dc=com"]
2280 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2289 description: "Authentication / authorization settings",
2292 key: :enforce_oauth_admin_scope_usage,
2295 "OAuth admin scope requirement toggle. " <>
2296 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2297 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2298 "`is_admin` user flag grants access to admin-specific actions."
2301 key: :auth_template,
2304 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2305 suggestions: ["show.html"]
2308 key: :oauth_consumer_template,
2311 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2312 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2313 suggestions: ["consumer.html"]
2316 key: :oauth_consumer_strategies,
2317 type: {:list, :string},
2319 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2320 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2321 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2322 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2328 key: :email_notifications,
2330 description: "Email notifications settings",
2336 "emails of \"what you've missed\" for users who have been inactive for a while",
2340 schedule: "0 0 * * 0",
2342 inactivity_threshold: 7
2350 description: "Globally enable or disable digest emails"
2356 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2357 suggestions: ["0 0 * * 0"]
2362 description: "Minimum interval between digest emails to one user",
2366 key: :inactivity_threshold,
2368 description: "Minimum user inactivity threshold",
2377 key: Pleroma.Emails.UserEmail,
2379 description: "Email template settings",
2384 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2385 suggestions: ["some/path/logo.png"]
2390 description: "a map with color settings for email templates.",
2393 link_color: "#d8a070",
2394 background_color: "#2C3645",
2395 content_background_color: "#1B2635",
2396 header_color: "#d8a070",
2397 text_color: "#b9b9ba",
2398 text_muted_color: "#b9b9ba"
2405 suggestions: ["#d8a070"]
2408 key: :background_color,
2410 suggestions: ["#2C3645"]
2413 key: :content_background_color,
2415 suggestions: ["#1B2635"]
2420 suggestions: ["#d8a070"]
2425 suggestions: ["#b9b9ba"]
2428 key: :text_muted_color,
2430 suggestions: ["#b9b9ba"]
2438 key: Pleroma.Emails.NewUsersDigestEmail,
2440 description: "New users admin email digest",
2445 description: "enables new users admin digest email when `true`",
2446 suggestions: [false]
2454 description: "Configure OAuth 2 provider capabilities",
2457 key: :token_expires_in,
2459 description: "The lifetime in seconds of the access token",
2463 key: :issue_new_refresh_token,
2466 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2469 key: :clean_expired_tokens,
2471 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2481 key: :shortcode_globs,
2482 type: {:list, :string},
2483 description: "Location of custom emoji files. * can be used as a wildcard.",
2484 suggestions: ["/emoji/custom/**/*.png"]
2487 key: :pack_extensions,
2488 type: {:list, :string},
2490 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2491 suggestions: [".png", ".gif"]
2495 type: {:keyword, :string, {:list, :string}},
2497 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2498 " and the value is the location or array of locations. * can be used as a wildcard.",
2500 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2504 key: :default_manifest,
2507 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2508 " Currently only one manifest can be added (no arrays).",
2509 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2512 key: :shared_pack_cache_seconds_per_file,
2513 label: "Shared pack cache s/file",
2516 "When an emoji pack is shared, the archive is created and cached in memory" <>
2517 " for this amount of seconds multiplied by the number of files.",
2527 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2531 type: [:tuple, {:list, :tuple}],
2532 description: "For the search requests (account & status search etc.)",
2533 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2537 type: [:tuple, {:list, :tuple}],
2538 description: "For requests to timelines (each timeline has it's own limiter)",
2539 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2542 key: :app_account_creation,
2543 type: [:tuple, {:list, :tuple}],
2544 description: "For registering user accounts from the same IP address",
2545 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2548 key: :relations_actions,
2549 type: [:tuple, {:list, :tuple}],
2550 description: "For actions on relationships with all users (follow, unfollow)",
2551 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2554 key: :relation_id_action,
2555 type: [:tuple, {:list, :tuple}],
2556 description: "For actions on relation with a specific user (follow, unfollow)",
2557 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2560 key: :statuses_actions,
2561 type: [:tuple, {:list, :tuple}],
2563 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2564 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2567 key: :status_id_action,
2568 type: [:tuple, {:list, :tuple}],
2570 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2571 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2574 key: :authentication,
2575 type: [:tuple, {:list, :tuple}],
2576 description: "For authentication create / password check / user existence check requests",
2577 suggestions: [{60_000, 15}]
2585 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2586 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2591 description: "Enables SSH"
2596 description: "Dir with SSH keys",
2597 suggestions: ["/some/path/ssh_keys"]
2602 description: "Handler module",
2603 suggestions: ["Pleroma.BBS.Handler"]
2608 description: "Port to connect",
2609 suggestions: [10_022]
2612 key: :password_authenticator,
2614 description: "Authenticator module",
2615 suggestions: ["Pleroma.BBS.Authenticator"]
2622 description: "Mime types",
2629 "application/xml" => ["xml"],
2630 "application/xrd+xml" => ["xrd+xml"],
2631 "application/jrd+json" => ["jrd+json"],
2632 "application/activity+json" => ["activity+json"],
2633 "application/ld+json" => ["activity+json"]
2638 key: "application/xml",
2639 type: {:list, :string},
2640 suggestions: ["xml"]
2643 key: "application/xrd+xml",
2644 type: {:list, :string},
2645 suggestions: ["xrd+xml"]
2648 key: "application/jrd+json",
2649 type: {:list, :string},
2650 suggestions: ["jrd+json"]
2653 key: "application/activity+json",
2654 type: {:list, :string},
2655 suggestions: ["activity+json"]
2658 key: "application/ld+json",
2659 type: {:list, :string},
2660 suggestions: ["activity+json"]
2670 description: "Pleroma chat settings",
2682 description: "HTTP settings",
2687 type: [:string, :tuple],
2688 description: "Proxy URL",
2689 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2692 key: :send_user_agent,
2697 type: [:string, :atom],
2699 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2700 suggestions: ["Pleroma", :default]
2705 description: "Adapter specific options",
2711 label: "SSL Options",
2712 description: "SSL options for HTTP adapter",
2716 type: {:list, :atom},
2717 description: "List of TLS version to use",
2718 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2732 key: :allow_inline_images,
2736 key: :allow_headings,
2749 type: {:list, :module},
2751 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2752 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2762 key: :deny_follow_blocked,
2769 key: :mrf_normalize_markup,
2770 label: "MRF normalize markup",
2771 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2777 suggestions: [Pleroma.HTML.Scrubber.Default]
2787 key: :restricted_nicknames,
2788 type: {:list, :string},
2807 "ostatus_subscribe",
2831 suggestions: [86_400]
2835 type: {:list, :string},
2836 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2840 type: {:list, :string},
2843 "X-RateLimit-Reset",
2844 "X-RateLimit-Limit",
2845 "X-RateLimit-Remaining",
2856 type: {:list, :string},
2857 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2863 key: Pleroma.Plugs.RemoteIp,
2866 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2867 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2873 description: "Enable/disable the plug. Default: disabled."
2877 type: {:list, :string},
2879 "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]`."
2883 type: {:list, :string},
2885 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2889 type: {:list, :string},
2891 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2897 key: :web_cache_ttl,
2900 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2906 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2907 suggestions: [30_000, nil]
2910 key: :activity_pub_question,
2912 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2913 suggestions: [30_000]
2922 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2927 description: "Enables the rendering of static HTML. Default: disabled."
2935 description: "Configure feed rendering",
2940 description: "Configure title rendering.",
2945 description: "Maximum number of characters before truncating title.",
2951 description: "Replacement which will be used after truncating string.",
2952 suggestions: ["..."]
2960 key: :mrf_object_age,
2962 description: "Rejects or delists posts based on their age when received.",
2967 description: "Required age (in seconds) of a post before actions are taken.",
2968 suggestions: [172_800]
2972 type: {:list, :atom},
2974 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2975 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2976 "`:reject` rejects the message entirely",
2977 suggestions: [:delist, :strip_followers, :reject]
2985 description: "Custom Runtime Modules",
2990 description: "A path to custom Elixir modules (such as MRF policies)."
2998 description: "Settings for notifications streamer",
3003 description: "Number of workers to send notifications.",
3007 key: :overflow_workers,
3009 description: "Maximum number of workers created if pool is empty.",
3016 key: :connections_pool,
3018 description: "Advanced settings for `gun` connections pool",
3021 key: :checkin_timeout,
3023 description: "Timeout to checkin connection from pool. Default: 250ms.",
3027 key: :max_connections,
3029 description: "Maximum number of connections in the pool. Default: 250 connections.",
3036 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3040 key: :retry_timeout,
3043 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3047 key: :await_up_timeout,
3049 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3058 description: "Advanced settings for `gun` workers pools",
3063 description: "Settings for federation pool.",
3068 description: "Number workers in the pool.",
3074 description: "Number of additional workers if pool is under load.",
3080 description: "Timeout while `gun` will wait for response.",
3081 suggestions: [150_000]
3088 description: "Settings for media pool.",
3093 description: "Number workers in the pool.",
3099 description: "Number of additional workers if pool is under load.",
3105 description: "Timeout while `gun` will wait for response.",
3106 suggestions: [150_000]
3113 description: "Settings for upload pool.",
3118 description: "Number workers in the pool.",
3124 description: "Number of additional workers if pool is under load.",
3130 description: "Timeout while `gun` will wait for response.",
3131 suggestions: [300_000]
3138 description: "Settings for default pool.",
3143 description: "Number workers in the pool.",
3149 description: "Number of additional workers if pool is under load.",
3155 description: "Timeout while `gun` will wait for response.",
3156 suggestions: [10_000]
3164 key: :hackney_pools,
3166 description: "Advanced settings for `hackney` connections pools",
3171 description: "Settings for federation pool.",
3174 key: :max_connections,
3176 description: "Number workers in the pool.",
3182 description: "Timeout while `hackney` will wait for response.",
3183 suggestions: [150_000]
3190 description: "Settings for media pool.",
3193 key: :max_connections,
3195 description: "Number workers in the pool.",
3201 description: "Timeout while `hackney` will wait for response.",
3202 suggestions: [150_000]
3209 description: "Settings for upload pool.",
3212 key: :max_connections,
3214 description: "Number workers in the pool.",
3220 description: "Timeout while `hackney` will wait for response.",
3221 suggestions: [300_000]
3229 key: :restrict_unauthenticated,
3232 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3237 description: "Settings for public and federated timelines.",
3242 description: "Disallow view public timeline."
3247 description: "Disallow view federated timeline."
3254 description: "Settings for user profiles.",
3259 description: "Disallow view local user profiles."
3264 description: "Disallow view remote user profiles."
3271 description: "Settings for statuses.",
3276 description: "Disallow view local statuses."
3281 description: "Disallow view remote statuses."
3289 key: Pleroma.Web.ApiSpec.CastAndValidate,
3296 "Enables strict input validation (useful in development, not recommended in production)",
3297 suggestions: [false]
3305 description: "General MRF settings",
3309 type: [:module, {:list, :module}],
3311 "A list of MRF policies enabled. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
3313 Generator.list_modules_in_dir(
3314 "lib/pleroma/web/activity_pub/mrf",
3315 "Elixir.Pleroma.Web.ActivityPub.MRF."
3320 label: "MRF transparency",
3323 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
3326 key: :transparency_exclusions,
3327 label: "MRF transparency exclusions",
3328 type: {:list, :string},
3330 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",