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
247 description: "Allow/disallow send emails"
250 group: {:subgroup, Swoosh.Adapters.SMTP},
253 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
254 suggestions: ["smtp.gmail.com"]
257 group: {:subgroup, Swoosh.Adapters.SMTP},
260 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
261 suggestions: ["pleroma"]
264 group: {:subgroup, Swoosh.Adapters.SMTP},
267 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
268 suggestions: ["password"]
271 group: {:subgroup, Swoosh.Adapters.SMTP},
275 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
278 group: {:subgroup, Swoosh.Adapters.SMTP},
282 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
283 suggestions: [:always, :never, :if_available]
286 group: {:subgroup, Swoosh.Adapters.SMTP},
289 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
290 suggestions: [:always, :never, :if_available]
293 group: {:subgroup, Swoosh.Adapters.SMTP},
296 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
300 group: {:subgroup, Swoosh.Adapters.SMTP},
303 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
307 group: {:subgroup, Swoosh.Adapters.SMTP},
309 label: "No MX lookups",
311 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
314 group: {:subgroup, Swoosh.Adapters.Sendgrid},
318 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
319 suggestions: ["my-api-key"]
322 group: {:subgroup, Swoosh.Adapters.Sendmail},
325 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
326 suggestions: ["/usr/bin/sendmail"]
329 group: {:subgroup, Swoosh.Adapters.Sendmail},
332 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
333 suggestions: ["-N delay,failure,success"]
336 group: {:subgroup, Swoosh.Adapters.Sendmail},
339 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
342 group: {:subgroup, Swoosh.Adapters.Mandrill},
346 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
347 suggestions: ["my-api-key"]
350 group: {:subgroup, Swoosh.Adapters.Mailgun},
354 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
355 suggestions: ["my-api-key"]
358 group: {:subgroup, Swoosh.Adapters.Mailgun},
361 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
362 suggestions: ["pleroma.com"]
365 group: {:subgroup, Swoosh.Adapters.Mailjet},
369 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
370 suggestions: ["my-api-key"]
373 group: {:subgroup, Swoosh.Adapters.Mailjet},
376 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
377 suggestions: ["my-secret-key"]
380 group: {:subgroup, Swoosh.Adapters.Postmark},
384 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
385 suggestions: ["my-api-key"]
388 group: {:subgroup, Swoosh.Adapters.SparkPost},
392 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
393 suggestions: ["my-api-key"]
396 group: {:subgroup, Swoosh.Adapters.SparkPost},
399 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
400 suggestions: ["https://api.sparkpost.com/api/v1"]
403 group: {:subgroup, Swoosh.Adapters.AmazonSES},
406 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
407 suggestions: ["us-east-1", "us-east-2"]
410 group: {:subgroup, Swoosh.Adapters.AmazonSES},
413 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
414 suggestions: ["aws-access-key"]
417 group: {:subgroup, Swoosh.Adapters.AmazonSES},
420 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
421 suggestions: ["aws-secret-key"]
424 group: {:subgroup, Swoosh.Adapters.Dyn},
428 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
429 suggestions: ["my-api-key"]
432 group: {:subgroup, Swoosh.Adapters.SocketLabs},
435 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
438 group: {:subgroup, Swoosh.Adapters.SocketLabs},
442 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
445 group: {:subgroup, Swoosh.Adapters.Gmail},
448 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
456 description: "URI schemes related settings",
460 type: {:list, :string},
461 description: "List of the scheme part that is considered valid to be an URL",
485 description: "Instance-related settings",
490 description: "Name of the instance",
498 description: "Email used to reach an Administrator/Moderator of the instance",
506 description: "Email used for notifications",
514 description: "The instance's description, can be seen in nodeinfo and /api/v1/instance",
522 description: "Posts character limit (CW/Subject included in the counter)",
530 description: "Hard character limit beyond which remote posts will be dropped",
538 description: "File size limit of uploads (except for avatar, background, banner)",
544 key: :avatar_upload_limit,
546 description: "File size limit of user's profile avatars",
552 key: :background_upload_limit,
554 description: "File size limit of user's profile backgrounds",
560 key: :banner_upload_limit,
562 description: "File size limit of user's profile banners",
570 description: "A map with poll limits for local polls",
574 max_option_chars: 200,
576 max_expiration: 31_536_000
583 description: "Maximum number of options",
587 key: :max_option_chars,
589 description: "Maximum number of characters per option",
593 key: :min_expiration,
595 description: "Minimum expiration time (in seconds)",
599 key: :max_expiration,
601 description: "Maximum expiration time (in seconds)",
607 key: :registrations_open,
609 description: "Enable registrations for anyone, invitations can be enabled when false"
612 key: :invites_enabled,
614 description: "Enable user invitations for admins (depends on registrations_open: false)"
617 key: :account_activation_required,
619 description: "Require users to confirm their emails before signing in"
624 description: "Enable federation with other instances"
627 key: :federation_incoming_replies_max_depth,
630 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
631 " 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",
637 key: :federation_reachability_timeout_days,
640 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
646 key: :federation_publisher_modules,
647 type: {:list, :module},
648 description: "List of modules for federation publishing",
650 Pleroma.Web.ActivityPub.Publisher
656 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
659 key: :rewrite_policy,
660 type: [:module, {:list, :module}],
661 description: "A list of MRF policies enabled",
663 Generator.list_modules_in_dir(
664 "lib/pleroma/web/activity_pub/mrf",
665 "Elixir.Pleroma.Web.ActivityPub.MRF."
672 "Makes the client API in authentificated mode-only except for user-profiles." <>
673 " Useful for disabling the Local Timeline and The Whole Known Network"
676 key: :quarantined_instances,
677 type: {:list, :string},
679 "List of ActivityPub instances where private(DMs, followers-only) activities will not be send",
686 key: :managed_config,
689 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
694 description: "Instance static directory",
700 key: :allowed_post_formats,
701 type: {:list, :string},
702 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
711 key: :mrf_transparency,
712 label: "MRF transparency",
715 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
718 key: :mrf_transparency_exclusions,
719 label: "MRF transparency exclusions",
720 type: {:list, :string},
722 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value",
728 key: :extended_nickname_format,
731 "Set to true to use extended local nicknames format (allows underscores/dashes)." <>
732 " This will break federation with older software for theses nicknames"
735 key: :max_pinned_statuses,
737 description: "The maximum number of pinned statuses. 0 will disable the feature",
745 key: :autofollowed_nicknames,
746 type: {:list, :string},
748 "Set to nicknames of (local) users that every new user should automatically follow",
757 key: :no_attachment_links,
760 "Set to true to disable automatically adding attachment link text to statuses"
763 key: :welcome_message,
766 "A message that will be send to a newly registered users as a direct message",
768 "Hi, @username! Welcome on board!"
772 key: :welcome_user_nickname,
774 description: "The nickname of the local user that sends the welcome message",
780 key: :max_report_comment_size,
782 description: "The maximum size of the report comment (Default: 1000)",
788 key: :safe_dm_mentions,
791 "If set to true, only mentions at the beginning of a post will be used to address people in direct messages." <>
792 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@friend hey i really don't like @enemy\")." <>
798 description: "If set to true, system data will be shown on /api/pleroma/healthcheck"
801 key: :remote_post_retention_days,
804 "The default amount of days to retain remote posts when pruning the database",
810 key: :user_bio_length,
812 description: "A user bio maximum length (default: 5000)",
818 key: :user_name_length,
820 description: "A user name maximum length (default: 100)",
826 key: :skip_thread_containment,
828 description: "Skip filter out broken threads. The default is true"
831 key: :limit_to_local_content,
832 type: [:atom, false],
834 "Limit unauthenticated users to search for local statutes and users only. The default is :unauthenticated ",
842 key: :dynamic_configuration,
845 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"
848 key: :max_account_fields,
850 description: "The maximum number of custom fields in the user profile (default: 10)",
856 key: :max_remote_account_fields,
859 "The maximum number of custom fields in the remote user profile (default: 20)",
865 key: :account_field_name_length,
867 description: "An account field name maximum length (default: 512)",
873 key: :account_field_value_length,
875 description: "An account field value maximum length (default: 2048)",
881 key: :external_user_synchronization,
883 description: "Enabling following/followers counters synchronization for external users"
890 description: "Logger-related settings",
894 type: [:atom, :tuple, :module],
896 "Where logs will be send, :console - send logs to stdout, {ExSyslogger, :ex_syslogger} - to syslog, Quack.Logger - to Slack.",
897 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
905 description: "ExSyslogger-related settings",
910 description: "Log level",
911 suggestions: [:debug, :info, :warn, :error]
917 "A string that's prepended to every message, and is typically set to the app name",
918 suggestions: ["pleroma"]
923 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
924 suggestions: ["$metadata[$level] $message"]
928 type: {:list, :atom},
929 suggestions: [:request_id]
937 description: "Console logger settings",
942 description: "Log level",
943 suggestions: [:debug, :info, :warn, :error]
948 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
949 suggestions: ["$metadata[$level] $message"]
953 type: {:list, :atom},
954 suggestions: [:request_id]
961 description: "Quack-related settings",
966 description: "Log level",
967 suggestions: [:debug, :info, :warn, :error]
971 type: {:list, :atom},
972 description: "Configure which metadata you want to report on",
990 description: "Configure the Slack incoming webhook",
991 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
997 key: :frontend_configurations,
1000 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1001 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1002 "add your own configuration your settings need to be complete as they will override the defaults.",
1006 label: "Pleroma FE",
1008 description: "Settings for Pleroma FE",
1011 theme: "pleroma-dark",
1012 logo: "/static/logo.png",
1013 background: "/images/city.jpg",
1014 redirectRootNoLogin: "/main/all",
1015 redirectRootLogin: "/main/friends",
1016 showInstanceSpecificPanel: true,
1017 scopeOptionsEnabled: false,
1018 formattingOptionsEnabled: false,
1019 collapseMessageWithSubject: false,
1020 hidePostStats: false,
1021 hideUserStats: false,
1023 subjectLineBehavior: "email",
1024 alwaysShowSubjectInput: true
1031 description: "Which theme to use, they are defined in styles.json",
1032 suggestions: ["pleroma-dark"]
1037 description: "URL of the logo, defaults to Pleroma's logo",
1038 suggestions: ["/static/logo.png"]
1044 "URL of the background, unless viewing a user profile with a background that is set",
1045 suggestions: ["/images/city.jpg"]
1048 key: :redirectRootNoLogin,
1049 label: "Redirect root no login",
1052 "relative URL which indicates where to redirect when a user isn't logged in",
1053 suggestions: ["/main/all"]
1056 key: :redirectRootLogin,
1057 label: "Redirect root login",
1060 "relative URL which indicates where to redirect when a user is logged in",
1061 suggestions: ["/main/friends"]
1064 key: :showInstanceSpecificPanel,
1065 label: "Show instance specific panel",
1067 description: "Whenether to show the instance's specific panel"
1070 key: :scopeOptionsEnabled,
1071 label: "Scope options enabled",
1073 description: "Enable setting an notice visibility and subject/CW when posting"
1076 key: :formattingOptionsEnabled,
1077 label: "Formatting options enabled",
1080 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to :instance, allowed_post_formats"
1083 key: :collapseMessageWithSubject,
1084 label: "Collapse message with subject",
1087 "When a message has a subject(aka Content Warning), collapse it by default"
1090 key: :hidePostStats,
1091 label: "Hide post stats",
1093 description: "Hide notices statistics(repeats, favorites, ...)"
1096 key: :hideUserStats,
1097 label: "Hide user stats",
1100 "Hide profile statistics(posts, posts per day, followers, followings, ...)"
1104 label: "Scope copy",
1106 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1109 key: :subjectLineBehavior,
1110 label: "Subject line behavior",
1112 description: "Allows changing the default behaviour of subject lines in replies.
1113 `email`: Copy and preprend re:, as in email,
1114 `masto`: Copy verbatim, as in Mastodon,
1115 `noop`: Don't copy the subjec",
1116 suggestions: ["email", "masto", "noop"]
1119 key: :alwaysShowSubjectInput,
1120 label: "Always show subject input",
1122 description: "When set to false, auto-hide the subject field when it's empty"
1130 description: "Settings for Masto FE",
1133 showInstanceSpecificPanel: true
1138 key: :showInstanceSpecificPanel,
1139 label: "Show instance specific panel",
1141 description: "Whenether to show the instance's specific panel"
1152 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1156 type: {:keyword, :map},
1158 "Keyword of mascots, each element MUST contain both a url and a mime_type key",
1161 url: "/images/pleroma-fox-tan-smol.png",
1162 mime_type: "image/png"
1164 pleroma_fox_tan_shy: %{
1165 url: "/images/pleroma-fox-tan-shy.png",
1166 mime_type: "image/png"
1171 key: :default_mascot,
1174 "This will be used as the default mascot on MastoFE (default: :pleroma_fox_tan)",
1186 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1190 type: {:list, :map},
1191 description: "Describe the icons of the app",
1194 src: "/static/logo.png"
1197 src: "/static/icon.png",
1201 src: "/static/icon.ico",
1202 sizes: "72x72 96x96 128x128 256x256"
1209 description: "Describe the theme color of the app",
1210 suggestions: ["#282c37", "mediumpurple"]
1213 key: :background_color,
1215 description: "Describe the background color of the app",
1216 suggestions: ["#191b22", "aliceblue"]
1223 label: "MRF simple",
1225 description: "Message Rewrite Facility",
1228 key: :media_removal,
1229 type: {:list, :string},
1230 description: "List of instances to remove medias from",
1231 suggestions: ["example.com", "*.example.com"]
1235 label: "Media NSFW",
1236 type: {:list, :string},
1237 description: "List of instances to put medias as NSFW(sensitive) from",
1238 suggestions: ["example.com", "*.example.com"]
1241 key: :federated_timeline_removal,
1242 type: {:list, :string},
1244 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1245 suggestions: ["example.com", "*.example.com"]
1249 type: {:list, :string},
1250 description: "List of instances to reject any activities from",
1251 suggestions: ["example.com", "*.example.com"]
1255 type: {:list, :string},
1256 description: "List of instances to accept any activities from",
1257 suggestions: ["example.com", "*.example.com"]
1260 key: :report_removal,
1261 type: {:list, :string},
1262 description: "List of instances to reject reports from",
1263 suggestions: ["example.com", "*.example.com"]
1266 key: :avatar_removal,
1267 type: {:list, :string},
1268 description: "List of instances to strip avatars from",
1269 suggestions: ["example.com", "*.example.com"]
1272 key: :banner_removal,
1273 type: {:list, :string},
1274 description: "List of instances to strip banners from",
1275 suggestions: ["example.com", "*.example.com"]
1282 label: "MRF subchain",
1285 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1286 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1291 description: "Matches a series of regular expressions against the actor field",
1294 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1302 key: :mrf_rejectnonpublic,
1304 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1305 label: "MRF reject non public",
1309 key: :allow_followersonly,
1310 label: "Allow followers-only",
1312 description: "whether to allow followers-only posts"
1317 description: "whether to allow direct messages"
1323 key: :mrf_hellthread,
1324 label: "MRF hellthread",
1326 description: "Block messages with too much mentions",
1329 key: :delist_threshold,
1332 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1333 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable",
1337 key: :reject_threshold,
1340 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable",
1348 label: "MRF keyword",
1350 description: "Reject or Word-Replace messages with a keyword or regex",
1354 type: [:string, :regex],
1356 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression",
1357 suggestions: ["foo", ~r/foo/iu]
1360 key: :federated_timeline_removal,
1361 type: [:string, :regex],
1363 "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",
1364 suggestions: ["foo", ~r/foo/iu]
1368 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1370 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1371 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1378 label: "MRF mention",
1380 description: "Block messages which mention a user",
1384 type: {:list, :string},
1385 description: "A list of actors, for which to drop any posts mentioning",
1386 suggestions: ["actor1", "actor2"]
1392 key: :mrf_vocabulary,
1393 label: "MRF vocabulary",
1395 description: "Filter messages which belong to certain activity vocabularies",
1399 type: {:list, :string},
1401 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1402 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1406 type: {:list, :string},
1408 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1409 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1415 # key: :mrf_user_allowlist,
1418 # "The keys in this section are the domain names that the policy should apply to." <>
1419 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1421 # ["example.org": ["https://example.org/users/admin"]],
1423 # ["example.org": ["https://example.org/users/admin"]]
1431 description: "Media proxy",
1436 description: "Enables proxying of remote media to the instance's proxy"
1442 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts",
1443 suggestions: ["https://example.com"]
1448 description: "Options for Pleroma.ReverseProxy",
1450 redirect_on_failure: false,
1451 max_body_length: 25 * 1_048_576,
1453 follow_redirect: true,
1459 key: :redirect_on_failure,
1462 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1463 "Any error during body processing will not be redirected as the response is chunked"
1466 key: :max_body_length,
1469 "limits the content length to be approximately the " <>
1470 "specified length. It is validated with the `content-length` header and also verified when proxying"
1475 description: "HTTP options",
1480 description: "Adapter specific options",
1485 label: "SSL Options",
1486 description: "SSL options for HTTP adapter",
1490 type: {:list, :atom},
1491 descriptions: "List of TLS version to use",
1492 suggestions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"]
1501 type: [:string, :tuple],
1502 description: "Proxy URL",
1503 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1511 type: {:list, :string},
1512 description: "List of domains to bypass the mediaproxy",
1513 suggestions: ["example.com"]
1521 description: "Gopher settings",
1526 description: "Enables the gopher interface"
1531 description: "IP address to bind to",
1532 suggestions: [{0, 0, 0, 0}]
1537 description: "Port to bind to",
1543 description: "Port advertised in urls (optional, defaults to port)",
1550 key: Pleroma.Web.Endpoint,
1552 description: "Phoenix endpoint configuration",
1557 type: {:keyword, :integer, :tuple},
1558 description: "http protocol configuration",
1566 type: {:list, :tuple},
1567 description: "dispatch settings",
1571 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1572 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1573 {Phoenix.Transports.WebSocket,
1574 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1575 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1577 # end copied from config.exs
1592 description: "port",
1602 type: {:keyword, :string, :integer},
1603 description: "configuration for generating urls",
1605 host: "example.com",
1613 description: "Host",
1621 description: "port",
1629 description: "Scheme",
1638 key: :instrumenters,
1639 type: {:list, :module},
1640 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1645 suggestions: ["https"]
1648 key: :secret_key_base,
1650 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1655 suggestions: ["CqaoopA2"]
1658 key: :render_errors,
1660 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1665 suggestions: [Pleroma.Web.ErrorView]
1669 type: {:list, :string},
1670 suggestions: ["json"]
1677 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1682 suggestions: [Pleroma.PubSub]
1687 suggestions: [Phoenix.PubSub.PG2]
1692 key: :secure_cookie_flag,
1696 key: :extra_cookie_attrs,
1697 type: {:list, :string},
1698 suggestions: ["SameSite=Lax"]
1706 description: "ActivityPub-related settings",
1709 key: :unfollow_blocked,
1711 description: "Whether blocks result in people getting unfollowed"
1714 key: :outgoing_blocks,
1716 description: "Whether to federate blocks to other instances"
1719 key: :sign_object_fetches,
1721 description: "Sign object fetches with HTTP signatures"
1724 key: :follow_handshake_timeout,
1726 description: "Following handshake timeout",
1733 key: :http_security,
1735 description: "HTTP security settings",
1740 description: "Whether the managed content security policy is enabled"
1746 description: "Whether to additionally send a Strict-Transport-Security header"
1750 label: "STS max age",
1752 description: "The maximum age for the Strict-Transport-Security header if sent",
1753 suggestions: [31_536_000]
1757 label: "CT max age",
1759 description: "The maximum age for the Expect-CT header if sent",
1760 suggestions: [2_592_000]
1763 key: :referrer_policy,
1765 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1766 suggestions: ["same-origin", "no-referrer"]
1770 label: "Report URI",
1772 description: "Adds the specified url to report-uri and report-to group in CSP header",
1773 suggestions: ["https://example.com/report-uri"]
1778 group: :web_push_encryption,
1779 key: :vapid_details,
1782 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1788 "a mailto link for the administrative contact." <>
1789 " 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," <>
1790 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can",
1791 suggestions: ["Subject"]
1796 description: "VAPID public key",
1797 suggestions: ["Public key"]
1802 description: "VAPID private keyn",
1803 suggestions: ["Private key"]
1809 key: Pleroma.Captcha,
1811 description: "Captcha-related settings",
1816 description: "Whether the captcha should be shown on registration"
1821 description: "The method/service to use for captcha",
1822 suggestions: [Pleroma.Captcha.Kocaptcha]
1825 key: :seconds_valid,
1827 description: "The time in seconds for which the captcha is valid",
1834 key: Pleroma.Captcha.Kocaptcha,
1837 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1838 " here: https://github.com/koto-bank/kocaptcha. The default endpoint https://captcha.kotobank.ch is hosted by the developer",
1843 description: "the kocaptcha endpoint to use",
1844 suggestions: ["https://captcha.kotobank.ch"]
1852 "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",
1857 description: "Token",
1858 suggestions: ["some_random_token"]
1863 group: :pleroma_job_queue,
1866 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1870 key: Pleroma.Web.Federator.RetryQueue,
1872 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1877 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1886 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1888 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1889 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1890 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1891 (see https://github.com/sorentwo/oban/issues/52).
1897 description: "Application's Ecto repo",
1898 suggestions: [Pleroma.Repo]
1903 description: "Logs verbose mode"
1907 type: [:atom, :tuple],
1909 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1910 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1914 type: {:keyword, :integer},
1916 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1918 activity_expiration: 10,
1920 federator_incoming: 50,
1921 federator_outgoing: 50,
1923 scheduled_activities: 10,
1929 key: :activity_expiration,
1931 description: "Activity expiration queue",
1937 description: "Background queue",
1941 key: :federator_incoming,
1943 description: "Incoming federation queue",
1947 key: :federator_outgoing,
1949 description: "Outgoing federation queue",
1955 description: "Email sender queue, see Pleroma.Emails.Mailer",
1959 key: :scheduled_activities,
1961 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1965 key: :transmogrifier,
1967 description: "Transmogrifier queue",
1973 description: "Web push notifications queue",
1984 description: "Includes custom worker options not interpretable directly by `Oban`",
1988 type: {:keyword, :integer},
1989 description: "Max retry attempts for failed jobs, per `Oban` queue",
1991 federator_incoming: 5,
1992 federator_outgoing: 5
1999 key: Pleroma.Web.Metadata,
2001 description: "Metadata-related settings",
2005 type: {:list, :module},
2006 description: "List of metadata providers to enable",
2008 Pleroma.Web.Metadata.Providers.OpenGraph,
2009 Pleroma.Web.Metadata.Providers.TwitterCard,
2010 Pleroma.Web.Metadata.Providers.RelMe
2015 label: "Unfurl NSFW",
2017 description: "If set to true nsfw attachments will be shown in previews"
2026 "If enabled the instance will parse metadata from attached links to generate link previews.",
2031 description: "Enables/disables RichMedia."
2035 type: {:list, :string},
2036 description: "List of hosts which will be ignored by the metadata parser.",
2037 suggestions: ["accounts.google.com", "xss.website"]
2041 label: "Ignore TLD",
2042 type: {:list, :string},
2043 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2044 suggestions: ["local", "localdomain", "lan"]
2048 type: {:list, :module},
2049 description: "List of Rich Media parsers.",
2051 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2052 Pleroma.Web.RichMedia.Parsers.OEmbed,
2053 Pleroma.Web.RichMedia.Parsers.OGP,
2054 Pleroma.Web.RichMedia.Parsers.TwitterCard
2059 label: "TTL setters",
2060 type: {:list, :module},
2061 description: "List of rich media ttl setters.",
2063 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2070 key: :fetch_initial_posts,
2072 description: "Fetching initial posts settings",
2078 "if enabled, when a new user is federated with, fetch some of their latest posts"
2083 description: "the amount of pages to fetch",
2089 group: :auto_linker,
2092 description: "Configuration for the auto_linker library",
2096 type: [:string, false],
2097 description: "specify the class to be added to the generated link. false to clear",
2098 suggestions: ["auto-linker", false]
2102 type: [:string, false],
2103 description: "override the rel attribute. false to clear",
2104 suggestions: ["ugc", "noopener noreferrer", false]
2109 description: "set to false to remove target='_blank' attribute"
2114 description: "Set to true to link urls with schema http://google.com"
2118 type: [:integer, false],
2120 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2121 suggestions: [15, false]
2126 description: "Strip the scheme prefix"
2131 description: "link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2137 key: Pleroma.ScheduledActivity,
2139 description: "Scheduled activities settings",
2142 key: :daily_user_limit,
2145 "the number of scheduled activities a user is allowed to create in a single day (Default: 25)",
2149 key: :total_user_limit,
2152 "the number of scheduled activities a user is allowed to create in total (Default: 300)",
2158 description: "whether scheduled activities are sent to the job queue to be executed"
2164 key: Pleroma.ActivityExpiration,
2166 description: "Expired activity settings",
2171 description: "whether expired activities will be sent to the job queue to be deleted"
2178 description: "Authenticator",
2181 key: Pleroma.Web.Auth.Authenticator,
2183 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2192 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2193 " will be verified by trying to authenticate (bind) to an LDAP server." <>
2194 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2195 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2200 description: "enables LDAP authentication"
2205 description: "LDAP server hostname",
2206 suggestions: ["localhosts"]
2211 description: "LDAP port, e.g. 389 or 636",
2212 suggestions: [389, 636]
2218 description: "true to use SSL, usually implies the port 636"
2222 label: "SSL options",
2224 description: "additional SSL options",
2225 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2230 description: "Path to file with PEM encoded cacerts",
2231 suggestions: ["path/to/file/with/PEM/cacerts"]
2236 description: "Type of cert verification",
2237 suggestions: [:verify_peer]
2245 description: "true to start TLS, usually implies the port 389"
2249 label: "TLS options",
2251 description: "additional TLS options",
2252 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2257 description: "Path to file with PEM encoded cacerts",
2258 suggestions: ["path/to/file/with/PEM/cacerts"]
2263 description: "Type of cert verification",
2264 suggestions: [:verify_peer]
2271 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2272 suggestions: ["dc=example,dc=com"]
2278 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2287 description: "Authentication / authorization settings",
2290 key: :enforce_oauth_admin_scope_usage,
2293 "OAuth admin scope requirement toggle. " <>
2294 "If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2295 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2296 "`is_admin` user flag grants access to admin-specific actions."
2299 key: :auth_template,
2302 "authentication form template. By default it's show.html which corresponds to lib/pleroma/web/templates/o_auth/o_auth/show.html.ee",
2303 suggestions: ["show.html"]
2306 key: :oauth_consumer_template,
2309 "OAuth consumer mode authentication form template. By default it's consumer.html which corresponds to" <>
2310 " lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex",
2311 suggestions: ["consumer.html"]
2314 key: :oauth_consumer_strategies,
2315 type: {:list, :string},
2317 "the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2318 " Each entry in this space-delimited string should be of format <strategy> or <strategy>:<dependency>" <>
2319 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2320 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2326 key: :email_notifications,
2328 description: "Email notifications settings",
2334 "emails of \"what you've missed\" for users who have been inactive for a while",
2338 schedule: "0 0 * * 0",
2340 inactivity_threshold: 7
2347 description: "globally enable or disable digest emails"
2353 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\"",
2354 suggestions: ["0 0 * * 0"]
2359 description: "Minimum interval between digest emails to one user",
2363 key: :inactivity_threshold,
2365 description: "Minimum user inactivity threshold",
2374 key: Pleroma.Emails.UserEmail,
2376 description: "Email template settings",
2381 description: "a path to a custom logo. Set it to nil to use the default Pleroma logo",
2382 suggestions: ["some/path/logo.png"]
2387 description: "a map with color settings for email templates.",
2390 link_color: "#d8a070",
2391 background_color: "#2C3645",
2392 content_background_color: "#1B2635",
2393 header_color: "#d8a070",
2394 text_color: "#b9b9ba",
2395 text_muted_color: "#b9b9ba"
2402 suggestions: ["#d8a070"]
2405 key: :background_color,
2407 suggestions: ["#2C3645"]
2410 key: :content_background_color,
2412 suggestions: ["#1B2635"]
2417 suggestions: ["#d8a070"]
2422 suggestions: ["#b9b9ba"]
2425 key: :text_muted_color,
2427 suggestions: ["#b9b9ba"]
2437 description: "Configure OAuth 2 provider capabilities",
2440 key: :token_expires_in,
2442 description: "The lifetime in seconds of the access token",
2446 key: :issue_new_refresh_token,
2449 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2452 key: :clean_expired_tokens,
2454 description: "Enable a background job to clean expired oauth tokens. Defaults to false"
2457 key: :clean_expired_tokens_interval,
2460 "Interval to run the job to clean expired tokens. Defaults to 86_400_000 (24 hours).",
2461 suggestions: [86_400_000]
2471 key: :shortcode_globs,
2472 type: {:list, :string},
2473 description: "Location of custom emoji files. * can be used as a wildcard",
2474 suggestions: ["/emoji/custom/**/*.png"]
2477 key: :pack_extensions,
2478 type: {:list, :string},
2480 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2481 suggestions: [".png", ".gif"]
2485 type: {:keyword, :string, {:list, :string}},
2487 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname" <>
2488 " and the value the location or array of locations. * can be used as a wildcard",
2490 # Put groups that have higher priority than defaults here. Example in `docs/config/custom_emoji.md`
2491 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2495 key: :default_manifest,
2498 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2499 " Currently only one manifest can be added (no arrays)",
2500 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2503 key: :shared_pack_cache_seconds_per_file,
2506 "When an emoji pack is shared, the archive is created and cached in memory" <>
2507 " for this amount of seconds multiplied by the number of files.",
2516 description: "Database related settings",
2521 description: "If RUM indexes should be used. Defaults to false"
2530 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2534 type: [:tuple, {:list, :tuple}],
2535 description: "for the search requests (account & status search etc.)",
2536 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2539 key: :app_account_creation,
2540 type: [:tuple, {:list, :tuple}],
2541 description: "for registering user accounts from the same IP address",
2542 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2545 key: :relations_actions,
2546 type: [:tuple, {:list, :tuple}],
2547 description: "for actions on relations with all users (follow, unfollow)",
2548 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2551 key: :relation_id_action,
2552 type: [:tuple, {:list, :tuple}],
2553 description: "for actions on relation with a specific user (follow, unfollow)",
2554 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2557 key: :statuses_actions,
2558 type: [:tuple, {:list, :tuple}],
2560 "for create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2561 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2564 key: :status_id_action,
2565 type: [:tuple, {:list, :tuple}],
2567 "for fav / unfav or reblog / unreblog actions on the same status by the same user",
2568 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2571 key: :authentication,
2572 type: [:tuple, {:list, :tuple}],
2573 description: "for authentication create / password check / user existence check requests",
2574 suggestions: [{60_000, 15}]
2582 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2583 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2588 description: "Enables ssh"
2593 description: "Dir with ssh keys",
2594 suggestions: ["/some/path/ssh_keys"]
2599 description: "Handler module",
2600 suggestions: ["Pleroma.BBS.Handler"]
2605 description: "Port to connect",
2606 suggestions: [10_022]
2609 key: :password_authenticator,
2611 description: "Authenticator module",
2612 suggestions: ["Pleroma.BBS.Authenticator"]
2619 description: "Mime types",
2626 "application/xml" => ["xml"],
2627 "application/xrd+xml" => ["xrd+xml"],
2628 "application/jrd+json" => ["jrd+json"],
2629 "application/activity+json" => ["activity+json"],
2630 "application/ld+json" => ["activity+json"]
2635 key: "application/xml",
2636 type: {:list, :string},
2637 suggestions: ["xml"]
2640 key: "application/xrd+xml",
2641 type: {:list, :string},
2642 suggestions: ["xrd+xml"]
2645 key: "application/jrd+json",
2646 type: {:list, :string},
2647 suggestions: ["jrd+json"]
2650 key: "application/activity+json",
2651 type: {:list, :string},
2652 suggestions: ["activity+json"]
2655 key: "application/ld+json",
2656 type: {:list, :string},
2657 suggestions: ["activity+json"]
2666 description: "Tesla settings",
2671 description: "Tesla adapter",
2672 suggestions: [Tesla.Adapter.Hackney]
2680 description: "Pleroma chat settings",
2696 description: "Enables suggestions"
2699 key: :third_party_engine,
2701 description: "URL for third party engine",
2703 "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}"
2709 description: "Request timeout to third party engine",
2710 suggestions: [300_000]
2715 description: "Limit for suggestions",
2721 suggestions: ["https://vinayaka.distsn.org"]
2727 key: Pleroma.Web.Endpoint.MetricsExporter,
2729 description: "Prometheus settings",
2734 description: "API endpoint with metrics",
2735 suggestions: ["/api/pleroma/app_metrics"]
2740 group: :http_signatures,
2742 description: "HTTP Signatures settings",
2747 suggestions: [Pleroma.Signature]
2753 key: Pleroma.Uploaders.MDII,
2755 "Uploader for https://github.com/hakaba-hitoyo/minimal-digital-image-infrastructure",
2761 suggestions: ["https://mdii.sakura.ne.jp/mdii-post.cgi"]
2766 suggestions: ["https://mdii.sakura.ne.jp"]
2774 description: "HTTP settings",
2779 type: [:string, :tuple],
2780 description: "Proxy URL",
2781 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2784 key: :send_user_agent,
2790 description: "Adapter specific options",
2796 label: "SSL Options",
2797 description: "SSL options for HTTP adapter",
2801 type: {:list, :atom},
2802 descriptions: "List of TLS version to use",
2803 suggestions: [:tlsv1, :"tlsv1.1", :"tlsv1.2"]
2817 key: :allow_inline_images,
2821 key: :allow_headings,
2834 type: {:list, :module},
2835 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2845 key: :deny_follow_blocked,
2852 key: :mrf_normalize_markup,
2853 label: "MRF normalize markup",
2854 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2860 suggestions: [Pleroma.HTML.Scrubber.Default]
2870 key: :restricted_nicknames,
2871 type: {:list, :string},
2890 "ostatus_subscribe",
2914 suggestions: [86_400]
2918 type: {:list, :string},
2919 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2923 type: {:list, :string},
2926 "X-RateLimit-Reset",
2927 "X-RateLimit-Limit",
2928 "X-RateLimit-Remaining",
2939 type: {:list, :string},
2940 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2946 key: Pleroma.Plugs.RemoteIp,
2949 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2950 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2956 description: "Enable/disable the plug. Defaults to `false`."
2960 type: {:list, :string},
2962 "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]`."
2966 type: {:list, :string},
2968 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`."
2972 type: {:list, :string},
2974 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2980 key: :web_cache_ttl,
2983 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2989 "activity pub routes (except question activities). Defaults to `nil` (no expiration).",
2990 suggestions: [30_000]
2993 key: :activity_pub_question,
2996 "activity pub routes (question activities). Defaults to `30_000` (30 seconds).",
2997 suggestions: [30_000]