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},
31 description: "List of filter modules for uploads",
33 Generator.list_modules_in_dir(
34 "lib/pleroma/upload/filter",
35 "Elixir.Pleroma.Upload.Filter."
42 "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`."
47 description: "Base url for the uploads, needed if you use CDN",
49 "https://cdn-host.com"
56 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
61 description: "Options for Pleroma.ReverseProxy",
63 redirect_on_failure: false,
64 max_body_length: 25 * 1_048_576,
66 follow_redirect: true,
72 key: :redirect_on_failure,
75 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
76 "Any error during body processing will not be redirected as the response is chunked."
79 key: :max_body_length,
82 "Limits the content length to be approximately the " <>
83 "specified length. It is validated with the `content-length` header and also verified when proxying."
88 description: "HTTP options",
93 description: "Adapter specific options",
99 description: "SSL options for HTTP adapter",
103 type: {:list, :atom},
104 description: "List of TLS version to use",
105 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
114 type: [:string, :tuple],
115 description: "Proxy URL",
116 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
126 key: Pleroma.Uploaders.Local,
128 description: "Local uploader-related settings",
133 description: "Path where user's uploads will be saved",
142 key: Pleroma.Uploaders.S3,
144 description: "S3 uploader-related settings",
149 description: "S3 bucket",
155 key: :bucket_namespace,
157 description: "S3 bucket namespace",
158 suggestions: ["pleroma"]
161 key: :public_endpoint,
163 description: "S3 endpoint",
164 suggestions: ["https://s3.amazonaws.com"]
167 key: :truncated_namespace,
170 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
171 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
174 key: :streaming_enabled,
177 "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."
183 key: Pleroma.Upload.Filter.Mogrify,
185 description: "Uploads mogrify filter settings",
189 type: [:string, {:list, :string}, {:list, :tuple}],
190 description: "List of actions for the mogrify command",
201 key: Pleroma.Upload.Filter.AnonymizeFilename,
203 description: "Filter replaces the filename of the upload",
209 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
210 " filename extension by using {extension}, for example custom-file-name.{extension}.",
212 "custom-file-name.{extension}"
219 key: Pleroma.Emails.Mailer,
221 description: "Mailer-related settings",
227 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
228 " or Swoosh.Adapters.Local for in-memory mailbox",
230 Swoosh.Adapters.SMTP,
231 Swoosh.Adapters.Sendgrid,
232 Swoosh.Adapters.Sendmail,
233 Swoosh.Adapters.Mandrill,
234 Swoosh.Adapters.Mailgun,
235 Swoosh.Adapters.Mailjet,
236 Swoosh.Adapters.Postmark,
237 Swoosh.Adapters.SparkPost,
238 Swoosh.Adapters.AmazonSES,
240 Swoosh.Adapters.SocketLabs,
241 Swoosh.Adapters.Gmail,
242 Swoosh.Adapters.Local
248 description: "Allow/disallow send emails"
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
255 suggestions: ["smtp.gmail.com"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
262 suggestions: ["pleroma"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
283 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
284 suggestions: [:always, :never, :if_available]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
291 suggestions: [:always, :never, :if_available]
294 group: {:subgroup, Swoosh.Adapters.SMTP},
297 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
301 group: {:subgroup, Swoosh.Adapters.SMTP},
304 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
308 group: {:subgroup, Swoosh.Adapters.SMTP},
310 label: "No MX lookups",
312 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
315 group: {:subgroup, Swoosh.Adapters.Sendgrid},
319 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
320 suggestions: ["my-api-key"]
323 group: {:subgroup, Swoosh.Adapters.Sendmail},
326 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
327 suggestions: ["/usr/bin/sendmail"]
330 group: {:subgroup, Swoosh.Adapters.Sendmail},
333 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
334 suggestions: ["-N delay,failure,success"]
337 group: {:subgroup, Swoosh.Adapters.Sendmail},
340 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
343 group: {:subgroup, Swoosh.Adapters.Mandrill},
347 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
348 suggestions: ["my-api-key"]
351 group: {:subgroup, Swoosh.Adapters.Mailgun},
355 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
356 suggestions: ["my-api-key"]
359 group: {:subgroup, Swoosh.Adapters.Mailgun},
362 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
363 suggestions: ["pleroma.com"]
366 group: {:subgroup, Swoosh.Adapters.Mailjet},
370 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
371 suggestions: ["my-api-key"]
374 group: {:subgroup, Swoosh.Adapters.Mailjet},
377 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
378 suggestions: ["my-secret-key"]
381 group: {:subgroup, Swoosh.Adapters.Postmark},
385 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
386 suggestions: ["my-api-key"]
389 group: {:subgroup, Swoosh.Adapters.SparkPost},
393 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
394 suggestions: ["my-api-key"]
397 group: {:subgroup, Swoosh.Adapters.SparkPost},
400 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
401 suggestions: ["https://api.sparkpost.com/api/v1"]
404 group: {:subgroup, Swoosh.Adapters.AmazonSES},
407 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
408 suggestions: ["us-east-1", "us-east-2"]
411 group: {:subgroup, Swoosh.Adapters.AmazonSES},
414 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
415 suggestions: ["aws-access-key"]
418 group: {:subgroup, Swoosh.Adapters.AmazonSES},
421 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
422 suggestions: ["aws-secret-key"]
425 group: {:subgroup, Swoosh.Adapters.Dyn},
429 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
430 suggestions: ["my-api-key"]
433 group: {:subgroup, Swoosh.Adapters.SocketLabs},
436 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
439 group: {:subgroup, Swoosh.Adapters.SocketLabs},
443 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
446 group: {:subgroup, Swoosh.Adapters.Gmail},
449 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
456 description: "`Swoosh.Adapters.Local` adapter specific settings",
459 group: {:subgroup, Swoosh.Adapters.Local},
462 description: "Run the preview server together as part of your app"
465 group: {:subgroup, Swoosh.Adapters.Local},
468 description: "The preview server port",
477 description: "URI schemes related settings",
481 type: {:list, :string},
482 description: "List of the scheme part that is considered valid to be an URL",
506 description: "Instance-related settings",
511 description: "Name of the instance",
518 label: "Admin Email Address",
520 description: "Email used to reach an Administrator/Moderator of the instance",
527 label: "Sender Email Address",
529 description: "Envelope FROM address for mail sent via Pleroma",
537 description: "The instance's description, can be seen in nodeinfo and /api/v1/instance",
545 description: "Posts character limit (CW/Subject included in the counter)",
553 description: "Character limit of the instance chat messages",
561 description: "Hard character limit beyond which remote posts will be dropped",
569 description: "File size limit of uploads (except for avatar, background, banner)",
575 key: :avatar_upload_limit,
577 description: "File size limit of user's profile avatars",
583 key: :background_upload_limit,
585 description: "File size limit of user's profile backgrounds",
591 key: :banner_upload_limit,
593 description: "File size limit of user's profile banners",
601 description: "A map with poll limits for local polls",
605 max_option_chars: 200,
607 max_expiration: 31_536_000
614 description: "Maximum number of options",
618 key: :max_option_chars,
620 description: "Maximum number of characters per option",
624 key: :min_expiration,
626 description: "Minimum expiration time (in seconds)",
630 key: :max_expiration,
632 description: "Maximum expiration time (in seconds)",
638 key: :registrations_open,
640 description: "Enable registrations for anyone, invitations can be enabled when `false`"
643 key: :invites_enabled,
645 description: "Enable user invitations for admins (depends on `registrations_open: false`)"
648 key: :account_activation_required,
650 description: "Require users to confirm their emails before signing in"
655 description: "Enable federation with other instances"
658 key: :federation_incoming_replies_max_depth,
659 label: "Fed. incoming replies max depth",
662 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
663 " 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.",
669 key: :federation_reachability_timeout_days,
670 label: "Fed. reachability timeout days",
673 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
679 key: :federation_publisher_modules,
680 type: {:list, :module},
681 description: "List of modules for federation publishing",
683 Pleroma.Web.ActivityPub.Publisher
689 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
692 key: :rewrite_policy,
693 type: [:module, {:list, :module}],
694 description: "A list of MRF policies enabled",
696 Generator.list_modules_in_dir(
697 "lib/pleroma/web/activity_pub/mrf",
698 "Elixir.Pleroma.Web.ActivityPub.MRF."
705 "Makes the client API in authentificated mode-only except for user-profiles." <>
706 " Useful for disabling the Local Timeline and The Whole Known Network."
709 key: :quarantined_instances,
710 type: {:list, :string},
712 "List of ActivityPub instances where private (DMs, followers-only) activities will not be send",
719 key: :managed_config,
722 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
727 description: "Instance static directory",
733 key: :allowed_post_formats,
734 type: {:list, :string},
735 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
744 key: :mrf_transparency,
745 label: "MRF transparency",
748 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
751 key: :mrf_transparency_exclusions,
752 label: "MRF transparency exclusions",
753 type: {:list, :string},
755 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
761 key: :extended_nickname_format,
764 "Set to `true` to use extended local nicknames format (allows underscores/dashes)." <>
765 " This will break federation with older software for theses nicknames."
768 key: :cleanup_attachments,
771 "Set to `true` to remove associated attachments when status is removed.
772 This will not affect duplicates and attachments without status.
773 Enabling this will increase load to database when deleting statuses on larger instances.
777 key: :max_pinned_statuses,
779 description: "The maximum number of pinned statuses. 0 will disable the feature.",
787 key: :autofollowed_nicknames,
788 type: {:list, :string},
790 "Set to nicknames of (local) users that every new user should automatically follow",
799 key: :no_attachment_links,
802 "Set to `true` to disable automatically adding attachment link text to statuses"
805 key: :welcome_message,
808 "A message that will be sent to a newly registered users as a direct message",
810 "Hi, @username! Welcome on board!"
814 key: :welcome_user_nickname,
816 description: "The nickname of the local user that sends the welcome message",
822 key: :max_report_comment_size,
824 description: "The maximum size of the report comment. Default: 1000.",
830 key: :safe_dm_mentions,
833 "If set to `true`, only mentions at the beginning of a post will be used to address people in direct messages." <>
834 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
840 description: "If set to `true`, system data will be shown on /api/pleroma/healthcheck"
843 key: :remote_post_retention_days,
846 "The default amount of days to retain remote posts when pruning the database",
852 key: :user_bio_length,
854 description: "A user bio maximum length. Default: 5000.",
860 key: :user_name_length,
862 description: "A user name maximum length. Default: 100.",
868 key: :skip_thread_containment,
870 description: "Skip filter out broken threads. Default: `true`"
873 key: :limit_to_local_content,
874 type: {:dropdown, :atom},
876 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
884 key: :max_account_fields,
886 description: "The maximum number of custom fields in the user profile. Default: 10.",
892 key: :max_remote_account_fields,
895 "The maximum number of custom fields in the remote user profile. Default: 20.",
901 key: :account_field_name_length,
903 description: "An account field name maximum length. Default: 512.",
909 key: :account_field_value_length,
911 description: "An account field value maximum length. Default: 2048.",
917 key: :external_user_synchronization,
919 description: "Enabling following/followers counters synchronization for external users"
926 description: "Logger-related settings",
930 type: [:atom, :tuple, :module],
932 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
933 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
941 description: "ExSyslogger-related settings",
945 type: {:dropdown, :atom},
946 description: "Log level",
947 suggestions: [:debug, :info, :warn, :error]
953 "A string that's prepended to every message, and is typically set to the app name",
954 suggestions: ["pleroma"]
959 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
960 suggestions: ["$metadata[$level] $message"]
964 type: {:list, :atom},
965 suggestions: [:request_id]
973 description: "Console logger settings",
977 type: {:dropdown, :atom},
978 description: "Log level",
979 suggestions: [:debug, :info, :warn, :error]
984 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
985 suggestions: ["$metadata[$level] $message"]
989 type: {:list, :atom},
990 suggestions: [:request_id]
997 description: "Quack-related settings",
1001 type: {:dropdown, :atom},
1002 description: "Log level",
1003 suggestions: [:debug, :info, :warn, :error]
1007 type: {:list, :atom},
1008 description: "Configure which metadata you want to report on",
1026 description: "Configure the Slack incoming webhook",
1027 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1033 key: :frontend_configurations,
1036 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1037 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1038 "add your own configuration your settings all fields must be complete.",
1042 label: "Pleroma FE",
1044 description: "Settings for Pleroma FE",
1047 theme: "pleroma-dark",
1048 logo: "/static/logo.png",
1049 background: "/images/city.jpg",
1050 redirectRootNoLogin: "/main/all",
1051 redirectRootLogin: "/main/friends",
1052 showInstanceSpecificPanel: true,
1053 scopeOptionsEnabled: false,
1054 formattingOptionsEnabled: false,
1055 collapseMessageWithSubject: false,
1056 hidePostStats: false,
1057 hideUserStats: false,
1059 subjectLineBehavior: "email",
1060 alwaysShowSubjectInput: true,
1064 enableEmojiPicker: false
1071 description: "Which theme to use, they are defined in styles.json",
1072 suggestions: ["pleroma-dark"]
1077 description: "URL of the logo, defaults to Pleroma's logo",
1078 suggestions: ["/static/logo.png"]
1084 "URL of the background, unless viewing a user profile with a background that is set",
1085 suggestions: ["/images/city.jpg"]
1088 key: :redirectRootNoLogin,
1089 label: "Redirect root no login",
1092 "Relative URL which indicates where to redirect when a user isn't logged in",
1093 suggestions: ["/main/all"]
1096 key: :redirectRootLogin,
1097 label: "Redirect root login",
1100 "Relative URL which indicates where to redirect when a user is logged in",
1101 suggestions: ["/main/friends"]
1104 key: :showInstanceSpecificPanel,
1105 label: "Show instance specific panel",
1107 description: "Whenether to show the instance's specific panel"
1110 key: :scopeOptionsEnabled,
1111 label: "Scope options enabled",
1113 description: "Enable setting a notice visibility and subject/CW when posting"
1116 key: :formattingOptionsEnabled,
1117 label: "Formatting options enabled",
1120 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1123 key: :collapseMessageWithSubject,
1124 label: "Collapse message with subject",
1127 "When a message has a subject (aka Content Warning), collapse it by default"
1130 key: :hidePostStats,
1131 label: "Hide post stats",
1133 description: "Hide notices statistics (repeats, favorites, ...)"
1136 key: :hideUserStats,
1137 label: "Hide user stats",
1140 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1144 label: "Scope copy",
1146 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1149 key: :subjectLineBehavior,
1150 label: "Subject line behavior",
1152 description: "Allows changing the default behaviour of subject lines in replies.
1153 `email`: copy and preprend re:, as in email,
1154 `masto`: copy verbatim, as in Mastodon,
1155 `noop`: don't copy the subject.",
1156 suggestions: ["email", "masto", "noop"]
1159 key: :alwaysShowSubjectInput,
1160 label: "Always show subject input",
1162 description: "When set to `false`, auto-hide the subject field when it's empty"
1169 "By default it assumes logo used will be monochrome-with-alpha one, this is done to be compatible with both light and dark themes, " <>
1170 "so that white logo designed with dark theme in mind won't be invisible over light theme, this is done via CSS3 Masking. " <>
1171 "Basically - it will take alpha channel of the image and fill non-transparent areas of it with solid color. " <>
1172 "If you really want colorful logo - it can be done by setting logoMask to false."
1176 label: "Logo margin",
1179 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1180 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1181 suggestions: [".1em"]
1186 description: "Enables/disables stickers."
1189 key: :enableEmojiPicker,
1190 label: "Emoji picker",
1192 description: "Enables/disables emoji picker."
1200 description: "Settings for Masto FE",
1203 showInstanceSpecificPanel: true
1208 key: :showInstanceSpecificPanel,
1209 label: "Show instance specific panel",
1211 description: "Whenether to show the instance's specific panel"
1222 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1226 type: {:keyword, :map},
1228 "Keyword of mascots, each element must contain both an url and a mime_type key",
1231 url: "/images/pleroma-fox-tan-smol.png",
1232 mime_type: "image/png"
1234 pleroma_fox_tan_shy: %{
1235 url: "/images/pleroma-fox-tan-shy.png",
1236 mime_type: "image/png"
1241 key: :default_mascot,
1244 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1256 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1260 type: {:list, :map},
1261 description: "Describe the icons of the app",
1264 src: "/static/logo.png"
1267 src: "/static/icon.png",
1271 src: "/static/icon.ico",
1272 sizes: "72x72 96x96 128x128 256x256"
1279 description: "Describe the theme color of the app",
1280 suggestions: ["#282c37", "mediumpurple"]
1283 key: :background_color,
1285 description: "Describe the background color of the app",
1286 suggestions: ["#191b22", "aliceblue"]
1293 label: "MRF simple",
1295 description: "Message Rewrite Facility",
1298 key: :media_removal,
1299 type: {:list, :string},
1300 description: "List of instances to remove medias from",
1301 suggestions: ["example.com", "*.example.com"]
1305 label: "Media NSFW",
1306 type: {:list, :string},
1307 description: "List of instances to put medias as NSFW (sensitive) from",
1308 suggestions: ["example.com", "*.example.com"]
1311 key: :federated_timeline_removal,
1312 type: {:list, :string},
1314 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1315 suggestions: ["example.com", "*.example.com"]
1319 type: {:list, :string},
1320 description: "List of instances to reject any activities from",
1321 suggestions: ["example.com", "*.example.com"]
1325 type: {:list, :string},
1326 description: "List of instances to accept any activities from",
1327 suggestions: ["example.com", "*.example.com"]
1330 key: :report_removal,
1331 type: {:list, :string},
1332 description: "List of instances to reject reports from",
1333 suggestions: ["example.com", "*.example.com"]
1336 key: :avatar_removal,
1337 type: {:list, :string},
1338 description: "List of instances to strip avatars from",
1339 suggestions: ["example.com", "*.example.com"]
1342 key: :banner_removal,
1343 type: {:list, :string},
1344 description: "List of instances to strip banners from",
1345 suggestions: ["example.com", "*.example.com"]
1351 key: :mrf_activity_expiration,
1352 label: "MRF Activity Expiration Policy",
1354 description: "Adds expiration to all local Create activities",
1359 description: "Default global expiration time for all local Create activities (in days)",
1360 suggestions: [90, 365]
1367 label: "MRF subchain",
1370 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1371 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1376 description: "Matches a series of regular expressions against the actor field",
1379 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1387 key: :mrf_rejectnonpublic,
1389 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1390 label: "MRF reject non public",
1394 key: :allow_followersonly,
1395 label: "Allow followers-only",
1397 description: "Whether to allow followers-only posts"
1402 description: "Whether to allow direct messages"
1408 key: :mrf_hellthread,
1409 label: "MRF hellthread",
1411 description: "Block messages with too much mentions",
1414 key: :delist_threshold,
1417 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1418 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1422 key: :reject_threshold,
1425 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1433 label: "MRF keyword",
1435 description: "Reject or Word-Replace messages with a keyword or regex",
1439 type: [:string, :regex],
1441 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression.",
1442 suggestions: ["foo", ~r/foo/iu]
1445 key: :federated_timeline_removal,
1446 type: [:string, :regex],
1448 "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.",
1449 suggestions: ["foo", ~r/foo/iu]
1453 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1455 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1456 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1463 label: "MRF mention",
1465 description: "Block messages which mention a user",
1469 type: {:list, :string},
1470 description: "A list of actors, for which to drop any posts mentioning",
1471 suggestions: ["actor1", "actor2"]
1477 key: :mrf_vocabulary,
1478 label: "MRF vocabulary",
1480 description: "Filter messages which belong to certain activity vocabularies",
1484 type: {:list, :string},
1486 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1487 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1491 type: {:list, :string},
1493 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1494 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1500 # key: :mrf_user_allowlist,
1503 # "The keys in this section are the domain names that the policy should apply to." <>
1504 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1506 # ["example.org": ["https://example.org/users/admin"]],
1508 # ["example.org": ["https://example.org/users/admin"]]
1516 description: "Media proxy",
1521 description: "Enables proxying of remote media to the instance's proxy"
1527 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1528 suggestions: ["https://example.com"]
1533 description: "Options for Pleroma.ReverseProxy",
1535 redirect_on_failure: false,
1536 max_body_length: 25 * 1_048_576,
1538 follow_redirect: true,
1544 key: :redirect_on_failure,
1547 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1548 "Any error during body processing will not be redirected as the response is chunked."
1551 key: :max_body_length,
1554 "Limits the content length to be approximately the " <>
1555 "specified length. It is validated with the `content-length` header and also verified when proxying."
1560 description: "HTTP options",
1565 description: "Adapter specific options",
1570 label: "SSL Options",
1571 description: "SSL options for HTTP adapter",
1575 type: {:list, :atom},
1576 description: "List of TLS version to use",
1577 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1586 type: [:string, :tuple],
1587 description: "Proxy URL",
1588 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1596 type: {:list, :string},
1597 description: "List of domains to bypass the mediaproxy",
1598 suggestions: ["example.com"]
1606 description: "Gopher settings",
1611 description: "Enables the gopher interface"
1616 description: "IP address to bind to",
1617 suggestions: [{0, 0, 0, 0}]
1622 description: "Port to bind to",
1628 description: "Port advertised in urls (optional, defaults to port)",
1635 key: Pleroma.Web.Endpoint,
1637 description: "Phoenix endpoint configuration",
1642 type: {:keyword, :integer, :tuple},
1643 description: "http protocol configuration",
1651 type: {:list, :tuple},
1652 description: "dispatch settings",
1656 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1657 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1658 {Phoenix.Transports.WebSocket,
1659 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1660 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1662 # end copied from config.exs
1677 description: "port",
1687 type: {:keyword, :string, :integer},
1688 description: "configuration for generating urls",
1690 host: "example.com",
1698 description: "Host",
1706 description: "port",
1714 description: "Scheme",
1723 key: :instrumenters,
1724 type: {:list, :module},
1725 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1730 suggestions: ["https"]
1733 key: :secret_key_base,
1735 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1740 suggestions: ["CqaoopA2"]
1743 key: :render_errors,
1745 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1750 suggestions: [Pleroma.Web.ErrorView]
1754 type: {:list, :string},
1755 suggestions: ["json"]
1762 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1767 suggestions: [Pleroma.PubSub]
1772 suggestions: [Phoenix.PubSub.PG2]
1777 key: :secure_cookie_flag,
1781 key: :extra_cookie_attrs,
1782 type: {:list, :string},
1783 suggestions: ["SameSite=Lax"]
1791 description: "ActivityPub-related settings",
1794 key: :unfollow_blocked,
1796 description: "Whether blocks result in people getting unfollowed"
1799 key: :outgoing_blocks,
1801 description: "Whether to federate blocks to other instances"
1804 key: :sign_object_fetches,
1806 description: "Sign object fetches with HTTP signatures"
1809 key: :follow_handshake_timeout,
1811 description: "Following handshake timeout",
1818 key: :http_security,
1820 description: "HTTP security settings",
1825 description: "Whether the managed content security policy is enabled"
1831 description: "Whether to additionally send a Strict-Transport-Security header"
1835 label: "STS max age",
1837 description: "The maximum age for the Strict-Transport-Security header if sent",
1838 suggestions: [31_536_000]
1842 label: "CT max age",
1844 description: "The maximum age for the Expect-CT header if sent",
1845 suggestions: [2_592_000]
1848 key: :referrer_policy,
1850 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1851 suggestions: ["same-origin", "no-referrer"]
1855 label: "Report URI",
1857 description: "Adds the specified url to report-uri and report-to group in CSP header",
1858 suggestions: ["https://example.com/report-uri"]
1863 group: :web_push_encryption,
1864 key: :vapid_details,
1867 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1873 "A mailto link for the administrative contact." <>
1874 " It's best if this email is not a personal email address, but rather a group email so that if a person leaves an organization," <>
1875 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can.",
1876 suggestions: ["Subject"]
1881 description: "VAPID public key",
1882 suggestions: ["Public key"]
1887 description: "VAPID private key",
1888 suggestions: ["Private key"]
1894 key: Pleroma.Captcha,
1896 description: "Captcha-related settings",
1901 description: "Whether the captcha should be shown on registration"
1906 description: "The method/service to use for captcha",
1907 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1910 key: :seconds_valid,
1912 description: "The time in seconds for which the captcha is valid",
1919 key: Pleroma.Captcha.Kocaptcha,
1922 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1923 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1928 description: "The kocaptcha endpoint to use",
1929 suggestions: ["https://captcha.kotobank.ch"]
1937 "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",
1942 description: "Token",
1943 suggestions: ["some_random_token"]
1948 group: :pleroma_job_queue,
1951 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1955 key: Pleroma.Web.Federator.RetryQueue,
1957 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1962 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1971 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1973 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1974 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1975 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1976 (see https://github.com/sorentwo/oban/issues/52).
1982 description: "Application's Ecto repo",
1983 suggestions: [Pleroma.Repo]
1987 type: {:dropdown, :atom},
1988 description: "Logs verbose mode",
1989 suggestions: [false, :error, :warn, :info, :debug]
1993 type: [:atom, :tuple],
1995 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1996 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
2000 type: {:keyword, :integer},
2002 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2004 activity_expiration: 10,
2006 federator_incoming: 50,
2007 federator_outgoing: 50,
2009 scheduled_activities: 10,
2015 key: :activity_expiration,
2017 description: "Activity expiration queue",
2023 description: "Background queue",
2027 key: :federator_incoming,
2029 description: "Incoming federation queue",
2033 key: :federator_outgoing,
2035 description: "Outgoing federation queue",
2041 description: "Email sender queue, see Pleroma.Emails.Mailer",
2045 key: :scheduled_activities,
2047 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2051 key: :transmogrifier,
2053 description: "Transmogrifier queue",
2059 description: "Web push notifications queue",
2070 description: "Includes custom worker options not interpretable directly by `Oban`",
2074 type: {:keyword, :integer},
2075 description: "Max retry attempts for failed jobs, per `Oban` queue",
2077 federator_incoming: 5,
2078 federator_outgoing: 5
2085 key: Pleroma.Web.Metadata,
2087 description: "Metadata-related settings",
2091 type: {:list, :module},
2092 description: "List of metadata providers to enable",
2094 Pleroma.Web.Metadata.Providers.OpenGraph,
2095 Pleroma.Web.Metadata.Providers.TwitterCard,
2096 Pleroma.Web.Metadata.Providers.RelMe,
2097 Pleroma.Web.Metadata.Providers.Feed
2102 label: "Unfurl NSFW",
2104 description: "If set to `true` NSFW attachments will be shown in previews"
2113 "If enabled the instance will parse metadata from attached links to generate link previews.",
2118 description: "Enables/disables RichMedia."
2122 type: {:list, :string},
2123 description: "List of hosts which will be ignored by the metadata parser.",
2124 suggestions: ["accounts.google.com", "xss.website"]
2128 label: "Ignore TLD",
2129 type: {:list, :string},
2130 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2131 suggestions: ["local", "localdomain", "lan"]
2135 type: {:list, :module},
2136 description: "List of Rich Media parsers.",
2138 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2139 Pleroma.Web.RichMedia.Parsers.OEmbed,
2140 Pleroma.Web.RichMedia.Parsers.OGP,
2141 Pleroma.Web.RichMedia.Parsers.TwitterCard
2146 label: "TTL setters",
2147 type: {:list, :module},
2148 description: "List of rich media TTL setters.",
2150 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2157 key: :fetch_initial_posts,
2159 description: "Fetching initial posts settings",
2165 "If enabled, when a new user is federated with, fetch some of their latest posts"
2170 description: "The amount of pages to fetch",
2176 group: :auto_linker,
2179 description: "Configuration for the auto_linker library",
2183 type: [:string, false],
2184 description: "Specify the class to be added to the generated link. `False` to clear",
2185 suggestions: ["auto-linker", false]
2189 type: [:string, false],
2190 description: "Override the rel attribute. `False` to clear",
2191 suggestions: ["ugc", "noopener noreferrer", false]
2196 description: "Link urls will open in new window/tab"
2200 type: [:integer, false],
2202 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2203 suggestions: [15, false]
2208 description: "Strip the scheme prefix"
2213 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2219 key: Pleroma.ScheduledActivity,
2221 description: "Scheduled activities settings",
2224 key: :daily_user_limit,
2227 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2231 key: :total_user_limit,
2234 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2240 description: "Whether scheduled activities are sent to the job queue to be executed"
2246 key: Pleroma.ActivityExpiration,
2248 description: "Expired activity settings",
2253 description: "Whether expired activities will be sent to the job queue to be deleted"
2260 description: "Authenticator",
2263 key: Pleroma.Web.Auth.Authenticator,
2265 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2274 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2275 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2276 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2277 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2282 description: "Enables LDAP authentication"
2287 description: "LDAP server hostname",
2288 suggestions: ["localhosts"]
2293 description: "LDAP port, e.g. 389 or 636",
2294 suggestions: [389, 636]
2300 description: "`True` to use SSL, usually implies the port 636"
2304 label: "SSL options",
2306 description: "Additional SSL options",
2307 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2312 description: "Path to file with PEM encoded cacerts",
2313 suggestions: ["path/to/file/with/PEM/cacerts"]
2318 description: "Type of cert verification",
2319 suggestions: [:verify_peer]
2327 description: "`True` to start TLS, usually implies the port 389"
2331 label: "TLS options",
2333 description: "Additional TLS options",
2334 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2339 description: "Path to file with PEM encoded cacerts",
2340 suggestions: ["path/to/file/with/PEM/cacerts"]
2345 description: "Type of cert verification",
2346 suggestions: [:verify_peer]
2353 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2354 suggestions: ["dc=example,dc=com"]
2360 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2369 description: "Authentication / authorization settings",
2372 key: :enforce_oauth_admin_scope_usage,
2375 "OAuth admin scope requirement toggle. " <>
2376 "If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2377 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2378 "`is_admin` user flag grants access to admin-specific actions."
2381 key: :auth_template,
2384 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2385 suggestions: ["show.html"]
2388 key: :oauth_consumer_template,
2391 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2392 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2393 suggestions: ["consumer.html"]
2396 key: :oauth_consumer_strategies,
2397 type: {:list, :string},
2399 "The list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2400 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2401 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2402 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2408 key: :email_notifications,
2410 description: "Email notifications settings",
2416 "emails of \"what you've missed\" for users who have been inactive for a while",
2420 schedule: "0 0 * * 0",
2422 inactivity_threshold: 7
2429 description: "Globally enable or disable digest emails"
2435 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2436 suggestions: ["0 0 * * 0"]
2441 description: "Minimum interval between digest emails to one user",
2445 key: :inactivity_threshold,
2447 description: "Minimum user inactivity threshold",
2456 key: Pleroma.Emails.UserEmail,
2458 description: "Email template settings",
2463 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2464 suggestions: ["some/path/logo.png"]
2469 description: "a map with color settings for email templates.",
2472 link_color: "#d8a070",
2473 background_color: "#2C3645",
2474 content_background_color: "#1B2635",
2475 header_color: "#d8a070",
2476 text_color: "#b9b9ba",
2477 text_muted_color: "#b9b9ba"
2484 suggestions: ["#d8a070"]
2487 key: :background_color,
2489 suggestions: ["#2C3645"]
2492 key: :content_background_color,
2494 suggestions: ["#1B2635"]
2499 suggestions: ["#d8a070"]
2504 suggestions: ["#b9b9ba"]
2507 key: :text_muted_color,
2509 suggestions: ["#b9b9ba"]
2519 description: "Configure OAuth 2 provider capabilities",
2522 key: :token_expires_in,
2524 description: "The lifetime in seconds of the access token",
2528 key: :issue_new_refresh_token,
2531 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2534 key: :clean_expired_tokens,
2536 description: "Enable a background job to clean expired oauth tokens. Default: `false`."
2546 key: :shortcode_globs,
2547 type: {:list, :string},
2548 description: "Location of custom emoji files. * can be used as a wildcard.",
2549 suggestions: ["/emoji/custom/**/*.png"]
2552 key: :pack_extensions,
2553 type: {:list, :string},
2555 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2556 suggestions: [".png", ".gif"]
2560 type: {:keyword, :string, {:list, :string}},
2562 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2563 " and the value is the location or array of locations. * can be used as a wildcard.",
2565 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2569 key: :default_manifest,
2572 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2573 " Currently only one manifest can be added (no arrays).",
2574 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2577 key: :shared_pack_cache_seconds_per_file,
2578 label: "Shared pack cache s/file",
2581 "When an emoji pack is shared, the archive is created and cached in memory" <>
2582 " for this amount of seconds multiplied by the number of files.",
2591 description: "Database related settings",
2596 description: "If RUM indexes should be used. Default: `false`"
2605 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2609 type: [:tuple, {:list, :tuple}],
2610 description: "For the search requests (account & status search etc.)",
2611 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2614 key: :app_account_creation,
2615 type: [:tuple, {:list, :tuple}],
2616 description: "For registering user accounts from the same IP address",
2617 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2620 key: :relations_actions,
2621 type: [:tuple, {:list, :tuple}],
2622 description: "For actions on relations with all users (follow, unfollow)",
2623 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2626 key: :relation_id_action,
2627 type: [:tuple, {:list, :tuple}],
2628 description: "For actions on relation with a specific user (follow, unfollow)",
2629 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2632 key: :statuses_actions,
2633 type: [:tuple, {:list, :tuple}],
2635 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2636 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2639 key: :status_id_action,
2640 type: [:tuple, {:list, :tuple}],
2642 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2643 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2646 key: :authentication,
2647 type: [:tuple, {:list, :tuple}],
2648 description: "For authentication create / password check / user existence check requests",
2649 suggestions: [{60_000, 15}]
2657 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2658 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2663 description: "Enables SSH"
2668 description: "Dir with SSH keys",
2669 suggestions: ["/some/path/ssh_keys"]
2674 description: "Handler module",
2675 suggestions: ["Pleroma.BBS.Handler"]
2680 description: "Port to connect",
2681 suggestions: [10_022]
2684 key: :password_authenticator,
2686 description: "Authenticator module",
2687 suggestions: ["Pleroma.BBS.Authenticator"]
2694 description: "Mime types",
2701 "application/xml" => ["xml"],
2702 "application/xrd+xml" => ["xrd+xml"],
2703 "application/jrd+json" => ["jrd+json"],
2704 "application/activity+json" => ["activity+json"],
2705 "application/ld+json" => ["activity+json"]
2710 key: "application/xml",
2711 type: {:list, :string},
2712 suggestions: ["xml"]
2715 key: "application/xrd+xml",
2716 type: {:list, :string},
2717 suggestions: ["xrd+xml"]
2720 key: "application/jrd+json",
2721 type: {:list, :string},
2722 suggestions: ["jrd+json"]
2725 key: "application/activity+json",
2726 type: {:list, :string},
2727 suggestions: ["activity+json"]
2730 key: "application/ld+json",
2731 type: {:list, :string},
2732 suggestions: ["activity+json"]
2741 description: "Tesla settings",
2746 description: "Tesla adapter",
2747 suggestions: [Tesla.Adapter.Hackney]
2755 description: "Pleroma chat settings",
2765 key: Pleroma.Web.Endpoint.MetricsExporter,
2767 description: "Prometheus settings",
2772 description: "API endpoint with metrics",
2773 suggestions: ["/api/pleroma/app_metrics"]
2778 group: :http_signatures,
2780 description: "HTTP Signatures settings",
2785 suggestions: [Pleroma.Signature]
2793 description: "HTTP settings",
2798 type: [:string, :tuple],
2799 description: "Proxy URL",
2800 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2803 key: :send_user_agent,
2808 type: [:string, :atom],
2810 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2811 suggestions: ["Pleroma", :default]
2816 description: "Adapter specific options",
2822 label: "SSL Options",
2823 description: "SSL options for HTTP adapter",
2827 type: {:list, :atom},
2828 description: "List of TLS version to use",
2829 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2843 key: :allow_inline_images,
2847 key: :allow_headings,
2860 type: {:list, :module},
2861 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2871 key: :deny_follow_blocked,
2878 key: :mrf_normalize_markup,
2879 label: "MRF normalize markup",
2880 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2886 suggestions: [Pleroma.HTML.Scrubber.Default]
2896 key: :restricted_nicknames,
2897 type: {:list, :string},
2916 "ostatus_subscribe",
2940 suggestions: [86_400]
2944 type: {:list, :string},
2945 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2949 type: {:list, :string},
2952 "X-RateLimit-Reset",
2953 "X-RateLimit-Limit",
2954 "X-RateLimit-Remaining",
2965 type: {:list, :string},
2966 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2972 key: Pleroma.Plugs.RemoteIp,
2975 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2976 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2982 description: "Enable/disable the plug. Default: `false`."
2986 type: {:list, :string},
2988 "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]`."
2992 type: {:list, :string},
2994 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2998 type: {:list, :string},
3000 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3006 key: :web_cache_ttl,
3009 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3015 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3016 suggestions: [30_000, nil]
3019 key: :activity_pub_question,
3021 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3022 suggestions: [30_000]
3031 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3036 description: "Enables the rendering of static HTML. Defaults to `false`."
3044 description: "Configure feed rendering.",
3049 description: "Configure title rendering.",
3054 description: "Maximum number of characters before truncating title.",
3060 description: "Replacement which will be used after truncating string.",
3061 suggestions: ["..."]
3069 key: :mrf_object_age,
3071 description: "Rejects or delists posts based on their age when received.",
3076 description: "Required age (in seconds) of a post before actions are taken.",
3077 suggestions: [172_800]
3081 type: {:list, :atom},
3083 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3084 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3085 "`:reject` rejects the message entirely",
3086 suggestions: [:delist, :strip_followers, :reject]
3094 description: "Custom Runtime Modules.",
3099 description: "A path to custom Elixir modules (such as MRF policies)."
3106 description: "Allow instance configuration from database.",
3109 key: :configurable_from_database,
3112 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"