2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
26 suggestions: [Pleroma.Uploaders.Local, Pleroma.Uploaders.S3]
30 type: {:list, :module},
31 description: "List of filter modules for uploads",
33 Generator.list_modules_in_dir(
34 "lib/pleroma/upload/filter",
35 "Elixir.Pleroma.Upload.Filter."
42 "If enabled, a name parameter will be added to the url of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
47 description: "Base url for the uploads, needed if you use CDN",
49 "https://cdn-host.com"
56 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
61 description: "Options for Pleroma.ReverseProxy",
63 redirect_on_failure: false,
64 max_body_length: 25 * 1_048_576,
66 follow_redirect: true,
72 key: :redirect_on_failure,
75 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
76 "Any error during body processing will not be redirected as the response is chunked."
79 key: :max_body_length,
82 "Limits the content length to be approximately the " <>
83 "specified length. It is validated with the `content-length` header and also verified when proxying."
88 description: "HTTP options",
93 description: "Adapter specific options",
99 description: "SSL options for HTTP adapter",
103 type: {:list, :atom},
104 description: "List of TLS version to use",
105 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
114 type: [:string, :tuple],
115 description: "Proxy URL",
116 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
126 key: Pleroma.Uploaders.Local,
128 description: "Local uploader-related settings",
133 description: "Path where user's uploads will be saved",
142 key: Pleroma.Uploaders.S3,
144 description: "S3 uploader-related settings",
149 description: "S3 bucket",
155 key: :bucket_namespace,
157 description: "S3 bucket namespace",
158 suggestions: ["pleroma"]
161 key: :public_endpoint,
163 description: "S3 endpoint",
164 suggestions: ["https://s3.amazonaws.com"]
167 key: :truncated_namespace,
170 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
171 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
174 key: :streaming_enabled,
177 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
183 key: Pleroma.Upload.Filter.Mogrify,
185 description: "Uploads mogrify filter settings",
189 type: [:string, {:list, :string}, {:list, :tuple}],
190 description: "List of actions for the mogrify command",
201 key: Pleroma.Upload.Filter.AnonymizeFilename,
203 description: "Filter replaces the filename of the upload",
209 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
210 " filename extension by using {extension}, for example custom-file-name.{extension}.",
212 "custom-file-name.{extension}"
219 key: Pleroma.Emails.Mailer,
221 description: "Mailer-related settings",
227 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
228 " or Swoosh.Adapters.Local for in-memory mailbox",
230 Swoosh.Adapters.SMTP,
231 Swoosh.Adapters.Sendgrid,
232 Swoosh.Adapters.Sendmail,
233 Swoosh.Adapters.Mandrill,
234 Swoosh.Adapters.Mailgun,
235 Swoosh.Adapters.Mailjet,
236 Swoosh.Adapters.Postmark,
237 Swoosh.Adapters.SparkPost,
238 Swoosh.Adapters.AmazonSES,
240 Swoosh.Adapters.SocketLabs,
241 Swoosh.Adapters.Gmail,
242 Swoosh.Adapters.Local
248 description: "Allow/disallow send emails"
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
255 suggestions: ["smtp.gmail.com"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
262 suggestions: ["pleroma"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
283 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
284 suggestions: [:always, :never, :if_available]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
291 suggestions: [:always, :never, :if_available]
294 group: {:subgroup, Swoosh.Adapters.SMTP},
297 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
301 group: {:subgroup, Swoosh.Adapters.SMTP},
304 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
308 group: {:subgroup, Swoosh.Adapters.SMTP},
310 label: "No MX lookups",
312 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
315 group: {:subgroup, Swoosh.Adapters.Sendgrid},
319 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
320 suggestions: ["my-api-key"]
323 group: {:subgroup, Swoosh.Adapters.Sendmail},
326 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
327 suggestions: ["/usr/bin/sendmail"]
330 group: {:subgroup, Swoosh.Adapters.Sendmail},
333 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
334 suggestions: ["-N delay,failure,success"]
337 group: {:subgroup, Swoosh.Adapters.Sendmail},
340 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
343 group: {:subgroup, Swoosh.Adapters.Mandrill},
347 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
348 suggestions: ["my-api-key"]
351 group: {:subgroup, Swoosh.Adapters.Mailgun},
355 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
356 suggestions: ["my-api-key"]
359 group: {:subgroup, Swoosh.Adapters.Mailgun},
362 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
363 suggestions: ["pleroma.com"]
366 group: {:subgroup, Swoosh.Adapters.Mailjet},
370 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
371 suggestions: ["my-api-key"]
374 group: {:subgroup, Swoosh.Adapters.Mailjet},
377 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
378 suggestions: ["my-secret-key"]
381 group: {:subgroup, Swoosh.Adapters.Postmark},
385 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
386 suggestions: ["my-api-key"]
389 group: {:subgroup, Swoosh.Adapters.SparkPost},
393 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
394 suggestions: ["my-api-key"]
397 group: {:subgroup, Swoosh.Adapters.SparkPost},
400 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
401 suggestions: ["https://api.sparkpost.com/api/v1"]
404 group: {:subgroup, Swoosh.Adapters.AmazonSES},
407 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
408 suggestions: ["us-east-1", "us-east-2"]
411 group: {:subgroup, Swoosh.Adapters.AmazonSES},
414 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
415 suggestions: ["aws-access-key"]
418 group: {:subgroup, Swoosh.Adapters.AmazonSES},
421 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
422 suggestions: ["aws-secret-key"]
425 group: {:subgroup, Swoosh.Adapters.Dyn},
429 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
430 suggestions: ["my-api-key"]
433 group: {:subgroup, Swoosh.Adapters.SocketLabs},
436 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
439 group: {:subgroup, Swoosh.Adapters.SocketLabs},
443 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
446 group: {:subgroup, Swoosh.Adapters.Gmail},
449 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
456 description: "`Swoosh.Adapters.Local` adapter specific settings",
459 group: {:subgroup, Swoosh.Adapters.Local},
462 description: "Run the preview server together as part of your app"
465 group: {:subgroup, Swoosh.Adapters.Local},
468 description: "The preview server port",
477 description: "URI schemes related settings",
481 type: {:list, :string},
482 description: "List of the scheme part that is considered valid to be an URL",
506 description: "Instance-related settings",
511 description: "Name of the instance",
518 label: "Admin Email Address",
520 description: "Email used to reach an Administrator/Moderator of the instance",
527 label: "Sender Email Address",
529 description: "Envelope FROM address for mail sent via Pleroma",
537 description: "The instance's description, can be seen in nodeinfo and /api/v1/instance",
545 description: "Posts character limit (CW/Subject included in the counter)",
553 description: "Character limit of the instance chat messages",
561 description: "Hard character limit beyond which remote posts will be dropped",
569 description: "File size limit of uploads (except for avatar, background, banner)",
575 key: :avatar_upload_limit,
577 description: "File size limit of user's profile avatars",
583 key: :background_upload_limit,
585 description: "File size limit of user's profile backgrounds",
591 key: :banner_upload_limit,
593 description: "File size limit of user's profile banners",
601 description: "A map with poll limits for local polls",
605 max_option_chars: 200,
607 max_expiration: 31_536_000
614 description: "Maximum number of options",
618 key: :max_option_chars,
620 description: "Maximum number of characters per option",
624 key: :min_expiration,
626 description: "Minimum expiration time (in seconds)",
630 key: :max_expiration,
632 description: "Maximum expiration time (in seconds)",
638 key: :registrations_open,
640 description: "Enable registrations for anyone, invitations can be enabled when `false`"
643 key: :invites_enabled,
645 description: "Enable user invitations for admins (depends on `registrations_open: false`)"
648 key: :account_activation_required,
650 description: "Require users to confirm their emails before signing in"
655 description: "Enable federation with other instances"
658 key: :federation_incoming_replies_max_depth,
659 label: "Fed. incoming replies max depth",
662 "Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while" <>
663 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
669 key: :federation_reachability_timeout_days,
670 label: "Fed. reachability timeout days",
673 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
679 key: :federation_publisher_modules,
680 type: {:list, :module},
681 description: "List of modules for federation publishing",
683 Pleroma.Web.ActivityPub.Publisher
689 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
692 key: :rewrite_policy,
693 type: [:module, {:list, :module}],
694 description: "A list of MRF policies enabled",
696 Generator.list_modules_in_dir(
697 "lib/pleroma/web/activity_pub/mrf",
698 "Elixir.Pleroma.Web.ActivityPub.MRF."
705 "Makes the client API in authentificated mode-only except for user-profiles." <>
706 " Useful for disabling the Local Timeline and The Whole Known Network."
709 key: :quarantined_instances,
710 type: {:list, :string},
712 "List of ActivityPub instances where private (DMs, followers-only) activities will not be send",
719 key: :managed_config,
722 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
727 description: "Instance static directory",
733 key: :allowed_post_formats,
734 type: {:list, :string},
735 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
744 key: :mrf_transparency,
745 label: "MRF transparency",
748 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
751 key: :mrf_transparency_exclusions,
752 label: "MRF transparency exclusions",
753 type: {:list, :string},
755 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
761 key: :extended_nickname_format,
764 "Set to `true` to use extended local nicknames format (allows underscores/dashes)." <>
765 " This will break federation with older software for theses nicknames."
768 key: :max_pinned_statuses,
770 description: "The maximum number of pinned statuses. 0 will disable the feature.",
778 key: :autofollowed_nicknames,
779 type: {:list, :string},
781 "Set to nicknames of (local) users that every new user should automatically follow",
790 key: :no_attachment_links,
793 "Set to `true` to disable automatically adding attachment link text to statuses"
796 key: :welcome_message,
799 "A message that will be sent to a newly registered users as a direct message",
801 "Hi, @username! Welcome on board!"
805 key: :welcome_user_nickname,
807 description: "The nickname of the local user that sends the welcome message",
813 key: :max_report_comment_size,
815 description: "The maximum size of the report comment. Default: 1000.",
821 key: :safe_dm_mentions,
824 "If set to `true`, only mentions at the beginning of a post will be used to address people in direct messages." <>
825 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
831 description: "If set to `true`, system data will be shown on /api/pleroma/healthcheck"
834 key: :remote_post_retention_days,
837 "The default amount of days to retain remote posts when pruning the database",
843 key: :user_bio_length,
845 description: "A user bio maximum length. Default: 5000.",
851 key: :user_name_length,
853 description: "A user name maximum length. Default: 100.",
859 key: :skip_thread_containment,
861 description: "Skip filter out broken threads. Default: `true`"
864 key: :limit_to_local_content,
865 type: [:atom, false],
867 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
875 key: :max_account_fields,
877 description: "The maximum number of custom fields in the user profile. Default: 10.",
883 key: :max_remote_account_fields,
886 "The maximum number of custom fields in the remote user profile. Default: 20.",
892 key: :account_field_name_length,
894 description: "An account field name maximum length. Default: 512.",
900 key: :account_field_value_length,
902 description: "An account field value maximum length. Default: 2048.",
908 key: :external_user_synchronization,
910 description: "Enabling following/followers counters synchronization for external users"
917 description: "Logger-related settings",
921 type: [:atom, :tuple, :module],
923 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
924 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
932 description: "ExSyslogger-related settings",
937 description: "Log level",
938 suggestions: [:debug, :info, :warn, :error]
944 "A string that's prepended to every message, and is typically set to the app name",
945 suggestions: ["pleroma"]
950 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
951 suggestions: ["$metadata[$level] $message"]
955 type: {:list, :atom},
956 suggestions: [:request_id]
964 description: "Console logger settings",
969 description: "Log level",
970 suggestions: [:debug, :info, :warn, :error]
975 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
976 suggestions: ["$metadata[$level] $message"]
980 type: {:list, :atom},
981 suggestions: [:request_id]
988 description: "Quack-related settings",
993 description: "Log level",
994 suggestions: [:debug, :info, :warn, :error]
998 type: {:list, :atom},
999 description: "Configure which metadata you want to report on",
1017 description: "Configure the Slack incoming webhook",
1018 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1024 key: :frontend_configurations,
1027 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1028 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1029 "add your own configuration your settings all fields must be complete.",
1033 label: "Pleroma FE",
1035 description: "Settings for Pleroma FE",
1038 theme: "pleroma-dark",
1039 logo: "/static/logo.png",
1040 background: "/images/city.jpg",
1041 redirectRootNoLogin: "/main/all",
1042 redirectRootLogin: "/main/friends",
1043 showInstanceSpecificPanel: true,
1044 scopeOptionsEnabled: false,
1045 formattingOptionsEnabled: false,
1046 collapseMessageWithSubject: false,
1047 hidePostStats: false,
1048 hideUserStats: false,
1050 subjectLineBehavior: "email",
1051 alwaysShowSubjectInput: true,
1055 enableEmojiPicker: false
1062 description: "Which theme to use, they are defined in styles.json",
1063 suggestions: ["pleroma-dark"]
1068 description: "URL of the logo, defaults to Pleroma's logo",
1069 suggestions: ["/static/logo.png"]
1075 "URL of the background, unless viewing a user profile with a background that is set",
1076 suggestions: ["/images/city.jpg"]
1079 key: :redirectRootNoLogin,
1080 label: "Redirect root no login",
1083 "Relative URL which indicates where to redirect when a user isn't logged in",
1084 suggestions: ["/main/all"]
1087 key: :redirectRootLogin,
1088 label: "Redirect root login",
1091 "Relative URL which indicates where to redirect when a user is logged in",
1092 suggestions: ["/main/friends"]
1095 key: :showInstanceSpecificPanel,
1096 label: "Show instance specific panel",
1098 description: "Whenether to show the instance's specific panel"
1101 key: :scopeOptionsEnabled,
1102 label: "Scope options enabled",
1104 description: "Enable setting a notice visibility and subject/CW when posting"
1107 key: :formattingOptionsEnabled,
1108 label: "Formatting options enabled",
1111 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1114 key: :collapseMessageWithSubject,
1115 label: "Collapse message with subject",
1118 "When a message has a subject (aka Content Warning), collapse it by default"
1121 key: :hidePostStats,
1122 label: "Hide post stats",
1124 description: "Hide notices statistics (repeats, favorites, ...)"
1127 key: :hideUserStats,
1128 label: "Hide user stats",
1131 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1135 label: "Scope copy",
1137 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1140 key: :subjectLineBehavior,
1141 label: "Subject line behavior",
1143 description: "Allows changing the default behaviour of subject lines in replies.
1144 `email`: copy and preprend re:, as in email,
1145 `masto`: copy verbatim, as in Mastodon,
1146 `noop`: don't copy the subject.",
1147 suggestions: ["email", "masto", "noop"]
1150 key: :alwaysShowSubjectInput,
1151 label: "Always show subject input",
1153 description: "When set to `false`, auto-hide the subject field when it's empty"
1160 "By default it assumes logo used will be monochrome-with-alpha one, this is done to be compatible with both light and dark themes, " <>
1161 "so that white logo designed with dark theme in mind won't be invisible over light theme, this is done via CSS3 Masking. " <>
1162 "Basically - it will take alpha channel of the image and fill non-transparent areas of it with solid color. " <>
1163 "If you really want colorful logo - it can be done by setting logoMask to false."
1167 label: "Logo margin",
1170 "allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1171 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1172 suggestions: [".1em"]
1177 description: "Enables/disables stickers."
1180 key: :enableEmojiPicker,
1181 label: "Emoji picker",
1183 description: "Enables/disables emoji picker."
1191 description: "Settings for Masto FE",
1194 showInstanceSpecificPanel: true
1199 key: :showInstanceSpecificPanel,
1200 label: "Show instance specific panel",
1202 description: "Whenether to show the instance's specific panel"
1213 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1217 type: {:keyword, :map},
1219 "Keyword of mascots, each element must contain both an url and a mime_type key",
1222 url: "/images/pleroma-fox-tan-smol.png",
1223 mime_type: "image/png"
1225 pleroma_fox_tan_shy: %{
1226 url: "/images/pleroma-fox-tan-shy.png",
1227 mime_type: "image/png"
1232 key: :default_mascot,
1235 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1247 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1251 type: {:list, :map},
1252 description: "Describe the icons of the app",
1255 src: "/static/logo.png"
1258 src: "/static/icon.png",
1262 src: "/static/icon.ico",
1263 sizes: "72x72 96x96 128x128 256x256"
1270 description: "Describe the theme color of the app",
1271 suggestions: ["#282c37", "mediumpurple"]
1274 key: :background_color,
1276 description: "Describe the background color of the app",
1277 suggestions: ["#191b22", "aliceblue"]
1284 label: "MRF simple",
1286 description: "Message Rewrite Facility",
1289 key: :media_removal,
1290 type: {:list, :string},
1291 description: "List of instances to remove medias from",
1292 suggestions: ["example.com", "*.example.com"]
1296 label: "Media NSFW",
1297 type: {:list, :string},
1298 description: "List of instances to put medias as NSFW (sensitive) from",
1299 suggestions: ["example.com", "*.example.com"]
1302 key: :federated_timeline_removal,
1303 type: {:list, :string},
1305 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1306 suggestions: ["example.com", "*.example.com"]
1310 type: {:list, :string},
1311 description: "List of instances to reject any activities from",
1312 suggestions: ["example.com", "*.example.com"]
1316 type: {:list, :string},
1317 description: "List of instances to accept any activities from",
1318 suggestions: ["example.com", "*.example.com"]
1321 key: :report_removal,
1322 type: {:list, :string},
1323 description: "List of instances to reject reports from",
1324 suggestions: ["example.com", "*.example.com"]
1327 key: :avatar_removal,
1328 type: {:list, :string},
1329 description: "List of instances to strip avatars from",
1330 suggestions: ["example.com", "*.example.com"]
1333 key: :banner_removal,
1334 type: {:list, :string},
1335 description: "List of instances to strip banners from",
1336 suggestions: ["example.com", "*.example.com"]
1343 label: "MRF subchain",
1346 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1347 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1352 description: "Matches a series of regular expressions against the actor field",
1355 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1363 key: :mrf_rejectnonpublic,
1365 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1366 label: "MRF reject non public",
1370 key: :allow_followersonly,
1371 label: "Allow followers-only",
1373 description: "Whether to allow followers-only posts"
1378 description: "Whether to allow direct messages"
1384 key: :mrf_hellthread,
1385 label: "MRF hellthread",
1387 description: "Block messages with too much mentions",
1390 key: :delist_threshold,
1393 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1394 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1398 key: :reject_threshold,
1401 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1409 label: "MRF keyword",
1411 description: "Reject or Word-Replace messages with a keyword or regex",
1415 type: [:string, :regex],
1417 "A list of patterns which result in message being rejected, each pattern can be a string or a regular expression.",
1418 suggestions: ["foo", ~r/foo/iu]
1421 key: :federated_timeline_removal,
1422 type: [:string, :regex],
1424 "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.",
1425 suggestions: ["foo", ~r/foo/iu]
1429 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1431 "A list of tuples containing {pattern, replacement}, pattern can be a string or a regular expression.",
1432 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1439 label: "MRF mention",
1441 description: "Block messages which mention a user",
1445 type: {:list, :string},
1446 description: "A list of actors, for which to drop any posts mentioning",
1447 suggestions: ["actor1", "actor2"]
1453 key: :mrf_vocabulary,
1454 label: "MRF vocabulary",
1456 description: "Filter messages which belong to certain activity vocabularies",
1460 type: {:list, :string},
1462 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1463 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1467 type: {:list, :string},
1469 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1470 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1476 # key: :mrf_user_allowlist,
1479 # "The keys in this section are the domain names that the policy should apply to." <>
1480 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1482 # ["example.org": ["https://example.org/users/admin"]],
1484 # ["example.org": ["https://example.org/users/admin"]]
1492 description: "Media proxy",
1497 description: "Enables proxying of remote media to the instance's proxy"
1503 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1504 suggestions: ["https://example.com"]
1509 description: "Options for Pleroma.ReverseProxy",
1511 redirect_on_failure: false,
1512 max_body_length: 25 * 1_048_576,
1514 follow_redirect: true,
1520 key: :redirect_on_failure,
1523 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1524 "Any error during body processing will not be redirected as the response is chunked."
1527 key: :max_body_length,
1530 "Limits the content length to be approximately the " <>
1531 "specified length. It is validated with the `content-length` header and also verified when proxying."
1536 description: "HTTP options",
1541 description: "Adapter specific options",
1546 label: "SSL Options",
1547 description: "SSL options for HTTP adapter",
1551 type: {:list, :atom},
1552 description: "List of TLS version to use",
1553 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1562 type: [:string, :tuple],
1563 description: "Proxy URL",
1564 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1572 type: {:list, :string},
1573 description: "List of domains to bypass the mediaproxy",
1574 suggestions: ["example.com"]
1582 description: "Gopher settings",
1587 description: "Enables the gopher interface"
1592 description: "IP address to bind to",
1593 suggestions: [{0, 0, 0, 0}]
1598 description: "Port to bind to",
1604 description: "Port advertised in urls (optional, defaults to port)",
1611 key: Pleroma.Web.Endpoint,
1613 description: "Phoenix endpoint configuration",
1618 type: {:keyword, :integer, :tuple},
1619 description: "http protocol configuration",
1627 type: {:list, :tuple},
1628 description: "dispatch settings",
1632 {"/api/v1/streaming", Pleroma.Web.MastodonAPI.WebsocketHandler, []},
1633 {"/websocket", Phoenix.Endpoint.CowboyWebSocket,
1634 {Phoenix.Transports.WebSocket,
1635 {Pleroma.Web.Endpoint, Pleroma.Web.UserSocket, websocket_config}}},
1636 {:_, Phoenix.Endpoint.Cowboy2Handler, {Pleroma.Web.Endpoint, []}}
1638 # end copied from config.exs
1653 description: "port",
1663 type: {:keyword, :string, :integer},
1664 description: "configuration for generating urls",
1666 host: "example.com",
1674 description: "Host",
1682 description: "port",
1690 description: "Scheme",
1699 key: :instrumenters,
1700 type: {:list, :module},
1701 suggestions: [Pleroma.Web.Endpoint.Instrumenter]
1706 suggestions: ["https"]
1709 key: :secret_key_base,
1711 suggestions: ["aK4Abxf29xU9TTDKre9coZPUgevcVCFQJe/5xP/7Lt4BEif6idBIbjupVbOrbKxl"]
1716 suggestions: ["CqaoopA2"]
1719 key: :render_errors,
1721 suggestions: [view: Pleroma.Web.ErrorView, accepts: ~w(json)],
1726 suggestions: [Pleroma.Web.ErrorView]
1730 type: {:list, :string},
1731 suggestions: ["json"]
1738 suggestions: [name: Pleroma.PubSub, adapter: Phoenix.PubSub.PG2],
1743 suggestions: [Pleroma.PubSub]
1748 suggestions: [Phoenix.PubSub.PG2]
1753 key: :secure_cookie_flag,
1757 key: :extra_cookie_attrs,
1758 type: {:list, :string},
1759 suggestions: ["SameSite=Lax"]
1767 description: "ActivityPub-related settings",
1770 key: :unfollow_blocked,
1772 description: "Whether blocks result in people getting unfollowed"
1775 key: :outgoing_blocks,
1777 description: "Whether to federate blocks to other instances"
1780 key: :sign_object_fetches,
1782 description: "Sign object fetches with HTTP signatures"
1785 key: :follow_handshake_timeout,
1787 description: "Following handshake timeout",
1794 key: :http_security,
1796 description: "HTTP security settings",
1801 description: "Whether the managed content security policy is enabled"
1807 description: "Whether to additionally send a Strict-Transport-Security header"
1811 label: "STS max age",
1813 description: "The maximum age for the Strict-Transport-Security header if sent",
1814 suggestions: [31_536_000]
1818 label: "CT max age",
1820 description: "The maximum age for the Expect-CT header if sent",
1821 suggestions: [2_592_000]
1824 key: :referrer_policy,
1826 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1827 suggestions: ["same-origin", "no-referrer"]
1831 label: "Report URI",
1833 description: "Adds the specified url to report-uri and report-to group in CSP header",
1834 suggestions: ["https://example.com/report-uri"]
1839 group: :web_push_encryption,
1840 key: :vapid_details,
1843 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1849 "A mailto link for the administrative contact." <>
1850 " 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," <>
1851 " is unavailable for an extended period, or otherwise can't respond, someone else on the list can.",
1852 suggestions: ["Subject"]
1857 description: "VAPID public key",
1858 suggestions: ["Public key"]
1863 description: "VAPID private key",
1864 suggestions: ["Private key"]
1870 key: Pleroma.Captcha,
1872 description: "Captcha-related settings",
1877 description: "Whether the captcha should be shown on registration"
1882 description: "The method/service to use for captcha",
1883 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1886 key: :seconds_valid,
1888 description: "The time in seconds for which the captcha is valid",
1895 key: Pleroma.Captcha.Kocaptcha,
1898 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1899 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1904 description: "The kocaptcha endpoint to use",
1905 suggestions: ["https://captcha.kotobank.ch"]
1913 "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",
1918 description: "Token",
1919 suggestions: ["some_random_token"]
1924 group: :pleroma_job_queue,
1927 description: "[Deprecated] Replaced with `Oban`/`:queues` (keeping the same format)"
1931 key: Pleroma.Web.Federator.RetryQueue,
1933 description: "[Deprecated] See `Oban` and `:workers` sections for configuration notes",
1938 description: "[Deprecated] Replaced as `Oban`/`:queues`/`:outgoing_federation` value"
1947 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1949 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1950 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1951 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1952 (see https://github.com/sorentwo/oban/issues/52).
1958 description: "Application's Ecto repo",
1959 suggestions: [Pleroma.Repo]
1964 description: "Logs verbose mode",
1965 suggestions: [false, :error, :warn, :info, :debug]
1969 type: [:atom, :tuple],
1971 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1972 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1976 type: {:keyword, :integer},
1978 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1980 activity_expiration: 10,
1982 federator_incoming: 50,
1983 federator_outgoing: 50,
1985 scheduled_activities: 10,
1991 key: :activity_expiration,
1993 description: "Activity expiration queue",
1999 description: "Background queue",
2003 key: :federator_incoming,
2005 description: "Incoming federation queue",
2009 key: :federator_outgoing,
2011 description: "Outgoing federation queue",
2017 description: "Email sender queue, see Pleroma.Emails.Mailer",
2021 key: :scheduled_activities,
2023 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2027 key: :transmogrifier,
2029 description: "Transmogrifier queue",
2035 description: "Web push notifications queue",
2046 description: "Includes custom worker options not interpretable directly by `Oban`",
2050 type: {:keyword, :integer},
2051 description: "Max retry attempts for failed jobs, per `Oban` queue",
2053 federator_incoming: 5,
2054 federator_outgoing: 5
2061 key: Pleroma.Web.Metadata,
2063 description: "Metadata-related settings",
2067 type: {:list, :module},
2068 description: "List of metadata providers to enable",
2070 Pleroma.Web.Metadata.Providers.OpenGraph,
2071 Pleroma.Web.Metadata.Providers.TwitterCard,
2072 Pleroma.Web.Metadata.Providers.RelMe,
2073 Pleroma.Web.Metadata.Providers.Feed
2078 label: "Unfurl NSFW",
2080 description: "If set to `true` NSFW attachments will be shown in previews"
2089 "If enabled the instance will parse metadata from attached links to generate link previews.",
2094 description: "Enables/disables RichMedia."
2098 type: {:list, :string},
2099 description: "List of hosts which will be ignored by the metadata parser.",
2100 suggestions: ["accounts.google.com", "xss.website"]
2104 label: "Ignore TLD",
2105 type: {:list, :string},
2106 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2107 suggestions: ["local", "localdomain", "lan"]
2111 type: {:list, :module},
2112 description: "List of Rich Media parsers.",
2114 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2115 Pleroma.Web.RichMedia.Parsers.OEmbed,
2116 Pleroma.Web.RichMedia.Parsers.OGP,
2117 Pleroma.Web.RichMedia.Parsers.TwitterCard
2122 label: "TTL setters",
2123 type: {:list, :module},
2124 description: "List of rich media TTL setters.",
2126 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2133 key: :fetch_initial_posts,
2135 description: "Fetching initial posts settings",
2141 "If enabled, when a new user is federated with, fetch some of their latest posts"
2146 description: "The amount of pages to fetch",
2152 group: :auto_linker,
2155 description: "Configuration for the auto_linker library",
2159 type: [:string, false],
2160 description: "Specify the class to be added to the generated link. `False` to clear",
2161 suggestions: ["auto-linker", false]
2165 type: [:string, false],
2166 description: "Override the rel attribute. `False` to clear",
2167 suggestions: ["ugc", "noopener noreferrer", false]
2172 description: "Set to `false` to remove target='_blank' attribute"
2177 description: "Set to `true` to link urls with schema http://google.com"
2181 type: [:integer, false],
2183 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2184 suggestions: [15, false]
2189 description: "Strip the scheme prefix"
2194 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2200 key: Pleroma.ScheduledActivity,
2202 description: "Scheduled activities settings",
2205 key: :daily_user_limit,
2208 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2212 key: :total_user_limit,
2215 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2221 description: "Whether scheduled activities are sent to the job queue to be executed"
2227 key: Pleroma.ActivityExpiration,
2229 description: "Expired activity settings",
2234 description: "Whether expired activities will be sent to the job queue to be deleted"
2241 description: "Authenticator",
2244 key: Pleroma.Web.Auth.Authenticator,
2246 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2255 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2256 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2257 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2258 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2263 description: "Enables LDAP authentication"
2268 description: "LDAP server hostname",
2269 suggestions: ["localhosts"]
2274 description: "LDAP port, e.g. 389 or 636",
2275 suggestions: [389, 636]
2281 description: "`True` to use SSL, usually implies the port 636"
2285 label: "SSL options",
2287 description: "Additional SSL options",
2288 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2293 description: "Path to file with PEM encoded cacerts",
2294 suggestions: ["path/to/file/with/PEM/cacerts"]
2299 description: "Type of cert verification",
2300 suggestions: [:verify_peer]
2308 description: "`True` to start TLS, usually implies the port 389"
2312 label: "TLS options",
2314 description: "Additional TLS options",
2315 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2320 description: "Path to file with PEM encoded cacerts",
2321 suggestions: ["path/to/file/with/PEM/cacerts"]
2326 description: "Type of cert verification",
2327 suggestions: [:verify_peer]
2334 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2335 suggestions: ["dc=example,dc=com"]
2341 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2350 description: "Authentication / authorization settings",
2353 key: :enforce_oauth_admin_scope_usage,
2356 "OAuth admin scope requirement toggle. " <>
2357 "If `true`, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2358 "(client app must support admin scopes). If `false` and token doesn't have admin scope(s)," <>
2359 "`is_admin` user flag grants access to admin-specific actions."
2362 key: :auth_template,
2365 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2366 suggestions: ["show.html"]
2369 key: :oauth_consumer_template,
2372 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2373 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2374 suggestions: ["consumer.html"]
2377 key: :oauth_consumer_strategies,
2378 type: {:list, :string},
2380 "The list of enabled OAuth consumer strategies; by default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2381 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2382 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2383 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2389 key: :email_notifications,
2391 description: "Email notifications settings",
2397 "emails of \"what you've missed\" for users who have been inactive for a while",
2401 schedule: "0 0 * * 0",
2403 inactivity_threshold: 7
2410 description: "Globally enable or disable digest emails"
2416 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2417 suggestions: ["0 0 * * 0"]
2422 description: "Minimum interval between digest emails to one user",
2426 key: :inactivity_threshold,
2428 description: "Minimum user inactivity threshold",
2437 key: Pleroma.Emails.UserEmail,
2439 description: "Email template settings",
2444 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2445 suggestions: ["some/path/logo.png"]
2450 description: "a map with color settings for email templates.",
2453 link_color: "#d8a070",
2454 background_color: "#2C3645",
2455 content_background_color: "#1B2635",
2456 header_color: "#d8a070",
2457 text_color: "#b9b9ba",
2458 text_muted_color: "#b9b9ba"
2465 suggestions: ["#d8a070"]
2468 key: :background_color,
2470 suggestions: ["#2C3645"]
2473 key: :content_background_color,
2475 suggestions: ["#1B2635"]
2480 suggestions: ["#d8a070"]
2485 suggestions: ["#b9b9ba"]
2488 key: :text_muted_color,
2490 suggestions: ["#b9b9ba"]
2500 description: "Configure OAuth 2 provider capabilities",
2503 key: :token_expires_in,
2505 description: "The lifetime in seconds of the access token",
2509 key: :issue_new_refresh_token,
2512 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2515 key: :clean_expired_tokens,
2517 description: "Enable a background job to clean expired oauth tokens. Default: `false`."
2520 key: :clean_expired_tokens_interval,
2523 "Interval to run the job to clean expired tokens. Default: 86_400_000 (24 hours).",
2524 suggestions: [86_400_000]
2534 key: :shortcode_globs,
2535 type: {:list, :string},
2536 description: "Location of custom emoji files. * can be used as a wildcard.",
2537 suggestions: ["/emoji/custom/**/*.png"]
2540 key: :pack_extensions,
2541 type: {:list, :string},
2543 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2544 suggestions: [".png", ".gif"]
2548 type: {:keyword, :string, {:list, :string}},
2550 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2551 " and the value is the location or array of locations. * can be used as a wildcard.",
2553 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2557 key: :default_manifest,
2560 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2561 " Currently only one manifest can be added (no arrays).",
2562 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2565 key: :shared_pack_cache_seconds_per_file,
2566 label: "Shared pack cache s/file",
2569 "When an emoji pack is shared, the archive is created and cached in memory" <>
2570 " for this amount of seconds multiplied by the number of files.",
2579 description: "Database related settings",
2584 description: "If RUM indexes should be used. Default: `false`"
2593 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2597 type: [:tuple, {:list, :tuple}],
2598 description: "For the search requests (account & status search etc.)",
2599 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2602 key: :app_account_creation,
2603 type: [:tuple, {:list, :tuple}],
2604 description: "For registering user accounts from the same IP address",
2605 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2608 key: :relations_actions,
2609 type: [:tuple, {:list, :tuple}],
2610 description: "For actions on relations with all users (follow, unfollow)",
2611 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2614 key: :relation_id_action,
2615 type: [:tuple, {:list, :tuple}],
2616 description: "For actions on relation with a specific user (follow, unfollow)",
2617 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2620 key: :statuses_actions,
2621 type: [:tuple, {:list, :tuple}],
2623 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2624 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2627 key: :status_id_action,
2628 type: [:tuple, {:list, :tuple}],
2630 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2631 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2634 key: :authentication,
2635 type: [:tuple, {:list, :tuple}],
2636 description: "For authentication create / password check / user existence check requests",
2637 suggestions: [{60_000, 15}]
2645 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2646 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2651 description: "Enables SSH"
2656 description: "Dir with SSH keys",
2657 suggestions: ["/some/path/ssh_keys"]
2662 description: "Handler module",
2663 suggestions: ["Pleroma.BBS.Handler"]
2668 description: "Port to connect",
2669 suggestions: [10_022]
2672 key: :password_authenticator,
2674 description: "Authenticator module",
2675 suggestions: ["Pleroma.BBS.Authenticator"]
2682 description: "Mime types",
2689 "application/xml" => ["xml"],
2690 "application/xrd+xml" => ["xrd+xml"],
2691 "application/jrd+json" => ["jrd+json"],
2692 "application/activity+json" => ["activity+json"],
2693 "application/ld+json" => ["activity+json"]
2698 key: "application/xml",
2699 type: {:list, :string},
2700 suggestions: ["xml"]
2703 key: "application/xrd+xml",
2704 type: {:list, :string},
2705 suggestions: ["xrd+xml"]
2708 key: "application/jrd+json",
2709 type: {:list, :string},
2710 suggestions: ["jrd+json"]
2713 key: "application/activity+json",
2714 type: {:list, :string},
2715 suggestions: ["activity+json"]
2718 key: "application/ld+json",
2719 type: {:list, :string},
2720 suggestions: ["activity+json"]
2729 description: "Tesla settings",
2734 description: "Tesla adapter",
2735 suggestions: [Tesla.Adapter.Hackney]
2743 description: "Pleroma chat settings",
2759 description: "Enables suggestions"
2762 key: :third_party_engine,
2764 description: "URL for third party engine",
2766 "http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-suggestions-api.cgi?{{host}}+{{user}}"
2772 description: "Request timeout to third party engine",
2773 suggestions: [300_000]
2778 description: "Limit for suggestions",
2784 suggestions: ["https://vinayaka.distsn.org"]
2790 key: Pleroma.Web.Endpoint.MetricsExporter,
2792 description: "Prometheus settings",
2797 description: "API endpoint with metrics",
2798 suggestions: ["/api/pleroma/app_metrics"]
2803 group: :http_signatures,
2805 description: "HTTP Signatures settings",
2810 suggestions: [Pleroma.Signature]
2818 description: "HTTP settings",
2823 type: [:string, :tuple],
2824 description: "Proxy URL",
2825 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2828 key: :send_user_agent,
2833 type: [:string, :atom],
2835 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2836 suggestions: ["Pleroma", :default]
2841 description: "Adapter specific options",
2847 label: "SSL Options",
2848 description: "SSL options for HTTP adapter",
2852 type: {:list, :atom},
2853 description: "List of TLS version to use",
2854 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2868 key: :allow_inline_images,
2872 key: :allow_headings,
2885 type: {:list, :module},
2886 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2896 key: :deny_follow_blocked,
2903 key: :mrf_normalize_markup,
2904 label: "MRF normalize markup",
2905 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2911 suggestions: [Pleroma.HTML.Scrubber.Default]
2921 key: :restricted_nicknames,
2922 type: {:list, :string},
2941 "ostatus_subscribe",
2965 suggestions: [86_400]
2969 type: {:list, :string},
2970 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2974 type: {:list, :string},
2977 "X-RateLimit-Reset",
2978 "X-RateLimit-Limit",
2979 "X-RateLimit-Remaining",
2990 type: {:list, :string},
2991 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2997 key: Pleroma.Plugs.RemoteIp,
3000 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3001 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3007 description: "Enable/disable the plug. Default: `false`."
3011 type: {:list, :string},
3013 "A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Default: `~w[forwarded x-forwarded-for x-client-ip x-real-ip]`."
3017 type: {:list, :string},
3019 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3023 type: {:list, :string},
3025 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3031 key: :web_cache_ttl,
3034 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3040 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3041 suggestions: [30_000, nil]
3044 key: :activity_pub_question,
3046 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3047 suggestions: [30_000]
3056 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3061 description: "Enables the rendering of static HTML. Defaults to `false`."
3069 description: "Configure feed rendering.",
3074 description: "Configure title rendering.",
3079 description: "Maximum number of characters before truncating title.",
3085 description: "Replacement which will be used after truncating string.",
3086 suggestions: ["..."]
3094 key: :mrf_object_age,
3096 description: "Rejects or delists posts based on their age when received.",
3101 description: "Required age (in seconds) of a post before actions are taken.",
3102 suggestions: [172_800]
3106 type: {:list, :atom},
3108 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3109 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3110 "`:reject` rejects the message entirely",
3111 suggestions: [:delist, :strip_followers, :reject]
3119 description: "Custom Runtime Modules.",
3124 description: "A path to custom Elixir modules (such as MRF policies)."
3131 description: "Allow instance configuration from database.",
3134 key: :configurable_from_database,
3137 "Allow transferring configuration to DB with the subsequent customization from Admin api. Defaults to `false`"