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 versions 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}]
128 description: "Pleroma-specific extensions",
131 key: :output_relationships_in_statuses_by_default,
134 "If `true`, outputs account/pleroma/relationship map for each rendered status / notification (for all clients). " <>
135 "If `false`, outputs the above only if `with_relationships` param is tru-ish " <>
136 "(that breaks compatibility with older PleromaFE versions which do not send this param but expect the output)."
142 key: Pleroma.Uploaders.Local,
144 description: "Local uploader-related settings",
149 description: "Path where user's uploads will be saved",
158 key: Pleroma.Uploaders.S3,
160 description: "S3 uploader-related settings",
165 description: "S3 bucket",
171 key: :bucket_namespace,
173 description: "S3 bucket namespace",
174 suggestions: ["pleroma"]
177 key: :public_endpoint,
179 description: "S3 endpoint",
180 suggestions: ["https://s3.amazonaws.com"]
183 key: :truncated_namespace,
186 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
187 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
190 key: :streaming_enabled,
193 "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."
199 key: Pleroma.Upload.Filter.Mogrify,
201 description: "Uploads mogrify filter settings",
205 type: [:string, {:list, :string}, {:list, :tuple}],
206 description: "List of actions for the mogrify command",
217 key: Pleroma.Upload.Filter.AnonymizeFilename,
219 description: "Filter replaces the filename of the upload",
225 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
226 " filename extension by using {extension}, for example custom-file-name.{extension}.",
228 "custom-file-name.{extension}"
235 key: Pleroma.Emails.Mailer,
237 description: "Mailer-related settings",
243 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
244 " or Swoosh.Adapters.Local for in-memory mailbox",
246 Swoosh.Adapters.SMTP,
247 Swoosh.Adapters.Sendgrid,
248 Swoosh.Adapters.Sendmail,
249 Swoosh.Adapters.Mandrill,
250 Swoosh.Adapters.Mailgun,
251 Swoosh.Adapters.Mailjet,
252 Swoosh.Adapters.Postmark,
253 Swoosh.Adapters.SparkPost,
254 Swoosh.Adapters.AmazonSES,
256 Swoosh.Adapters.SocketLabs,
257 Swoosh.Adapters.Gmail,
258 Swoosh.Adapters.Local
264 description: "Allow/disallow send emails"
267 group: {:subgroup, Swoosh.Adapters.SMTP},
270 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
271 suggestions: ["smtp.gmail.com"]
274 group: {:subgroup, Swoosh.Adapters.SMTP},
277 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
278 suggestions: ["pleroma"]
281 group: {:subgroup, Swoosh.Adapters.SMTP},
284 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
285 suggestions: ["password"]
288 group: {:subgroup, Swoosh.Adapters.SMTP},
292 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
295 group: {:subgroup, Swoosh.Adapters.SMTP},
299 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
300 suggestions: [:always, :never, :if_available]
303 group: {:subgroup, Swoosh.Adapters.SMTP},
306 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
307 suggestions: [:always, :never, :if_available]
310 group: {:subgroup, Swoosh.Adapters.SMTP},
313 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
317 group: {:subgroup, Swoosh.Adapters.SMTP},
320 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
324 group: {:subgroup, Swoosh.Adapters.SMTP},
326 label: "No MX lookups",
328 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
331 group: {:subgroup, Swoosh.Adapters.Sendgrid},
335 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
336 suggestions: ["my-api-key"]
339 group: {:subgroup, Swoosh.Adapters.Sendmail},
342 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
343 suggestions: ["/usr/bin/sendmail"]
346 group: {:subgroup, Swoosh.Adapters.Sendmail},
349 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
350 suggestions: ["-N delay,failure,success"]
353 group: {:subgroup, Swoosh.Adapters.Sendmail},
356 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
359 group: {:subgroup, Swoosh.Adapters.Mandrill},
363 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
364 suggestions: ["my-api-key"]
367 group: {:subgroup, Swoosh.Adapters.Mailgun},
371 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
372 suggestions: ["my-api-key"]
375 group: {:subgroup, Swoosh.Adapters.Mailgun},
378 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
379 suggestions: ["pleroma.com"]
382 group: {:subgroup, Swoosh.Adapters.Mailjet},
386 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
387 suggestions: ["my-api-key"]
390 group: {:subgroup, Swoosh.Adapters.Mailjet},
393 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
394 suggestions: ["my-secret-key"]
397 group: {:subgroup, Swoosh.Adapters.Postmark},
401 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
402 suggestions: ["my-api-key"]
405 group: {:subgroup, Swoosh.Adapters.SparkPost},
409 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
410 suggestions: ["my-api-key"]
413 group: {:subgroup, Swoosh.Adapters.SparkPost},
416 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
417 suggestions: ["https://api.sparkpost.com/api/v1"]
420 group: {:subgroup, Swoosh.Adapters.AmazonSES},
423 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
424 suggestions: ["us-east-1", "us-east-2"]
427 group: {:subgroup, Swoosh.Adapters.AmazonSES},
430 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
431 suggestions: ["aws-access-key"]
434 group: {:subgroup, Swoosh.Adapters.AmazonSES},
437 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
438 suggestions: ["aws-secret-key"]
441 group: {:subgroup, Swoosh.Adapters.Dyn},
445 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
446 suggestions: ["my-api-key"]
449 group: {:subgroup, Swoosh.Adapters.SocketLabs},
452 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
455 group: {:subgroup, Swoosh.Adapters.SocketLabs},
459 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
462 group: {:subgroup, Swoosh.Adapters.Gmail},
465 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
472 description: "`Swoosh.Adapters.Local` adapter specific settings",
475 group: {:subgroup, Swoosh.Adapters.Local},
478 description: "Run the preview server together as part of your app"
481 group: {:subgroup, Swoosh.Adapters.Local},
484 description: "The preview server port",
493 description: "URI schemes related settings",
497 type: {:list, :string},
498 description: "List of the scheme part that is considered valid to be an URL",
522 description: "Instance-related settings",
527 description: "Name of the instance",
534 label: "Admin Email Address",
536 description: "Email used to reach an Administrator/Moderator of the instance",
543 label: "Sender Email Address",
545 description: "Envelope FROM address for mail sent via Pleroma",
554 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
562 description: "Posts character limit (CW/Subject included in the counter)",
570 description: "Character limit of the instance chat messages",
578 description: "Hard character limit beyond which remote posts will be dropped",
586 description: "File size limit of uploads (except for avatar, background, banner)",
592 key: :avatar_upload_limit,
594 description: "File size limit of user's profile avatars",
600 key: :background_upload_limit,
602 description: "File size limit of user's profile backgrounds",
608 key: :banner_upload_limit,
610 description: "File size limit of user's profile banners",
618 description: "A map with poll limits for local polls",
622 max_option_chars: 200,
624 max_expiration: 31_536_000
631 description: "Maximum number of options",
635 key: :max_option_chars,
637 description: "Maximum number of characters per option",
641 key: :min_expiration,
643 description: "Minimum expiration time (in seconds)",
647 key: :max_expiration,
649 description: "Maximum expiration time (in seconds)",
655 key: :registrations_open,
658 "Enable registrations for anyone. Invitations require this setting to be disabled."
661 key: :invites_enabled,
664 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
667 key: :account_activation_required,
669 description: "Require users to confirm their emails before signing in."
674 description: "Enable federation with other instances."
677 key: :federation_incoming_replies_max_depth,
678 label: "Fed. incoming replies max depth",
681 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
682 " 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.",
688 key: :federation_reachability_timeout_days,
689 label: "Fed. reachability timeout days",
692 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
698 key: :federation_publisher_modules,
699 type: {:list, :module},
700 description: "List of modules for federation publishing",
702 Pleroma.Web.ActivityPub.Publisher
708 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
711 key: :rewrite_policy,
712 type: [:module, {:list, :module}],
713 description: "A list of MRF policies enabled",
715 Generator.list_modules_in_dir(
716 "lib/pleroma/web/activity_pub/mrf",
717 "Elixir.Pleroma.Web.ActivityPub.MRF."
724 "Makes the client API in authentificated mode-only except for user-profiles." <>
725 " Useful for disabling the Local Timeline and The Whole Known Network."
728 key: :quarantined_instances,
729 type: {:list, :string},
731 "List of ActivityPub instances where private (DMs, followers-only) activities will not be send",
738 key: :managed_config,
741 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
746 description: "Instance static directory",
752 key: :allowed_post_formats,
753 type: {:list, :string},
754 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
763 key: :mrf_transparency,
764 label: "MRF transparency",
767 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
770 key: :mrf_transparency_exclusions,
771 label: "MRF transparency exclusions",
772 type: {:list, :string},
774 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
780 key: :extended_nickname_format,
783 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
784 " This will break federation with older software for theses nicknames."
787 key: :cleanup_attachments,
790 Enable to remove associated attachments when status is removed.
791 This will not affect duplicates and attachments without status.
792 Enabling this will increase load to database when deleting statuses on larger instances.
796 key: :max_pinned_statuses,
798 description: "The maximum number of pinned statuses. 0 will disable the feature.",
806 key: :autofollowed_nicknames,
807 type: {:list, :string},
809 "Set to nicknames of (local) users that every new user should automatically follow",
818 key: :attachment_links,
820 description: "Enable to automatically add attachment link text to statuses"
823 key: :welcome_message,
826 "A message that will be sent to a newly registered users as a direct message",
828 "Hi, @username! Welcome on board!"
832 key: :welcome_user_nickname,
834 description: "The nickname of the local user that sends the welcome message",
840 key: :max_report_comment_size,
842 description: "The maximum size of the report comment. Default: 1000.",
848 key: :safe_dm_mentions,
851 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
852 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
858 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
861 key: :remote_post_retention_days,
864 "The default amount of days to retain remote posts when pruning the database",
870 key: :user_bio_length,
872 description: "A user bio maximum length. Default: 5000.",
878 key: :user_name_length,
880 description: "A user name maximum length. Default: 100.",
886 key: :skip_thread_containment,
888 description: "Skip filtering out broken threads. Default: enabled"
891 key: :limit_to_local_content,
892 type: {:dropdown, :atom},
894 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
902 key: :max_account_fields,
904 description: "The maximum number of custom fields in the user profile. Default: 10.",
910 key: :max_remote_account_fields,
913 "The maximum number of custom fields in the remote user profile. Default: 20.",
919 key: :account_field_name_length,
921 description: "An account field name maximum length. Default: 512.",
927 key: :account_field_value_length,
929 description: "An account field value maximum length. Default: 2048.",
935 key: :external_user_synchronization,
937 description: "Enabling following/followers counters synchronization for external users"
944 description: "Logger-related settings",
948 type: [:atom, :tuple, :module],
950 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
951 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
959 description: "ExSyslogger-related settings",
963 type: {:dropdown, :atom},
964 description: "Log level",
965 suggestions: [:debug, :info, :warn, :error]
971 "A string that's prepended to every message, and is typically set to the app name",
972 suggestions: ["pleroma"]
977 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
978 suggestions: ["$metadata[$level] $message"]
982 type: {:list, :atom},
983 suggestions: [:request_id]
991 description: "Console logger settings",
995 type: {:dropdown, :atom},
996 description: "Log level",
997 suggestions: [:debug, :info, :warn, :error]
1002 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1003 suggestions: ["$metadata[$level] $message"]
1007 type: {:list, :atom},
1008 suggestions: [:request_id]
1015 description: "Quack-related settings",
1019 type: {:dropdown, :atom},
1020 description: "Log level",
1021 suggestions: [:debug, :info, :warn, :error]
1025 type: {:list, :atom},
1026 description: "Configure which metadata you want to report on",
1044 description: "Configure the Slack incoming webhook",
1045 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1051 key: :frontend_configurations,
1054 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1055 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1056 "add your own configuration your settings all fields must be complete.",
1060 label: "Pleroma FE",
1062 description: "Settings for Pleroma FE",
1065 theme: "pleroma-dark",
1066 logo: "/static/logo.png",
1067 background: "/images/city.jpg",
1068 redirectRootNoLogin: "/main/all",
1069 redirectRootLogin: "/main/friends",
1070 showInstanceSpecificPanel: true,
1071 scopeOptionsEnabled: false,
1072 formattingOptionsEnabled: false,
1073 collapseMessageWithSubject: false,
1074 hidePostStats: false,
1075 hideUserStats: false,
1077 subjectLineBehavior: "email",
1078 alwaysShowSubjectInput: true,
1082 enableEmojiPicker: false
1089 description: "Which theme to use, they are defined in styles.json",
1090 suggestions: ["pleroma-dark"]
1095 description: "URL of the logo, defaults to Pleroma's logo",
1096 suggestions: ["/static/logo.png"]
1102 "URL of the background, unless viewing a user profile with a background that is set",
1103 suggestions: ["/images/city.jpg"]
1106 key: :redirectRootNoLogin,
1107 label: "Redirect root no login",
1110 "Relative URL which indicates where to redirect when a user isn't logged in",
1111 suggestions: ["/main/all"]
1114 key: :redirectRootLogin,
1115 label: "Redirect root login",
1118 "Relative URL which indicates where to redirect when a user is logged in",
1119 suggestions: ["/main/friends"]
1122 key: :showInstanceSpecificPanel,
1123 label: "Show instance specific panel",
1125 description: "Whenether to show the instance's specific panel"
1128 key: :scopeOptionsEnabled,
1129 label: "Scope options enabled",
1131 description: "Enable setting a notice visibility and subject/CW when posting"
1134 key: :formattingOptionsEnabled,
1135 label: "Formatting options enabled",
1138 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1141 key: :collapseMessageWithSubject,
1142 label: "Collapse message with subject",
1145 "When a message has a subject (aka Content Warning), collapse it by default"
1148 key: :hidePostStats,
1149 label: "Hide post stats",
1151 description: "Hide notices statistics (repeats, favorites, ...)"
1154 key: :hideUserStats,
1155 label: "Hide user stats",
1158 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1162 label: "Scope copy",
1164 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1167 key: :subjectLineBehavior,
1168 label: "Subject line behavior",
1170 description: "Allows changing the default behaviour of subject lines in replies.
1171 `email`: copy and preprend re:, as in email,
1172 `masto`: copy verbatim, as in Mastodon,
1173 `noop`: don't copy the subject.",
1174 suggestions: ["email", "masto", "noop"]
1177 key: :alwaysShowSubjectInput,
1178 label: "Always show subject input",
1180 description: "When disabled, auto-hide the subject field if it's empty"
1187 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1188 "If you want a colorful logo you must disable logoMask."
1192 label: "Logo margin",
1195 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1196 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1197 suggestions: [".1em"]
1202 description: "Enables stickers."
1205 key: :enableEmojiPicker,
1206 label: "Emoji picker",
1208 description: "Enables emoji picker."
1216 description: "Settings for Masto FE",
1219 showInstanceSpecificPanel: true
1224 key: :showInstanceSpecificPanel,
1225 label: "Show instance specific panel",
1227 description: "Whenether to show the instance's specific panel"
1238 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1242 type: {:keyword, :map},
1244 "Keyword of mascots, each element must contain both an url and a mime_type key",
1247 url: "/images/pleroma-fox-tan-smol.png",
1248 mime_type: "image/png"
1250 pleroma_fox_tan_shy: %{
1251 url: "/images/pleroma-fox-tan-shy.png",
1252 mime_type: "image/png"
1257 key: :default_mascot,
1260 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1272 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1276 type: {:list, :map},
1277 description: "Describe the icons of the app",
1280 src: "/static/logo.png"
1283 src: "/static/icon.png",
1287 src: "/static/icon.ico",
1288 sizes: "72x72 96x96 128x128 256x256"
1295 description: "Describe the theme color of the app",
1296 suggestions: ["#282c37", "mediumpurple"]
1299 key: :background_color,
1301 description: "Describe the background color of the app",
1302 suggestions: ["#191b22", "aliceblue"]
1309 label: "MRF simple",
1311 description: "Message Rewrite Facility",
1314 key: :media_removal,
1315 type: {:list, :string},
1316 description: "List of instances to strip media attachments from",
1317 suggestions: ["example.com", "*.example.com"]
1321 label: "Media NSFW",
1322 type: {:list, :string},
1323 description: "List of instances to tag all media as NSFW (sensitive) from",
1324 suggestions: ["example.com", "*.example.com"]
1327 key: :federated_timeline_removal,
1328 type: {:list, :string},
1330 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1331 suggestions: ["example.com", "*.example.com"]
1335 type: {:list, :string},
1336 description: "List of instances to reject any activities from",
1337 suggestions: ["example.com", "*.example.com"]
1341 type: {:list, :string},
1342 description: "List of instances to accept any activities from",
1343 suggestions: ["example.com", "*.example.com"]
1346 key: :report_removal,
1347 type: {:list, :string},
1348 description: "List of instances to reject reports from",
1349 suggestions: ["example.com", "*.example.com"]
1352 key: :avatar_removal,
1353 type: {:list, :string},
1354 description: "List of instances to strip avatars from",
1355 suggestions: ["example.com", "*.example.com"]
1358 key: :banner_removal,
1359 type: {:list, :string},
1360 description: "List of instances to strip banners from",
1361 suggestions: ["example.com", "*.example.com"]
1368 label: "MRF subchain",
1371 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1372 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1377 description: "Matches a series of regular expressions against the actor field",
1380 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1388 key: :mrf_rejectnonpublic,
1390 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1391 label: "MRF reject non public",
1395 key: :allow_followersonly,
1396 label: "Allow followers-only",
1398 description: "Whether to allow followers-only posts"
1403 description: "Whether to allow direct messages"
1409 key: :mrf_hellthread,
1410 label: "MRF hellthread",
1412 description: "Block messages with too much mentions",
1415 key: :delist_threshold,
1418 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1419 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1423 key: :reject_threshold,
1426 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1434 label: "MRF keyword",
1436 description: "Reject or Word-Replace messages with a keyword or regex",
1440 type: [:string, :regex],
1442 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1443 suggestions: ["foo", ~r/foo/iu]
1446 key: :federated_timeline_removal,
1447 type: [:string, :regex],
1449 "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.",
1450 suggestions: ["foo", ~r/foo/iu]
1454 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1456 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1457 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1464 label: "MRF mention",
1466 description: "Block messages which mention a user",
1470 type: {:list, :string},
1471 description: "A list of actors for which any post mentioning them will be dropped.",
1472 suggestions: ["actor1", "actor2"]
1478 key: :mrf_vocabulary,
1479 label: "MRF vocabulary",
1481 description: "Filter messages which belong to certain activity vocabularies",
1485 type: {:list, :string},
1487 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1488 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1492 type: {:list, :string},
1494 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1495 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1501 # key: :mrf_user_allowlist,
1504 # "The keys in this section are the domain names that the policy should apply to." <>
1505 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1507 # ["example.org": ["https://example.org/users/admin"]],
1509 # ["example.org": ["https://example.org/users/admin"]]
1517 description: "Media proxy",
1522 description: "Enables proxying of remote media to the instance's proxy"
1528 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1529 suggestions: ["https://example.com"]
1534 description: "Options for Pleroma.ReverseProxy",
1536 redirect_on_failure: false,
1537 max_body_length: 25 * 1_048_576,
1539 follow_redirect: true,
1545 key: :redirect_on_failure,
1548 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1549 "Any error during body processing will not be redirected as the response is chunked."
1552 key: :max_body_length,
1555 "Limits the content length to be approximately the " <>
1556 "specified length. It is validated with the `content-length` header and also verified when proxying."
1561 description: "HTTP options",
1566 description: "Adapter specific options",
1571 label: "SSL Options",
1572 description: "SSL options for HTTP adapter",
1576 type: {:list, :atom},
1577 description: "List of TLS version to use",
1578 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1587 type: [:string, :tuple],
1588 description: "Proxy URL",
1589 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1597 type: {:list, :string},
1598 description: "List of domains to bypass the mediaproxy",
1599 suggestions: ["example.com"]
1607 description: "Gopher settings",
1612 description: "Enables the gopher interface"
1617 description: "IP address to bind to",
1618 suggestions: [{0, 0, 0, 0}]
1623 description: "Port to bind to",
1629 description: "Port advertised in urls (optional, defaults to port)",
1638 description: "ActivityPub-related settings",
1641 key: :unfollow_blocked,
1643 description: "Whether blocks result in people getting unfollowed"
1646 key: :outgoing_blocks,
1648 description: "Whether to federate blocks to other instances"
1651 key: :sign_object_fetches,
1653 description: "Sign object fetches with HTTP signatures"
1656 key: :note_replies_output_limit,
1659 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1662 key: :follow_handshake_timeout,
1664 description: "Following handshake timeout",
1671 key: :http_security,
1673 description: "HTTP security settings",
1678 description: "Whether the managed content security policy is enabled"
1684 description: "Whether to additionally send a Strict-Transport-Security header"
1688 label: "STS max age",
1690 description: "The maximum age for the Strict-Transport-Security header if sent",
1691 suggestions: [31_536_000]
1695 label: "CT max age",
1697 description: "The maximum age for the Expect-CT header if sent",
1698 suggestions: [2_592_000]
1701 key: :referrer_policy,
1703 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1704 suggestions: ["same-origin", "no-referrer"]
1708 label: "Report URI",
1710 description: "Adds the specified url to report-uri and report-to group in CSP header",
1711 suggestions: ["https://example.com/report-uri"]
1716 group: :web_push_encryption,
1717 key: :vapid_details,
1720 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1726 "A mailto link for the administrative contact." <>
1727 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1728 suggestions: ["mailto:moderators@pleroma.com"]
1733 description: "VAPID public key",
1734 suggestions: ["Public key"]
1739 description: "VAPID private key",
1740 suggestions: ["Private key"]
1746 key: Pleroma.Captcha,
1748 description: "Captcha-related settings",
1753 description: "Whether the captcha should be shown on registration"
1758 description: "The method/service to use for captcha",
1759 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1762 key: :seconds_valid,
1764 description: "The time in seconds for which the captcha is valid",
1771 key: Pleroma.Captcha.Kocaptcha,
1774 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1775 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1780 description: "The kocaptcha endpoint to use",
1781 suggestions: ["https://captcha.kotobank.ch"]
1789 "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",
1794 description: "Token",
1795 suggestions: ["We recommend a secure random string or UUID"]
1804 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1806 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1807 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1808 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1809 (see https://github.com/sorentwo/oban/issues/52).
1815 description: "Application's Ecto repo",
1816 suggestions: [Pleroma.Repo]
1820 type: {:dropdown, :atom},
1821 description: "Logs verbose mode",
1822 suggestions: [false, :error, :warn, :info, :debug]
1826 type: [:atom, :tuple],
1828 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1829 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1833 type: {:keyword, :integer},
1835 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1837 activity_expiration: 10,
1838 attachments_cleanup: 5,
1840 federator_incoming: 50,
1841 federator_outgoing: 50,
1843 scheduled_activities: 10,
1849 key: :activity_expiration,
1851 description: "Activity expiration queue",
1855 key: :attachments_cleanup,
1857 description: "Attachment deletion queue",
1863 description: "Background queue",
1867 key: :federator_incoming,
1869 description: "Incoming federation queue",
1873 key: :federator_outgoing,
1875 description: "Outgoing federation queue",
1881 description: "Email sender queue, see Pleroma.Emails.Mailer",
1885 key: :scheduled_activities,
1887 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1891 key: :transmogrifier,
1893 description: "Transmogrifier queue",
1899 description: "Web push notifications queue",
1906 type: {:list, :tuple},
1907 description: "Settings for cron background jobs",
1909 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1910 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1911 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1912 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1913 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1922 description: "Includes custom worker options not interpretable directly by `Oban`",
1926 type: {:keyword, :integer},
1927 description: "Max retry attempts for failed jobs, per `Oban` queue",
1929 federator_incoming: 5,
1930 federator_outgoing: 5
1937 key: Pleroma.Web.Metadata,
1939 description: "Metadata-related settings",
1943 type: {:list, :module},
1944 description: "List of metadata providers to enable",
1946 Pleroma.Web.Metadata.Providers.OpenGraph,
1947 Pleroma.Web.Metadata.Providers.TwitterCard,
1948 Pleroma.Web.Metadata.Providers.RelMe,
1949 Pleroma.Web.Metadata.Providers.Feed
1954 label: "Unfurl NSFW",
1956 description: "When enabled NSFW attachments will be shown in previews"
1965 "If enabled the instance will parse metadata from attached links to generate link previews.",
1970 description: "Enables RichMedia parsing of URLs."
1974 type: {:list, :string},
1975 description: "List of hosts which will be ignored by the metadata parser.",
1976 suggestions: ["accounts.google.com", "xss.website"]
1980 label: "Ignore TLD",
1981 type: {:list, :string},
1982 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
1983 suggestions: ["local", "localdomain", "lan"]
1987 type: {:list, :module},
1988 description: "List of Rich Media parsers.",
1990 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
1991 Pleroma.Web.RichMedia.Parsers.OEmbed,
1992 Pleroma.Web.RichMedia.Parsers.OGP,
1993 Pleroma.Web.RichMedia.Parsers.TwitterCard
1998 label: "TTL setters",
1999 type: {:list, :module},
2000 description: "List of rich media TTL setters.",
2002 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2008 group: :auto_linker,
2011 description: "Configuration for the auto_linker library",
2015 type: [:string, false],
2016 description: "Specify the class to be added to the generated link. Disable to clear",
2017 suggestions: ["auto-linker", false]
2021 type: [:string, false],
2022 description: "Override the rel attribute. Disable to clear",
2023 suggestions: ["ugc", "noopener noreferrer", false]
2028 description: "Link urls will open in new window/tab"
2032 type: [:integer, false],
2034 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2035 suggestions: [15, false]
2040 description: "Strip the scheme prefix"
2045 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2051 key: Pleroma.ScheduledActivity,
2053 description: "Scheduled activities settings",
2056 key: :daily_user_limit,
2059 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2063 key: :total_user_limit,
2066 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2072 description: "Whether scheduled activities are sent to the job queue to be executed"
2078 key: Pleroma.ActivityExpiration,
2080 description: "Expired activity settings",
2085 description: "Whether expired activities will be sent to the job queue to be deleted"
2092 description: "Authenticator",
2095 key: Pleroma.Web.Auth.Authenticator,
2097 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2106 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2107 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2108 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2109 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2114 description: "Enables LDAP authentication"
2119 description: "LDAP server hostname",
2120 suggestions: ["localhosts"]
2125 description: "LDAP port, e.g. 389 or 636",
2126 suggestions: [389, 636]
2132 description: "Enable to use SSL, usually implies the port 636"
2136 label: "SSL options",
2138 description: "Additional SSL options",
2139 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2144 description: "Path to file with PEM encoded cacerts",
2145 suggestions: ["path/to/file/with/PEM/cacerts"]
2150 description: "Type of cert verification",
2151 suggestions: [:verify_peer]
2159 description: "Enable to use STARTTLS, usually implies the port 389"
2163 label: "TLS options",
2165 description: "Additional TLS options",
2166 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2171 description: "Path to file with PEM encoded cacerts",
2172 suggestions: ["path/to/file/with/PEM/cacerts"]
2177 description: "Type of cert verification",
2178 suggestions: [:verify_peer]
2185 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2186 suggestions: ["dc=example,dc=com"]
2192 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2201 description: "Authentication / authorization settings",
2204 key: :enforce_oauth_admin_scope_usage,
2207 "OAuth admin scope requirement toggle. " <>
2208 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2209 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2210 "`is_admin` user flag grants access to admin-specific actions."
2213 key: :auth_template,
2216 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2217 suggestions: ["show.html"]
2220 key: :oauth_consumer_template,
2223 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2224 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2225 suggestions: ["consumer.html"]
2228 key: :oauth_consumer_strategies,
2229 type: {:list, :string},
2231 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2232 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2233 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2234 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2240 key: :email_notifications,
2242 description: "Email notifications settings",
2248 "emails of \"what you've missed\" for users who have been inactive for a while",
2252 schedule: "0 0 * * 0",
2254 inactivity_threshold: 7
2261 description: "Globally enable or disable digest emails"
2267 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2268 suggestions: ["0 0 * * 0"]
2273 description: "Minimum interval between digest emails to one user",
2277 key: :inactivity_threshold,
2279 description: "Minimum user inactivity threshold",
2288 key: Pleroma.Emails.UserEmail,
2290 description: "Email template settings",
2295 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2296 suggestions: ["some/path/logo.png"]
2301 description: "a map with color settings for email templates.",
2304 link_color: "#d8a070",
2305 background_color: "#2C3645",
2306 content_background_color: "#1B2635",
2307 header_color: "#d8a070",
2308 text_color: "#b9b9ba",
2309 text_muted_color: "#b9b9ba"
2316 suggestions: ["#d8a070"]
2319 key: :background_color,
2321 suggestions: ["#2C3645"]
2324 key: :content_background_color,
2326 suggestions: ["#1B2635"]
2331 suggestions: ["#d8a070"]
2336 suggestions: ["#b9b9ba"]
2339 key: :text_muted_color,
2341 suggestions: ["#b9b9ba"]
2349 key: Pleroma.Emails.NewUsersDigestEmail,
2351 description: "New users admin email digest",
2356 description: "enables new users admin digest email when `true`",
2357 suggestions: [false]
2365 description: "Configure OAuth 2 provider capabilities",
2368 key: :token_expires_in,
2370 description: "The lifetime in seconds of the access token",
2374 key: :issue_new_refresh_token,
2377 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2380 key: :clean_expired_tokens,
2382 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2392 key: :shortcode_globs,
2393 type: {:list, :string},
2394 description: "Location of custom emoji files. * can be used as a wildcard.",
2395 suggestions: ["/emoji/custom/**/*.png"]
2398 key: :pack_extensions,
2399 type: {:list, :string},
2401 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2402 suggestions: [".png", ".gif"]
2406 type: {:keyword, :string, {:list, :string}},
2408 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2409 " and the value is the location or array of locations. * can be used as a wildcard.",
2411 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2415 key: :default_manifest,
2418 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2419 " Currently only one manifest can be added (no arrays).",
2420 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2423 key: :shared_pack_cache_seconds_per_file,
2424 label: "Shared pack cache s/file",
2427 "When an emoji pack is shared, the archive is created and cached in memory" <>
2428 " for this amount of seconds multiplied by the number of files.",
2438 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2442 type: [:tuple, {:list, :tuple}],
2443 description: "For the search requests (account & status search etc.)",
2444 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2448 type: [:tuple, {:list, :tuple}],
2449 description: "For requests to timelines (each timeline has it's own limiter)",
2450 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2453 key: :app_account_creation,
2454 type: [:tuple, {:list, :tuple}],
2455 description: "For registering user accounts from the same IP address",
2456 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2459 key: :relations_actions,
2460 type: [:tuple, {:list, :tuple}],
2461 description: "For actions on relationships with all users (follow, unfollow)",
2462 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2465 key: :relation_id_action,
2466 type: [:tuple, {:list, :tuple}],
2467 description: "For actions on relation with a specific user (follow, unfollow)",
2468 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2471 key: :statuses_actions,
2472 type: [:tuple, {:list, :tuple}],
2474 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2475 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2478 key: :status_id_action,
2479 type: [:tuple, {:list, :tuple}],
2481 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2482 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2485 key: :authentication,
2486 type: [:tuple, {:list, :tuple}],
2487 description: "For authentication create / password check / user existence check requests",
2488 suggestions: [{60_000, 15}]
2496 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2497 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2502 description: "Enables SSH"
2507 description: "Dir with SSH keys",
2508 suggestions: ["/some/path/ssh_keys"]
2513 description: "Handler module",
2514 suggestions: ["Pleroma.BBS.Handler"]
2519 description: "Port to connect",
2520 suggestions: [10_022]
2523 key: :password_authenticator,
2525 description: "Authenticator module",
2526 suggestions: ["Pleroma.BBS.Authenticator"]
2533 description: "Mime types",
2540 "application/xml" => ["xml"],
2541 "application/xrd+xml" => ["xrd+xml"],
2542 "application/jrd+json" => ["jrd+json"],
2543 "application/activity+json" => ["activity+json"],
2544 "application/ld+json" => ["activity+json"]
2549 key: "application/xml",
2550 type: {:list, :string},
2551 suggestions: ["xml"]
2554 key: "application/xrd+xml",
2555 type: {:list, :string},
2556 suggestions: ["xrd+xml"]
2559 key: "application/jrd+json",
2560 type: {:list, :string},
2561 suggestions: ["jrd+json"]
2564 key: "application/activity+json",
2565 type: {:list, :string},
2566 suggestions: ["activity+json"]
2569 key: "application/ld+json",
2570 type: {:list, :string},
2571 suggestions: ["activity+json"]
2581 description: "Pleroma chat settings",
2590 group: :http_signatures,
2592 description: "HTTP Signatures settings",
2597 suggestions: [Pleroma.Signature]
2605 description: "HTTP settings",
2610 type: [:string, :tuple],
2611 description: "Proxy URL",
2612 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2615 key: :send_user_agent,
2620 type: [:string, :atom],
2622 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2623 suggestions: ["Pleroma", :default]
2628 description: "Adapter specific options",
2634 label: "SSL Options",
2635 description: "SSL options for HTTP adapter",
2639 type: {:list, :atom},
2640 description: "List of TLS version to use",
2641 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2655 key: :allow_inline_images,
2659 key: :allow_headings,
2672 type: {:list, :module},
2673 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2683 key: :deny_follow_blocked,
2690 key: :mrf_normalize_markup,
2691 label: "MRF normalize markup",
2692 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2698 suggestions: [Pleroma.HTML.Scrubber.Default]
2708 key: :restricted_nicknames,
2709 type: {:list, :string},
2728 "ostatus_subscribe",
2752 suggestions: [86_400]
2756 type: {:list, :string},
2757 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2761 type: {:list, :string},
2764 "X-RateLimit-Reset",
2765 "X-RateLimit-Limit",
2766 "X-RateLimit-Remaining",
2777 type: {:list, :string},
2778 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2784 key: Pleroma.Plugs.RemoteIp,
2787 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2788 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2794 description: "Enable/disable the plug. Default: disabled."
2798 type: {:list, :string},
2800 "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]`."
2804 type: {:list, :string},
2806 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2810 type: {:list, :string},
2812 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2818 key: :web_cache_ttl,
2821 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2827 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2828 suggestions: [30_000, nil]
2831 key: :activity_pub_question,
2833 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2834 suggestions: [30_000]
2843 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2848 description: "Enables the rendering of static HTML. Default: disabled."
2856 description: "Configure feed rendering",
2861 description: "Configure title rendering.",
2866 description: "Maximum number of characters before truncating title.",
2872 description: "Replacement which will be used after truncating string.",
2873 suggestions: ["..."]
2881 key: :mrf_object_age,
2883 description: "Rejects or delists posts based on their age when received.",
2888 description: "Required age (in seconds) of a post before actions are taken.",
2889 suggestions: [172_800]
2893 type: {:list, :atom},
2895 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2896 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2897 "`:reject` rejects the message entirely",
2898 suggestions: [:delist, :strip_followers, :reject]
2906 description: "Custom Runtime Modules",
2911 description: "A path to custom Elixir modules (such as MRF policies)."
2919 description: "Settings for notifications streamer",
2924 description: "Number of workers to send notifications.",
2928 key: :overflow_workers,
2930 description: "Maximum number of workers created if pool is empty.",
2937 key: :connections_pool,
2939 description: "Advanced settings for `gun` connections pool",
2942 key: :checkin_timeout,
2944 description: "Timeout to checkin connection from pool. Default: 250ms.",
2948 key: :max_connections,
2950 description: "Maximum number of connections in the pool. Default: 250 connections.",
2957 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
2961 key: :retry_timeout,
2964 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
2968 key: :await_up_timeout,
2970 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
2979 description: "Advanced settings for `gun` workers pools",
2984 description: "Settings for federation pool.",
2989 description: "Number workers in the pool.",
2995 description: "Number of additional workers if pool is under load.",
3001 description: "Timeout while `gun` will wait for response.",
3002 suggestions: [150_000]
3009 description: "Settings for media pool.",
3014 description: "Number workers in the pool.",
3020 description: "Number of additional workers if pool is under load.",
3026 description: "Timeout while `gun` will wait for response.",
3027 suggestions: [150_000]
3034 description: "Settings for upload pool.",
3039 description: "Number workers in the pool.",
3045 description: "Number of additional workers if pool is under load.",
3051 description: "Timeout while `gun` will wait for response.",
3052 suggestions: [300_000]
3059 description: "Settings for default pool.",
3064 description: "Number workers in the pool.",
3070 description: "Number of additional workers if pool is under load.",
3076 description: "Timeout while `gun` will wait for response.",
3077 suggestions: [10_000]
3085 key: :hackney_pools,
3087 description: "Advanced settings for `hackney` connections pools",
3092 description: "Settings for federation pool.",
3095 key: :max_connections,
3097 description: "Number workers in the pool.",
3103 description: "Timeout while `hackney` will wait for response.",
3104 suggestions: [150_000]
3111 description: "Settings for media pool.",
3114 key: :max_connections,
3116 description: "Number workers in the pool.",
3122 description: "Timeout while `hackney` will wait for response.",
3123 suggestions: [150_000]
3130 description: "Settings for upload pool.",
3133 key: :max_connections,
3135 description: "Number workers in the pool.",
3141 description: "Timeout while `hackney` will wait for response.",
3142 suggestions: [300_000]
3150 key: :restrict_unauthenticated,
3153 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3158 description: "Settings for public and federated timelines.",
3163 description: "Disallow view public timeline."
3168 description: "Disallow view federated timeline."
3175 description: "Settings for user profiles.",
3180 description: "Disallow view local user profiles."
3185 description: "Disallow view remote user profiles."
3192 description: "Settings for statuses.",
3197 description: "Disallow view local statuses."
3202 description: "Disallow view remote statuses."