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},
32 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
34 Generator.list_modules_in_dir(
35 "lib/pleroma/upload/filter",
36 "Elixir.Pleroma.Upload.Filter."
43 "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`."
49 description: "Base URL for the uploads, needed if you use CDN",
51 "https://cdn-host.com"
58 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
62 label: "Proxy Options",
64 description: "Options for Pleroma.ReverseProxy",
66 redirect_on_failure: false,
67 max_body_length: 25 * 1_048_576,
69 follow_redirect: true,
75 key: :redirect_on_failure,
78 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
79 "Any error during body processing will not be redirected as the response is chunked."
82 key: :max_body_length,
85 "Limits the content length to be approximately the " <>
86 "specified length. It is validated with the `content-length` header and also verified when proxying."
92 description: "HTTP options",
97 description: "Adapter specific options",
102 label: "SSL Options",
103 description: "SSL options for HTTP adapter",
107 type: {:list, :atom},
108 description: "List of TLS versions to use",
109 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
118 type: [:string, :tuple],
119 description: "Proxy URL",
120 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
127 key: :filename_display_max_length,
129 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
135 key: Pleroma.Uploaders.Local,
137 description: "Local uploader-related settings",
142 description: "Path where user's uploads will be saved",
151 key: Pleroma.Uploaders.S3,
153 description: "S3 uploader-related settings",
158 description: "S3 bucket",
164 key: :bucket_namespace,
166 description: "S3 bucket namespace",
167 suggestions: ["pleroma"]
170 key: :public_endpoint,
172 description: "S3 endpoint",
173 suggestions: ["https://s3.amazonaws.com"]
176 key: :truncated_namespace,
179 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
180 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
183 key: :streaming_enabled,
186 "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."
192 key: Pleroma.Upload.Filter.Mogrify,
194 description: "Uploads mogrify filter settings",
198 type: [:string, {:list, :string}, {:list, :tuple}],
199 description: "List of actions for the mogrify command",
210 key: Pleroma.Upload.Filter.AnonymizeFilename,
212 description: "Filter replaces the filename of the upload",
218 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
219 " filename extension by using {extension}, for example custom-file-name.{extension}.",
221 "custom-file-name.{extension}"
228 key: Pleroma.Emails.Mailer,
230 description: "Mailer-related settings",
236 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
237 " or Swoosh.Adapters.Local for in-memory mailbox",
239 Swoosh.Adapters.SMTP,
240 Swoosh.Adapters.Sendgrid,
241 Swoosh.Adapters.Sendmail,
242 Swoosh.Adapters.Mandrill,
243 Swoosh.Adapters.Mailgun,
244 Swoosh.Adapters.Mailjet,
245 Swoosh.Adapters.Postmark,
246 Swoosh.Adapters.SparkPost,
247 Swoosh.Adapters.AmazonSES,
249 Swoosh.Adapters.SocketLabs,
250 Swoosh.Adapters.Gmail,
251 Swoosh.Adapters.Local
257 description: "Allow/disallow send emails"
260 group: {:subgroup, Swoosh.Adapters.SMTP},
263 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
264 suggestions: ["smtp.gmail.com"]
267 group: {:subgroup, Swoosh.Adapters.SMTP},
270 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
271 suggestions: ["pleroma"]
274 group: {:subgroup, Swoosh.Adapters.SMTP},
277 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
278 suggestions: ["password"]
281 group: {:subgroup, Swoosh.Adapters.SMTP},
285 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
288 group: {:subgroup, Swoosh.Adapters.SMTP},
292 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
293 suggestions: [:always, :never, :if_available]
296 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",
310 group: {:subgroup, Swoosh.Adapters.SMTP},
313 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
317 group: {:subgroup, Swoosh.Adapters.SMTP},
319 label: "No MX lookups",
321 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
324 group: {:subgroup, Swoosh.Adapters.Sendgrid},
328 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
329 suggestions: ["my-api-key"]
332 group: {:subgroup, Swoosh.Adapters.Sendmail},
335 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
336 suggestions: ["/usr/bin/sendmail"]
339 group: {:subgroup, Swoosh.Adapters.Sendmail},
342 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
343 suggestions: ["-N delay,failure,success"]
346 group: {:subgroup, Swoosh.Adapters.Sendmail},
349 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
352 group: {:subgroup, Swoosh.Adapters.Mandrill},
356 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
357 suggestions: ["my-api-key"]
360 group: {:subgroup, Swoosh.Adapters.Mailgun},
364 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
365 suggestions: ["my-api-key"]
368 group: {:subgroup, Swoosh.Adapters.Mailgun},
371 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
372 suggestions: ["pleroma.com"]
375 group: {:subgroup, Swoosh.Adapters.Mailjet},
379 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
380 suggestions: ["my-api-key"]
383 group: {:subgroup, Swoosh.Adapters.Mailjet},
386 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
387 suggestions: ["my-secret-key"]
390 group: {:subgroup, Swoosh.Adapters.Postmark},
394 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
395 suggestions: ["my-api-key"]
398 group: {:subgroup, Swoosh.Adapters.SparkPost},
402 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
403 suggestions: ["my-api-key"]
406 group: {:subgroup, Swoosh.Adapters.SparkPost},
409 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
410 suggestions: ["https://api.sparkpost.com/api/v1"]
413 group: {:subgroup, Swoosh.Adapters.AmazonSES},
416 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
417 suggestions: ["us-east-1", "us-east-2"]
420 group: {:subgroup, Swoosh.Adapters.AmazonSES},
423 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
424 suggestions: ["aws-access-key"]
427 group: {:subgroup, Swoosh.Adapters.AmazonSES},
430 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
431 suggestions: ["aws-secret-key"]
434 group: {:subgroup, Swoosh.Adapters.Dyn},
438 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
439 suggestions: ["my-api-key"]
442 group: {:subgroup, Swoosh.Adapters.SocketLabs},
445 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
448 group: {:subgroup, Swoosh.Adapters.SocketLabs},
452 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
455 group: {:subgroup, Swoosh.Adapters.Gmail},
458 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
465 description: "`Swoosh.Adapters.Local` adapter specific settings",
468 group: {:subgroup, Swoosh.Adapters.Local},
471 description: "Run the preview server together as part of your app"
474 group: {:subgroup, Swoosh.Adapters.Local},
477 description: "The preview server port",
485 label: "URI Schemes",
487 description: "URI schemes related settings",
491 type: {:list, :string},
492 description: "List of the scheme part that is considered valid to be an URL",
516 description: "Instance-related settings",
521 description: "Name of the instance",
528 label: "Admin Email Address",
530 description: "Email used to reach an Administrator/Moderator of the instance",
537 label: "Sender Email Address",
539 description: "Envelope FROM address for mail sent via Pleroma",
548 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
556 description: "Posts character limit (CW/Subject included in the counter)",
564 description: "Character limit of the instance chat messages",
572 description: "Hard character limit beyond which remote posts will be dropped",
580 description: "File size limit of uploads (except for avatar, background, banner)",
586 key: :avatar_upload_limit,
588 description: "File size limit of user's profile avatars",
594 key: :background_upload_limit,
596 description: "File size limit of user's profile backgrounds",
602 key: :banner_upload_limit,
604 description: "File size limit of user's profile banners",
612 description: "A map with poll limits for local polls",
616 max_option_chars: 200,
618 max_expiration: 31_536_000
625 description: "Maximum number of options",
629 key: :max_option_chars,
631 description: "Maximum number of characters per option",
635 key: :min_expiration,
637 description: "Minimum expiration time (in seconds)",
641 key: :max_expiration,
643 description: "Maximum expiration time (in seconds)",
649 key: :registrations_open,
652 "Enable registrations for anyone. Invitations require this setting to be disabled."
655 key: :invites_enabled,
658 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
661 key: :account_activation_required,
663 description: "Require users to confirm their emails before signing in"
668 description: "Enable federation with other instances"
671 key: :federation_incoming_replies_max_depth,
672 label: "Fed. incoming replies max depth",
675 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
676 " 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.",
682 key: :federation_reachability_timeout_days,
683 label: "Fed. reachability timeout days",
686 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
694 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
700 "Makes the client API in authentificated mode-only except for user-profiles." <>
701 " Useful for disabling the Local Timeline and The Whole Known Network."
704 key: :quarantined_instances,
705 type: {:list, :string},
707 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
714 key: :managed_config,
717 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
722 description: "Instance static directory",
728 key: :allowed_post_formats,
729 type: {:list, :string},
730 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
739 key: :extended_nickname_format,
742 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
743 " This will break federation with older software for theses nicknames."
746 key: :cleanup_attachments,
749 Enable to remove associated attachments when status is removed.
750 This will not affect duplicates and attachments without status.
751 Enabling this will increase load to database when deleting statuses on larger instances.
755 key: :max_pinned_statuses,
757 description: "The maximum number of pinned statuses. 0 will disable the feature.",
765 key: :autofollowed_nicknames,
766 type: {:list, :string},
768 "Set to nicknames of (local) users that every new user should automatically follow",
777 key: :attachment_links,
779 description: "Enable to automatically add attachment link text to statuses"
782 key: :welcome_message,
785 "A message that will be sent to a newly registered users as a direct message",
787 "Hi, @username! Welcome on board!"
791 key: :welcome_user_nickname,
793 description: "The nickname of the local user that sends the welcome message",
799 key: :max_report_comment_size,
801 description: "The maximum size of the report comment. Default: 1000.",
807 key: :safe_dm_mentions,
808 label: "Safe DM mentions",
811 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
812 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
818 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
821 key: :remote_post_retention_days,
824 "The default amount of days to retain remote posts when pruning the database",
830 key: :user_bio_length,
832 description: "A user bio maximum length. Default: 5000.",
838 key: :user_name_length,
840 description: "A user name maximum length. Default: 100.",
846 key: :skip_thread_containment,
848 description: "Skip filtering out broken threads. Default: enabled."
851 key: :limit_to_local_content,
852 type: {:dropdown, :atom},
854 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
862 key: :max_account_fields,
864 description: "The maximum number of custom fields in the user profile. Default: 10.",
870 key: :max_remote_account_fields,
873 "The maximum number of custom fields in the remote user profile. Default: 20.",
879 key: :account_field_name_length,
881 description: "An account field name maximum length. Default: 512.",
887 key: :account_field_value_length,
889 description: "An account field value maximum length. Default: 2048.",
895 key: :external_user_synchronization,
897 description: "Enabling following/followers counters synchronization for external users"
900 key: :multi_factor_authentication,
902 description: "Multi-factor authentication settings",
905 totp: [digits: 6, period: 30],
906 backup_codes: [number: 5, length: 16]
912 label: "TOTP settings",
914 description: "TOTP settings",
915 suggestions: [digits: 6, period: 30],
922 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
929 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
936 description: "MFA backup codes settings",
937 suggestions: [number: 5, length: 16],
943 description: "Number of backup codes to generate."
950 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
957 key: :instance_thumbnail,
960 "The instance thumbnail can be any image that represents your instance and is used by some apps or services when they display information about your instance.",
961 suggestions: ["/instance/thumbnail.jpeg"]
968 description: "Logger-related settings",
972 type: [:atom, :tuple, :module],
974 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
975 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
983 label: "ExSyslogger",
984 description: "ExSyslogger-related settings",
988 type: {:dropdown, :atom},
989 description: "Log level",
990 suggestions: [:debug, :info, :warn, :error]
996 "A string that's prepended to every message, and is typically set to the app name",
997 suggestions: ["pleroma"]
1002 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1003 suggestions: ["$metadata[$level] $message"]
1007 type: {:list, :atom},
1008 suggestions: [:request_id]
1016 label: "Console Logger",
1017 description: "Console logger settings",
1021 type: {:dropdown, :atom},
1022 description: "Log level",
1023 suggestions: [:debug, :info, :warn, :error]
1028 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1029 suggestions: ["$metadata[$level] $message"]
1033 type: {:list, :atom},
1034 suggestions: [:request_id]
1041 label: "Quack Logger",
1042 description: "Quack-related settings",
1046 type: {:dropdown, :atom},
1047 description: "Log level",
1048 suggestions: [:debug, :info, :warn, :error]
1052 type: {:list, :atom},
1053 description: "Configure which metadata you want to report on",
1071 description: "Configure the Slack incoming webhook",
1072 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1078 key: :frontend_configurations,
1081 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1082 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1083 "add your own configuration your settings all fields must be complete.",
1087 label: "Pleroma FE",
1089 description: "Settings for Pleroma FE",
1092 alwaysShowSubjectInput: true,
1093 background: "/static/aurora_borealis.jpg",
1094 collapseMessageWithSubject: false,
1097 hideFilteredStatuses: false,
1098 hideMutedPosts: false,
1099 hidePostStats: false,
1100 hideSitename: false,
1101 hideUserStats: false,
1102 loginMethod: "password",
1103 logo: "/static/logo.png",
1106 minimalScopesMode: false,
1107 noAttachmentLinks: false,
1108 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1109 postContentType: "text/plain",
1110 redirectRootLogin: "/main/friends",
1111 redirectRootNoLogin: "/main/all",
1113 sidebarRight: false,
1114 showFeaturesPanel: true,
1115 showInstanceSpecificPanel: false,
1116 subjectLineBehavior: "email",
1117 theme: "pleroma-dark",
1118 webPushNotifications: false
1123 key: :alwaysShowSubjectInput,
1124 label: "Always show subject input",
1126 description: "When disabled, auto-hide the subject field if it's empty"
1132 "URL of the background, unless viewing a user profile with a background that is set",
1133 suggestions: ["/images/city.jpg"]
1136 key: :collapseMessageWithSubject,
1137 label: "Collapse message with subject",
1140 "When a message has a subject (aka Content Warning), collapse it by default"
1144 label: "PleromaFE Chat",
1146 description: "Disables PleromaFE Chat component"
1152 description: "Enables green text on lines prefixed with the > character"
1155 key: :hideFilteredStatuses,
1156 label: "Hide Filtered Statuses",
1158 description: "Hides filtered statuses from timelines"
1161 key: :hideMutedPosts,
1162 label: "Hide Muted Posts",
1164 description: "Hides muted statuses from timelines"
1167 key: :hidePostStats,
1168 label: "Hide post stats",
1170 description: "Hide notices statistics (repeats, favorites, ...)"
1174 label: "Hide Sitename",
1176 description: "Hides instance name from PleromaFE banner"
1179 key: :hideUserStats,
1180 label: "Hide user stats",
1183 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1188 description: "URL of the logo, defaults to Pleroma's logo",
1189 suggestions: ["/static/logo.png"]
1193 label: "Logo margin",
1196 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1197 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1198 suggestions: [".1em"]
1205 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1206 "If you want a colorful logo you must disable logoMask."
1209 key: :minimalScopesMode,
1210 label: "Minimal scopes mode",
1213 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1214 "Also prevents replying to a DM with a public post from PleromaFE."
1217 key: :nsfwCensorImage,
1218 label: "NSFW Censor Image",
1221 "URL of the image to use for hiding NSFW media attachments in the timeline",
1222 suggestions: ["/static/img/nsfw.74818f9.png"]
1225 key: :postContentType,
1226 label: "Post Content Type",
1227 type: {:dropdown, :atom},
1228 description: "Default post formatting option",
1229 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1232 key: :redirectRootNoLogin,
1233 label: "Redirect root no login",
1236 "Relative URL which indicates where to redirect when a user isn't logged in",
1237 suggestions: ["/main/all"]
1240 key: :redirectRootLogin,
1241 label: "Redirect root login",
1244 "Relative URL which indicates where to redirect when a user is logged in",
1245 suggestions: ["/main/friends"]
1249 label: "Scope copy",
1251 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1255 label: "Sidebar on Right",
1257 description: "Change alignment of sidebar and panels to the right"
1260 key: :showFeaturesPanel,
1261 label: "Show instance features panel",
1264 "Enables panel displaying functionality of the instance on the About page"
1267 key: :showInstanceSpecificPanel,
1268 label: "Show instance specific panel",
1270 description: "Whether to show the instance's custom panel"
1273 key: :subjectLineBehavior,
1274 label: "Subject line behavior",
1276 description: "Allows changing the default behaviour of subject lines in replies.
1277 `email`: copy and preprend re:, as in email,
1278 `masto`: copy verbatim, as in Mastodon,
1279 `noop`: don't copy the subject.",
1280 suggestions: ["email", "masto", "noop"]
1285 description: "Which theme to use. Available themes are defined in styles.json",
1286 suggestions: ["pleroma-dark"]
1294 description: "Settings for Masto FE",
1297 showInstanceSpecificPanel: true
1302 key: :showInstanceSpecificPanel,
1303 label: "Show instance specific panel",
1305 description: "Whenether to show the instance's specific panel"
1316 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1320 type: {:keyword, :map},
1322 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1325 url: "/images/pleroma-fox-tan-smol.png",
1326 mime_type: "image/png"
1328 pleroma_fox_tan_shy: %{
1329 url: "/images/pleroma-fox-tan-shy.png",
1330 mime_type: "image/png"
1335 key: :default_mascot,
1338 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1344 key: :default_user_avatar,
1346 description: "URL of the default user avatar",
1347 suggestions: ["/images/avi.png"]
1356 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1360 type: {:list, :map},
1361 description: "Describe the icons of the app",
1364 src: "/static/logo.png"
1367 src: "/static/icon.png",
1371 src: "/static/icon.ico",
1372 sizes: "72x72 96x96 128x128 256x256"
1379 description: "Describe the theme color of the app",
1380 suggestions: ["#282c37", "mediumpurple"]
1383 key: :background_color,
1385 description: "Describe the background color of the app",
1386 suggestions: ["#191b22", "aliceblue"]
1393 label: "MRF Simple",
1395 description: "Message Rewrite Facility",
1398 key: :media_removal,
1399 type: {:list, :string},
1400 description: "List of instances to strip media attachments from",
1401 suggestions: ["example.com", "*.example.com"]
1405 label: "Media NSFW",
1406 type: {:list, :string},
1407 description: "List of instances to tag all media as NSFW (sensitive) from",
1408 suggestions: ["example.com", "*.example.com"]
1411 key: :federated_timeline_removal,
1412 type: {:list, :string},
1414 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1415 suggestions: ["example.com", "*.example.com"]
1419 type: {:list, :string},
1420 description: "List of instances to reject activities from (except deletes)",
1421 suggestions: ["example.com", "*.example.com"]
1425 type: {:list, :string},
1426 description: "List of instances to only accept activities from (except deletes)",
1427 suggestions: ["example.com", "*.example.com"]
1430 key: :report_removal,
1431 type: {:list, :string},
1432 description: "List of instances to reject reports from",
1433 suggestions: ["example.com", "*.example.com"]
1436 key: :avatar_removal,
1437 type: {:list, :string},
1438 description: "List of instances to strip avatars from",
1439 suggestions: ["example.com", "*.example.com"]
1442 key: :banner_removal,
1443 type: {:list, :string},
1444 description: "List of instances to strip banners from",
1445 suggestions: ["example.com", "*.example.com"]
1448 key: :reject_deletes,
1449 type: {:list, :string},
1450 description: "List of instances to reject deletions from",
1451 suggestions: ["example.com", "*.example.com"]
1457 key: :mrf_activity_expiration,
1458 label: "MRF Activity Expiration Policy",
1460 description: "Adds expiration to all local Create Note activities",
1465 description: "Default global expiration time for all local Create activities (in days)",
1466 suggestions: [90, 365]
1473 label: "MRF Subchain",
1476 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1477 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1482 description: "Matches a series of regular expressions against the actor field",
1485 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1493 key: :mrf_rejectnonpublic,
1495 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1496 label: "MRF Reject Non Public",
1500 key: :allow_followersonly,
1501 label: "Allow followers-only",
1503 description: "Whether to allow followers-only posts"
1508 description: "Whether to allow direct messages"
1514 key: :mrf_hellthread,
1515 label: "MRF Hellthread",
1517 description: "Block messages with too much mentions",
1520 key: :delist_threshold,
1523 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1524 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1528 key: :reject_threshold,
1531 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1539 label: "MRF Keyword",
1541 description: "Reject or Word-Replace messages with a keyword or regex",
1545 type: [:string, :regex],
1547 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1548 suggestions: ["foo", ~r/foo/iu]
1551 key: :federated_timeline_removal,
1552 type: [:string, :regex],
1554 "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.",
1555 suggestions: ["foo", ~r/foo/iu]
1559 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1561 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1562 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1569 label: "MRF Mention",
1571 description: "Block messages which mention a user",
1575 type: {:list, :string},
1576 description: "A list of actors for which any post mentioning them will be dropped",
1577 suggestions: ["actor1", "actor2"]
1583 key: :mrf_vocabulary,
1584 label: "MRF Vocabulary",
1586 description: "Filter messages which belong to certain activity vocabularies",
1590 type: {:list, :string},
1592 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1593 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1597 type: {:list, :string},
1599 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1600 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1606 # key: :mrf_user_allowlist,
1609 # "The keys in this section are the domain names that the policy should apply to." <>
1610 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1612 # %{"example.org" => ["https://example.org/users/admin"]}
1620 description: "Media proxy",
1625 description: "Enables proxying of remote media to the instance's proxy"
1632 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1633 suggestions: ["https://example.com"]
1641 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1647 description: "Enables invalidate media cache"
1652 description: "Module which will be used to cache purge.",
1654 Pleroma.Web.MediaProxy.Invalidation.Script,
1655 Pleroma.Web.MediaProxy.Invalidation.Http
1662 label: "Proxy Options",
1664 description: "Options for Pleroma.ReverseProxy",
1666 redirect_on_failure: false,
1667 max_body_length: 25 * 1_048_576,
1669 follow_redirect: true,
1675 key: :redirect_on_failure,
1678 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1679 "Any error during body processing will not be redirected as the response is chunked."
1682 key: :max_body_length,
1685 "Limits the content length to be approximately the " <>
1686 "specified length. It is validated with the `content-length` header and also verified when proxying."
1692 description: "HTTP options",
1697 description: "Adapter specific options",
1702 label: "SSL Options",
1703 description: "SSL options for HTTP adapter",
1707 type: {:list, :atom},
1708 description: "List of TLS version to use",
1709 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1718 type: [:string, :tuple],
1719 description: "Proxy URL",
1720 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1728 type: {:list, :string},
1729 description: "List of domains to bypass the mediaproxy",
1730 suggestions: ["example.com"]
1736 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1738 description: "HTTP invalidate settings",
1743 description: "HTTP method of request. Default: :purge"
1747 type: {:list, :tuple},
1748 description: "HTTP headers of request.",
1749 suggestions: [{"x-refresh", 1}]
1754 description: "Request options.",
1755 suggestions: [params: %{ts: "xxx"}]
1761 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1763 description: "Script invalidate settings",
1768 description: "Path to shell script. Which will run purge cache.",
1769 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1777 description: "Gopher settings",
1782 description: "Enables the gopher interface"
1788 description: "IP address to bind to",
1789 suggestions: [{0, 0, 0, 0}]
1794 description: "Port to bind to",
1800 description: "Port advertised in URLs (optional, defaults to port)",
1808 label: "ActivityPub",
1810 description: "ActivityPub-related settings",
1813 key: :unfollow_blocked,
1815 description: "Whether blocks result in people getting unfollowed"
1818 key: :outgoing_blocks,
1820 description: "Whether to federate blocks to other instances"
1823 key: :sign_object_fetches,
1825 description: "Sign object fetches with HTTP signatures"
1828 key: :note_replies_output_limit,
1831 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1834 key: :follow_handshake_timeout,
1836 description: "Following handshake timeout",
1843 key: :http_security,
1844 label: "HTTP security",
1846 description: "HTTP security settings",
1851 description: "Whether the managed content security policy is enabled"
1857 description: "Whether to additionally send a Strict-Transport-Security header"
1861 label: "STS max age",
1863 description: "The maximum age for the Strict-Transport-Security header if sent",
1864 suggestions: [31_536_000]
1868 label: "CT max age",
1870 description: "The maximum age for the Expect-CT header if sent",
1871 suggestions: [2_592_000]
1874 key: :referrer_policy,
1876 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1877 suggestions: ["same-origin", "no-referrer"]
1881 label: "Report URI",
1883 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1884 suggestions: ["https://example.com/report-uri"]
1889 group: :web_push_encryption,
1890 key: :vapid_details,
1891 label: "Vapid Details",
1894 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1900 "A mailto link for the administrative contact." <>
1901 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1902 suggestions: ["mailto:moderators@pleroma.com"]
1907 description: "VAPID public key",
1908 suggestions: ["Public key"]
1913 description: "VAPID private key",
1914 suggestions: ["Private key"]
1920 key: Pleroma.Captcha,
1922 description: "Captcha-related settings",
1927 description: "Whether the captcha should be shown on registration"
1932 description: "The method/service to use for captcha",
1933 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1936 key: :seconds_valid,
1938 description: "The time in seconds for which the captcha is valid",
1945 key: Pleroma.Captcha.Kocaptcha,
1948 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1949 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1954 description: "The kocaptcha endpoint to use",
1955 suggestions: ["https://captcha.kotobank.ch"]
1961 label: "Pleroma Admin Token",
1964 "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",
1969 description: "Admin token",
1970 suggestions: ["We recommend a secure random string or UUID"]
1979 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1981 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1982 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1983 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1984 (see https://github.com/sorentwo/oban/issues/52).
1989 type: {:dropdown, :atom},
1990 description: "Logs verbose mode",
1991 suggestions: [false, :error, :warn, :info, :debug]
1995 type: [:atom, :tuple],
1997 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1998 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
2002 type: {:keyword, :integer},
2004 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2006 activity_expiration: 10,
2007 attachments_cleanup: 5,
2009 federator_incoming: 50,
2010 federator_outgoing: 50,
2012 scheduled_activities: 10,
2018 key: :activity_expiration,
2020 description: "Activity expiration queue",
2024 key: :attachments_cleanup,
2026 description: "Attachment deletion queue",
2032 description: "Background queue",
2036 key: :federator_incoming,
2038 description: "Incoming federation queue",
2042 key: :federator_outgoing,
2044 description: "Outgoing federation queue",
2050 description: "Email sender queue, see Pleroma.Emails.Mailer",
2054 key: :scheduled_activities,
2056 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2060 key: :transmogrifier,
2062 description: "Transmogrifier queue",
2068 description: "Web push notifications queue",
2075 type: {:list, :tuple},
2076 description: "Settings for cron background jobs",
2078 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2079 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2080 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2081 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2082 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2091 description: "Includes custom worker options not interpretable directly by `Oban`",
2095 type: {:keyword, :integer},
2096 description: "Max retry attempts for failed jobs, per `Oban` queue",
2098 federator_incoming: 5,
2099 federator_outgoing: 5
2106 key: Pleroma.Web.Metadata,
2108 description: "Metadata-related settings",
2112 type: {:list, :module},
2113 description: "List of metadata providers to enable",
2115 Pleroma.Web.Metadata.Providers.OpenGraph,
2116 Pleroma.Web.Metadata.Providers.TwitterCard,
2117 Pleroma.Web.Metadata.Providers.RelMe,
2118 Pleroma.Web.Metadata.Providers.Feed
2123 label: "Unfurl NSFW",
2125 description: "When enabled NSFW attachments will be shown in previews"
2134 "If enabled the instance will parse metadata from attached links to generate link previews",
2139 description: "Enables RichMedia parsing of URLs"
2143 type: {:list, :string},
2144 description: "List of hosts which will be ignored by the metadata parser",
2145 suggestions: ["accounts.google.com", "xss.website"]
2149 label: "Ignore TLD",
2150 type: {:list, :string},
2151 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2152 suggestions: ["local", "localdomain", "lan"]
2156 type: {:list, :module},
2158 "List of Rich Media parsers. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parsers.` part), but on adding custom module you need to use full name.",
2160 Pleroma.Web.RichMedia.Parsers.OEmbed,
2161 Pleroma.Web.RichMedia.Parsers.TwitterCard
2166 label: "TTL setters",
2167 type: {:list, :module},
2169 "List of rich media TTL setters. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parser.` part), but on adding custom module you need to use full name.",
2171 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2177 group: :auto_linker,
2179 label: "Auto Linker",
2181 description: "Configuration for the auto_linker library",
2185 type: [:string, false],
2186 description: "Specify the class to be added to the generated link. Disable to clear.",
2187 suggestions: ["auto-linker", false]
2191 type: [:string, false],
2192 description: "Override the rel attribute. Disable to clear.",
2193 suggestions: ["ugc", "noopener noreferrer", false]
2198 description: "Link URLs will open in new window/tab"
2202 type: [:integer, false],
2204 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2205 suggestions: [15, false]
2210 description: "Strip the scheme prefix"
2215 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2221 key: Pleroma.ScheduledActivity,
2223 description: "Scheduled activities settings",
2226 key: :daily_user_limit,
2229 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2233 key: :total_user_limit,
2236 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2242 description: "Whether scheduled activities are sent to the job queue to be executed"
2248 key: Pleroma.ActivityExpiration,
2250 description: "Expired activity settings",
2255 description: "Whether expired activities will be sent to the job queue to be deleted"
2261 label: "Pleroma Authenticator",
2263 description: "Authenticator",
2266 key: Pleroma.Web.Auth.Authenticator,
2268 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2278 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2279 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2280 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2281 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2286 description: "Enables LDAP authentication"
2291 description: "LDAP server hostname",
2292 suggestions: ["localhosts"]
2297 description: "LDAP port, e.g. 389 or 636",
2298 suggestions: [389, 636]
2304 description: "Enable to use SSL, usually implies the port 636"
2308 label: "SSL options",
2310 description: "Additional SSL options",
2311 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2316 description: "Path to file with PEM encoded cacerts",
2317 suggestions: ["path/to/file/with/PEM/cacerts"]
2322 description: "Type of cert verification",
2323 suggestions: [:verify_peer]
2331 description: "Enable to use STARTTLS, usually implies the port 389"
2335 label: "TLS options",
2337 description: "Additional TLS options",
2338 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2343 description: "Path to file with PEM encoded cacerts",
2344 suggestions: ["path/to/file/with/PEM/cacerts"]
2349 description: "Type of cert verification",
2350 suggestions: [:verify_peer]
2357 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2358 suggestions: ["dc=example,dc=com"]
2365 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2374 description: "Authentication / authorization settings",
2377 key: :enforce_oauth_admin_scope_usage,
2378 label: "Enforce OAuth admin scope usage",
2381 "OAuth admin scope requirement toggle. " <>
2382 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2383 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2384 "`is_admin` user flag grants access to admin-specific actions."
2387 key: :auth_template,
2390 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2391 suggestions: ["show.html"]
2394 key: :oauth_consumer_template,
2395 label: "OAuth consumer template",
2398 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2399 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2400 suggestions: ["consumer.html"]
2403 key: :oauth_consumer_strategies,
2404 label: "OAuth consumer strategies",
2405 type: {:list, :string},
2407 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2408 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2409 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2410 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2416 key: :email_notifications,
2418 description: "Email notifications settings",
2424 "emails of \"what you've missed\" for users who have been inactive for a while",
2428 schedule: "0 0 * * 0",
2430 inactivity_threshold: 7
2438 description: "Globally enable or disable digest emails"
2444 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2445 suggestions: ["0 0 * * 0"]
2450 description: "Minimum interval between digest emails to one user",
2454 key: :inactivity_threshold,
2456 description: "Minimum user inactivity threshold",
2465 key: Pleroma.Emails.UserEmail,
2467 description: "Email template settings",
2472 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2473 suggestions: ["some/path/logo.png"]
2478 description: "a map with color settings for email templates.",
2481 link_color: "#d8a070",
2482 background_color: "#2C3645",
2483 content_background_color: "#1B2635",
2484 header_color: "#d8a070",
2485 text_color: "#b9b9ba",
2486 text_muted_color: "#b9b9ba"
2493 suggestions: ["#d8a070"]
2496 key: :background_color,
2498 suggestions: ["#2C3645"]
2501 key: :content_background_color,
2503 suggestions: ["#1B2635"]
2508 suggestions: ["#d8a070"]
2513 suggestions: ["#b9b9ba"]
2516 key: :text_muted_color,
2518 suggestions: ["#b9b9ba"]
2526 key: Pleroma.Emails.NewUsersDigestEmail,
2528 description: "New users admin email digest",
2533 description: "Enables new users admin digest email when `true`",
2534 suggestions: [false]
2543 description: "Configure OAuth 2 provider capabilities",
2546 key: :token_expires_in,
2548 description: "The lifetime in seconds of the access token",
2552 key: :issue_new_refresh_token,
2555 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2558 key: :clean_expired_tokens,
2560 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2570 key: :shortcode_globs,
2571 type: {:list, :string},
2572 description: "Location of custom emoji files. * can be used as a wildcard.",
2573 suggestions: ["/emoji/custom/**/*.png"]
2576 key: :pack_extensions,
2577 type: {:list, :string},
2579 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2580 suggestions: [".png", ".gif"]
2584 type: {:keyword, :string, {:list, :string}},
2586 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2587 " and the value is the location or array of locations. * can be used as a wildcard.",
2589 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2593 key: :default_manifest,
2596 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2597 " Currently only one manifest can be added (no arrays).",
2598 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2601 key: :shared_pack_cache_seconds_per_file,
2602 label: "Shared pack cache s/file",
2605 "When an emoji pack is shared, the archive is created and cached in memory" <>
2606 " for this amount of seconds multiplied by the number of files.",
2616 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2620 type: [:tuple, {:list, :tuple}],
2621 description: "For the search requests (account & status search etc.)",
2622 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2626 type: [:tuple, {:list, :tuple}],
2627 description: "For requests to timelines (each timeline has it's own limiter)",
2628 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2631 key: :app_account_creation,
2632 type: [:tuple, {:list, :tuple}],
2633 description: "For registering user accounts from the same IP address",
2634 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2637 key: :relations_actions,
2638 type: [:tuple, {:list, :tuple}],
2639 description: "For actions on relationships with all users (follow, unfollow)",
2640 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2643 key: :relation_id_action,
2644 label: "Relation ID action",
2645 type: [:tuple, {:list, :tuple}],
2646 description: "For actions on relation with a specific user (follow, unfollow)",
2647 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2650 key: :statuses_actions,
2651 type: [:tuple, {:list, :tuple}],
2653 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2654 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2657 key: :status_id_action,
2658 label: "Status ID action",
2659 type: [:tuple, {:list, :tuple}],
2661 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2662 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2665 key: :authentication,
2666 type: [:tuple, {:list, :tuple}],
2667 description: "For authentication create / password check / user existence check requests",
2668 suggestions: [{60_000, 15}]
2677 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2678 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2683 description: "Enables SSH"
2688 description: "Dir with SSH keys",
2689 suggestions: ["/some/path/ssh_keys"]
2694 description: "Handler module",
2695 suggestions: ["Pleroma.BBS.Handler"]
2700 description: "Port to connect",
2701 suggestions: [10_022]
2704 key: :password_authenticator,
2706 description: "Authenticator module",
2707 suggestions: ["Pleroma.BBS.Authenticator"]
2713 label: "Mime Types",
2715 description: "Mime Types settings",
2722 "application/xml" => ["xml"],
2723 "application/xrd+xml" => ["xrd+xml"],
2724 "application/jrd+json" => ["jrd+json"],
2725 "application/activity+json" => ["activity+json"],
2726 "application/ld+json" => ["activity+json"]
2731 key: "application/xml",
2732 type: {:list, :string},
2733 suggestions: ["xml"]
2736 key: "application/xrd+xml",
2737 type: {:list, :string},
2738 suggestions: ["xrd+xml"]
2741 key: "application/jrd+json",
2742 type: {:list, :string},
2743 suggestions: ["jrd+json"]
2746 key: "application/activity+json",
2747 type: {:list, :string},
2748 suggestions: ["activity+json"]
2751 key: "application/ld+json",
2752 type: {:list, :string},
2753 suggestions: ["activity+json"]
2763 description: "Pleroma chat settings",
2776 description: "HTTP settings",
2781 type: [:string, :tuple],
2782 description: "Proxy URL",
2783 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2786 key: :send_user_agent,
2791 type: [:string, :atom],
2793 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2794 suggestions: ["Pleroma", :default]
2799 description: "Adapter specific options",
2805 label: "SSL Options",
2806 description: "SSL options for HTTP adapter",
2810 type: {:list, :atom},
2811 description: "List of TLS version to use",
2812 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2823 label: "Markup Settings",
2827 key: :allow_inline_images,
2831 key: :allow_headings,
2844 type: {:list, :module},
2846 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2847 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2857 key: :deny_follow_blocked,
2864 key: :mrf_normalize_markup,
2865 label: "MRF Normalize Markup",
2866 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2872 suggestions: [Pleroma.HTML.Scrubber.Default]
2882 key: :restricted_nicknames,
2883 type: {:list, :string},
2902 "ostatus_subscribe",
2921 label: "CORS plug config",
2927 suggestions: [86_400]
2931 type: {:list, :string},
2932 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2936 type: {:list, :string},
2939 "X-RateLimit-Reset",
2940 "X-RateLimit-Limit",
2941 "X-RateLimit-Remaining",
2952 type: {:list, :string},
2953 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2959 key: Pleroma.Plugs.RemoteIp,
2962 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2963 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2969 description: "Enable/disable the plug. Default: disabled."
2973 type: {:list, :string},
2975 "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]`."
2979 type: {:list, :string},
2981 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2985 type: {:list, :string},
2987 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2993 key: :web_cache_ttl,
2994 label: "Web cache TTL",
2997 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3003 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3004 suggestions: [30_000, nil]
3007 key: :activity_pub_question,
3009 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3010 suggestions: [30_000]
3020 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3025 description: "Enables the rendering of static HTML. Default: disabled."
3033 description: "Configure feed rendering",
3038 description: "Configure title rendering",
3043 description: "Maximum number of characters before truncating title",
3049 description: "Replacement which will be used after truncating string",
3050 suggestions: ["..."]
3058 key: :mrf_object_age,
3059 label: "MRF Object Age",
3061 description: "Rejects or delists posts based on their age when received.",
3066 description: "Required age (in seconds) of a post before actions are taken.",
3067 suggestions: [172_800]
3071 type: {:list, :atom},
3073 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3074 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3075 "`:reject` rejects the message entirely",
3076 suggestions: [:delist, :strip_followers, :reject]
3084 description: "Custom Runtime Modules",
3089 description: "A path to custom Elixir modules (such as MRF policies)."
3097 description: "Settings for notifications streamer",
3102 description: "Number of workers to send notifications",
3106 key: :overflow_workers,
3108 description: "Maximum number of workers created if pool is empty",
3115 key: :connections_pool,
3117 description: "Advanced settings for `gun` connections pool",
3120 key: :checkin_timeout,
3122 description: "Timeout to checkin connection from pool. Default: 250ms.",
3126 key: :max_connections,
3128 description: "Maximum number of connections in the pool. Default: 250 connections.",
3135 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3139 key: :retry_timeout,
3142 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3146 key: :await_up_timeout,
3148 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3157 description: "Advanced settings for `gun` workers pools",
3162 description: "Settings for federation pool.",
3167 description: "Number workers in the pool.",
3173 description: "Number of additional workers if pool is under load.",
3179 description: "Timeout while `gun` will wait for response.",
3180 suggestions: [150_000]
3187 description: "Settings for media pool.",
3192 description: "Number workers in the pool.",
3198 description: "Number of additional workers if pool is under load.",
3204 description: "Timeout while `gun` will wait for response.",
3205 suggestions: [150_000]
3212 description: "Settings for upload pool.",
3217 description: "Number workers in the pool.",
3223 description: "Number of additional workers if pool is under load.",
3229 description: "Timeout while `gun` will wait for response.",
3230 suggestions: [300_000]
3237 description: "Settings for default pool.",
3242 description: "Number workers in the pool.",
3248 description: "Number of additional workers if pool is under load.",
3254 description: "Timeout while `gun` will wait for response.",
3255 suggestions: [10_000]
3263 key: :hackney_pools,
3265 description: "Advanced settings for `hackney` connections pools",
3270 description: "Settings for federation pool.",
3273 key: :max_connections,
3275 description: "Number workers in the pool.",
3281 description: "Timeout while `hackney` will wait for response.",
3282 suggestions: [150_000]
3289 description: "Settings for media pool.",
3292 key: :max_connections,
3294 description: "Number workers in the pool.",
3300 description: "Timeout while `hackney` will wait for response.",
3301 suggestions: [150_000]
3308 description: "Settings for upload pool.",
3311 key: :max_connections,
3313 description: "Number workers in the pool.",
3319 description: "Timeout while `hackney` will wait for response.",
3320 suggestions: [300_000]
3328 key: :restrict_unauthenticated,
3331 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3336 description: "Settings for public and federated timelines.",
3341 description: "Disallow view public timeline."
3346 description: "Disallow view federated timeline."
3353 description: "Settings for user profiles.",
3358 description: "Disallow view local user profiles."
3363 description: "Disallow view remote user profiles."
3370 description: "Settings for statuses.",
3375 description: "Disallow view local statuses."
3380 description: "Disallow view remote statuses."
3388 key: Pleroma.Web.ApiSpec.CastAndValidate,
3395 "Enables strict input validation (useful in development, not recommended in production)",
3396 suggestions: [false]
3404 description: "General MRF settings",
3408 type: [:module, {:list, :module}],
3410 "A list of MRF policies enabled. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
3412 Generator.list_modules_in_dir(
3413 "lib/pleroma/web/activity_pub/mrf",
3414 "Elixir.Pleroma.Web.ActivityPub.MRF."
3419 label: "MRF transparency",
3422 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
3425 key: :transparency_exclusions,
3426 label: "MRF transparency exclusions",
3427 type: {:list, :string},
3429 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",