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 description: "List of TLS version to use",
105 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
114 type: [:string, :tuple],
115 description: "Proxy URL",
116 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
126 key: Pleroma.Uploaders.Local,
128 description: "Local uploader-related settings",
133 description: "Path where user uploads will be saved",
142 key: Pleroma.Uploaders.S3,
144 description: "S3 uploader-related settings",
149 description: "S3 bucket",
155 key: :bucket_namespace,
157 description: "S3 bucket namespace",
158 suggestions: ["pleroma"]
161 key: :public_endpoint,
163 description: "S3 endpoint",
164 suggestions: ["https://s3.amazonaws.com"]
167 key: :truncated_namespace,
170 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
171 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
174 key: :streaming_enabled,
177 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
183 key: Pleroma.Upload.Filter.Mogrify,
185 description: "Uploads mogrify filter settings",
189 type: [:string, {:list, :string}, {:list, :tuple}],
190 description: "List of actions for the mogrify command",
201 key: Pleroma.Upload.Filter.AnonymizeFilename,
203 description: "Filter replaces the filename of the upload",
209 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
210 " filename extension by using {extension}, for example custom-file-name.{extension}",
212 "custom-file-name.{extension}"
219 key: Pleroma.Emails.Mailer,
221 description: "Mailer-related settings",
227 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
228 " or Swoosh.Adapters.Local for in-memory mailbox",
230 Swoosh.Adapters.SMTP,
231 Swoosh.Adapters.Sendgrid,
232 Swoosh.Adapters.Sendmail,
233 Swoosh.Adapters.Mandrill,
234 Swoosh.Adapters.Mailgun,
235 Swoosh.Adapters.Mailjet,
236 Swoosh.Adapters.Postmark,
237 Swoosh.Adapters.SparkPost,
238 Swoosh.Adapters.AmazonSES,
240 Swoosh.Adapters.SocketLabs,
241 Swoosh.Adapters.Gmail,
242 Swoosh.Adapters.Local
248 description: "Allow/disallow send emails"
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
255 suggestions: ["smtp.gmail.com"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
262 suggestions: ["pleroma"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
283 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
284 suggestions: [:always, :never, :if_available]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
291 suggestions: [:always, :never, :if_available]
294 group: {:subgroup, Swoosh.Adapters.SMTP},
297 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
301 group: {:subgroup, Swoosh.Adapters.SMTP},
304 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
308 group: {:subgroup, Swoosh.Adapters.SMTP},
310 label: "No MX lookups",
312 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
315 group: {:subgroup, Swoosh.Adapters.Sendgrid},
319 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
320 suggestions: ["my-api-key"]
323 group: {:subgroup, Swoosh.Adapters.Sendmail},
326 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
327 suggestions: ["/usr/bin/sendmail"]
330 group: {:subgroup, Swoosh.Adapters.Sendmail},
333 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
334 suggestions: ["-N delay,failure,success"]
337 group: {:subgroup, Swoosh.Adapters.Sendmail},
340 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
343 group: {:subgroup, Swoosh.Adapters.Mandrill},
347 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
348 suggestions: ["my-api-key"]
351 group: {:subgroup, Swoosh.Adapters.Mailgun},
355 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
356 suggestions: ["my-api-key"]
359 group: {:subgroup, Swoosh.Adapters.Mailgun},
362 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
363 suggestions: ["pleroma.com"]
366 group: {:subgroup, Swoosh.Adapters.Mailjet},
370 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
371 suggestions: ["my-api-key"]
374 group: {:subgroup, Swoosh.Adapters.Mailjet},
377 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
378 suggestions: ["my-secret-key"]
381 group: {:subgroup, Swoosh.Adapters.Postmark},
385 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
386 suggestions: ["my-api-key"]
389 group: {:subgroup, Swoosh.Adapters.SparkPost},
393 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
394 suggestions: ["my-api-key"]
397 group: {:subgroup, Swoosh.Adapters.SparkPost},
400 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
401 suggestions: ["https://api.sparkpost.com/api/v1"]
404 group: {:subgroup, Swoosh.Adapters.AmazonSES},
407 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
408 suggestions: ["us-east-1", "us-east-2"]
411 group: {:subgroup, Swoosh.Adapters.AmazonSES},
414 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
415 suggestions: ["aws-access-key"]
418 group: {:subgroup, Swoosh.Adapters.AmazonSES},
421 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
422 suggestions: ["aws-secret-key"]
425 group: {:subgroup, Swoosh.Adapters.Dyn},
429 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
430 suggestions: ["my-api-key"]
433 group: {:subgroup, Swoosh.Adapters.SocketLabs},
436 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
439 group: {:subgroup, Swoosh.Adapters.SocketLabs},
443 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
446 group: {:subgroup, Swoosh.Adapters.Gmail},
449 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
456 description: "`Swoosh.Adapters.Local` adapter specific settings",
459 group: {:subgroup, Swoosh.Adapters.Local},
462 description: "Run the preview server together as part of your app"
465 group: {:subgroup, Swoosh.Adapters.Local},
468 description: "The preview server port",
477 description: "URI schemes related settings",
481 type: {:list, :string},
482 description: "List of the scheme part that is considered valid to be an URL",
506 description: "Instance-related settings",
511 description: "Name of the instance",
519 description: "Email used to reach an Administrator/Moderator of the instance",
527 description: "Email used for notifications",
535 description: "The instance's description, can be seen in nodeinfo and /api/v1/instance",
543 description: "Posts character limit (CW/Subject included in the counter)",
551 description: "Character limit of the instance chat messages",
559 description: "Hard character limit beyond which remote posts will be dropped",
567 description: "File size limit of uploads (except for avatar, background, banner)",
573 key: :avatar_upload_limit,
575 description: "File size limit of user's profile avatars",
581 key: :background_upload_limit,
583 description: "File size limit of user's profile backgrounds",
589 key: :banner_upload_limit,
591 description: "File size limit of user's profile banners",
599 description: "A map with poll limits for local polls",
603 max_option_chars: 200,
605 max_expiration: 31_536_000
612 description: "Maximum number of options",
616 key: :max_option_chars,
618 description: "Maximum number of characters per option",
622 key: :min_expiration,
624 description: "Minimum expiration time (in seconds)",
628 key: :max_expiration,
630 description: "Maximum expiration time (in seconds)",
636 key: :registrations_open,
638 description: "Enable registrations for anyone, invitations can be enabled when false"
641 key: :invites_enabled,
643 description: "Enable user invitations for admins (depends on registrations_open: false)"
646 key: :account_activation_required,
648 description: "Require users to confirm their emails before signing in"
653 description: "Enable federation with other instances"
656 key: :federation_incoming_replies_max_depth,
659 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
660 " 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",
666 key: :federation_reachability_timeout_days,
669 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
675 key: :federation_publisher_modules,
676 type: {:list, :module},
677 description: "List of modules for federation publishing",
679 Pleroma.Web.ActivityPub.Publisher
685 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
688 key: :rewrite_policy,
689 type: [:module, {:list, :module}],
690 description: "A list of MRF policies enabled",
692 Generator.list_modules_in_dir(
693 "lib/pleroma/web/activity_pub/mrf",
694 "Elixir.Pleroma.Web.ActivityPub.MRF."
701 "Makes the client API in authentificated mode-only except for user-profiles." <>
702 " Useful for disabling the Local Timeline and The Whole Known Network"
705 key: :quarantined_instances,
706 type: {:list, :string},
708 "List of ActivityPub instances where private(DMs, followers-only) activities will not be send",
715 key: :managed_config,
718 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
723 description: "Instance static directory",
729 key: :allowed_post_formats,
730 type: {:list, :string},
731 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
740 key: :mrf_transparency,
741 label: "MRF transparency",
744 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
747 key: :mrf_transparency_exclusions,
748 label: "MRF transparency exclusions",
749 type: {:list, :string},
751 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value",
757 key: :extended_nickname_format,
760 "Set to true to use extended local nicknames format (allows underscores/dashes)." <>
761 " This will break federation with older software for theses nicknames"
764 key: :max_pinned_statuses,
766 description: "The maximum number of pinned statuses. 0 will disable the feature",
774 key: :autofollowed_nicknames,
775 type: {:list, :string},
777 "Set to nicknames of (local) users that every new user should automatically follow",
786 key: :no_attachment_links,
789 "Set to true to disable automatically adding attachment link text to statuses"
792 key: :welcome_message,
795 "A message that will be send to a newly registered users as a direct message",
797 "Hi, @username! Welcome on board!"
801 key: :welcome_user_nickname,
803 description: "The nickname of the local user that sends the welcome message",
809 key: :max_report_comment_size,
811 description: "The maximum size of the report comment (Default: 1000)",
817 key: :safe_dm_mentions,
820 "If set to true, only mentions at the beginning of a post will be used to address people in direct messages." <>
821 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@friend hey i really don't like @enemy\")." <>
827 description: "If set to true, system data will be shown on /api/pleroma/healthcheck"
830 key: :remote_post_retention_days,
833 "The default amount of days to retain remote posts when pruning the database",
839 key: :user_bio_length,
841 description: "A user bio maximum length (default: 5000)",
847 key: :user_name_length,
849 description: "A user name maximum length (default: 100)",
855 key: :skip_thread_containment,
857 description: "Skip filter out broken threads. The default is true"
860 key: :limit_to_local_content,
861 type: [:atom, false],
863 "Limit unauthenticated users to search for local statutes and users only. The default is :unauthenticated ",
871 key: :max_account_fields,
873 description: "The maximum number of custom fields in the user profile (default: 10)",
879 key: :max_remote_account_fields,
882 "The maximum number of custom fields in the remote user profile (default: 20)",
888 key: :account_field_name_length,
890 description: "An account field name maximum length (default: 512)",
896 key: :account_field_value_length,
898 description: "An account field value maximum length (default: 2048)",
904 key: :external_user_synchronization,
906 description: "Enabling following/followers counters synchronization for external users"
913 description: "Logger-related settings",
917 type: [:atom, :tuple, :module],
919 "Where logs will be send, :console - send logs to stdout, {ExSyslogger, :ex_syslogger} - to syslog, Quack.Logger - to Slack.",
920 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
928 description: "ExSyslogger-related settings",
933 description: "Log level",
934 suggestions: [:debug, :info, :warn, :error]
940 "A string that's prepended to every message, and is typically set to the app name",
941 suggestions: ["pleroma"]
946 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
947 suggestions: ["$metadata[$level] $message"]
951 type: {:list, :atom},
952 suggestions: [:request_id]
960 description: "Console logger settings",
965 description: "Log level",
966 suggestions: [:debug, :info, :warn, :error]
971 description: "It defaults to \"$date $time [$level] $levelpad$node $metadata $message\"",
972 suggestions: ["$metadata[$level] $message"]
976 type: {:list, :atom},
977 suggestions: [:request_id]
984 description: "Quack-related settings",
989 description: "Log level",
990 suggestions: [:debug, :info, :warn, :error]
994 type: {:list, :atom},
995 description: "Configure which metadata you want to report on",
1013 description: "Configure the Slack incoming webhook",
1014 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1020 key: :frontend_configurations,
1023 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1024 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1025 "add your own configuration your settings need to be complete as they will override the defaults.",
1029 label: "Pleroma FE",
1031 description: "Settings for Pleroma FE",
1034 theme: "pleroma-dark",
1035 logo: "/static/logo.png",
1036 background: "/images/city.jpg",
1037 redirectRootNoLogin: "/main/all",
1038 redirectRootLogin: "/main/friends",
1039 showInstanceSpecificPanel: true,
1040 scopeOptionsEnabled: false,
1041 formattingOptionsEnabled: false,
1042 collapseMessageWithSubject: false,
1043 hidePostStats: false,
1044 hideUserStats: false,
1046 subjectLineBehavior: "email",
1047 alwaysShowSubjectInput: true
1054 description: "Which theme to use, they are defined in styles.json",
1055 suggestions: ["pleroma-dark"]
1060 description: "URL of the logo, defaults to Pleroma's logo",
1061 suggestions: ["/static/logo.png"]
1067 "URL of the background, unless viewing a user profile with a background that is set",
1068 suggestions: ["/images/city.jpg"]
1071 key: :redirectRootNoLogin,
1072 label: "Redirect root no login",
1075 "relative URL which indicates where to redirect when a user isn't logged in",
1076 suggestions: ["/main/all"]
1079 key: :redirectRootLogin,
1080 label: "Redirect root login",
1083 "relative URL which indicates where to redirect when a user is logged in",
1084 suggestions: ["/main/friends"]
1087 key: :showInstanceSpecificPanel,
1088 label: "Show instance specific panel",
1090 description: "Whenether to show the instance's specific panel"
1093 key: :scopeOptionsEnabled,
1094 label: "Scope options enabled",
1096 description: "Enable setting an notice visibility and subject/CW when posting"
1099 key: :formattingOptionsEnabled,
1100 label: "Formatting options enabled",
1103 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to :instance, allowed_post_formats"
1106 key: :collapseMessageWithSubject,
1107 label: "Collapse message with subject",
1110 "When a message has a subject(aka Content Warning), collapse it by default"
1113 key: :hidePostStats,
1114 label: "Hide post stats",
1116 description: "Hide notices statistics(repeats, favorites, ...)"
1119 key: :hideUserStats,
1120 label: "Hide user stats",
1123 "Hide profile statistics(posts, posts per day, followers, followings, ...)"
1127 label: "Scope copy",
1129 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1132 key: :subjectLineBehavior,
1133 label: "Subject line behavior",
1135 description: "Allows changing the default behaviour of subject lines in replies.
1136 `email`: Copy and preprend re:, as in email,
1137 `masto`: Copy verbatim, as in Mastodon,
1138 `noop`: Don't copy the subjec",
1139 suggestions: ["email", "masto", "noop"]
1142 key: :alwaysShowSubjectInput,
1143 label: "Always show subject input",
1145 description: "When set to false, auto-hide the subject field when it's empty"
1153 description: "Settings for Masto FE",
1156 showInstanceSpecificPanel: true
1161 key: :showInstanceSpecificPanel,
1162 label: "Show instance specific panel",
1164 description: "Whenether to show the instance's specific panel"
1175 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1179 type: {:keyword, :map},
1181 "Keyword of mascots, each element MUST contain both a url and a mime_type key",
1184 url: "/images/pleroma-fox-tan-smol.png",
1185 mime_type: "image/png"
1187 pleroma_fox_tan_shy: %{
1188 url: "/images/pleroma-fox-tan-shy.png",
1189 mime_type: "image/png"
1194 key: :default_mascot,
1197 "This will be used as the default mascot on MastoFE (default: :pleroma_fox_tan)",
1209 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1213 type: {:list, :map},
1214 description: "Describe the icons of the app",
1217 src: "/static/logo.png"
1220 src: "/static/icon.png",
1224 src: "/static/icon.ico",
1225 sizes: "72x72 96x96 128x128 256x256"
1232 description: "Describe the theme color of the app",
1233 suggestions: ["#282c37", "mediumpurple"]
1236 key: :background_color,
1238 description: "Describe the background color of the app",
1239 suggestions: ["#191b22", "aliceblue"]
1246 label: "MRF simple",
1248 description: "Message Rewrite Facility",
1251 key: :media_removal,
1252 type: {:list, :string},
1253 description: "List of instances to remove medias from",
1254 suggestions: ["example.com", "*.example.com"]
1258 label: "Media NSFW",
1259 type: {:list, :string},
1260 description: "List of instances to put medias as NSFW(sensitive) from",
1261 suggestions: ["example.com", "*.example.com"]
1264 key: :federated_timeline_removal,
1265 type: {:list, :string},
1267 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1268 suggestions: ["example.com", "*.example.com"]
1272 type: {:list, :string},
1273 description: "List of instances to reject any activities from",
1274 suggestions: ["example.com", "*.example.com"]
1278 type: {:list, :string},
1279 description: "List of instances to accept any activities from",
1280 suggestions: ["example.com", "*.example.com"]
1283 key: :report_removal,
1284 type: {:list, :string},
1285 description: "List of instances to reject reports from",
1286 suggestions: ["example.com", "*.example.com"]
1289 key: :avatar_removal,
1290 type: {:list, :string},
1291 description: "List of instances to strip avatars from",
1292 suggestions: ["example.com", "*.example.com"]
1295 key: :banner_removal,
1296 type: {:list, :string},
1297 description: "List of instances to strip banners from",
1298 suggestions: ["example.com", "*.example.com"]
1305 label: "MRF subchain",
1308 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1309 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1314 description: "Matches a series of regular expressions against the actor field",
1317 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1325 key: :mrf_rejectnonpublic,
1327 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1328 label: "MRF reject non public",
1332 key: :allow_followersonly,
1333 label: "Allow followers-only",
1335 description: "whether to allow followers-only posts"
1340 description: "whether to allow direct messages"
1346 key: :mrf_hellthread,
1347 label: "MRF hellthread",
1349 description: "Block messages with too much mentions",
1352 key: :delist_threshold,
1355 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1356 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable",
1360 key: :reject_threshold,
1363 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable",
1371 label: "MRF keyword",
1373 description: "Reject or Word-Replace messages with a keyword or regex",
1377 type: [:string, :regex],
1379 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression",
1380 suggestions: ["foo", ~r/foo/iu]
1383 key: :federated_timeline_removal,
1384 type: [:string, :regex],
1386 "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",
1387 suggestions: ["foo", ~r/foo/iu]
1391 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1393 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1394 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1401 label: "MRF mention",
1403 description: "Block messages which mention a user",
1407 type: {:list, :string},
1408 description: "A list of actors, for which to drop any posts mentioning",
1409 suggestions: ["actor1", "actor2"]
1415 key: :mrf_vocabulary,
1416 label: "MRF vocabulary",
1418 description: "Filter messages which belong to certain activity vocabularies",
1422 type: {:list, :string},
1424 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1425 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1429 type: {:list, :string},
1431 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1432 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1438 # key: :mrf_user_allowlist,
1441 # "The keys in this section are the domain names that the policy should apply to." <>
1442 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1444 # ["example.org": ["https://example.org/users/admin"]],
1446 # ["example.org": ["https://example.org/users/admin"]]
1454 description: "Media proxy",
1459 description: "Enables proxying of remote media to the instance's proxy"
1465 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts",
1466 suggestions: ["https://example.com"]
1471 description: "Options for Pleroma.ReverseProxy",
1473 redirect_on_failure: false,
1474 max_body_length: 25 * 1_048_576,
1476 follow_redirect: true,
1482 key: :redirect_on_failure,
1485 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1486 "Any error during body processing will not be redirected as the response is chunked"
1489 key: :max_body_length,
1492 "limits the content length to be approximately the " <>
1493 "specified length. It is validated with the `content-length` header and also verified when proxying"
1498 description: "HTTP options",
1503 description: "Adapter specific options",
1508 label: "SSL Options",
1509 description: "SSL options for HTTP adapter",
1513 type: {:list, :atom},
1514 description: "List of TLS version to use",
1515 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1524 type: [:string, :tuple],
1525 description: "Proxy URL",
1526 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1534 type: {:list, :string},
1535 description: "List of domains to bypass the mediaproxy",
1536 suggestions: ["example.com"]
1544 description: "Gopher settings",
1549 description: "Enables the gopher interface"
1554 description: "IP address to bind to",
1555 suggestions: [{0, 0, 0, 0}]
1560 description: "Port to bind to",
1566 description: "Port advertised in urls (optional, defaults to port)",
1573 key: Pleroma.Web.Endpoint,
1575 description: "Phoenix endpoint configuration",
1580 type: {:keyword, :integer, :tuple},
1581 description: "http protocol configuration",
1589 type: {:list, :tuple},
1590 description: "dispatch settings",
1594 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1595 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1596 {Phoenix.Transports.WebSocket,
1597 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1598 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1600 # end copied from config.exs
1615 description: "port",
1625 type: {:keyword, :string, :integer},
1626 description: "configuration for generating urls",
1628 host: "example.com",
1636 description: "Host",
1644 description: "port",
1652 description: "Scheme",
1661 key: :instrumenters,
1662 type: {:list, :module},
1663 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1668 suggestions: ["https"]
1671 key: :secret_key_base,
1673 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1678 suggestions: ["CqaoopA2"]
1681 key: :render_errors,
1683 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1688 suggestions: [Pleroma.Web.ErrorView]
1692 type: {:list, :string},
1693 suggestions: ["json"]
1700 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1705 suggestions: [Pleroma.PubSub]
1710 suggestions: [Phoenix.PubSub.PG2]
1715 key: :secure_cookie_flag,
1719 key: :extra_cookie_attrs,
1720 type: {:list, :string},
1721 suggestions: ["SameSite=Lax"]
1729 description: "ActivityPub-related settings",
1732 key: :unfollow_blocked,
1734 description: "Whether blocks result in people getting unfollowed"
1737 key: :outgoing_blocks,
1739 description: "Whether to federate blocks to other instances"
1742 key: :sign_object_fetches,
1744 description: "Sign object fetches with HTTP signatures"
1747 key: :follow_handshake_timeout,
1749 description: "Following handshake timeout",
1756 key: :http_security,
1758 description: "HTTP security settings",
1763 description: "Whether the managed content security policy is enabled"
1769 description: "Whether to additionally send a Strict-Transport-Security header"
1773 label: "STS max age",
1775 description: "The maximum age for the Strict-Transport-Security header if sent",
1776 suggestions: [31_536_000]
1780 label: "CT max age",
1782 description: "The maximum age for the Expect-CT header if sent",
1783 suggestions: [2_592_000]
1786 key: :referrer_policy,
1788 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1789 suggestions: ["same-origin", "no-referrer"]
1793 label: "Report URI",
1795 description: "Adds the specified url to report-uri and report-to group in CSP header",
1796 suggestions: ["https://example.com/report-uri"]
1801 group: :web_push_encryption,
1802 key: :vapid_details,
1805 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1811 "a mailto link for the administrative contact." <>
1812 " 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," <>
1813 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can",
1814 suggestions: ["Subject"]
1819 description: "VAPID public key",
1820 suggestions: ["Public key"]
1825 description: "VAPID private keyn",
1826 suggestions: ["Private key"]
1832 key: Pleroma.Captcha,
1834 description: "Captcha-related settings",
1839 description: "Whether the captcha should be shown on registration"
1844 description: "The method/service to use for captcha",
1845 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1848 key: :seconds_valid,
1850 description: "The time in seconds for which the captcha is valid",
1857 key: Pleroma.Captcha.Kocaptcha,
1860 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1861 " here: https://github.com/koto-bank/kocaptcha. The default endpoint https://captcha.kotobank.ch is hosted by the developer",
1866 description: "the kocaptcha endpoint to use",
1867 suggestions: ["https://captcha.kotobank.ch"]
1875 "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",
1880 description: "Token",
1881 suggestions: ["some_random_token"]
1886 group: :pleroma_job_queue,
1889 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1893 key: Pleroma.Web.Federator.RetryQueue,
1895 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1900 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1909 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1911 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1912 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1913 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1914 (see https://github.com/sorentwo/oban/issues/52).
1920 description: "Application's Ecto repo",
1921 suggestions: [Pleroma.Repo]
1926 description: "Logs verbose mode"
1930 type: [:atom, :tuple],
1932 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1933 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1937 type: {:keyword, :integer},
1939 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1941 activity_expiration: 10,
1943 federator_incoming: 50,
1944 federator_outgoing: 50,
1946 scheduled_activities: 10,
1952 key: :activity_expiration,
1954 description: "Activity expiration queue",
1960 description: "Background queue",
1964 key: :federator_incoming,
1966 description: "Incoming federation queue",
1970 key: :federator_outgoing,
1972 description: "Outgoing federation queue",
1978 description: "Email sender queue, see Pleroma.Emails.Mailer",
1982 key: :scheduled_activities,
1984 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1988 key: :transmogrifier,
1990 description: "Transmogrifier queue",
1996 description: "Web push notifications queue",
2007 description: "Includes custom worker options not interpretable directly by `Oban`",
2011 type: {:keyword, :integer},
2012 description: "Max retry attempts for failed jobs, per `Oban` queue",
2014 federator_incoming: 5,
2015 federator_outgoing: 5
2022 key: Pleroma.Web.Metadata,
2024 description: "Metadata-related settings",
2028 type: {:list, :module},
2029 description: "List of metadata providers to enable",
2031 Pleroma.Web.Metadata.Providers.OpenGraph,
2032 Pleroma.Web.Metadata.Providers.TwitterCard,
2033 Pleroma.Web.Metadata.Providers.RelMe,
2034 Pleroma.Web.Metadata.Providers.Feed
2039 label: "Unfurl NSFW",
2041 description: "If set to true nsfw attachments will be shown in previews"
2050 "If enabled the instance will parse metadata from attached links to generate link previews.",
2055 description: "Enables/disables RichMedia."
2059 type: {:list, :string},
2060 description: "List of hosts which will be ignored by the metadata parser.",
2061 suggestions: ["accounts.google.com", "xss.website"]
2065 label: "Ignore TLD",
2066 type: {:list, :string},
2067 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2068 suggestions: ["local", "localdomain", "lan"]
2072 type: {:list, :module},
2073 description: "List of Rich Media parsers.",
2075 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2076 Pleroma.Web.RichMedia.Parsers.OEmbed,
2077 Pleroma.Web.RichMedia.Parsers.OGP,
2078 Pleroma.Web.RichMedia.Parsers.TwitterCard
2083 label: "TTL setters",
2084 type: {:list, :module},
2085 description: "List of rich media ttl setters.",
2087 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2094 key: :fetch_initial_posts,
2096 description: "Fetching initial posts settings",
2102 "if enabled, when a new user is federated with, fetch some of their latest posts"
2107 description: "the amount of pages to fetch",
2113 group: :auto_linker,
2116 description: "Configuration for the auto_linker library",
2120 type: [:string, false],
2121 description: "specify the class to be added to the generated link. false to clear",
2122 suggestions: ["auto-linker", false]
2126 type: [:string, false],
2127 description: "override the rel attribute. false to clear",
2128 suggestions: ["ugc", "noopener noreferrer", false]
2133 description: "set to false to remove target='_blank' attribute"
2138 description: "Set to true to link urls with schema http://google.com"
2142 type: [:integer, false],
2144 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2145 suggestions: [15, false]
2150 description: "Strip the scheme prefix"
2155 description: "link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2161 key: Pleroma.ScheduledActivity,
2163 description: "Scheduled activities settings",
2166 key: :daily_user_limit,
2169 "the number of scheduled activities a user is allowed to create in a single day (Default: 25)",
2173 key: :total_user_limit,
2176 "the number of scheduled activities a user is allowed to create in total (Default: 300)",
2182 description: "whether scheduled activities are sent to the job queue to be executed"
2188 key: Pleroma.ActivityExpiration,
2190 description: "Expired activity settings",
2195 description: "whether expired activities will be sent to the job queue to be deleted"
2202 description: "Authenticator",
2205 key: Pleroma.Web.Auth.Authenticator,
2207 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2216 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2217 " will be verified by trying to authenticate (bind) to an LDAP server." <>
2218 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2219 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2224 description: "enables LDAP authentication"
2229 description: "LDAP server hostname",
2230 suggestions: ["localhosts"]
2235 description: "LDAP port, e.g. 389 or 636",
2236 suggestions: [389, 636]
2242 description: "true to use SSL, usually implies the port 636"
2246 label: "SSL options",
2248 description: "additional SSL options",
2249 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2254 description: "Path to file with PEM encoded cacerts",
2255 suggestions: ["path/to/file/with/PEM/cacerts"]
2260 description: "Type of cert verification",
2261 suggestions: [:verify_peer]
2269 description: "true to start TLS, usually implies the port 389"
2273 label: "TLS options",
2275 description: "additional TLS options",
2276 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2281 description: "Path to file with PEM encoded cacerts",
2282 suggestions: ["path/to/file/with/PEM/cacerts"]
2287 description: "Type of cert verification",
2288 suggestions: [:verify_peer]
2295 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2296 suggestions: ["dc=example,dc=com"]
2302 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2311 description: "Authentication / authorization settings",
2314 key: :enforce_oauth_admin_scope_usage,
2317 "OAuth admin scope requirement toggle. " <>
2318 "If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2319 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2320 "`is_admin` user flag grants access to admin-specific actions."
2323 key: :auth_template,
2326 "authentication form template. By default it's show.html which corresponds to lib/pleroma/web/templates/o_auth/o_auth/show.html.ee",
2327 suggestions: ["show.html"]
2330 key: :oauth_consumer_template,
2333 "OAuth consumer mode authentication form template. By default it's consumer.html which corresponds to" <>
2334 " lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex",
2335 suggestions: ["consumer.html"]
2338 key: :oauth_consumer_strategies,
2339 type: {:list, :string},
2341 "the list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2342 " Each entry in this space-delimited string should be of format <strategy> or <strategy>:<dependency>" <>
2343 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2344 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2350 key: :email_notifications,
2352 description: "Email notifications settings",
2358 "emails of \"what you've missed\" for users who have been inactive for a while",
2362 schedule: "0 0 * * 0",
2364 inactivity_threshold: 7
2371 description: "globally enable or disable digest emails"
2377 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\"",
2378 suggestions: ["0 0 * * 0"]
2383 description: "Minimum interval between digest emails to one user",
2387 key: :inactivity_threshold,
2389 description: "Minimum user inactivity threshold",
2398 key: Pleroma.Emails.UserEmail,
2400 description: "Email template settings",
2405 description: "a path to a custom logo. Set it to nil to use the default Pleroma logo",
2406 suggestions: ["some/path/logo.png"]
2411 description: "a map with color settings for email templates.",
2414 link_color: "#d8a070",
2415 background_color: "#2C3645",
2416 content_background_color: "#1B2635",
2417 header_color: "#d8a070",
2418 text_color: "#b9b9ba",
2419 text_muted_color: "#b9b9ba"
2426 suggestions: ["#d8a070"]
2429 key: :background_color,
2431 suggestions: ["#2C3645"]
2434 key: :content_background_color,
2436 suggestions: ["#1B2635"]
2441 suggestions: ["#d8a070"]
2446 suggestions: ["#b9b9ba"]
2449 key: :text_muted_color,
2451 suggestions: ["#b9b9ba"]
2461 description: "Configure OAuth 2 provider capabilities",
2464 key: :token_expires_in,
2466 description: "The lifetime in seconds of the access token",
2470 key: :issue_new_refresh_token,
2473 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2476 key: :clean_expired_tokens,
2478 description: "Enable a background job to clean expired oauth tokens. Defaults to false"
2481 key: :clean_expired_tokens_interval,
2484 "Interval to run the job to clean expired tokens. Defaults to 86_400_000 (24 hours).",
2485 suggestions: [86_400_000]
2495 key: :shortcode_globs,
2496 type: {:list, :string},
2497 description: "Location of custom emoji files. * can be used as a wildcard",
2498 suggestions: ["/emoji/custom/**/*.png"]
2501 key: :pack_extensions,
2502 type: {:list, :string},
2504 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2505 suggestions: [".png", ".gif"]
2509 type: {:keyword, :string, {:list, :string}},
2511 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the groupname" <>
2512 " and the value the location or array of locations. * can be used as a wildcard",
2514 # Put groups that have higher priority than defaults here. Example in `docs/config/custom_emoji.md`
2515 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2519 key: :default_manifest,
2522 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2523 " Currently only one manifest can be added (no arrays)",
2524 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2527 key: :shared_pack_cache_seconds_per_file,
2530 "When an emoji pack is shared, the archive is created and cached in memory" <>
2531 " for this amount of seconds multiplied by the number of files.",
2540 description: "Database related settings",
2545 description: "If RUM indexes should be used. Defaults to false"
2554 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2558 type: [:tuple, {:list, :tuple}],
2559 description: "for the search requests (account & status search etc.)",
2560 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2563 key: :app_account_creation,
2564 type: [:tuple, {:list, :tuple}],
2565 description: "for registering user accounts from the same IP address",
2566 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2569 key: :relations_actions,
2570 type: [:tuple, {:list, :tuple}],
2571 description: "for actions on relations with all users (follow, unfollow)",
2572 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2575 key: :relation_id_action,
2576 type: [:tuple, {:list, :tuple}],
2577 description: "for actions on relation with a specific user (follow, unfollow)",
2578 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2581 key: :statuses_actions,
2582 type: [:tuple, {:list, :tuple}],
2584 "for create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2585 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2588 key: :status_id_action,
2589 type: [:tuple, {:list, :tuple}],
2591 "for fav / unfav or reblog / unreblog actions on the same status by the same user",
2592 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2595 key: :authentication,
2596 type: [:tuple, {:list, :tuple}],
2597 description: "for authentication create / password check / user existence check requests",
2598 suggestions: [{60_000, 15}]
2606 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2607 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2612 description: "Enables ssh"
2617 description: "Dir with ssh keys",
2618 suggestions: ["/some/path/ssh_keys"]
2623 description: "Handler module",
2624 suggestions: ["Pleroma.BBS.Handler"]
2629 description: "Port to connect",
2630 suggestions: [10_022]
2633 key: :password_authenticator,
2635 description: "Authenticator module",
2636 suggestions: ["Pleroma.BBS.Authenticator"]
2643 description: "Mime types",
2650 "application/xml" => ["xml"],
2651 "application/xrd+xml" => ["xrd+xml"],
2652 "application/jrd+json" => ["jrd+json"],
2653 "application/activity+json" => ["activity+json"],
2654 "application/ld+json" => ["activity+json"]
2659 key: "application/xml",
2660 type: {:list, :string},
2661 suggestions: ["xml"]
2664 key: "application/xrd+xml",
2665 type: {:list, :string},
2666 suggestions: ["xrd+xml"]
2669 key: "application/jrd+json",
2670 type: {:list, :string},
2671 suggestions: ["jrd+json"]
2674 key: "application/activity+json",
2675 type: {:list, :string},
2676 suggestions: ["activity+json"]
2679 key: "application/ld+json",
2680 type: {:list, :string},
2681 suggestions: ["activity+json"]
2690 description: "Tesla settings",
2695 description: "Tesla adapter",
2696 suggestions: [Tesla.Adapter.Hackney]
2704 description: "Pleroma chat settings",
2720 description: "Enables suggestions"
2723 key: :third_party_engine,
2725 description: "URL for third party engine",
2727 "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}"
2733 description: "Request timeout to third party engine",
2734 suggestions: [300_000]
2739 description: "Limit for suggestions",
2745 suggestions: ["https://vinayaka.distsn.org"]
2751 key: Pleroma.Web.Endpoint.MetricsExporter,
2753 description: "Prometheus settings",
2758 description: "API endpoint with metrics",
2759 suggestions: ["/api/pleroma/app_metrics"]
2764 group: :http_signatures,
2766 description: "HTTP Signatures settings",
2771 suggestions: [Pleroma.Signature]
2777 key: Pleroma.Uploaders.MDII,
2779 "Uploader for https://github.com/hakaba-hitoyo/minimal-digital-image-infrastructure",
2785 suggestions: ["https://mdii.sakura.ne.jp/mdii-post.cgi"]
2790 suggestions: ["https://mdii.sakura.ne.jp"]
2798 description: "HTTP settings",
2803 type: [:string, :tuple],
2804 description: "Proxy URL",
2805 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2808 key: :send_user_agent,
2813 type: [:string, :atom],
2815 "what user agent should we use? (default: `:default`), must be string or `:default`",
2816 suggestions: ["Pleroma", :default]
2821 description: "Adapter specific options",
2827 label: "SSL Options",
2828 description: "SSL options for HTTP adapter",
2832 type: {:list, :atom},
2833 description: "List of TLS version to use",
2834 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2848 key: :allow_inline_images,
2852 key: :allow_headings,
2865 type: {:list, :module},
2866 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2876 key: :deny_follow_blocked,
2883 key: :mrf_normalize_markup,
2884 label: "MRF normalize markup",
2885 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2891 suggestions: [Pleroma.HTML.Scrubber.Default]
2901 key: :restricted_nicknames,
2902 type: {:list, :string},
2921 "ostatus_subscribe",
2945 suggestions: [86_400]
2949 type: {:list, :string},
2950 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2954 type: {:list, :string},
2957 "X-RateLimit-Reset",
2958 "X-RateLimit-Limit",
2959 "X-RateLimit-Remaining",
2970 type: {:list, :string},
2971 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2977 key: Pleroma.Plugs.RemoteIp,
2980 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2981 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2987 description: "Enable/disable the plug. Defaults to `false`."
2991 type: {:list, :string},
2993 "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]`."
2997 type: {:list, :string},
2999 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Defaults to `[]`."
3003 type: {:list, :string},
3005 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3011 key: :web_cache_ttl,
3014 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3020 "activity pub routes (except question activities). Defaults to `nil` (no expiration).",
3021 suggestions: [30_000]
3024 key: :activity_pub_question,
3027 "activity pub routes (question activities). Defaults to `30_000` (30 seconds).",
3028 suggestions: [30_000]
3037 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3042 description: "Enables the rendering of static HTML. Defaults to `false`."
3050 description: "Configure feed rendering.",
3055 description: "Configure title rendering.",
3060 description: "Maximum number of characters before truncating title.",
3066 description: "Replacement which will be used after truncating string.",
3067 suggestions: ["..."]
3075 key: :mrf_object_age,
3077 description: "Rejects or delists posts based on their age when received.",
3082 description: "Required age (in seconds) of a post before actions are taken.",
3083 suggestions: [172_800]
3087 type: {:list, :atom},
3089 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3090 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3091 "`:reject` rejects the message entirely",
3092 suggestions: [:delist, :strip_followers, :reject]
3100 description: "Custom Runtime Modules.",
3105 description: "A path to custom Elixir modules (such as MRF policies)."
3112 description: "Allow instance configuration from database.",
3115 key: :configurable_from_database,
3118 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"