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}]
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",
538 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
546 description: "Posts character limit (CW/Subject included in the counter)",
554 description: "Character limit of the instance chat messages",
562 description: "Hard character limit beyond which remote posts will be dropped",
570 description: "File size limit of uploads (except for avatar, background, banner)",
576 key: :avatar_upload_limit,
578 description: "File size limit of user's profile avatars",
584 key: :background_upload_limit,
586 description: "File size limit of user's profile backgrounds",
592 key: :banner_upload_limit,
594 description: "File size limit of user's profile banners",
602 description: "A map with poll limits for local polls",
606 max_option_chars: 200,
608 max_expiration: 31_536_000
615 description: "Maximum number of options",
619 key: :max_option_chars,
621 description: "Maximum number of characters per option",
625 key: :min_expiration,
627 description: "Minimum expiration time (in seconds)",
631 key: :max_expiration,
633 description: "Maximum expiration time (in seconds)",
639 key: :registrations_open,
642 "Enable registrations for anyone. Invitations require this setting to be disabled."
645 key: :invites_enabled,
648 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
651 key: :account_activation_required,
653 description: "Require users to confirm their emails before signing in."
658 description: "Enable federation with other instances."
661 key: :federation_incoming_replies_max_depth,
662 label: "Fed. incoming replies max depth",
665 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
666 " 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.",
672 key: :federation_reachability_timeout_days,
673 label: "Fed. reachability timeout days",
676 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
682 key: :federation_publisher_modules,
683 type: {:list, :module},
684 description: "List of modules for federation publishing",
686 Pleroma.Web.ActivityPub.Publisher
692 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
695 key: :rewrite_policy,
696 type: [:module, {:list, :module}],
697 description: "A list of MRF policies enabled",
699 Generator.list_modules_in_dir(
700 "lib/pleroma/web/activity_pub/mrf",
701 "Elixir.Pleroma.Web.ActivityPub.MRF."
708 "Makes the client API in authentificated mode-only except for user-profiles." <>
709 " Useful for disabling the Local Timeline and The Whole Known Network."
712 key: :quarantined_instances,
713 type: {:list, :string},
715 "List of ActivityPub instances where private (DMs, followers-only) activities will not be send",
722 key: :managed_config,
725 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
730 description: "Instance static directory",
736 key: :allowed_post_formats,
737 type: {:list, :string},
738 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
747 key: :mrf_transparency,
748 label: "MRF transparency",
751 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
754 key: :mrf_transparency_exclusions,
755 label: "MRF transparency exclusions",
756 type: {:list, :string},
758 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
764 key: :extended_nickname_format,
767 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
768 " This will break federation with older software for theses nicknames."
771 key: :cleanup_attachments,
774 Enable to remove associated attachments when status is removed.
775 This will not affect duplicates and attachments without status.
776 Enabling this will increase load to database when deleting statuses on larger instances.
780 key: :max_pinned_statuses,
782 description: "The maximum number of pinned statuses. 0 will disable the feature.",
790 key: :autofollowed_nicknames,
791 type: {:list, :string},
793 "Set to nicknames of (local) users that every new user should automatically follow",
802 key: :attachment_links,
804 description: "Enable to automatically add attachment link text to statuses"
807 key: :welcome_message,
810 "A message that will be sent to a newly registered users as a direct message",
812 "Hi, @username! Welcome on board!"
816 key: :welcome_user_nickname,
818 description: "The nickname of the local user that sends the welcome message",
824 key: :max_report_comment_size,
826 description: "The maximum size of the report comment. Default: 1000.",
832 key: :safe_dm_mentions,
835 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
836 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
842 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
845 key: :remote_post_retention_days,
848 "The default amount of days to retain remote posts when pruning the database",
854 key: :user_bio_length,
856 description: "A user bio maximum length. Default: 5000.",
862 key: :user_name_length,
864 description: "A user name maximum length. Default: 100.",
870 key: :skip_thread_containment,
872 description: "Skip filtering out broken threads. Default: enabled"
875 key: :limit_to_local_content,
876 type: {:dropdown, :atom},
878 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
886 key: :max_account_fields,
888 description: "The maximum number of custom fields in the user profile. Default: 10.",
894 key: :max_remote_account_fields,
897 "The maximum number of custom fields in the remote user profile. Default: 20.",
903 key: :account_field_name_length,
905 description: "An account field name maximum length. Default: 512.",
911 key: :account_field_value_length,
913 description: "An account field value maximum length. Default: 2048.",
919 key: :external_user_synchronization,
921 description: "Enabling following/followers counters synchronization for external users"
928 description: "Logger-related settings",
932 type: [:atom, :tuple, :module],
934 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
935 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
943 description: "ExSyslogger-related settings",
947 type: {:dropdown, :atom},
948 description: "Log level",
949 suggestions: [:debug, :info, :warn, :error]
955 "A string that's prepended to every message, and is typically set to the app name",
956 suggestions: ["pleroma"]
961 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
962 suggestions: ["$metadata[$level] $message"]
966 type: {:list, :atom},
967 suggestions: [:request_id]
975 description: "Console logger settings",
979 type: {:dropdown, :atom},
980 description: "Log level",
981 suggestions: [:debug, :info, :warn, :error]
986 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
987 suggestions: ["$metadata[$level] $message"]
991 type: {:list, :atom},
992 suggestions: [:request_id]
999 description: "Quack-related settings",
1003 type: {:dropdown, :atom},
1004 description: "Log level",
1005 suggestions: [:debug, :info, :warn, :error]
1009 type: {:list, :atom},
1010 description: "Configure which metadata you want to report on",
1028 description: "Configure the Slack incoming webhook",
1029 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1035 key: :frontend_configurations,
1038 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1039 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1040 "add your own configuration your settings all fields must be complete.",
1044 label: "Pleroma FE",
1046 description: "Settings for Pleroma FE",
1049 theme: "pleroma-dark",
1050 logo: "/static/logo.png",
1051 background: "/images/city.jpg",
1052 redirectRootNoLogin: "/main/all",
1053 redirectRootLogin: "/main/friends",
1054 showInstanceSpecificPanel: true,
1055 scopeOptionsEnabled: false,
1056 formattingOptionsEnabled: false,
1057 collapseMessageWithSubject: false,
1058 hidePostStats: false,
1059 hideUserStats: false,
1061 subjectLineBehavior: "email",
1062 alwaysShowSubjectInput: true,
1066 enableEmojiPicker: false
1073 description: "Which theme to use, they are defined in styles.json",
1074 suggestions: ["pleroma-dark"]
1079 description: "URL of the logo, defaults to Pleroma's logo",
1080 suggestions: ["/static/logo.png"]
1086 "URL of the background, unless viewing a user profile with a background that is set",
1087 suggestions: ["/images/city.jpg"]
1090 key: :redirectRootNoLogin,
1091 label: "Redirect root no login",
1094 "Relative URL which indicates where to redirect when a user isn't logged in",
1095 suggestions: ["/main/all"]
1098 key: :redirectRootLogin,
1099 label: "Redirect root login",
1102 "Relative URL which indicates where to redirect when a user is logged in",
1103 suggestions: ["/main/friends"]
1106 key: :showInstanceSpecificPanel,
1107 label: "Show instance specific panel",
1109 description: "Whenether to show the instance's specific panel"
1112 key: :scopeOptionsEnabled,
1113 label: "Scope options enabled",
1115 description: "Enable setting a notice visibility and subject/CW when posting"
1118 key: :formattingOptionsEnabled,
1119 label: "Formatting options enabled",
1122 "Enable setting a formatting different than plain-text (ie. HTML, Markdown) when posting, relates to `:instance`, `allowed_post_formats`"
1125 key: :collapseMessageWithSubject,
1126 label: "Collapse message with subject",
1129 "When a message has a subject (aka Content Warning), collapse it by default"
1132 key: :hidePostStats,
1133 label: "Hide post stats",
1135 description: "Hide notices statistics (repeats, favorites, ...)"
1138 key: :hideUserStats,
1139 label: "Hide user stats",
1142 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1146 label: "Scope copy",
1148 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1151 key: :subjectLineBehavior,
1152 label: "Subject line behavior",
1154 description: "Allows changing the default behaviour of subject lines in replies.
1155 `email`: copy and preprend re:, as in email,
1156 `masto`: copy verbatim, as in Mastodon,
1157 `noop`: don't copy the subject.",
1158 suggestions: ["email", "masto", "noop"]
1161 key: :alwaysShowSubjectInput,
1162 label: "Always show subject input",
1164 description: "When disabled, auto-hide the subject field if it's empty"
1171 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1172 "If you want a colorful logo you must disable logoMask."
1176 label: "Logo margin",
1179 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1180 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1181 suggestions: [".1em"]
1186 description: "Enables stickers."
1189 key: :enableEmojiPicker,
1190 label: "Emoji picker",
1192 description: "Enables emoji picker."
1200 description: "Settings for Masto FE",
1203 showInstanceSpecificPanel: true
1208 key: :showInstanceSpecificPanel,
1209 label: "Show instance specific panel",
1211 description: "Whenether to show the instance's specific panel"
1222 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1226 type: {:keyword, :map},
1228 "Keyword of mascots, each element must contain both an url and a mime_type key",
1231 url: "/images/pleroma-fox-tan-smol.png",
1232 mime_type: "image/png"
1234 pleroma_fox_tan_shy: %{
1235 url: "/images/pleroma-fox-tan-shy.png",
1236 mime_type: "image/png"
1241 key: :default_mascot,
1244 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1256 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1260 type: {:list, :map},
1261 description: "Describe the icons of the app",
1264 src: "/static/logo.png"
1267 src: "/static/icon.png",
1271 src: "/static/icon.ico",
1272 sizes: "72x72 96x96 128x128 256x256"
1279 description: "Describe the theme color of the app",
1280 suggestions: ["#282c37", "mediumpurple"]
1283 key: :background_color,
1285 description: "Describe the background color of the app",
1286 suggestions: ["#191b22", "aliceblue"]
1293 label: "MRF simple",
1295 description: "Message Rewrite Facility",
1298 key: :media_removal,
1299 type: {:list, :string},
1300 description: "List of instances to strip media attachments from",
1301 suggestions: ["example.com", "*.example.com"]
1305 label: "Media NSFW",
1306 type: {:list, :string},
1307 description: "List of instances to tag all media as NSFW (sensitive) from",
1308 suggestions: ["example.com", "*.example.com"]
1311 key: :federated_timeline_removal,
1312 type: {:list, :string},
1314 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1315 suggestions: ["example.com", "*.example.com"]
1319 type: {:list, :string},
1320 description: "List of instances to reject activities from (except deletes)",
1321 suggestions: ["example.com", "*.example.com"]
1325 type: {:list, :string},
1326 description: "List of instances to only accept activities from (except deletes)",
1327 suggestions: ["example.com", "*.example.com"]
1330 key: :report_removal,
1331 type: {:list, :string},
1332 description: "List of instances to reject reports from",
1333 suggestions: ["example.com", "*.example.com"]
1336 key: :avatar_removal,
1337 type: {:list, :string},
1338 description: "List of instances to strip avatars from",
1339 suggestions: ["example.com", "*.example.com"]
1342 key: :banner_removal,
1343 type: {:list, :string},
1344 description: "List of instances to strip banners from",
1345 suggestions: ["example.com", "*.example.com"]
1348 key: :reject_deletes,
1349 type: {:list, :string},
1350 description: "List of instances to reject deletions from",
1351 suggestions: ["example.com", "*.example.com"]
1357 key: :mrf_activity_expiration,
1358 label: "MRF Activity Expiration Policy",
1360 description: "Adds expiration to all local Create activities",
1365 description: "Default global expiration time for all local Create activities (in days)",
1366 suggestions: [90, 365]
1373 label: "MRF subchain",
1376 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1377 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1382 description: "Matches a series of regular expressions against the actor field",
1385 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1393 key: :mrf_rejectnonpublic,
1395 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1396 label: "MRF reject non public",
1400 key: :allow_followersonly,
1401 label: "Allow followers-only",
1403 description: "Whether to allow followers-only posts"
1408 description: "Whether to allow direct messages"
1414 key: :mrf_hellthread,
1415 label: "MRF hellthread",
1417 description: "Block messages with too much mentions",
1420 key: :delist_threshold,
1423 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1424 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1428 key: :reject_threshold,
1431 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1439 label: "MRF keyword",
1441 description: "Reject or Word-Replace messages with a keyword or regex",
1445 type: [:string, :regex],
1447 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1448 suggestions: ["foo", ~r/foo/iu]
1451 key: :federated_timeline_removal,
1452 type: [:string, :regex],
1454 "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.",
1455 suggestions: ["foo", ~r/foo/iu]
1459 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1461 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1462 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1469 label: "MRF mention",
1471 description: "Block messages which mention a user",
1475 type: {:list, :string},
1476 description: "A list of actors for which any post mentioning them will be dropped.",
1477 suggestions: ["actor1", "actor2"]
1483 key: :mrf_vocabulary,
1484 label: "MRF vocabulary",
1486 description: "Filter messages which belong to certain activity vocabularies",
1490 type: {:list, :string},
1492 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1493 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1497 type: {:list, :string},
1499 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1500 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1506 # key: :mrf_user_allowlist,
1509 # "The keys in this section are the domain names that the policy should apply to." <>
1510 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1512 # ["example.org": ["https://example.org/users/admin"]],
1514 # ["example.org": ["https://example.org/users/admin"]]
1522 description: "Media proxy",
1527 description: "Enables proxying of remote media to the instance's proxy"
1533 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1534 suggestions: ["https://example.com"]
1539 description: "Options for Pleroma.ReverseProxy",
1541 redirect_on_failure: false,
1542 max_body_length: 25 * 1_048_576,
1544 follow_redirect: true,
1550 key: :redirect_on_failure,
1553 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1554 "Any error during body processing will not be redirected as the response is chunked."
1557 key: :max_body_length,
1560 "Limits the content length to be approximately the " <>
1561 "specified length. It is validated with the `content-length` header and also verified when proxying."
1566 description: "HTTP options",
1571 description: "Adapter specific options",
1576 label: "SSL Options",
1577 description: "SSL options for HTTP adapter",
1581 type: {:list, :atom},
1582 description: "List of TLS version to use",
1583 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1592 type: [:string, :tuple],
1593 description: "Proxy URL",
1594 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1602 type: {:list, :string},
1603 description: "List of domains to bypass the mediaproxy",
1604 suggestions: ["example.com"]
1612 description: "Gopher settings",
1617 description: "Enables the gopher interface"
1622 description: "IP address to bind to",
1623 suggestions: [{0, 0, 0, 0}]
1628 description: "Port to bind to",
1634 description: "Port advertised in urls (optional, defaults to port)",
1643 description: "ActivityPub-related settings",
1646 key: :unfollow_blocked,
1648 description: "Whether blocks result in people getting unfollowed"
1651 key: :outgoing_blocks,
1653 description: "Whether to federate blocks to other instances"
1656 key: :sign_object_fetches,
1658 description: "Sign object fetches with HTTP signatures"
1661 key: :note_replies_output_limit,
1664 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1667 key: :follow_handshake_timeout,
1669 description: "Following handshake timeout",
1676 key: :http_security,
1678 description: "HTTP security settings",
1683 description: "Whether the managed content security policy is enabled"
1689 description: "Whether to additionally send a Strict-Transport-Security header"
1693 label: "STS max age",
1695 description: "The maximum age for the Strict-Transport-Security header if sent",
1696 suggestions: [31_536_000]
1700 label: "CT max age",
1702 description: "The maximum age for the Expect-CT header if sent",
1703 suggestions: [2_592_000]
1706 key: :referrer_policy,
1708 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1709 suggestions: ["same-origin", "no-referrer"]
1713 label: "Report URI",
1715 description: "Adds the specified url to report-uri and report-to group in CSP header",
1716 suggestions: ["https://example.com/report-uri"]
1721 group: :web_push_encryption,
1722 key: :vapid_details,
1725 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1731 "A mailto link for the administrative contact." <>
1732 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1733 suggestions: ["mailto:moderators@pleroma.com"]
1738 description: "VAPID public key",
1739 suggestions: ["Public key"]
1744 description: "VAPID private key",
1745 suggestions: ["Private key"]
1751 key: Pleroma.Captcha,
1753 description: "Captcha-related settings",
1758 description: "Whether the captcha should be shown on registration"
1763 description: "The method/service to use for captcha",
1764 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1767 key: :seconds_valid,
1769 description: "The time in seconds for which the captcha is valid",
1776 key: Pleroma.Captcha.Kocaptcha,
1779 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1780 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1785 description: "The kocaptcha endpoint to use",
1786 suggestions: ["https://captcha.kotobank.ch"]
1794 "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",
1799 description: "Token",
1800 suggestions: ["We recommend a secure random string or UUID"]
1809 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1811 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1812 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1813 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1814 (see https://github.com/sorentwo/oban/issues/52).
1820 description: "Application's Ecto repo",
1821 suggestions: [Pleroma.Repo]
1825 type: {:dropdown, :atom},
1826 description: "Logs verbose mode",
1827 suggestions: [false, :error, :warn, :info, :debug]
1831 type: [:atom, :tuple],
1833 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1834 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1838 type: {:keyword, :integer},
1840 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1842 activity_expiration: 10,
1843 attachments_cleanup: 5,
1845 federator_incoming: 50,
1846 federator_outgoing: 50,
1848 scheduled_activities: 10,
1854 key: :activity_expiration,
1856 description: "Activity expiration queue",
1860 key: :attachments_cleanup,
1862 description: "Attachment deletion queue",
1868 description: "Background queue",
1872 key: :federator_incoming,
1874 description: "Incoming federation queue",
1878 key: :federator_outgoing,
1880 description: "Outgoing federation queue",
1886 description: "Email sender queue, see Pleroma.Emails.Mailer",
1890 key: :scheduled_activities,
1892 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1896 key: :transmogrifier,
1898 description: "Transmogrifier queue",
1904 description: "Web push notifications queue",
1911 type: {:list, :tuple},
1912 description: "Settings for cron background jobs",
1914 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1915 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1916 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1917 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1918 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1927 description: "Includes custom worker options not interpretable directly by `Oban`",
1931 type: {:keyword, :integer},
1932 description: "Max retry attempts for failed jobs, per `Oban` queue",
1934 federator_incoming: 5,
1935 federator_outgoing: 5
1942 key: Pleroma.Web.Metadata,
1944 description: "Metadata-related settings",
1948 type: {:list, :module},
1949 description: "List of metadata providers to enable",
1951 Pleroma.Web.Metadata.Providers.OpenGraph,
1952 Pleroma.Web.Metadata.Providers.TwitterCard,
1953 Pleroma.Web.Metadata.Providers.RelMe,
1954 Pleroma.Web.Metadata.Providers.Feed
1959 label: "Unfurl NSFW",
1961 description: "When enabled NSFW attachments will be shown in previews"
1970 "If enabled the instance will parse metadata from attached links to generate link previews.",
1975 description: "Enables RichMedia parsing of URLs."
1979 type: {:list, :string},
1980 description: "List of hosts which will be ignored by the metadata parser.",
1981 suggestions: ["accounts.google.com", "xss.website"]
1985 label: "Ignore TLD",
1986 type: {:list, :string},
1987 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
1988 suggestions: ["local", "localdomain", "lan"]
1992 type: {:list, :module},
1993 description: "List of Rich Media parsers.",
1995 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
1996 Pleroma.Web.RichMedia.Parsers.OEmbed,
1997 Pleroma.Web.RichMedia.Parsers.OGP,
1998 Pleroma.Web.RichMedia.Parsers.TwitterCard
2003 label: "TTL setters",
2004 type: {:list, :module},
2005 description: "List of rich media TTL setters.",
2007 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2013 group: :auto_linker,
2016 description: "Configuration for the auto_linker library",
2020 type: [:string, false],
2021 description: "Specify the class to be added to the generated link. Disable to clear",
2022 suggestions: ["auto-linker", false]
2026 type: [:string, false],
2027 description: "Override the rel attribute. Disable to clear",
2028 suggestions: ["ugc", "noopener noreferrer", false]
2033 description: "Link urls will open in new window/tab"
2037 type: [:integer, false],
2039 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2040 suggestions: [15, false]
2045 description: "Strip the scheme prefix"
2050 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2056 key: Pleroma.ScheduledActivity,
2058 description: "Scheduled activities settings",
2061 key: :daily_user_limit,
2064 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2068 key: :total_user_limit,
2071 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2077 description: "Whether scheduled activities are sent to the job queue to be executed"
2083 key: Pleroma.ActivityExpiration,
2085 description: "Expired activity settings",
2090 description: "Whether expired activities will be sent to the job queue to be deleted"
2097 description: "Authenticator",
2100 key: Pleroma.Web.Auth.Authenticator,
2102 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2111 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2112 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2113 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2114 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2119 description: "Enables LDAP authentication"
2124 description: "LDAP server hostname",
2125 suggestions: ["localhosts"]
2130 description: "LDAP port, e.g. 389 or 636",
2131 suggestions: [389, 636]
2137 description: "Enable to use SSL, usually implies the port 636"
2141 label: "SSL options",
2143 description: "Additional SSL options",
2144 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2149 description: "Path to file with PEM encoded cacerts",
2150 suggestions: ["path/to/file/with/PEM/cacerts"]
2155 description: "Type of cert verification",
2156 suggestions: [:verify_peer]
2164 description: "Enable to use STARTTLS, usually implies the port 389"
2168 label: "TLS options",
2170 description: "Additional TLS options",
2171 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2176 description: "Path to file with PEM encoded cacerts",
2177 suggestions: ["path/to/file/with/PEM/cacerts"]
2182 description: "Type of cert verification",
2183 suggestions: [:verify_peer]
2190 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2191 suggestions: ["dc=example,dc=com"]
2197 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2206 description: "Authentication / authorization settings",
2209 key: :enforce_oauth_admin_scope_usage,
2212 "OAuth admin scope requirement toggle. " <>
2213 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2214 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2215 "`is_admin` user flag grants access to admin-specific actions."
2218 key: :auth_template,
2221 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2222 suggestions: ["show.html"]
2225 key: :oauth_consumer_template,
2228 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2229 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2230 suggestions: ["consumer.html"]
2233 key: :oauth_consumer_strategies,
2234 type: {:list, :string},
2236 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2237 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2238 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2239 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2245 key: :email_notifications,
2247 description: "Email notifications settings",
2253 "emails of \"what you've missed\" for users who have been inactive for a while",
2257 schedule: "0 0 * * 0",
2259 inactivity_threshold: 7
2266 description: "Globally enable or disable digest emails"
2272 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2273 suggestions: ["0 0 * * 0"]
2278 description: "Minimum interval between digest emails to one user",
2282 key: :inactivity_threshold,
2284 description: "Minimum user inactivity threshold",
2293 key: :notifications,
2295 description: "Notification settings",
2298 key: :enable_follow_request_notifications,
2301 "Enables notifications on new follow requests (causes issues with older PleromaFE versions)."
2307 key: Pleroma.Emails.UserEmail,
2309 description: "Email template settings",
2314 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2315 suggestions: ["some/path/logo.png"]
2320 description: "a map with color settings for email templates.",
2323 link_color: "#d8a070",
2324 background_color: "#2C3645",
2325 content_background_color: "#1B2635",
2326 header_color: "#d8a070",
2327 text_color: "#b9b9ba",
2328 text_muted_color: "#b9b9ba"
2335 suggestions: ["#d8a070"]
2338 key: :background_color,
2340 suggestions: ["#2C3645"]
2343 key: :content_background_color,
2345 suggestions: ["#1B2635"]
2350 suggestions: ["#d8a070"]
2355 suggestions: ["#b9b9ba"]
2358 key: :text_muted_color,
2360 suggestions: ["#b9b9ba"]
2368 key: Pleroma.Emails.NewUsersDigestEmail,
2370 description: "New users admin email digest",
2375 description: "enables new users admin digest email when `true`",
2376 suggestions: [false]
2384 description: "Configure OAuth 2 provider capabilities",
2387 key: :token_expires_in,
2389 description: "The lifetime in seconds of the access token",
2393 key: :issue_new_refresh_token,
2396 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2399 key: :clean_expired_tokens,
2401 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2411 key: :shortcode_globs,
2412 type: {:list, :string},
2413 description: "Location of custom emoji files. * can be used as a wildcard.",
2414 suggestions: ["/emoji/custom/**/*.png"]
2417 key: :pack_extensions,
2418 type: {:list, :string},
2420 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2421 suggestions: [".png", ".gif"]
2425 type: {:keyword, :string, {:list, :string}},
2427 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2428 " and the value is the location or array of locations. * can be used as a wildcard.",
2430 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2434 key: :default_manifest,
2437 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2438 " Currently only one manifest can be added (no arrays).",
2439 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2442 key: :shared_pack_cache_seconds_per_file,
2443 label: "Shared pack cache s/file",
2446 "When an emoji pack is shared, the archive is created and cached in memory" <>
2447 " for this amount of seconds multiplied by the number of files.",
2457 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2461 type: [:tuple, {:list, :tuple}],
2462 description: "For the search requests (account & status search etc.)",
2463 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2467 type: [:tuple, {:list, :tuple}],
2468 description: "For requests to timelines (each timeline has it's own limiter)",
2469 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2472 key: :app_account_creation,
2473 type: [:tuple, {:list, :tuple}],
2474 description: "For registering user accounts from the same IP address",
2475 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2478 key: :relations_actions,
2479 type: [:tuple, {:list, :tuple}],
2480 description: "For actions on relationships with all users (follow, unfollow)",
2481 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2484 key: :relation_id_action,
2485 type: [:tuple, {:list, :tuple}],
2486 description: "For actions on relation with a specific user (follow, unfollow)",
2487 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2490 key: :statuses_actions,
2491 type: [:tuple, {:list, :tuple}],
2493 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2494 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2497 key: :status_id_action,
2498 type: [:tuple, {:list, :tuple}],
2500 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2501 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2504 key: :authentication,
2505 type: [:tuple, {:list, :tuple}],
2506 description: "For authentication create / password check / user existence check requests",
2507 suggestions: [{60_000, 15}]
2515 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2516 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2521 description: "Enables SSH"
2526 description: "Dir with SSH keys",
2527 suggestions: ["/some/path/ssh_keys"]
2532 description: "Handler module",
2533 suggestions: ["Pleroma.BBS.Handler"]
2538 description: "Port to connect",
2539 suggestions: [10_022]
2542 key: :password_authenticator,
2544 description: "Authenticator module",
2545 suggestions: ["Pleroma.BBS.Authenticator"]
2552 description: "Mime types",
2559 "application/xml" => ["xml"],
2560 "application/xrd+xml" => ["xrd+xml"],
2561 "application/jrd+json" => ["jrd+json"],
2562 "application/activity+json" => ["activity+json"],
2563 "application/ld+json" => ["activity+json"]
2568 key: "application/xml",
2569 type: {:list, :string},
2570 suggestions: ["xml"]
2573 key: "application/xrd+xml",
2574 type: {:list, :string},
2575 suggestions: ["xrd+xml"]
2578 key: "application/jrd+json",
2579 type: {:list, :string},
2580 suggestions: ["jrd+json"]
2583 key: "application/activity+json",
2584 type: {:list, :string},
2585 suggestions: ["activity+json"]
2588 key: "application/ld+json",
2589 type: {:list, :string},
2590 suggestions: ["activity+json"]
2600 description: "Pleroma chat settings",
2609 group: :http_signatures,
2611 description: "HTTP Signatures settings",
2616 suggestions: [Pleroma.Signature]
2624 description: "HTTP settings",
2629 type: [:string, :tuple],
2630 description: "Proxy URL",
2631 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2634 key: :send_user_agent,
2639 type: [:string, :atom],
2641 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2642 suggestions: ["Pleroma", :default]
2647 description: "Adapter specific options",
2653 label: "SSL Options",
2654 description: "SSL options for HTTP adapter",
2658 type: {:list, :atom},
2659 description: "List of TLS version to use",
2660 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2674 key: :allow_inline_images,
2678 key: :allow_headings,
2691 type: {:list, :module},
2692 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2702 key: :deny_follow_blocked,
2709 key: :mrf_normalize_markup,
2710 label: "MRF normalize markup",
2711 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2717 suggestions: [Pleroma.HTML.Scrubber.Default]
2727 key: :restricted_nicknames,
2728 type: {:list, :string},
2747 "ostatus_subscribe",
2771 suggestions: [86_400]
2775 type: {:list, :string},
2776 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2780 type: {:list, :string},
2783 "X-RateLimit-Reset",
2784 "X-RateLimit-Limit",
2785 "X-RateLimit-Remaining",
2796 type: {:list, :string},
2797 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2803 key: Pleroma.Plugs.RemoteIp,
2806 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2807 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2813 description: "Enable/disable the plug. Default: disabled."
2817 type: {:list, :string},
2819 "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]`."
2823 type: {:list, :string},
2825 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2829 type: {:list, :string},
2831 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2837 key: :web_cache_ttl,
2840 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2846 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2847 suggestions: [30_000, nil]
2850 key: :activity_pub_question,
2852 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2853 suggestions: [30_000]
2862 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2867 description: "Enables the rendering of static HTML. Default: disabled."
2875 description: "Configure feed rendering",
2880 description: "Configure title rendering.",
2885 description: "Maximum number of characters before truncating title.",
2891 description: "Replacement which will be used after truncating string.",
2892 suggestions: ["..."]
2900 key: :mrf_object_age,
2902 description: "Rejects or delists posts based on their age when received.",
2907 description: "Required age (in seconds) of a post before actions are taken.",
2908 suggestions: [172_800]
2912 type: {:list, :atom},
2914 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2915 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2916 "`:reject` rejects the message entirely",
2917 suggestions: [:delist, :strip_followers, :reject]
2925 description: "Custom Runtime Modules",
2930 description: "A path to custom Elixir modules (such as MRF policies)."
2938 description: "Settings for notifications streamer",
2943 description: "Number of workers to send notifications.",
2947 key: :overflow_workers,
2949 description: "Maximum number of workers created if pool is empty.",
2956 key: :connections_pool,
2958 description: "Advanced settings for `gun` connections pool",
2961 key: :checkin_timeout,
2963 description: "Timeout to checkin connection from pool. Default: 250ms.",
2967 key: :max_connections,
2969 description: "Maximum number of connections in the pool. Default: 250 connections.",
2976 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
2980 key: :retry_timeout,
2983 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
2987 key: :await_up_timeout,
2989 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
2998 description: "Advanced settings for `gun` workers pools",
3003 description: "Settings for federation pool.",
3008 description: "Number workers in the pool.",
3014 description: "Number of additional workers if pool is under load.",
3020 description: "Timeout while `gun` will wait for response.",
3021 suggestions: [150_000]
3028 description: "Settings for media pool.",
3033 description: "Number workers in the pool.",
3039 description: "Number of additional workers if pool is under load.",
3045 description: "Timeout while `gun` will wait for response.",
3046 suggestions: [150_000]
3053 description: "Settings for upload pool.",
3058 description: "Number workers in the pool.",
3064 description: "Number of additional workers if pool is under load.",
3070 description: "Timeout while `gun` will wait for response.",
3071 suggestions: [300_000]
3078 description: "Settings for default pool.",
3083 description: "Number workers in the pool.",
3089 description: "Number of additional workers if pool is under load.",
3095 description: "Timeout while `gun` will wait for response.",
3096 suggestions: [10_000]
3104 key: :hackney_pools,
3106 description: "Advanced settings for `hackney` connections pools",
3111 description: "Settings for federation 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 media pool.",
3133 key: :max_connections,
3135 description: "Number workers in the pool.",
3141 description: "Timeout while `hackney` will wait for response.",
3142 suggestions: [150_000]
3149 description: "Settings for upload pool.",
3152 key: :max_connections,
3154 description: "Number workers in the pool.",
3160 description: "Timeout while `hackney` will wait for response.",
3161 suggestions: [300_000]
3169 key: :restrict_unauthenticated,
3172 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3177 description: "Settings for public and federated timelines.",
3182 description: "Disallow view public timeline."
3187 description: "Disallow view federated timeline."
3194 description: "Settings for user profiles.",
3199 description: "Disallow view local user profiles."
3204 description: "Disallow view remote user profiles."
3211 description: "Settings for statuses.",
3216 description: "Disallow view local statuses."
3221 description: "Disallow view remote statuses."