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 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",
519 description: "Email used to reach an Administrator/Moderator of the instance",
527 description: "Email used for notifications",
535 description: "The instance's description, can be seen in nodeinfo and /api/v1/instance",
543 description: "Posts character limit (CW/Subject included in the counter)",
551 description: "Character limit of the instance chat messages",
559 description: "Hard character limit beyond which remote posts will be dropped",
567 description: "File size limit of uploads (except for avatar, background, banner)",
573 key: :avatar_upload_limit,
575 description: "File size limit of user's profile avatars",
581 key: :background_upload_limit,
583 description: "File size limit of user's profile backgrounds",
589 key: :banner_upload_limit,
591 description: "File size limit of user's profile banners",
599 description: "A map with poll limits for local polls",
603 max_option_chars: 200,
605 max_expiration: 31_536_000
612 description: "Maximum number of options",
616 key: :max_option_chars,
618 description: "Maximum number of characters per option",
622 key: :min_expiration,
624 description: "Minimum expiration time (in seconds)",
628 key: :max_expiration,
630 description: "Maximum expiration time (in seconds)",
636 key: :registrations_open,
638 description: "Enable registrations for anyone, invitations can be enabled when false"
641 key: :invites_enabled,
643 description: "Enable user invitations for admins (depends on registrations_open: false)"
646 key: :account_activation_required,
648 description: "Require users to confirm their emails before signing in"
653 description: "Enable federation with other instances"
656 key: :federation_incoming_replies_max_depth,
657 label: "Fed. incoming replies max depth",
660 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
661 " 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",
667 key: :federation_reachability_timeout_days,
668 label: "Fed. reachability timeout days",
671 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
677 key: :federation_publisher_modules,
678 type: {:list, :module},
679 description: "List of modules for federation publishing",
681 Pleroma.Web.ActivityPub.Publisher
687 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
690 key: :rewrite_policy,
691 type: [:module, {:list, :module}],
692 description: "A list of MRF policies enabled",
694 Generator.list_modules_in_dir(
695 "lib/pleroma/web/activity_pub/mrf",
696 "Elixir.Pleroma.Web.ActivityPub.MRF."
703 "Makes the client API in authentificated mode-only except for user-profiles." <>
704 " Useful for disabling the Local Timeline and The Whole Known Network"
707 key: :quarantined_instances,
708 type: {:list, :string},
710 "List of ActivityPub instances where private(DMs, followers-only) activities will not be send",
717 key: :managed_config,
720 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
725 description: "Instance static directory",
731 key: :allowed_post_formats,
732 type: {:list, :string},
733 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
742 key: :mrf_transparency,
743 label: "MRF transparency",
746 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
749 key: :mrf_transparency_exclusions,
750 label: "MRF transparency exclusions",
751 type: {:list, :string},
753 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value",
759 key: :extended_nickname_format,
762 "Set to true to use extended local nicknames format (allows underscores/dashes)." <>
763 " This will break federation with older software for theses nicknames"
766 key: :max_pinned_statuses,
768 description: "The maximum number of pinned statuses. 0 will disable the feature",
776 key: :autofollowed_nicknames,
777 type: {:list, :string},
779 "Set to nicknames of (local) users that every new user should automatically follow",
788 key: :no_attachment_links,
791 "Set to true to disable automatically adding attachment link text to statuses"
794 key: :welcome_message,
797 "A message that will be send to a newly registered users as a direct message",
799 "Hi, @username! Welcome on board!"
803 key: :welcome_user_nickname,
805 description: "The nickname of the local user that sends the welcome message",
811 key: :max_report_comment_size,
813 description: "The maximum size of the report comment (Default: 1000)",
819 key: :safe_dm_mentions,
822 "If set to true, only mentions at the beginning of a post will be used to address people in direct messages." <>
823 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@friend hey i really don't like @enemy\")." <>
829 description: "If set to true, system data will be shown on /api/pleroma/healthcheck"
832 key: :remote_post_retention_days,
835 "The default amount of days to retain remote posts when pruning the database",
841 key: :user_bio_length,
843 description: "A user bio maximum length (default: 5000)",
849 key: :user_name_length,
851 description: "A user name maximum length (default: 100)",
857 key: :skip_thread_containment,
859 description: "Skip filter out broken threads. The default is true"
862 key: :limit_to_local_content,
863 type: [:atom, false],
865 "Limit unauthenticated users to search for local statutes and users only. The default is :unauthenticated ",
873 key: :max_account_fields,
875 description: "The maximum number of custom fields in the user profile (default: 10)",
881 key: :max_remote_account_fields,
884 "The maximum number of custom fields in the remote user profile (default: 20)",
890 key: :account_field_name_length,
892 description: "An account field name maximum length (default: 512)",
898 key: :account_field_value_length,
900 description: "An account field value maximum length (default: 2048)",
906 key: :external_user_synchronization,
908 description: "Enabling following/followers counters synchronization for external users"
915 description: "Logger-related settings",
919 type: [:atom, :tuple, :module],
921 "Where logs will be send, :console - send logs to stdout, {ExSyslogger, :ex_syslogger} - to syslog, Quack.Logger - to Slack.",
922 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
930 description: "ExSyslogger-related settings",
935 description: "Log level",
936 suggestions: [:debug, :info, :warn, :error]
942 "A string that's prepended to every message, and is typically set to the app name",
943 suggestions: ["pleroma"]
948 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
949 suggestions: ["$metadata[$level] $message"]
953 type: {:list, :atom},
954 suggestions: [:request_id]
962 description: "Console logger settings",
967 description: "Log level",
968 suggestions: [:debug, :info, :warn, :error]
973 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
974 suggestions: ["$metadata[$level] $message"]
978 type: {:list, :atom},
979 suggestions: [:request_id]
986 description: "Quack-related settings",
991 description: "Log level",
992 suggestions: [:debug, :info, :warn, :error]
996 type: {:list, :atom},
997 description: "Configure which metadata you want to report on",
1015 description: "Configure the Slack incoming webhook",
1016 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1022 key: :frontend_configurations,
1025 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1026 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1027 "add your own configuration your settings need to be complete as they will override the defaults.",
1031 label: "Pleroma FE",
1033 description: "Settings for Pleroma FE",
1036 theme: "pleroma-dark",
1037 logo: "/static/logo.png",
1038 background: "/images/city.jpg",
1039 redirectRootNoLogin: "/main/all",
1040 redirectRootLogin: "/main/friends",
1041 showInstanceSpecificPanel: true,
1042 scopeOptionsEnabled: false,
1043 formattingOptionsEnabled: false,
1044 collapseMessageWithSubject: false,
1045 hidePostStats: false,
1046 hideUserStats: false,
1048 subjectLineBehavior: "email",
1049 alwaysShowSubjectInput: true
1056 description: "Which theme to use, they are defined in styles.json",
1057 suggestions: ["pleroma-dark"]
1062 description: "URL of the logo, defaults to Pleroma's logo",
1063 suggestions: ["/static/logo.png"]
1069 "URL of the background, unless viewing a user profile with a background that is set",
1070 suggestions: ["/images/city.jpg"]
1073 key: :redirectRootNoLogin,
1074 label: "Redirect root no login",
1077 "relative URL which indicates where to redirect when a user isn't logged in",
1078 suggestions: ["/main/all"]
1081 key: :redirectRootLogin,
1082 label: "Redirect root login",
1085 "relative URL which indicates where to redirect when a user is logged in",
1086 suggestions: ["/main/friends"]
1089 key: :showInstanceSpecificPanel,
1090 label: "Show instance specific panel",
1092 description: "Whenether to show the instance's specific panel"
1095 key: :scopeOptionsEnabled,
1096 label: "Scope options enabled",
1098 description: "Enable setting an notice visibility and subject/CW when posting"
1101 key: :formattingOptionsEnabled,
1102 label: "Formatting options enabled",
1105 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to :instance, allowed_post_formats"
1108 key: :collapseMessageWithSubject,
1109 label: "Collapse message with subject",
1112 "When a message has a subject(aka Content Warning), collapse it by default"
1115 key: :hidePostStats,
1116 label: "Hide post stats",
1118 description: "Hide notices statistics(repeats, favorites, ...)"
1121 key: :hideUserStats,
1122 label: "Hide user stats",
1125 "Hide profile statistics(posts, posts per day, followers, followings, ...)"
1129 label: "Scope copy",
1131 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1134 key: :subjectLineBehavior,
1135 label: "Subject line behavior",
1137 description: "Allows changing the default behaviour of subject lines in replies.
1138 `email`: Copy and preprend re:, as in email,
1139 `masto`: Copy verbatim, as in Mastodon,
1140 `noop`: Don't copy the subjec",
1141 suggestions: ["email", "masto", "noop"]
1144 key: :alwaysShowSubjectInput,
1145 label: "Always show subject input",
1147 description: "When set to false, auto-hide the subject field when it's empty"
1155 description: "Settings for Masto FE",
1158 showInstanceSpecificPanel: true
1163 key: :showInstanceSpecificPanel,
1164 label: "Show instance specific panel",
1166 description: "Whenether to show the instance's specific panel"
1177 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1181 type: {:keyword, :map},
1183 "Keyword of mascots, each element MUST contain both a url and a mime_type key",
1186 url: "/images/pleroma-fox-tan-smol.png",
1187 mime_type: "image/png"
1189 pleroma_fox_tan_shy: %{
1190 url: "/images/pleroma-fox-tan-shy.png",
1191 mime_type: "image/png"
1196 key: :default_mascot,
1199 "This will be used as the default mascot on MastoFE (default: :pleroma_fox_tan)",
1211 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1215 type: {:list, :map},
1216 description: "Describe the icons of the app",
1219 src: "/static/logo.png"
1222 src: "/static/icon.png",
1226 src: "/static/icon.ico",
1227 sizes: "72x72 96x96 128x128 256x256"
1234 description: "Describe the theme color of the app",
1235 suggestions: ["#282c37", "mediumpurple"]
1238 key: :background_color,
1240 description: "Describe the background color of the app",
1241 suggestions: ["#191b22", "aliceblue"]
1248 label: "MRF simple",
1250 description: "Message Rewrite Facility",
1253 key: :media_removal,
1254 type: {:list, :string},
1255 description: "List of instances to remove medias from",
1256 suggestions: ["example.com", "*.example.com"]
1260 label: "Media NSFW",
1261 type: {:list, :string},
1262 description: "List of instances to put medias as NSFW(sensitive) from",
1263 suggestions: ["example.com", "*.example.com"]
1266 key: :federated_timeline_removal,
1267 type: {:list, :string},
1269 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1270 suggestions: ["example.com", "*.example.com"]
1274 type: {:list, :string},
1275 description: "List of instances to reject any activities from",
1276 suggestions: ["example.com", "*.example.com"]
1280 type: {:list, :string},
1281 description: "List of instances to accept any activities from",
1282 suggestions: ["example.com", "*.example.com"]
1285 key: :report_removal,
1286 type: {:list, :string},
1287 description: "List of instances to reject reports from",
1288 suggestions: ["example.com", "*.example.com"]
1291 key: :avatar_removal,
1292 type: {:list, :string},
1293 description: "List of instances to strip avatars from",
1294 suggestions: ["example.com", "*.example.com"]
1297 key: :banner_removal,
1298 type: {:list, :string},
1299 description: "List of instances to strip banners from",
1300 suggestions: ["example.com", "*.example.com"]
1307 label: "MRF subchain",
1310 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1311 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1316 description: "Matches a series of regular expressions against the actor field",
1319 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1327 key: :mrf_rejectnonpublic,
1329 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1330 label: "MRF reject non public",
1334 key: :allow_followersonly,
1335 label: "Allow followers-only",
1337 description: "whether to allow followers-only posts"
1342 description: "whether to allow direct messages"
1348 key: :mrf_hellthread,
1349 label: "MRF hellthread",
1351 description: "Block messages with too much mentions",
1354 key: :delist_threshold,
1357 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1358 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable",
1362 key: :reject_threshold,
1365 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable",
1373 label: "MRF keyword",
1375 description: "Reject or Word-Replace messages with a keyword or regex",
1379 type: [:string, :regex],
1381 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression",
1382 suggestions: ["foo", ~r/foo/iu]
1385 key: :federated_timeline_removal,
1386 type: [:string, :regex],
1388 "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",
1389 suggestions: ["foo", ~r/foo/iu]
1393 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1395 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1396 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1403 label: "MRF mention",
1405 description: "Block messages which mention a user",
1409 type: {:list, :string},
1410 description: "A list of actors, for which to drop any posts mentioning",
1411 suggestions: ["actor1", "actor2"]
1417 key: :mrf_vocabulary,
1418 label: "MRF vocabulary",
1420 description: "Filter messages which belong to certain activity vocabularies",
1424 type: {:list, :string},
1426 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1427 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1431 type: {:list, :string},
1433 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1434 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1440 # key: :mrf_user_allowlist,
1443 # "The keys in this section are the domain names that the policy should apply to." <>
1444 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1446 # ["example.org": ["https://example.org/users/admin"]],
1448 # ["example.org": ["https://example.org/users/admin"]]
1456 description: "Media proxy",
1461 description: "Enables proxying of remote media to the instance's proxy"
1467 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts",
1468 suggestions: ["https://example.com"]
1473 description: "Options for Pleroma.ReverseProxy",
1475 redirect_on_failure: false,
1476 max_body_length: 25 * 1_048_576,
1478 follow_redirect: true,
1484 key: :redirect_on_failure,
1487 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1488 "Any error during body processing will not be redirected as the response is chunked"
1491 key: :max_body_length,
1494 "limits the content length to be approximately the " <>
1495 "specified length. It is validated with the `content-length` header and also verified when proxying"
1500 description: "HTTP options",
1505 description: "Adapter specific options",
1510 label: "SSL Options",
1511 description: "SSL options for HTTP adapter",
1515 type: {:list, :atom},
1516 description: "List of TLS version to use",
1517 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1526 type: [:string, :tuple],
1527 description: "Proxy URL",
1528 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1536 type: {:list, :string},
1537 description: "List of domains to bypass the mediaproxy",
1538 suggestions: ["example.com"]
1546 description: "Gopher settings",
1551 description: "Enables the gopher interface"
1556 description: "IP address to bind to",
1557 suggestions: [{0, 0, 0, 0}]
1562 description: "Port to bind to",
1568 description: "Port advertised in urls (optional, defaults to port)",
1575 key: Pleroma.Web.Endpoint,
1577 description: "Phoenix endpoint configuration",
1582 type: {:keyword, :integer, :tuple},
1583 description: "http protocol configuration",
1591 type: {:list, :tuple},
1592 description: "dispatch settings",
1596 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1597 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1598 {Phoenix.Transports.WebSocket,
1599 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1600 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1602 # end copied from config.exs
1617 description: "port",
1627 type: {:keyword, :string, :integer},
1628 description: "configuration for generating urls",
1630 host: "example.com",
1638 description: "Host",
1646 description: "port",
1654 description: "Scheme",
1663 key: :instrumenters,
1664 type: {:list, :module},
1665 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1670 suggestions: ["https"]
1673 key: :secret_key_base,
1675 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1680 suggestions: ["CqaoopA2"]
1683 key: :render_errors,
1685 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1690 suggestions: [Pleroma.Web.ErrorView]
1694 type: {:list, :string},
1695 suggestions: ["json"]
1702 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1707 suggestions: [Pleroma.PubSub]
1712 suggestions: [Phoenix.PubSub.PG2]
1717 key: :secure_cookie_flag,
1721 key: :extra_cookie_attrs,
1722 type: {:list, :string},
1723 suggestions: ["SameSite=Lax"]
1731 description: "ActivityPub-related settings",
1734 key: :unfollow_blocked,
1736 description: "Whether blocks result in people getting unfollowed"
1739 key: :outgoing_blocks,
1741 description: "Whether to federate blocks to other instances"
1744 key: :sign_object_fetches,
1746 description: "Sign object fetches with HTTP signatures"
1749 key: :follow_handshake_timeout,
1751 description: "Following handshake timeout",
1758 key: :http_security,
1760 description: "HTTP security settings",
1765 description: "Whether the managed content security policy is enabled"
1771 description: "Whether to additionally send a Strict-Transport-Security header"
1775 label: "STS max age",
1777 description: "The maximum age for the Strict-Transport-Security header if sent",
1778 suggestions: [31_536_000]
1782 label: "CT max age",
1784 description: "The maximum age for the Expect-CT header if sent",
1785 suggestions: [2_592_000]
1788 key: :referrer_policy,
1790 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1791 suggestions: ["same-origin", "no-referrer"]
1795 label: "Report URI",
1797 description: "Adds the specified url to report-uri and report-to group in CSP header",
1798 suggestions: ["https://example.com/report-uri"]
1803 group: :web_push_encryption,
1804 key: :vapid_details,
1807 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1813 "a mailto link for the administrative contact." <>
1814 " 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," <>
1815 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can",
1816 suggestions: ["Subject"]
1821 description: "VAPID public key",
1822 suggestions: ["Public key"]
1827 description: "VAPID private key",
1828 suggestions: ["Private key"]
1834 key: Pleroma.Captcha,
1836 description: "Captcha-related settings",
1841 description: "Whether the captcha should be shown on registration"
1846 description: "The method/service to use for captcha",
1847 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1850 key: :seconds_valid,
1852 description: "The time in seconds for which the captcha is valid",
1859 key: Pleroma.Captcha.Kocaptcha,
1862 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1863 " here: https://github.com/koto-bank/kocaptcha. The default endpoint https://captcha.kotobank.ch is hosted by the developer",
1868 description: "the kocaptcha endpoint to use",
1869 suggestions: ["https://captcha.kotobank.ch"]
1877 "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",
1882 description: "Token",
1883 suggestions: ["some_random_token"]
1888 group: :pleroma_job_queue,
1891 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1895 key: Pleroma.Web.Federator.RetryQueue,
1897 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1902 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1911 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1913 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1914 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1915 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1916 (see https://github.com/sorentwo/oban/issues/52).
1922 description: "Application's Ecto repo",
1923 suggestions: [Pleroma.Repo]
1928 description: "Logs verbose mode"
1932 type: [:atom, :tuple],
1934 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1935 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1939 type: {:keyword, :integer},
1941 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1943 activity_expiration: 10,
1945 federator_incoming: 50,
1946 federator_outgoing: 50,
1948 scheduled_activities: 10,
1954 key: :activity_expiration,
1956 description: "Activity expiration queue",
1962 description: "Background queue",
1966 key: :federator_incoming,
1968 description: "Incoming federation queue",
1972 key: :federator_outgoing,
1974 description: "Outgoing federation queue",
1980 description: "Email sender queue, see Pleroma.Emails.Mailer",
1984 key: :scheduled_activities,
1986 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1990 key: :transmogrifier,
1992 description: "Transmogrifier queue",
1998 description: "Web push notifications queue",
2009 description: "Includes custom worker options not interpretable directly by `Oban`",
2013 type: {:keyword, :integer},
2014 description: "Max retry attempts for failed jobs, per `Oban` queue",
2016 federator_incoming: 5,
2017 federator_outgoing: 5
2024 key: Pleroma.Web.Metadata,
2026 description: "Metadata-related settings",
2030 type: {:list, :module},
2031 description: "List of metadata providers to enable",
2033 Pleroma.Web.Metadata.Providers.OpenGraph,
2034 Pleroma.Web.Metadata.Providers.TwitterCard,
2035 Pleroma.Web.Metadata.Providers.RelMe,
2036 Pleroma.Web.Metadata.Providers.Feed
2041 label: "Unfurl NSFW",
2043 description: "If set to true nsfw attachments will be shown in previews"
2052 "If enabled the instance will parse metadata from attached links to generate link previews.",
2057 description: "Enables/disables RichMedia."
2061 type: {:list, :string},
2062 description: "List of hosts which will be ignored by the metadata parser.",
2063 suggestions: ["accounts.google.com", "xss.website"]
2067 label: "Ignore TLD",
2068 type: {:list, :string},
2069 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2070 suggestions: ["local", "localdomain", "lan"]
2074 type: {:list, :module},
2075 description: "List of Rich Media parsers.",
2077 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2078 Pleroma.Web.RichMedia.Parsers.OEmbed,
2079 Pleroma.Web.RichMedia.Parsers.OGP,
2080 Pleroma.Web.RichMedia.Parsers.TwitterCard
2085 label: "TTL setters",
2086 type: {:list, :module},
2087 description: "List of rich media ttl setters.",
2089 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2096 key: :fetch_initial_posts,
2098 description: "Fetching initial posts settings",
2104 "if enabled, when a new user is federated with, fetch some of their latest posts"
2109 description: "the amount of pages to fetch",
2115 group: :auto_linker,
2118 description: "Configuration for the auto_linker library",
2122 type: [:string, false],
2123 description: "specify the class to be added to the generated link. false to clear",
2124 suggestions: ["auto-linker", false]
2128 type: [:string, false],
2129 description: "override the rel attribute. false to clear",
2130 suggestions: ["ugc", "noopener noreferrer", false]
2135 description: "set to false to remove target='_blank' attribute"
2140 description: "Set to true to link urls with schema http://google.com"
2144 type: [:integer, false],
2146 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2147 suggestions: [15, false]
2152 description: "Strip the scheme prefix"
2157 description: "link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2163 key: Pleroma.ScheduledActivity,
2165 description: "Scheduled activities settings",
2168 key: :daily_user_limit,
2171 "the number of scheduled activities a user is allowed to create in a single day (Default: 25)",
2175 key: :total_user_limit,
2178 "the number of scheduled activities a user is allowed to create in total (Default: 300)",
2184 description: "whether scheduled activities are sent to the job queue to be executed"
2190 key: Pleroma.ActivityExpiration,
2192 description: "Expired activity settings",
2197 description: "whether expired activities will be sent to the job queue to be deleted"
2204 description: "Authenticator",
2207 key: Pleroma.Web.Auth.Authenticator,
2209 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2218 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2219 " will be verified by trying to authenticate (bind) to an LDAP server." <>
2220 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2221 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2226 description: "enables LDAP authentication"
2231 description: "LDAP server hostname",
2232 suggestions: ["localhosts"]
2237 description: "LDAP port, e.g. 389 or 636",
2238 suggestions: [389, 636]
2244 description: "true to use SSL, usually implies the port 636"
2248 label: "SSL options",
2250 description: "additional SSL options",
2251 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2256 description: "Path to file with PEM encoded cacerts",
2257 suggestions: ["path/to/file/with/PEM/cacerts"]
2262 description: "Type of cert verification",
2263 suggestions: [:verify_peer]
2271 description: "true to start TLS, usually implies the port 389"
2275 label: "TLS options",
2277 description: "additional TLS options",
2278 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2283 description: "Path to file with PEM encoded cacerts",
2284 suggestions: ["path/to/file/with/PEM/cacerts"]
2289 description: "Type of cert verification",
2290 suggestions: [:verify_peer]
2297 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2298 suggestions: ["dc=example,dc=com"]
2304 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2313 description: "Authentication / authorization settings",
2316 key: :enforce_oauth_admin_scope_usage,
2319 "OAuth admin scope requirement toggle. " <>
2320 "If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2321 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2322 "`is_admin` user flag grants access to admin-specific actions."
2325 key: :auth_template,
2328 "authentication form template. By default it's show.html which corresponds to lib/pleroma/web/templates/o_auth/o_auth/show.html.ee",
2329 suggestions: ["show.html"]
2332 key: :oauth_consumer_template,
2335 "OAuth consumer mode authentication form template. By default it's consumer.html which corresponds to" <>
2336 " lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex",
2337 suggestions: ["consumer.html"]
2340 key: :oauth_consumer_strategies,
2341 type: {:list, :string},
2343 "the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2344 " Each entry in this space-delimited string should be of format <strategy> or <strategy>:<dependency>" <>
2345 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2346 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2352 key: :email_notifications,
2354 description: "Email notifications settings",
2360 "emails of \"what you've missed\" for users who have been inactive for a while",
2364 schedule: "0 0 * * 0",
2366 inactivity_threshold: 7
2373 description: "globally enable or disable digest emails"
2379 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\"",
2380 suggestions: ["0 0 * * 0"]
2385 description: "Minimum interval between digest emails to one user",
2389 key: :inactivity_threshold,
2391 description: "Minimum user inactivity threshold",
2400 key: Pleroma.Emails.UserEmail,
2402 description: "Email template settings",
2407 description: "a path to a custom logo. Set it to nil to use the default Pleroma logo",
2408 suggestions: ["some/path/logo.png"]
2413 description: "a map with color settings for email templates.",
2416 link_color: "#d8a070",
2417 background_color: "#2C3645",
2418 content_background_color: "#1B2635",
2419 header_color: "#d8a070",
2420 text_color: "#b9b9ba",
2421 text_muted_color: "#b9b9ba"
2428 suggestions: ["#d8a070"]
2431 key: :background_color,
2433 suggestions: ["#2C3645"]
2436 key: :content_background_color,
2438 suggestions: ["#1B2635"]
2443 suggestions: ["#d8a070"]
2448 suggestions: ["#b9b9ba"]
2451 key: :text_muted_color,
2453 suggestions: ["#b9b9ba"]
2463 description: "Configure OAuth 2 provider capabilities",
2466 key: :token_expires_in,
2468 description: "The lifetime in seconds of the access token",
2472 key: :issue_new_refresh_token,
2475 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2478 key: :clean_expired_tokens,
2480 description: "Enable a background job to clean expired oauth tokens. Defaults to false"
2483 key: :clean_expired_tokens_interval,
2486 "Interval to run the job to clean expired tokens. Defaults to 86_400_000 (24 hours).",
2487 suggestions: [86_400_000]
2497 key: :shortcode_globs,
2498 type: {:list, :string},
2499 description: "Location of custom emoji files. * can be used as a wildcard",
2500 suggestions: ["/emoji/custom/**/*.png"]
2503 key: :pack_extensions,
2504 type: {:list, :string},
2506 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2507 suggestions: [".png", ".gif"]
2511 type: {:keyword, :string, {:list, :string}},
2513 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname" <>
2514 " and the value the location or array of locations. * can be used as a wildcard",
2516 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2520 key: :default_manifest,
2523 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2524 " Currently only one manifest can be added (no arrays)",
2525 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2528 key: :shared_pack_cache_seconds_per_file,
2529 label: "Shared pack cache s/file",
2532 "When an emoji pack is shared, the archive is created and cached in memory" <>
2533 " for this amount of seconds multiplied by the number of files.",
2542 description: "Database related settings",
2547 description: "If RUM indexes should be used. Defaults to false"
2556 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2560 type: [:tuple, {:list, :tuple}],
2561 description: "for the search requests (account & status search etc.)",
2562 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2565 key: :app_account_creation,
2566 type: [:tuple, {:list, :tuple}],
2567 description: "for registering user accounts from the same IP address",
2568 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2571 key: :relations_actions,
2572 type: [:tuple, {:list, :tuple}],
2573 description: "for actions on relations with all users (follow, unfollow)",
2574 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2577 key: :relation_id_action,
2578 type: [:tuple, {:list, :tuple}],
2579 description: "for actions on relation with a specific user (follow, unfollow)",
2580 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2583 key: :statuses_actions,
2584 type: [:tuple, {:list, :tuple}],
2586 "for create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2587 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2590 key: :status_id_action,
2591 type: [:tuple, {:list, :tuple}],
2593 "for fav / unfav or reblog / unreblog actions on the same status by the same user",
2594 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2597 key: :authentication,
2598 type: [:tuple, {:list, :tuple}],
2599 description: "for authentication create / password check / user existence check requests",
2600 suggestions: [{60_000, 15}]
2608 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2609 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2614 description: "Enables ssh"
2619 description: "Dir with ssh keys",
2620 suggestions: ["/some/path/ssh_keys"]
2625 description: "Handler module",
2626 suggestions: ["Pleroma.BBS.Handler"]
2631 description: "Port to connect",
2632 suggestions: [10_022]
2635 key: :password_authenticator,
2637 description: "Authenticator module",
2638 suggestions: ["Pleroma.BBS.Authenticator"]
2645 description: "Mime types",
2652 "application/xml" => ["xml"],
2653 "application/xrd+xml" => ["xrd+xml"],
2654 "application/jrd+json" => ["jrd+json"],
2655 "application/activity+json" => ["activity+json"],
2656 "application/ld+json" => ["activity+json"]
2661 key: "application/xml",
2662 type: {:list, :string},
2663 suggestions: ["xml"]
2666 key: "application/xrd+xml",
2667 type: {:list, :string},
2668 suggestions: ["xrd+xml"]
2671 key: "application/jrd+json",
2672 type: {:list, :string},
2673 suggestions: ["jrd+json"]
2676 key: "application/activity+json",
2677 type: {:list, :string},
2678 suggestions: ["activity+json"]
2681 key: "application/ld+json",
2682 type: {:list, :string},
2683 suggestions: ["activity+json"]
2692 description: "Tesla settings",
2697 description: "Tesla adapter",
2698 suggestions: [Tesla.Adapter.Hackney]
2706 description: "Pleroma chat settings",
2722 description: "Enables suggestions"
2725 key: :third_party_engine,
2727 description: "URL for third party engine",
2729 "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}"
2735 description: "Request timeout to third party engine",
2736 suggestions: [300_000]
2741 description: "Limit for suggestions",
2747 suggestions: ["https://vinayaka.distsn.org"]
2753 key: Pleroma.Web.Endpoint.MetricsExporter,
2755 description: "Prometheus settings",
2760 description: "API endpoint with metrics",
2761 suggestions: ["/api/pleroma/app_metrics"]
2766 group: :http_signatures,
2768 description: "HTTP Signatures settings",
2773 suggestions: [Pleroma.Signature]
2781 description: "HTTP settings",
2786 type: [:string, :tuple],
2787 description: "Proxy URL",
2788 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2791 key: :send_user_agent,
2796 type: [:string, :atom],
2798 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`",
2799 suggestions: ["Pleroma", :default]
2804 description: "Adapter specific options",
2810 label: "SSL Options",
2811 description: "SSL options for HTTP adapter",
2815 type: {:list, :atom},
2816 description: "List of TLS version to use",
2817 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2831 key: :allow_inline_images,
2835 key: :allow_headings,
2848 type: {:list, :module},
2849 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2859 key: :deny_follow_blocked,
2866 key: :mrf_normalize_markup,
2867 label: "MRF normalize markup",
2868 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2874 suggestions: [Pleroma.HTML.Scrubber.Default]
2884 key: :restricted_nicknames,
2885 type: {:list, :string},
2904 "ostatus_subscribe",
2928 suggestions: [86_400]
2932 type: {:list, :string},
2933 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2937 type: {:list, :string},
2940 "X-RateLimit-Reset",
2941 "X-RateLimit-Limit",
2942 "X-RateLimit-Remaining",
2953 type: {:list, :string},
2954 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2960 key: Pleroma.Plugs.RemoteIp,
2963 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2964 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2970 description: "Enable/disable the plug. Defaults to `false`."
2974 type: {:list, :string},
2976 "A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Defaults to `~w[forwarded x-forwarded-for x-client-ip x-real-ip]`."
2980 type: {:list, :string},
2982 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`."
2986 type: {:list, :string},
2988 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2994 key: :web_cache_ttl,
2997 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3003 "activity pub routes (except question activities). Defaults to `nil` (no expiration).",
3004 suggestions: [30_000]
3007 key: :activity_pub_question,
3010 "activity pub routes (question activities). Defaults to `30_000` (30 seconds).",
3011 suggestions: [30_000]
3020 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3025 description: "Enables the rendering of static HTML. Defaults to `false`."
3033 description: "Configure feed rendering.",
3038 description: "Configure title rendering.",
3043 description: "Maximum number of characters before truncating title.",
3049 description: "Replacement which will be used after truncating string.",
3050 suggestions: ["..."]
3058 key: :mrf_object_age,
3060 description: "Rejects or delists posts based on their age when received.",
3065 description: "Required age (in seconds) of a post before actions are taken.",
3066 suggestions: [172_800]
3070 type: {:list, :atom},
3072 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3073 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3074 "`:reject` rejects the message entirely",
3075 suggestions: [:delist, :strip_followers, :reject]
3083 description: "Custom Runtime Modules.",
3088 description: "A path to custom Elixir modules (such as MRF policies)."
3095 description: "Allow instance configuration from database.",
3098 key: :configurable_from_database,
3101 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"