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.MDII, 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 descriptions: "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: "Hard character limit beyond which remote posts will be dropped",
559 description: "File size limit of uploads (except for avatar, background, banner)",
565 key: :avatar_upload_limit,
567 description: "File size limit of user's profile avatars",
573 key: :background_upload_limit,
575 description: "File size limit of user's profile backgrounds",
581 key: :banner_upload_limit,
583 description: "File size limit of user's profile banners",
591 description: "A map with poll limits for local polls",
595 max_option_chars: 200,
597 max_expiration: 31_536_000
604 description: "Maximum number of options",
608 key: :max_option_chars,
610 description: "Maximum number of characters per option",
614 key: :min_expiration,
616 description: "Minimum expiration time (in seconds)",
620 key: :max_expiration,
622 description: "Maximum expiration time (in seconds)",
628 key: :registrations_open,
630 description: "Enable registrations for anyone, invitations can be enabled when false"
633 key: :invites_enabled,
635 description: "Enable user invitations for admins (depends on registrations_open: false)"
638 key: :account_activation_required,
640 description: "Require users to confirm their emails before signing in"
645 description: "Enable federation with other instances"
648 key: :federation_incoming_replies_max_depth,
651 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
652 " 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",
658 key: :federation_reachability_timeout_days,
661 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
667 key: :federation_publisher_modules,
668 type: {:list, :module},
669 description: "List of modules for federation publishing",
671 Pleroma.Web.ActivityPub.Publisher
677 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
680 key: :rewrite_policy,
681 type: [:module, {:list, :module}],
682 description: "A list of MRF policies enabled",
684 Generator.list_modules_in_dir(
685 "lib/pleroma/web/activity_pub/mrf",
686 "Elixir.Pleroma.Web.ActivityPub.MRF."
693 "Makes the client API in authentificated mode-only except for user-profiles." <>
694 " Useful for disabling the Local Timeline and The Whole Known Network"
697 key: :quarantined_instances,
698 type: {:list, :string},
700 "List of ActivityPub instances where private(DMs, followers-only) activities will not be send",
707 key: :managed_config,
710 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
715 description: "Instance static directory",
721 key: :allowed_post_formats,
722 type: {:list, :string},
723 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
732 key: :mrf_transparency,
733 label: "MRF transparency",
736 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
739 key: :mrf_transparency_exclusions,
740 label: "MRF transparency exclusions",
741 type: {:list, :string},
743 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value",
749 key: :extended_nickname_format,
752 "Set to true to use extended local nicknames format (allows underscores/dashes)." <>
753 " This will break federation with older software for theses nicknames"
756 key: :max_pinned_statuses,
758 description: "The maximum number of pinned statuses. 0 will disable the feature",
766 key: :autofollowed_nicknames,
767 type: {:list, :string},
769 "Set to nicknames of (local) users that every new user should automatically follow",
778 key: :no_attachment_links,
781 "Set to true to disable automatically adding attachment link text to statuses"
784 key: :welcome_message,
787 "A message that will be send to a newly registered users as a direct message",
789 "Hi, @username! Welcome on board!"
793 key: :welcome_user_nickname,
795 description: "The nickname of the local user that sends the welcome message",
801 key: :max_report_comment_size,
803 description: "The maximum size of the report comment (Default: 1000)",
809 key: :safe_dm_mentions,
812 "If set to true, only mentions at the beginning of a post will be used to address people in direct messages." <>
813 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@friend hey i really don't like @enemy\")." <>
819 description: "If set to true, system data will be shown on /api/pleroma/healthcheck"
822 key: :remote_post_retention_days,
825 "The default amount of days to retain remote posts when pruning the database",
831 key: :user_bio_length,
833 description: "A user bio maximum length (default: 5000)",
839 key: :user_name_length,
841 description: "A user name maximum length (default: 100)",
847 key: :skip_thread_containment,
849 description: "Skip filter out broken threads. The default is true"
852 key: :limit_to_local_content,
853 type: [:atom, false],
855 "Limit unauthenticated users to search for local statutes and users only. The default is :unauthenticated ",
863 key: :dynamic_configuration,
866 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"
869 key: :max_account_fields,
871 description: "The maximum number of custom fields in the user profile (default: 10)",
877 key: :max_remote_account_fields,
880 "The maximum number of custom fields in the remote user profile (default: 20)",
886 key: :account_field_name_length,
888 description: "An account field name maximum length (default: 512)",
894 key: :account_field_value_length,
896 description: "An account field value maximum length (default: 2048)",
902 key: :external_user_synchronization,
904 description: "Enabling following/followers counters synchronization for external users"
911 description: "Logger-related settings",
915 type: [:atom, :tuple, :module],
917 "Where logs will be send, :console - send logs to stdout, {ExSyslogger, :ex_syslogger} - to syslog, Quack.Logger - to Slack.",
918 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
926 description: "ExSyslogger-related settings",
931 description: "Log level",
932 suggestions: [:debug, :info, :warn, :error]
938 "A string that's prepended to every message, and is typically set to the app name",
939 suggestions: ["pleroma"]
944 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
945 suggestions: ["$metadata[$level] $message"]
949 type: {:list, :atom},
950 suggestions: [:request_id]
958 description: "Console logger settings",
963 description: "Log level",
964 suggestions: [:debug, :info, :warn, :error]
969 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
970 suggestions: ["$metadata[$level] $message"]
974 type: {:list, :atom},
975 suggestions: [:request_id]
982 description: "Quack-related settings",
987 description: "Log level",
988 suggestions: [:debug, :info, :warn, :error]
992 type: {:list, :atom},
993 description: "Configure which metadata you want to report on",
1011 description: "Configure the Slack incoming webhook",
1012 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1018 key: :frontend_configurations,
1021 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1022 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1023 "add your own configuration your settings need to be complete as they will override the defaults.",
1027 label: "Pleroma FE",
1029 description: "Settings for Pleroma FE",
1032 theme: "pleroma-dark",
1033 logo: "/static/logo.png",
1034 background: "/images/city.jpg",
1035 redirectRootNoLogin: "/main/all",
1036 redirectRootLogin: "/main/friends",
1037 showInstanceSpecificPanel: true,
1038 scopeOptionsEnabled: false,
1039 formattingOptionsEnabled: false,
1040 collapseMessageWithSubject: false,
1041 hidePostStats: false,
1042 hideUserStats: false,
1044 subjectLineBehavior: "email",
1045 alwaysShowSubjectInput: true
1052 description: "Which theme to use, they are defined in styles.json",
1053 suggestions: ["pleroma-dark"]
1058 description: "URL of the logo, defaults to Pleroma's logo",
1059 suggestions: ["/static/logo.png"]
1065 "URL of the background, unless viewing a user profile with a background that is set",
1066 suggestions: ["/images/city.jpg"]
1069 key: :redirectRootNoLogin,
1070 label: "Redirect root no login",
1073 "relative URL which indicates where to redirect when a user isn't logged in",
1074 suggestions: ["/main/all"]
1077 key: :redirectRootLogin,
1078 label: "Redirect root login",
1081 "relative URL which indicates where to redirect when a user is logged in",
1082 suggestions: ["/main/friends"]
1085 key: :showInstanceSpecificPanel,
1086 label: "Show instance specific panel",
1088 description: "Whenether to show the instance's specific panel"
1091 key: :scopeOptionsEnabled,
1092 label: "Scope options enabled",
1094 description: "Enable setting an notice visibility and subject/CW when posting"
1097 key: :formattingOptionsEnabled,
1098 label: "Formatting options enabled",
1101 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to :instance, allowed_post_formats"
1104 key: :collapseMessageWithSubject,
1105 label: "Collapse message with subject",
1108 "When a message has a subject(aka Content Warning), collapse it by default"
1111 key: :hidePostStats,
1112 label: "Hide post stats",
1114 description: "Hide notices statistics(repeats, favorites, ...)"
1117 key: :hideUserStats,
1118 label: "Hide user stats",
1121 "Hide profile statistics(posts, posts per day, followers, followings, ...)"
1125 label: "Scope copy",
1127 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1130 key: :subjectLineBehavior,
1131 label: "Subject line behavior",
1133 description: "Allows changing the default behaviour of subject lines in replies.
1134 `email`: Copy and preprend re:, as in email,
1135 `masto`: Copy verbatim, as in Mastodon,
1136 `noop`: Don't copy the subjec",
1137 suggestions: ["email", "masto", "noop"]
1140 key: :alwaysShowSubjectInput,
1141 label: "Always show subject input",
1143 description: "When set to false, auto-hide the subject field when it's empty"
1151 description: "Settings for Masto FE",
1154 showInstanceSpecificPanel: true
1159 key: :showInstanceSpecificPanel,
1160 label: "Show instance specific panel",
1162 description: "Whenether to show the instance's specific panel"
1173 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1177 type: {:keyword, :map},
1179 "Keyword of mascots, each element MUST contain both a url and a mime_type key",
1182 url: "/images/pleroma-fox-tan-smol.png",
1183 mime_type: "image/png"
1185 pleroma_fox_tan_shy: %{
1186 url: "/images/pleroma-fox-tan-shy.png",
1187 mime_type: "image/png"
1192 key: :default_mascot,
1195 "This will be used as the default mascot on MastoFE (default: :pleroma_fox_tan)",
1207 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1211 type: {:list, :map},
1212 description: "Describe the icons of the app",
1215 src: "/static/logo.png"
1218 src: "/static/icon.png",
1222 src: "/static/icon.ico",
1223 sizes: "72x72 96x96 128x128 256x256"
1230 description: "Describe the theme color of the app",
1231 suggestions: ["#282c37", "mediumpurple"]
1234 key: :background_color,
1236 description: "Describe the background color of the app",
1237 suggestions: ["#191b22", "aliceblue"]
1244 label: "MRF simple",
1246 description: "Message Rewrite Facility",
1249 key: :media_removal,
1250 type: {:list, :string},
1251 description: "List of instances to remove medias from",
1252 suggestions: ["example.com", "*.example.com"]
1256 label: "Media NSFW",
1257 type: {:list, :string},
1258 description: "List of instances to put medias as NSFW(sensitive) from",
1259 suggestions: ["example.com", "*.example.com"]
1262 key: :federated_timeline_removal,
1263 type: {:list, :string},
1265 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1266 suggestions: ["example.com", "*.example.com"]
1270 type: {:list, :string},
1271 description: "List of instances to reject any activities from",
1272 suggestions: ["example.com", "*.example.com"]
1276 type: {:list, :string},
1277 description: "List of instances to accept any activities from",
1278 suggestions: ["example.com", "*.example.com"]
1281 key: :report_removal,
1282 type: {:list, :string},
1283 description: "List of instances to reject reports from",
1284 suggestions: ["example.com", "*.example.com"]
1287 key: :avatar_removal,
1288 type: {:list, :string},
1289 description: "List of instances to strip avatars from",
1290 suggestions: ["example.com", "*.example.com"]
1293 key: :banner_removal,
1294 type: {:list, :string},
1295 description: "List of instances to strip banners from",
1296 suggestions: ["example.com", "*.example.com"]
1303 label: "MRF subchain",
1306 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1307 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1312 description: "Matches a series of regular expressions against the actor field",
1315 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1323 key: :mrf_rejectnonpublic,
1325 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1326 label: "MRF reject non public",
1330 key: :allow_followersonly,
1331 label: "Allow followers-only",
1333 description: "whether to allow followers-only posts"
1338 description: "whether to allow direct messages"
1344 key: :mrf_hellthread,
1345 label: "MRF hellthread",
1347 description: "Block messages with too much mentions",
1350 key: :delist_threshold,
1353 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1354 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable",
1358 key: :reject_threshold,
1361 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable",
1369 label: "MRF keyword",
1371 description: "Reject or Word-Replace messages with a keyword or regex",
1375 type: [:string, :regex],
1377 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression",
1378 suggestions: ["foo", ~r/foo/iu]
1381 key: :federated_timeline_removal,
1382 type: [:string, :regex],
1384 "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",
1385 suggestions: ["foo", ~r/foo/iu]
1389 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1391 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1392 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1399 label: "MRF mention",
1401 description: "Block messages which mention a user",
1405 type: {:list, :string},
1406 description: "A list of actors, for which to drop any posts mentioning",
1407 suggestions: ["actor1", "actor2"]
1413 key: :mrf_vocabulary,
1414 label: "MRF vocabulary",
1416 description: "Filter messages which belong to certain activity vocabularies",
1420 type: {:list, :string},
1422 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1423 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1427 type: {:list, :string},
1429 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1430 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1436 # key: :mrf_user_allowlist,
1439 # "The keys in this section are the domain names that the policy should apply to." <>
1440 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1442 # ["example.org": ["https://example.org/users/admin"]],
1444 # ["example.org": ["https://example.org/users/admin"]]
1452 description: "Media proxy",
1457 description: "Enables proxying of remote media to the instance's proxy"
1463 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts",
1464 suggestions: ["https://example.com"]
1469 description: "Options for Pleroma.ReverseProxy",
1471 redirect_on_failure: false,
1472 max_body_length: 25 * 1_048_576,
1474 follow_redirect: true,
1480 key: :redirect_on_failure,
1483 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1484 "Any error during body processing will not be redirected as the response is chunked"
1487 key: :max_body_length,
1490 "limits the content length to be approximately the " <>
1491 "specified length. It is validated with the `content-length` header and also verified when proxying"
1496 description: "HTTP options",
1501 description: "Adapter specific options",
1506 label: "SSL Options",
1507 description: "SSL options for HTTP adapter",
1511 type: {:list, :atom},
1512 descriptions: "List of TLS version to use",
1513 suggestions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"]
1522 type: [:string, :tuple],
1523 description: "Proxy URL",
1524 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1532 type: {:list, :string},
1533 description: "List of domains to bypass the mediaproxy",
1534 suggestions: ["example.com"]
1542 description: "Gopher settings",
1547 description: "Enables the gopher interface"
1552 description: "IP address to bind to",
1553 suggestions: [{0, 0, 0, 0}]
1558 description: "Port to bind to",
1564 description: "Port advertised in urls (optional, defaults to port)",
1571 key: Pleroma.Web.Endpoint,
1573 description: "Phoenix endpoint configuration",
1578 type: {:keyword, :integer, :tuple},
1579 description: "http protocol configuration",
1587 type: {:list, :tuple},
1588 description: "dispatch settings",
1592 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1593 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1594 {Phoenix.Transports.WebSocket,
1595 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1596 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1598 # end copied from config.exs
1613 description: "port",
1623 type: {:keyword, :string, :integer},
1624 description: "configuration for generating urls",
1626 host: "example.com",
1634 description: "Host",
1642 description: "port",
1650 description: "Scheme",
1659 key: :instrumenters,
1660 type: {:list, :module},
1661 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1666 suggestions: ["https"]
1669 key: :secret_key_base,
1671 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1676 suggestions: ["CqaoopA2"]
1679 key: :render_errors,
1681 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1686 suggestions: [Pleroma.Web.ErrorView]
1690 type: {:list, :string},
1691 suggestions: ["json"]
1698 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1703 suggestions: [Pleroma.PubSub]
1708 suggestions: [Phoenix.PubSub.PG2]
1713 key: :secure_cookie_flag,
1717 key: :extra_cookie_attrs,
1718 type: {:list, :string},
1719 suggestions: ["SameSite=Lax"]
1727 description: "ActivityPub-related settings",
1730 key: :unfollow_blocked,
1732 description: "Whether blocks result in people getting unfollowed"
1735 key: :outgoing_blocks,
1737 description: "Whether to federate blocks to other instances"
1740 key: :sign_object_fetches,
1742 description: "Sign object fetches with HTTP signatures"
1745 key: :follow_handshake_timeout,
1747 description: "Following handshake timeout",
1754 key: :http_security,
1756 description: "HTTP security settings",
1761 description: "Whether the managed content security policy is enabled"
1767 description: "Whether to additionally send a Strict-Transport-Security header"
1771 label: "STS max age",
1773 description: "The maximum age for the Strict-Transport-Security header if sent",
1774 suggestions: [31_536_000]
1778 label: "CT max age",
1780 description: "The maximum age for the Expect-CT header if sent",
1781 suggestions: [2_592_000]
1784 key: :referrer_policy,
1786 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1787 suggestions: ["same-origin", "no-referrer"]
1791 label: "Report URI",
1793 description: "Adds the specified url to report-uri and report-to group in CSP header",
1794 suggestions: ["https://example.com/report-uri"]
1799 group: :web_push_encryption,
1800 key: :vapid_details,
1803 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1809 "a mailto link for the administrative contact." <>
1810 " 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," <>
1811 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can",
1812 suggestions: ["Subject"]
1817 description: "VAPID public key",
1818 suggestions: ["Public key"]
1823 description: "VAPID private keyn",
1824 suggestions: ["Private key"]
1830 key: Pleroma.Captcha,
1832 description: "Captcha-related settings",
1837 description: "Whether the captcha should be shown on registration"
1842 description: "The method/service to use for captcha",
1843 suggestions: [Pleroma.Captcha.Kocaptcha]
1846 key: :seconds_valid,
1848 description: "The time in seconds for which the captcha is valid",
1855 key: Pleroma.Captcha.Kocaptcha,
1858 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1859 " here: https://github.com/koto-bank/kocaptcha. The default endpoint https://captcha.kotobank.ch is hosted by the developer",
1864 description: "the kocaptcha endpoint to use",
1865 suggestions: ["https://captcha.kotobank.ch"]
1873 "Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the 'admin_token' parameter",
1878 description: "Token",
1879 suggestions: ["some_random_token"]
1884 group: :pleroma_job_queue,
1887 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1891 key: Pleroma.Web.Federator.RetryQueue,
1893 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1898 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1907 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1909 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1910 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1911 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1912 (see https://github.com/sorentwo/oban/issues/52).
1918 description: "Application's Ecto repo",
1919 suggestions: [Pleroma.Repo]
1924 description: "Logs verbose mode"
1928 type: [:atom, :tuple],
1930 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1931 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1935 type: {:keyword, :integer},
1937 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1939 activity_expiration: 10,
1941 federator_incoming: 50,
1942 federator_outgoing: 50,
1944 scheduled_activities: 10,
1950 key: :activity_expiration,
1952 description: "Activity expiration queue",
1958 description: "Background queue",
1962 key: :federator_incoming,
1964 description: "Incoming federation queue",
1968 key: :federator_outgoing,
1970 description: "Outgoing federation queue",
1976 description: "Email sender queue, see Pleroma.Emails.Mailer",
1980 key: :scheduled_activities,
1982 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1986 key: :transmogrifier,
1988 description: "Transmogrifier queue",
1994 description: "Web push notifications queue",
2005 description: "Includes custom worker options not interpretable directly by `Oban`",
2009 type: {:keyword, :integer},
2010 description: "Max retry attempts for failed jobs, per `Oban` queue",
2012 federator_incoming: 5,
2013 federator_outgoing: 5
2020 key: Pleroma.Web.Metadata,
2022 description: "Metadata-related settings",
2026 type: {:list, :module},
2027 description: "List of metadata providers to enable",
2029 Pleroma.Web.Metadata.Providers.OpenGraph,
2030 Pleroma.Web.Metadata.Providers.TwitterCard,
2031 Pleroma.Web.Metadata.Providers.RelMe
2036 label: "Unfurl NSFW",
2038 description: "If set to true nsfw attachments will be shown in previews"
2047 "If enabled the instance will parse metadata from attached links to generate link previews.",
2052 description: "Enables/disables RichMedia."
2056 type: {:list, :string},
2057 description: "List of hosts which will be ignored by the metadata parser.",
2058 suggestions: ["accounts.google.com", "xss.website"]
2062 label: "Ignore TLD",
2063 type: {:list, :string},
2064 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2065 suggestions: ["local", "localdomain", "lan"]
2069 type: {:list, :module},
2070 description: "List of Rich Media parsers.",
2072 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2073 Pleroma.Web.RichMedia.Parsers.OEmbed,
2074 Pleroma.Web.RichMedia.Parsers.OGP,
2075 Pleroma.Web.RichMedia.Parsers.TwitterCard
2080 label: "TTL setters",
2081 type: {:list, :module},
2082 description: "List of rich media ttl setters.",
2084 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2091 key: :fetch_initial_posts,
2093 description: "Fetching initial posts settings",
2099 "if enabled, when a new user is federated with, fetch some of their latest posts"
2104 description: "the amount of pages to fetch",
2110 group: :auto_linker,
2113 description: "Configuration for the auto_linker library",
2117 type: [:string, false],
2118 description: "specify the class to be added to the generated link. false to clear",
2119 suggestions: ["auto-linker", false]
2123 type: [:string, false],
2124 description: "override the rel attribute. false to clear",
2125 suggestions: ["ugc", "noopener noreferrer", false]
2130 description: "set to false to remove target='_blank' attribute"
2135 description: "Set to true to link urls with schema http://google.com"
2139 type: [:integer, false],
2141 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2142 suggestions: [15, false]
2147 description: "Strip the scheme prefix"
2152 description: "link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2158 key: Pleroma.ScheduledActivity,
2160 description: "Scheduled activities settings",
2163 key: :daily_user_limit,
2166 "the number of scheduled activities a user is allowed to create in a single day (Default: 25)",
2170 key: :total_user_limit,
2173 "the number of scheduled activities a user is allowed to create in total (Default: 300)",
2179 description: "whether scheduled activities are sent to the job queue to be executed"
2185 key: Pleroma.ActivityExpiration,
2187 description: "Expired activity settings",
2192 description: "whether expired activities will be sent to the job queue to be deleted"
2199 description: "Authenticator",
2202 key: Pleroma.Web.Auth.Authenticator,
2204 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2213 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2214 " will be verified by trying to authenticate (bind) to an LDAP server." <>
2215 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2216 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2221 description: "enables LDAP authentication"
2226 description: "LDAP server hostname",
2227 suggestions: ["localhosts"]
2232 description: "LDAP port, e.g. 389 or 636",
2233 suggestions: [389, 636]
2239 description: "true to use SSL, usually implies the port 636"
2243 label: "SSL options",
2245 description: "additional SSL options",
2246 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2251 description: "Path to file with PEM encoded cacerts",
2252 suggestions: ["path/to/file/with/PEM/cacerts"]
2257 description: "Type of cert verification",
2258 suggestions: [:verify_peer]
2266 description: "true to start TLS, usually implies the port 389"
2270 label: "TLS options",
2272 description: "additional TLS options",
2273 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2278 description: "Path to file with PEM encoded cacerts",
2279 suggestions: ["path/to/file/with/PEM/cacerts"]
2284 description: "Type of cert verification",
2285 suggestions: [:verify_peer]
2292 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2293 suggestions: ["dc=example,dc=com"]
2299 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2308 description: "Authentication / authorization settings",
2311 key: :enforce_oauth_admin_scope_usage,
2314 "OAuth admin scope requirement toggle. " <>
2315 "If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2316 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2317 "`is_admin` user flag grants access to admin-specific actions."
2320 key: :auth_template,
2323 "authentication form template. By default it's show.html which corresponds to lib/pleroma/web/templates/o_auth/o_auth/show.html.ee",
2324 suggestions: ["show.html"]
2327 key: :oauth_consumer_template,
2330 "OAuth consumer mode authentication form template. By default it's consumer.html which corresponds to" <>
2331 " lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex",
2332 suggestions: ["consumer.html"]
2335 key: :oauth_consumer_strategies,
2336 type: {:list, :string},
2338 "the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2339 " Each entry in this space-delimited string should be of format <strategy> or <strategy>:<dependency>" <>
2340 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2341 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2347 key: :email_notifications,
2349 description: "Email notifications settings",
2355 "emails of \"what you've missed\" for users who have been inactive for a while",
2359 schedule: "0 0 * * 0",
2361 inactivity_threshold: 7
2368 description: "globally enable or disable digest emails"
2374 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\"",
2375 suggestions: ["0 0 * * 0"]
2380 description: "Minimum interval between digest emails to one user",
2384 key: :inactivity_threshold,
2386 description: "Minimum user inactivity threshold",
2395 key: Pleroma.Emails.UserEmail,
2397 description: "Email template settings",
2402 description: "a path to a custom logo. Set it to nil to use the default Pleroma logo",
2403 suggestions: ["some/path/logo.png"]
2408 description: "a map with color settings for email templates.",
2411 link_color: "#d8a070",
2412 background_color: "#2C3645",
2413 content_background_color: "#1B2635",
2414 header_color: "#d8a070",
2415 text_color: "#b9b9ba",
2416 text_muted_color: "#b9b9ba"
2423 suggestions: ["#d8a070"]
2426 key: :background_color,
2428 suggestions: ["#2C3645"]
2431 key: :content_background_color,
2433 suggestions: ["#1B2635"]
2438 suggestions: ["#d8a070"]
2443 suggestions: ["#b9b9ba"]
2446 key: :text_muted_color,
2448 suggestions: ["#b9b9ba"]
2458 description: "Configure OAuth 2 provider capabilities",
2461 key: :token_expires_in,
2463 description: "The lifetime in seconds of the access token",
2467 key: :issue_new_refresh_token,
2470 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2473 key: :clean_expired_tokens,
2475 description: "Enable a background job to clean expired oauth tokens. Defaults to false"
2478 key: :clean_expired_tokens_interval,
2481 "Interval to run the job to clean expired tokens. Defaults to 86_400_000 (24 hours).",
2482 suggestions: [86_400_000]
2492 key: :shortcode_globs,
2493 type: {:list, :string},
2494 description: "Location of custom emoji files. * can be used as a wildcard",
2495 suggestions: ["/emoji/custom/**/*.png"]
2498 key: :pack_extensions,
2499 type: {:list, :string},
2501 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2502 suggestions: [".png", ".gif"]
2506 type: {:keyword, :string, {:list, :string}},
2508 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname" <>
2509 " and the value the location or array of locations. * can be used as a wildcard",
2511 # Put groups that have higher priority than defaults here. Example in `docs/config/custom_emoji.md`
2512 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2516 key: :default_manifest,
2519 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2520 " Currently only one manifest can be added (no arrays)",
2521 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2524 key: :shared_pack_cache_seconds_per_file,
2527 "When an emoji pack is shared, the archive is created and cached in memory" <>
2528 " for this amount of seconds multiplied by the number of files.",
2537 description: "Database related settings",
2542 description: "If RUM indexes should be used. Defaults to false"
2551 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2555 type: [:tuple, {:list, :tuple}],
2556 description: "for the search requests (account & status search etc.)",
2557 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2560 key: :app_account_creation,
2561 type: [:tuple, {:list, :tuple}],
2562 description: "for registering user accounts from the same IP address",
2563 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2566 key: :relations_actions,
2567 type: [:tuple, {:list, :tuple}],
2568 description: "for actions on relations with all users (follow, unfollow)",
2569 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2572 key: :relation_id_action,
2573 type: [:tuple, {:list, :tuple}],
2574 description: "for actions on relation with a specific user (follow, unfollow)",
2575 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2578 key: :statuses_actions,
2579 type: [:tuple, {:list, :tuple}],
2581 "for create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2582 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2585 key: :status_id_action,
2586 type: [:tuple, {:list, :tuple}],
2588 "for fav / unfav or reblog / unreblog actions on the same status by the same user",
2589 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2592 key: :authentication,
2593 type: [:tuple, {:list, :tuple}],
2594 description: "for authentication create / password check / user existence check requests",
2595 suggestions: [{60_000, 15}]
2603 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2604 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2609 description: "Enables ssh"
2614 description: "Dir with ssh keys",
2615 suggestions: ["/some/path/ssh_keys"]
2620 description: "Handler module",
2621 suggestions: ["Pleroma.BBS.Handler"]
2626 description: "Port to connect",
2627 suggestions: [10_022]
2630 key: :password_authenticator,
2632 description: "Authenticator module",
2633 suggestions: ["Pleroma.BBS.Authenticator"]
2640 description: "Mime types",
2647 "application/xml" => ["xml"],
2648 "application/xrd+xml" => ["xrd+xml"],
2649 "application/jrd+json" => ["jrd+json"],
2650 "application/activity+json" => ["activity+json"],
2651 "application/ld+json" => ["activity+json"]
2656 key: "application/xml",
2657 type: {:list, :string},
2658 suggestions: ["xml"]
2661 key: "application/xrd+xml",
2662 type: {:list, :string},
2663 suggestions: ["xrd+xml"]
2666 key: "application/jrd+json",
2667 type: {:list, :string},
2668 suggestions: ["jrd+json"]
2671 key: "application/activity+json",
2672 type: {:list, :string},
2673 suggestions: ["activity+json"]
2676 key: "application/ld+json",
2677 type: {:list, :string},
2678 suggestions: ["activity+json"]
2687 description: "Tesla settings",
2692 description: "Tesla adapter",
2693 suggestions: [Tesla.Adapter.Hackney]
2701 description: "Pleroma chat settings",
2717 description: "Enables suggestions"
2720 key: :third_party_engine,
2722 description: "URL for third party engine",
2724 "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}"
2730 description: "Request timeout to third party engine",
2731 suggestions: [300_000]
2736 description: "Limit for suggestions",
2742 suggestions: ["https://vinayaka.distsn.org"]
2748 key: Pleroma.Web.Endpoint.MetricsExporter,
2750 description: "Prometheus settings",
2755 description: "API endpoint with metrics",
2756 suggestions: ["/api/pleroma/app_metrics"]
2761 group: :http_signatures,
2763 description: "HTTP Signatures settings",
2768 suggestions: [Pleroma.Signature]
2774 key: Pleroma.Uploaders.MDII,
2776 "Uploader for https://github.com/hakaba-hitoyo/minimal-digital-image-infrastructure",
2782 suggestions: ["https://mdii.sakura.ne.jp/mdii-post.cgi"]
2787 suggestions: ["https://mdii.sakura.ne.jp"]
2795 description: "HTTP settings",
2800 type: [:string, :tuple],
2801 description: "Proxy URL",
2802 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2805 key: :send_user_agent,
2811 description: "Adapter specific options",
2817 label: "SSL Options",
2818 description: "SSL options for HTTP adapter",
2822 type: {:list, :atom},
2823 descriptions: "List of TLS version to use",
2824 suggestions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"]
2838 key: :allow_inline_images,
2842 key: :allow_headings,
2855 type: {:list, :module},
2856 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2866 key: :deny_follow_blocked,
2873 key: :mrf_normalize_markup,
2874 label: "MRF normalize markup",
2875 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2881 suggestions: [Pleroma.HTML.Scrubber.Default]
2891 key: :restricted_nicknames,
2892 type: {:list, :string},
2911 "ostatus_subscribe",
2935 suggestions: [86_400]
2939 type: {:list, :string},
2940 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2944 type: {:list, :string},
2947 "X-RateLimit-Reset",
2948 "X-RateLimit-Limit",
2949 "X-RateLimit-Remaining",
2960 type: {:list, :string},
2961 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2967 key: Pleroma.Plugs.RemoteIp,
2970 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2971 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2977 description: "Enable/disable the plug. Defaults to `false`."
2981 type: {:list, :string},
2983 "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]`."
2987 type: {:list, :string},
2989 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`."
2993 type: {:list, :string},
2995 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3001 key: :web_cache_ttl,
3004 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3010 "activity pub routes (except question activities). Defaults to `nil` (no expiration).",
3011 suggestions: [30_000]
3014 key: :activity_pub_question,
3017 "activity pub routes (question activities). Defaults to `30_000` (30 seconds).",
3018 suggestions: [30_000]