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",
518 label: "Admin Email Address",
520 description: "Email used to reach an Administrator/Moderator of the instance",
527 label: "Sender Email Address",
529 description: "Envelope FROM address for mail sent via Pleroma",
537 description: "The instance's description, can be seen in nodeinfo and /api/v1/instance",
545 description: "Posts character limit (CW/Subject included in the counter)",
553 description: "Character limit of the instance chat messages",
561 description: "Hard character limit beyond which remote posts will be dropped",
569 description: "File size limit of uploads (except for avatar, background, banner)",
575 key: :avatar_upload_limit,
577 description: "File size limit of user's profile avatars",
583 key: :background_upload_limit,
585 description: "File size limit of user's profile backgrounds",
591 key: :banner_upload_limit,
593 description: "File size limit of user's profile banners",
601 description: "A map with poll limits for local polls",
605 max_option_chars: 200,
607 max_expiration: 31_536_000
614 description: "Maximum number of options",
618 key: :max_option_chars,
620 description: "Maximum number of characters per option",
624 key: :min_expiration,
626 description: "Minimum expiration time (in seconds)",
630 key: :max_expiration,
632 description: "Maximum expiration time (in seconds)",
638 key: :registrations_open,
640 description: "Enable registrations for anyone, invitations can be enabled when false"
643 key: :invites_enabled,
645 description: "Enable user invitations for admins (depends on registrations_open: false)"
648 key: :account_activation_required,
650 description: "Require users to confirm their emails before signing in"
655 description: "Enable federation with other instances"
658 key: :federation_incoming_replies_max_depth,
659 label: "Fed. incoming replies max depth",
662 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
663 " fetching very long threads. If set to nil, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes",
669 key: :federation_reachability_timeout_days,
670 label: "Fed. reachability timeout days",
673 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
679 key: :federation_publisher_modules,
680 type: {:list, :module},
681 description: "List of modules for federation publishing",
683 Pleroma.Web.ActivityPub.Publisher
689 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
692 key: :rewrite_policy,
693 type: [:module, {:list, :module}],
694 description: "A list of MRF policies enabled",
696 Generator.list_modules_in_dir(
697 "lib/pleroma/web/activity_pub/mrf",
698 "Elixir.Pleroma.Web.ActivityPub.MRF."
705 "Makes the client API in authentificated mode-only except for user-profiles." <>
706 " Useful for disabling the Local Timeline and The Whole Known Network"
709 key: :quarantined_instances,
710 type: {:list, :string},
712 "List of ActivityPub instances where private(DMs, followers-only) activities will not be send",
719 key: :managed_config,
722 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
727 description: "Instance static directory",
733 key: :allowed_post_formats,
734 type: {:list, :string},
735 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
744 key: :mrf_transparency,
745 label: "MRF transparency",
748 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
751 key: :mrf_transparency_exclusions,
752 label: "MRF transparency exclusions",
753 type: {:list, :string},
755 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value",
761 key: :extended_nickname_format,
764 "Set to true to use extended local nicknames format (allows underscores/dashes)." <>
765 " This will break federation with older software for theses nicknames"
768 key: :max_pinned_statuses,
770 description: "The maximum number of pinned statuses. 0 will disable the feature",
778 key: :autofollowed_nicknames,
779 type: {:list, :string},
781 "Set to nicknames of (local) users that every new user should automatically follow",
790 key: :no_attachment_links,
793 "Set to true to disable automatically adding attachment link text to statuses"
796 key: :welcome_message,
799 "A message that will be send to a newly registered users as a direct message",
801 "Hi, @username! Welcome on board!"
805 key: :welcome_user_nickname,
807 description: "The nickname of the local user that sends the welcome message",
813 key: :max_report_comment_size,
815 description: "The maximum size of the report comment (Default: 1000)",
821 key: :safe_dm_mentions,
824 "If set to true, only mentions at the beginning of a post will be used to address people in direct messages." <>
825 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@friend hey i really don't like @enemy\")." <>
831 description: "If set to true, system data will be shown on /api/pleroma/healthcheck"
834 key: :remote_post_retention_days,
837 "The default amount of days to retain remote posts when pruning the database",
843 key: :user_bio_length,
845 description: "A user bio maximum length (default: 5000)",
851 key: :user_name_length,
853 description: "A user name maximum length (default: 100)",
859 key: :skip_thread_containment,
861 description: "Skip filter out broken threads. The default is true"
864 key: :limit_to_local_content,
865 type: [:atom, false],
867 "Limit unauthenticated users to search for local statutes and users only. The default is :unauthenticated ",
875 key: :max_account_fields,
877 description: "The maximum number of custom fields in the user profile (default: 10)",
883 key: :max_remote_account_fields,
886 "The maximum number of custom fields in the remote user profile (default: 20)",
892 key: :account_field_name_length,
894 description: "An account field name maximum length (default: 512)",
900 key: :account_field_value_length,
902 description: "An account field value maximum length (default: 2048)",
908 key: :external_user_synchronization,
910 description: "Enabling following/followers counters synchronization for external users"
917 description: "Logger-related settings",
921 type: [:atom, :tuple, :module],
923 "Where logs will be send, :console - send logs to stdout, {ExSyslogger, :ex_syslogger} - to syslog, Quack.Logger - to Slack.",
924 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
932 description: "ExSyslogger-related settings",
937 description: "Log level",
938 suggestions: [:debug, :info, :warn, :error]
944 "A string that's prepended to every message, and is typically set to the app name",
945 suggestions: ["pleroma"]
950 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
951 suggestions: ["$metadata[$level] $message"]
955 type: {:list, :atom},
956 suggestions: [:request_id]
964 description: "Console logger settings",
969 description: "Log level",
970 suggestions: [:debug, :info, :warn, :error]
975 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
976 suggestions: ["$metadata[$level] $message"]
980 type: {:list, :atom},
981 suggestions: [:request_id]
988 description: "Quack-related settings",
993 description: "Log level",
994 suggestions: [:debug, :info, :warn, :error]
998 type: {:list, :atom},
999 description: "Configure which metadata you want to report on",
1017 description: "Configure the Slack incoming webhook",
1018 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1024 key: :frontend_configurations,
1027 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1028 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1029 "add your own configuration your settings need to be complete as they will override the defaults.",
1033 label: "Pleroma FE",
1035 description: "Settings for Pleroma FE",
1038 theme: "pleroma-dark",
1039 logo: "/static/logo.png",
1040 background: "/images/city.jpg",
1041 redirectRootNoLogin: "/main/all",
1042 redirectRootLogin: "/main/friends",
1043 showInstanceSpecificPanel: true,
1044 scopeOptionsEnabled: false,
1045 formattingOptionsEnabled: false,
1046 collapseMessageWithSubject: false,
1047 hidePostStats: false,
1048 hideUserStats: false,
1050 subjectLineBehavior: "email",
1051 alwaysShowSubjectInput: true
1058 description: "Which theme to use, they are defined in styles.json",
1059 suggestions: ["pleroma-dark"]
1064 description: "URL of the logo, defaults to Pleroma's logo",
1065 suggestions: ["/static/logo.png"]
1071 "URL of the background, unless viewing a user profile with a background that is set",
1072 suggestions: ["/images/city.jpg"]
1075 key: :redirectRootNoLogin,
1076 label: "Redirect root no login",
1079 "relative URL which indicates where to redirect when a user isn't logged in",
1080 suggestions: ["/main/all"]
1083 key: :redirectRootLogin,
1084 label: "Redirect root login",
1087 "relative URL which indicates where to redirect when a user is logged in",
1088 suggestions: ["/main/friends"]
1091 key: :showInstanceSpecificPanel,
1092 label: "Show instance specific panel",
1094 description: "Whenether to show the instance's specific panel"
1097 key: :scopeOptionsEnabled,
1098 label: "Scope options enabled",
1100 description: "Enable setting an notice visibility and subject/CW when posting"
1103 key: :formattingOptionsEnabled,
1104 label: "Formatting options enabled",
1107 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to :instance, allowed_post_formats"
1110 key: :collapseMessageWithSubject,
1111 label: "Collapse message with subject",
1114 "When a message has a subject(aka Content Warning), collapse it by default"
1117 key: :hidePostStats,
1118 label: "Hide post stats",
1120 description: "Hide notices statistics(repeats, favorites, ...)"
1123 key: :hideUserStats,
1124 label: "Hide user stats",
1127 "Hide profile statistics(posts, posts per day, followers, followings, ...)"
1131 label: "Scope copy",
1133 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1136 key: :subjectLineBehavior,
1137 label: "Subject line behavior",
1139 description: "Allows changing the default behaviour of subject lines in replies.
1140 `email`: Copy and preprend re:, as in email,
1141 `masto`: Copy verbatim, as in Mastodon,
1142 `noop`: Don't copy the subjec",
1143 suggestions: ["email", "masto", "noop"]
1146 key: :alwaysShowSubjectInput,
1147 label: "Always show subject input",
1149 description: "When set to false, auto-hide the subject field when it's empty"
1157 description: "Settings for Masto FE",
1160 showInstanceSpecificPanel: true
1165 key: :showInstanceSpecificPanel,
1166 label: "Show instance specific panel",
1168 description: "Whenether to show the instance's specific panel"
1179 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1183 type: {:keyword, :map},
1185 "Keyword of mascots, each element MUST contain both a url and a mime_type key",
1188 url: "/images/pleroma-fox-tan-smol.png",
1189 mime_type: "image/png"
1191 pleroma_fox_tan_shy: %{
1192 url: "/images/pleroma-fox-tan-shy.png",
1193 mime_type: "image/png"
1198 key: :default_mascot,
1201 "This will be used as the default mascot on MastoFE (default: :pleroma_fox_tan)",
1213 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1217 type: {:list, :map},
1218 description: "Describe the icons of the app",
1221 src: "/static/logo.png"
1224 src: "/static/icon.png",
1228 src: "/static/icon.ico",
1229 sizes: "72x72 96x96 128x128 256x256"
1236 description: "Describe the theme color of the app",
1237 suggestions: ["#282c37", "mediumpurple"]
1240 key: :background_color,
1242 description: "Describe the background color of the app",
1243 suggestions: ["#191b22", "aliceblue"]
1250 label: "MRF simple",
1252 description: "Message Rewrite Facility",
1255 key: :media_removal,
1256 type: {:list, :string},
1257 description: "List of instances to remove medias from",
1258 suggestions: ["example.com", "*.example.com"]
1262 label: "Media NSFW",
1263 type: {:list, :string},
1264 description: "List of instances to put medias as NSFW(sensitive) from",
1265 suggestions: ["example.com", "*.example.com"]
1268 key: :federated_timeline_removal,
1269 type: {:list, :string},
1271 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1272 suggestions: ["example.com", "*.example.com"]
1276 type: {:list, :string},
1277 description: "List of instances to reject any activities from",
1278 suggestions: ["example.com", "*.example.com"]
1282 type: {:list, :string},
1283 description: "List of instances to accept any activities from",
1284 suggestions: ["example.com", "*.example.com"]
1287 key: :report_removal,
1288 type: {:list, :string},
1289 description: "List of instances to reject reports from",
1290 suggestions: ["example.com", "*.example.com"]
1293 key: :avatar_removal,
1294 type: {:list, :string},
1295 description: "List of instances to strip avatars from",
1296 suggestions: ["example.com", "*.example.com"]
1299 key: :banner_removal,
1300 type: {:list, :string},
1301 description: "List of instances to strip banners from",
1302 suggestions: ["example.com", "*.example.com"]
1309 label: "MRF subchain",
1312 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1313 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1318 description: "Matches a series of regular expressions against the actor field",
1321 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1329 key: :mrf_rejectnonpublic,
1331 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1332 label: "MRF reject non public",
1336 key: :allow_followersonly,
1337 label: "Allow followers-only",
1339 description: "whether to allow followers-only posts"
1344 description: "whether to allow direct messages"
1350 key: :mrf_hellthread,
1351 label: "MRF hellthread",
1353 description: "Block messages with too much mentions",
1356 key: :delist_threshold,
1359 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1360 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable",
1364 key: :reject_threshold,
1367 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable",
1375 label: "MRF keyword",
1377 description: "Reject or Word-Replace messages with a keyword or regex",
1381 type: [:string, :regex],
1383 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression",
1384 suggestions: ["foo", ~r/foo/iu]
1387 key: :federated_timeline_removal,
1388 type: [:string, :regex],
1390 "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",
1391 suggestions: ["foo", ~r/foo/iu]
1395 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1397 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1398 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1405 label: "MRF mention",
1407 description: "Block messages which mention a user",
1411 type: {:list, :string},
1412 description: "A list of actors, for which to drop any posts mentioning",
1413 suggestions: ["actor1", "actor2"]
1419 key: :mrf_vocabulary,
1420 label: "MRF vocabulary",
1422 description: "Filter messages which belong to certain activity vocabularies",
1426 type: {:list, :string},
1428 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1429 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1433 type: {:list, :string},
1435 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1436 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1442 # key: :mrf_user_allowlist,
1445 # "The keys in this section are the domain names that the policy should apply to." <>
1446 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1448 # ["example.org": ["https://example.org/users/admin"]],
1450 # ["example.org": ["https://example.org/users/admin"]]
1458 description: "Media proxy",
1463 description: "Enables proxying of remote media to the instance's proxy"
1469 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts",
1470 suggestions: ["https://example.com"]
1475 description: "Options for Pleroma.ReverseProxy",
1477 redirect_on_failure: false,
1478 max_body_length: 25 * 1_048_576,
1480 follow_redirect: true,
1486 key: :redirect_on_failure,
1489 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1490 "Any error during body processing will not be redirected as the response is chunked"
1493 key: :max_body_length,
1496 "limits the content length to be approximately the " <>
1497 "specified length. It is validated with the `content-length` header and also verified when proxying"
1502 description: "HTTP options",
1507 description: "Adapter specific options",
1512 label: "SSL Options",
1513 description: "SSL options for HTTP adapter",
1517 type: {:list, :atom},
1518 description: "List of TLS version to use",
1519 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1528 type: [:string, :tuple],
1529 description: "Proxy URL",
1530 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1538 type: {:list, :string},
1539 description: "List of domains to bypass the mediaproxy",
1540 suggestions: ["example.com"]
1548 description: "Gopher settings",
1553 description: "Enables the gopher interface"
1558 description: "IP address to bind to",
1559 suggestions: [{0, 0, 0, 0}]
1564 description: "Port to bind to",
1570 description: "Port advertised in urls (optional, defaults to port)",
1577 key: Pleroma.Web.Endpoint,
1579 description: "Phoenix endpoint configuration",
1584 type: {:keyword, :integer, :tuple},
1585 description: "http protocol configuration",
1593 type: {:list, :tuple},
1594 description: "dispatch settings",
1598 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1599 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1600 {Phoenix.Transports.WebSocket,
1601 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1602 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1604 # end copied from config.exs
1619 description: "port",
1629 type: {:keyword, :string, :integer},
1630 description: "configuration for generating urls",
1632 host: "example.com",
1640 description: "Host",
1648 description: "port",
1656 description: "Scheme",
1665 key: :instrumenters,
1666 type: {:list, :module},
1667 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1672 suggestions: ["https"]
1675 key: :secret_key_base,
1677 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1682 suggestions: ["CqaoopA2"]
1685 key: :render_errors,
1687 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1692 suggestions: [Pleroma.Web.ErrorView]
1696 type: {:list, :string},
1697 suggestions: ["json"]
1704 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1709 suggestions: [Pleroma.PubSub]
1714 suggestions: [Phoenix.PubSub.PG2]
1719 key: :secure_cookie_flag,
1723 key: :extra_cookie_attrs,
1724 type: {:list, :string},
1725 suggestions: ["SameSite=Lax"]
1733 description: "ActivityPub-related settings",
1736 key: :unfollow_blocked,
1738 description: "Whether blocks result in people getting unfollowed"
1741 key: :outgoing_blocks,
1743 description: "Whether to federate blocks to other instances"
1746 key: :sign_object_fetches,
1748 description: "Sign object fetches with HTTP signatures"
1751 key: :follow_handshake_timeout,
1753 description: "Following handshake timeout",
1760 key: :http_security,
1762 description: "HTTP security settings",
1767 description: "Whether the managed content security policy is enabled"
1773 description: "Whether to additionally send a Strict-Transport-Security header"
1777 label: "STS max age",
1779 description: "The maximum age for the Strict-Transport-Security header if sent",
1780 suggestions: [31_536_000]
1784 label: "CT max age",
1786 description: "The maximum age for the Expect-CT header if sent",
1787 suggestions: [2_592_000]
1790 key: :referrer_policy,
1792 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1793 suggestions: ["same-origin", "no-referrer"]
1797 label: "Report URI",
1799 description: "Adds the specified url to report-uri and report-to group in CSP header",
1800 suggestions: ["https://example.com/report-uri"]
1805 group: :web_push_encryption,
1806 key: :vapid_details,
1809 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1815 "a mailto link for the administrative contact." <>
1816 " 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," <>
1817 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can",
1818 suggestions: ["Subject"]
1823 description: "VAPID public key",
1824 suggestions: ["Public key"]
1829 description: "VAPID private key",
1830 suggestions: ["Private key"]
1836 key: Pleroma.Captcha,
1838 description: "Captcha-related settings",
1843 description: "Whether the captcha should be shown on registration"
1848 description: "The method/service to use for captcha",
1849 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1852 key: :seconds_valid,
1854 description: "The time in seconds for which the captcha is valid",
1861 key: Pleroma.Captcha.Kocaptcha,
1864 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1865 " here: https://github.com/koto-bank/kocaptcha. The default endpoint https://captcha.kotobank.ch is hosted by the developer",
1870 description: "the kocaptcha endpoint to use",
1871 suggestions: ["https://captcha.kotobank.ch"]
1879 "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",
1884 description: "Token",
1885 suggestions: ["some_random_token"]
1890 group: :pleroma_job_queue,
1893 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1897 key: Pleroma.Web.Federator.RetryQueue,
1899 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1904 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1913 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1915 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1916 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1917 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1918 (see https://github.com/sorentwo/oban/issues/52).
1924 description: "Application's Ecto repo",
1925 suggestions: [Pleroma.Repo]
1930 description: "Logs verbose mode"
1934 type: [:atom, :tuple],
1936 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1937 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1941 type: {:keyword, :integer},
1943 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1945 activity_expiration: 10,
1947 federator_incoming: 50,
1948 federator_outgoing: 50,
1950 scheduled_activities: 10,
1956 key: :activity_expiration,
1958 description: "Activity expiration queue",
1964 description: "Background queue",
1968 key: :federator_incoming,
1970 description: "Incoming federation queue",
1974 key: :federator_outgoing,
1976 description: "Outgoing federation queue",
1982 description: "Email sender queue, see Pleroma.Emails.Mailer",
1986 key: :scheduled_activities,
1988 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1992 key: :transmogrifier,
1994 description: "Transmogrifier queue",
2000 description: "Web push notifications queue",
2011 description: "Includes custom worker options not interpretable directly by `Oban`",
2015 type: {:keyword, :integer},
2016 description: "Max retry attempts for failed jobs, per `Oban` queue",
2018 federator_incoming: 5,
2019 federator_outgoing: 5
2026 key: Pleroma.Web.Metadata,
2028 description: "Metadata-related settings",
2032 type: {:list, :module},
2033 description: "List of metadata providers to enable",
2035 Pleroma.Web.Metadata.Providers.OpenGraph,
2036 Pleroma.Web.Metadata.Providers.TwitterCard,
2037 Pleroma.Web.Metadata.Providers.RelMe,
2038 Pleroma.Web.Metadata.Providers.Feed
2043 label: "Unfurl NSFW",
2045 description: "If set to true nsfw attachments will be shown in previews"
2054 "If enabled the instance will parse metadata from attached links to generate link previews.",
2059 description: "Enables/disables RichMedia."
2063 type: {:list, :string},
2064 description: "List of hosts which will be ignored by the metadata parser.",
2065 suggestions: ["accounts.google.com", "xss.website"]
2069 label: "Ignore TLD",
2070 type: {:list, :string},
2071 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2072 suggestions: ["local", "localdomain", "lan"]
2076 type: {:list, :module},
2077 description: "List of Rich Media parsers.",
2079 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2080 Pleroma.Web.RichMedia.Parsers.OEmbed,
2081 Pleroma.Web.RichMedia.Parsers.OGP,
2082 Pleroma.Web.RichMedia.Parsers.TwitterCard
2087 label: "TTL setters",
2088 type: {:list, :module},
2089 description: "List of rich media ttl setters.",
2091 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2098 key: :fetch_initial_posts,
2100 description: "Fetching initial posts settings",
2106 "if enabled, when a new user is federated with, fetch some of their latest posts"
2111 description: "the amount of pages to fetch",
2117 group: :auto_linker,
2120 description: "Configuration for the auto_linker library",
2124 type: [:string, false],
2125 description: "specify the class to be added to the generated link. false to clear",
2126 suggestions: ["auto-linker", false]
2130 type: [:string, false],
2131 description: "override the rel attribute. false to clear",
2132 suggestions: ["ugc", "noopener noreferrer", false]
2137 description: "set to false to remove target='_blank' attribute"
2142 description: "Set to true to link urls with schema http://google.com"
2146 type: [:integer, false],
2148 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2149 suggestions: [15, false]
2154 description: "Strip the scheme prefix"
2159 description: "link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2165 key: Pleroma.ScheduledActivity,
2167 description: "Scheduled activities settings",
2170 key: :daily_user_limit,
2173 "the number of scheduled activities a user is allowed to create in a single day (Default: 25)",
2177 key: :total_user_limit,
2180 "the number of scheduled activities a user is allowed to create in total (Default: 300)",
2186 description: "whether scheduled activities are sent to the job queue to be executed"
2192 key: Pleroma.ActivityExpiration,
2194 description: "Expired activity settings",
2199 description: "whether expired activities will be sent to the job queue to be deleted"
2206 description: "Authenticator",
2209 key: Pleroma.Web.Auth.Authenticator,
2211 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2220 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2221 " will be verified by trying to authenticate (bind) to an LDAP server." <>
2222 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2223 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2228 description: "enables LDAP authentication"
2233 description: "LDAP server hostname",
2234 suggestions: ["localhosts"]
2239 description: "LDAP port, e.g. 389 or 636",
2240 suggestions: [389, 636]
2246 description: "true to use SSL, usually implies the port 636"
2250 label: "SSL options",
2252 description: "additional SSL options",
2253 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2258 description: "Path to file with PEM encoded cacerts",
2259 suggestions: ["path/to/file/with/PEM/cacerts"]
2264 description: "Type of cert verification",
2265 suggestions: [:verify_peer]
2273 description: "true to start TLS, usually implies the port 389"
2277 label: "TLS options",
2279 description: "additional TLS options",
2280 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2285 description: "Path to file with PEM encoded cacerts",
2286 suggestions: ["path/to/file/with/PEM/cacerts"]
2291 description: "Type of cert verification",
2292 suggestions: [:verify_peer]
2299 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2300 suggestions: ["dc=example,dc=com"]
2306 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2315 description: "Authentication / authorization settings",
2318 key: :enforce_oauth_admin_scope_usage,
2321 "OAuth admin scope requirement toggle. " <>
2322 "If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2323 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2324 "`is_admin` user flag grants access to admin-specific actions."
2327 key: :auth_template,
2330 "authentication form template. By default it's show.html which corresponds to lib/pleroma/web/templates/o_auth/o_auth/show.html.ee",
2331 suggestions: ["show.html"]
2334 key: :oauth_consumer_template,
2337 "OAuth consumer mode authentication form template. By default it's consumer.html which corresponds to" <>
2338 " lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex",
2339 suggestions: ["consumer.html"]
2342 key: :oauth_consumer_strategies,
2343 type: {:list, :string},
2345 "the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2346 " Each entry in this space-delimited string should be of format <strategy> or <strategy>:<dependency>" <>
2347 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2348 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2354 key: :email_notifications,
2356 description: "Email notifications settings",
2362 "emails of \"what you've missed\" for users who have been inactive for a while",
2366 schedule: "0 0 * * 0",
2368 inactivity_threshold: 7
2375 description: "globally enable or disable digest emails"
2381 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\"",
2382 suggestions: ["0 0 * * 0"]
2387 description: "Minimum interval between digest emails to one user",
2391 key: :inactivity_threshold,
2393 description: "Minimum user inactivity threshold",
2402 key: Pleroma.Emails.UserEmail,
2404 description: "Email template settings",
2409 description: "a path to a custom logo. Set it to nil to use the default Pleroma logo",
2410 suggestions: ["some/path/logo.png"]
2415 description: "a map with color settings for email templates.",
2418 link_color: "#d8a070",
2419 background_color: "#2C3645",
2420 content_background_color: "#1B2635",
2421 header_color: "#d8a070",
2422 text_color: "#b9b9ba",
2423 text_muted_color: "#b9b9ba"
2430 suggestions: ["#d8a070"]
2433 key: :background_color,
2435 suggestions: ["#2C3645"]
2438 key: :content_background_color,
2440 suggestions: ["#1B2635"]
2445 suggestions: ["#d8a070"]
2450 suggestions: ["#b9b9ba"]
2453 key: :text_muted_color,
2455 suggestions: ["#b9b9ba"]
2465 description: "Configure OAuth 2 provider capabilities",
2468 key: :token_expires_in,
2470 description: "The lifetime in seconds of the access token",
2474 key: :issue_new_refresh_token,
2477 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2480 key: :clean_expired_tokens,
2482 description: "Enable a background job to clean expired oauth tokens. Defaults to false"
2485 key: :clean_expired_tokens_interval,
2488 "Interval to run the job to clean expired tokens. Defaults to 86_400_000 (24 hours).",
2489 suggestions: [86_400_000]
2499 key: :shortcode_globs,
2500 type: {:list, :string},
2501 description: "Location of custom emoji files. * can be used as a wildcard",
2502 suggestions: ["/emoji/custom/**/*.png"]
2505 key: :pack_extensions,
2506 type: {:list, :string},
2508 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2509 suggestions: [".png", ".gif"]
2513 type: {:keyword, :string, {:list, :string}},
2515 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname" <>
2516 " and the value the location or array of locations. * can be used as a wildcard",
2518 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2522 key: :default_manifest,
2525 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2526 " Currently only one manifest can be added (no arrays)",
2527 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2530 key: :shared_pack_cache_seconds_per_file,
2531 label: "Shared pack cache s/file",
2534 "When an emoji pack is shared, the archive is created and cached in memory" <>
2535 " for this amount of seconds multiplied by the number of files.",
2544 description: "Database related settings",
2549 description: "If RUM indexes should be used. Defaults to false"
2558 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2562 type: [:tuple, {:list, :tuple}],
2563 description: "for the search requests (account & status search etc.)",
2564 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2567 key: :app_account_creation,
2568 type: [:tuple, {:list, :tuple}],
2569 description: "for registering user accounts from the same IP address",
2570 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2573 key: :relations_actions,
2574 type: [:tuple, {:list, :tuple}],
2575 description: "for actions on relations with all users (follow, unfollow)",
2576 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2579 key: :relation_id_action,
2580 type: [:tuple, {:list, :tuple}],
2581 description: "for actions on relation with a specific user (follow, unfollow)",
2582 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2585 key: :statuses_actions,
2586 type: [:tuple, {:list, :tuple}],
2588 "for create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2589 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2592 key: :status_id_action,
2593 type: [:tuple, {:list, :tuple}],
2595 "for fav / unfav or reblog / unreblog actions on the same status by the same user",
2596 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2599 key: :authentication,
2600 type: [:tuple, {:list, :tuple}],
2601 description: "for authentication create / password check / user existence check requests",
2602 suggestions: [{60_000, 15}]
2610 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2611 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2616 description: "Enables ssh"
2621 description: "Dir with ssh keys",
2622 suggestions: ["/some/path/ssh_keys"]
2627 description: "Handler module",
2628 suggestions: ["Pleroma.BBS.Handler"]
2633 description: "Port to connect",
2634 suggestions: [10_022]
2637 key: :password_authenticator,
2639 description: "Authenticator module",
2640 suggestions: ["Pleroma.BBS.Authenticator"]
2647 description: "Mime types",
2654 "application/xml" => ["xml"],
2655 "application/xrd+xml" => ["xrd+xml"],
2656 "application/jrd+json" => ["jrd+json"],
2657 "application/activity+json" => ["activity+json"],
2658 "application/ld+json" => ["activity+json"]
2663 key: "application/xml",
2664 type: {:list, :string},
2665 suggestions: ["xml"]
2668 key: "application/xrd+xml",
2669 type: {:list, :string},
2670 suggestions: ["xrd+xml"]
2673 key: "application/jrd+json",
2674 type: {:list, :string},
2675 suggestions: ["jrd+json"]
2678 key: "application/activity+json",
2679 type: {:list, :string},
2680 suggestions: ["activity+json"]
2683 key: "application/ld+json",
2684 type: {:list, :string},
2685 suggestions: ["activity+json"]
2694 description: "Tesla settings",
2699 description: "Tesla adapter",
2700 suggestions: [Tesla.Adapter.Hackney]
2708 description: "Pleroma chat settings",
2724 description: "Enables suggestions"
2727 key: :third_party_engine,
2729 description: "URL for third party engine",
2731 "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}"
2737 description: "Request timeout to third party engine",
2738 suggestions: [300_000]
2743 description: "Limit for suggestions",
2749 suggestions: ["https://vinayaka.distsn.org"]
2755 key: Pleroma.Web.Endpoint.MetricsExporter,
2757 description: "Prometheus settings",
2762 description: "API endpoint with metrics",
2763 suggestions: ["/api/pleroma/app_metrics"]
2768 group: :http_signatures,
2770 description: "HTTP Signatures settings",
2775 suggestions: [Pleroma.Signature]
2783 description: "HTTP settings",
2788 type: [:string, :tuple],
2789 description: "Proxy URL",
2790 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2793 key: :send_user_agent,
2798 type: [:string, :atom],
2800 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`",
2801 suggestions: ["Pleroma", :default]
2806 description: "Adapter specific options",
2812 label: "SSL Options",
2813 description: "SSL options for HTTP adapter",
2817 type: {:list, :atom},
2818 description: "List of TLS version to use",
2819 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2833 key: :allow_inline_images,
2837 key: :allow_headings,
2850 type: {:list, :module},
2851 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2861 key: :deny_follow_blocked,
2868 key: :mrf_normalize_markup,
2869 label: "MRF normalize markup",
2870 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2876 suggestions: [Pleroma.HTML.Scrubber.Default]
2886 key: :restricted_nicknames,
2887 type: {:list, :string},
2906 "ostatus_subscribe",
2930 suggestions: [86_400]
2934 type: {:list, :string},
2935 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2939 type: {:list, :string},
2942 "X-RateLimit-Reset",
2943 "X-RateLimit-Limit",
2944 "X-RateLimit-Remaining",
2955 type: {:list, :string},
2956 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2962 key: Pleroma.Plugs.RemoteIp,
2965 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2966 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2972 description: "Enable/disable the plug. Defaults to `false`."
2976 type: {:list, :string},
2978 "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]`."
2982 type: {:list, :string},
2984 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`."
2988 type: {:list, :string},
2990 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2996 key: :web_cache_ttl,
2999 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3005 "activity pub routes (except question activities). Defaults to `nil` (no expiration).",
3006 suggestions: [30_000]
3009 key: :activity_pub_question,
3012 "activity pub routes (question activities). Defaults to `30_000` (30 seconds).",
3013 suggestions: [30_000]
3022 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3027 description: "Enables the rendering of static HTML. Defaults to `false`."
3035 description: "Configure feed rendering.",
3040 description: "Configure title rendering.",
3045 description: "Maximum number of characters before truncating title.",
3051 description: "Replacement which will be used after truncating string.",
3052 suggestions: ["..."]
3060 key: :mrf_object_age,
3062 description: "Rejects or delists posts based on their age when received.",
3067 description: "Required age (in seconds) of a post before actions are taken.",
3068 suggestions: [172_800]
3072 type: {:list, :atom},
3074 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3075 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3076 "`:reject` rejects the message entirely",
3077 suggestions: [:delist, :strip_followers, :reject]
3085 description: "Custom Runtime Modules.",
3090 description: "A path to custom Elixir modules (such as MRF policies)."
3097 description: "Allow instance configuration from database.",
3100 key: :configurable_from_database,
3103 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"