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`."
48 description: "Base url for the uploads, needed if you use CDN",
50 "https://cdn-host.com"
57 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
62 description: "Options for Pleroma.ReverseProxy",
64 redirect_on_failure: false,
65 max_body_length: 25 * 1_048_576,
67 follow_redirect: true,
73 key: :redirect_on_failure,
76 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
77 "Any error during body processing will not be redirected as the response is chunked."
80 key: :max_body_length,
83 "Limits the content length to be approximately the " <>
84 "specified length. It is validated with the `content-length` header and also verified when proxying."
89 description: "HTTP options",
94 description: "Adapter specific options",
100 description: "SSL options for HTTP adapter",
104 type: {:list, :atom},
105 description: "List of TLS versions to use",
106 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
115 type: [:string, :tuple],
116 description: "Proxy URL",
117 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
124 key: :filename_display_max_length,
126 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
132 key: Pleroma.Uploaders.Local,
134 description: "Local uploader-related settings",
139 description: "Path where user's uploads will be saved",
148 key: Pleroma.Uploaders.S3,
150 description: "S3 uploader-related settings",
155 description: "S3 bucket",
161 key: :bucket_namespace,
163 description: "S3 bucket namespace",
164 suggestions: ["pleroma"]
167 key: :public_endpoint,
169 description: "S3 endpoint",
170 suggestions: ["https://s3.amazonaws.com"]
173 key: :truncated_namespace,
176 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
177 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
180 key: :streaming_enabled,
183 "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."
189 key: Pleroma.Upload.Filter.Mogrify,
191 description: "Uploads mogrify filter settings",
195 type: [:string, {:list, :string}, {:list, :tuple}],
196 description: "List of actions for the mogrify command",
207 key: Pleroma.Upload.Filter.AnonymizeFilename,
209 description: "Filter replaces the filename of the upload",
215 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
216 " filename extension by using {extension}, for example custom-file-name.{extension}.",
218 "custom-file-name.{extension}"
225 key: Pleroma.Emails.Mailer,
227 description: "Mailer-related settings",
233 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
234 " or Swoosh.Adapters.Local for in-memory mailbox",
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.Mandrill,
240 Swoosh.Adapters.Mailgun,
241 Swoosh.Adapters.Mailjet,
242 Swoosh.Adapters.Postmark,
243 Swoosh.Adapters.SparkPost,
244 Swoosh.Adapters.AmazonSES,
246 Swoosh.Adapters.SocketLabs,
247 Swoosh.Adapters.Gmail,
248 Swoosh.Adapters.Local
254 description: "Allow/disallow send emails"
257 group: {:subgroup, Swoosh.Adapters.SMTP},
260 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
261 suggestions: ["smtp.gmail.com"]
264 group: {:subgroup, Swoosh.Adapters.SMTP},
267 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
268 suggestions: ["pleroma"]
271 group: {:subgroup, Swoosh.Adapters.SMTP},
274 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
275 suggestions: ["password"]
278 group: {:subgroup, Swoosh.Adapters.SMTP},
282 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
285 group: {:subgroup, Swoosh.Adapters.SMTP},
289 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
290 suggestions: [:always, :never, :if_available]
293 group: {:subgroup, Swoosh.Adapters.SMTP},
296 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
297 suggestions: [:always, :never, :if_available]
300 group: {:subgroup, Swoosh.Adapters.SMTP},
303 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
307 group: {:subgroup, Swoosh.Adapters.SMTP},
310 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
314 group: {:subgroup, Swoosh.Adapters.SMTP},
316 label: "No MX lookups",
318 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
321 group: {:subgroup, Swoosh.Adapters.Sendgrid},
325 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
326 suggestions: ["my-api-key"]
329 group: {:subgroup, Swoosh.Adapters.Sendmail},
332 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
333 suggestions: ["/usr/bin/sendmail"]
336 group: {:subgroup, Swoosh.Adapters.Sendmail},
339 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
340 suggestions: ["-N delay,failure,success"]
343 group: {:subgroup, Swoosh.Adapters.Sendmail},
346 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
349 group: {:subgroup, Swoosh.Adapters.Mandrill},
353 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
354 suggestions: ["my-api-key"]
357 group: {:subgroup, Swoosh.Adapters.Mailgun},
361 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
362 suggestions: ["my-api-key"]
365 group: {:subgroup, Swoosh.Adapters.Mailgun},
368 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
369 suggestions: ["pleroma.com"]
372 group: {:subgroup, Swoosh.Adapters.Mailjet},
376 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
377 suggestions: ["my-api-key"]
380 group: {:subgroup, Swoosh.Adapters.Mailjet},
383 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
384 suggestions: ["my-secret-key"]
387 group: {:subgroup, Swoosh.Adapters.Postmark},
391 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
392 suggestions: ["my-api-key"]
395 group: {:subgroup, Swoosh.Adapters.SparkPost},
399 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
400 suggestions: ["my-api-key"]
403 group: {:subgroup, Swoosh.Adapters.SparkPost},
406 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
407 suggestions: ["https://api.sparkpost.com/api/v1"]
410 group: {:subgroup, Swoosh.Adapters.AmazonSES},
413 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
414 suggestions: ["us-east-1", "us-east-2"]
417 group: {:subgroup, Swoosh.Adapters.AmazonSES},
420 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
421 suggestions: ["aws-access-key"]
424 group: {:subgroup, Swoosh.Adapters.AmazonSES},
427 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
428 suggestions: ["aws-secret-key"]
431 group: {:subgroup, Swoosh.Adapters.Dyn},
435 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
436 suggestions: ["my-api-key"]
439 group: {:subgroup, Swoosh.Adapters.SocketLabs},
442 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
445 group: {:subgroup, Swoosh.Adapters.SocketLabs},
449 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
452 group: {:subgroup, Swoosh.Adapters.Gmail},
455 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
462 description: "`Swoosh.Adapters.Local` adapter specific settings",
465 group: {:subgroup, Swoosh.Adapters.Local},
468 description: "Run the preview server together as part of your app"
471 group: {:subgroup, Swoosh.Adapters.Local},
474 description: "The preview server port",
483 description: "URI schemes related settings",
487 type: {:list, :string},
488 description: "List of the scheme part that is considered valid to be an URL",
512 description: "Instance-related settings",
517 description: "Name of the instance",
524 label: "Admin Email Address",
526 description: "Email used to reach an Administrator/Moderator of the instance",
533 label: "Sender Email Address",
535 description: "Envelope FROM address for mail sent via Pleroma",
544 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
552 description: "Posts character limit (CW/Subject included in the counter)",
560 description: "Character limit of the instance chat messages",
568 description: "Hard character limit beyond which remote posts will be dropped",
576 description: "File size limit of uploads (except for avatar, background, banner)",
582 key: :avatar_upload_limit,
584 description: "File size limit of user's profile avatars",
590 key: :background_upload_limit,
592 description: "File size limit of user's profile backgrounds",
598 key: :banner_upload_limit,
600 description: "File size limit of user's profile banners",
608 description: "A map with poll limits for local polls",
612 max_option_chars: 200,
614 max_expiration: 31_536_000
621 description: "Maximum number of options",
625 key: :max_option_chars,
627 description: "Maximum number of characters per option",
631 key: :min_expiration,
633 description: "Minimum expiration time (in seconds)",
637 key: :max_expiration,
639 description: "Maximum expiration time (in seconds)",
645 key: :registrations_open,
648 "Enable registrations for anyone. Invitations require this setting to be disabled."
651 key: :invites_enabled,
654 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
657 key: :account_activation_required,
659 description: "Require users to confirm their emails before signing in."
664 description: "Enable federation with other instances."
667 key: :federation_incoming_replies_max_depth,
668 label: "Fed. incoming replies max depth",
671 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
672 " 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.",
678 key: :federation_reachability_timeout_days,
679 label: "Fed. reachability timeout days",
682 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
690 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
693 key: :rewrite_policy,
694 type: [:module, {:list, :module}],
696 "A list of enabled MRF policies. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
698 Generator.list_modules_in_dir(
699 "lib/pleroma/web/activity_pub/mrf",
700 "Elixir.Pleroma.Web.ActivityPub.MRF."
707 "Makes the client API in authentificated mode-only except for user-profiles." <>
708 " Useful for disabling the Local Timeline and The Whole Known Network."
711 key: :quarantined_instances,
712 type: {:list, :string},
714 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
721 key: :managed_config,
724 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
729 description: "Instance static directory",
735 key: :allowed_post_formats,
736 type: {:list, :string},
737 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
746 key: :mrf_transparency,
747 label: "MRF transparency",
750 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
753 key: :mrf_transparency_exclusions,
754 label: "MRF transparency exclusions",
755 type: {:list, :string},
757 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
763 key: :extended_nickname_format,
766 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
767 " This will break federation with older software for theses nicknames."
770 key: :cleanup_attachments,
773 Enable to remove associated attachments when status is removed.
774 This will not affect duplicates and attachments without status.
775 Enabling this will increase load to database when deleting statuses on larger instances.
779 key: :max_pinned_statuses,
781 description: "The maximum number of pinned statuses. 0 will disable the feature.",
789 key: :autofollowed_nicknames,
790 type: {:list, :string},
792 "Set to nicknames of (local) users that every new user should automatically follow",
801 key: :attachment_links,
803 description: "Enable to automatically add attachment link text to statuses"
806 key: :welcome_message,
809 "A message that will be sent to a newly registered users as a direct message",
811 "Hi, @username! Welcome on board!"
815 key: :welcome_user_nickname,
817 description: "The nickname of the local user that sends the welcome message",
823 key: :max_report_comment_size,
825 description: "The maximum size of the report comment. Default: 1000.",
831 key: :safe_dm_mentions,
834 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
835 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
841 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
844 key: :remote_post_retention_days,
847 "The default amount of days to retain remote posts when pruning the database",
853 key: :user_bio_length,
855 description: "A user bio maximum length. Default: 5000.",
861 key: :user_name_length,
863 description: "A user name maximum length. Default: 100.",
869 key: :skip_thread_containment,
871 description: "Skip filtering out broken threads. Default: enabled"
874 key: :limit_to_local_content,
875 type: {:dropdown, :atom},
877 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
885 key: :max_account_fields,
887 description: "The maximum number of custom fields in the user profile. Default: 10.",
893 key: :max_remote_account_fields,
896 "The maximum number of custom fields in the remote user profile. Default: 20.",
902 key: :account_field_name_length,
904 description: "An account field name maximum length. Default: 512.",
910 key: :account_field_value_length,
912 description: "An account field value maximum length. Default: 2048.",
918 key: :external_user_synchronization,
920 description: "Enabling following/followers counters synchronization for external users"
923 key: :multi_factor_authentication,
925 description: "Multi-factor authentication settings",
928 totp: [digits: 6, period: 30],
929 backup_codes: [number: 5, length: 16]
936 description: "TOTP settings",
937 suggestions: [digits: 6, period: 30],
944 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
951 "a period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
958 description: "MFA backup codes settings",
959 suggestions: [number: 5, length: 16],
965 description: "number of backup codes to generate."
972 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
979 key: :instance_thumbnail,
982 "The instance thumbnail image. It will appear in [Pleroma Instances](http://distsn.org/pleroma-instances.html)",
983 suggestions: ["/instance/thumbnail.jpeg"]
990 description: "Logger-related settings",
994 type: [:atom, :tuple, :module],
996 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
997 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1005 description: "ExSyslogger-related settings",
1009 type: {:dropdown, :atom},
1010 description: "Log level",
1011 suggestions: [:debug, :info, :warn, :error]
1017 "A string that's prepended to every message, and is typically set to the app name",
1018 suggestions: ["pleroma"]
1023 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1024 suggestions: ["$metadata[$level] $message"]
1028 type: {:list, :atom},
1029 suggestions: [:request_id]
1037 description: "Console logger settings",
1041 type: {:dropdown, :atom},
1042 description: "Log level",
1043 suggestions: [:debug, :info, :warn, :error]
1048 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1049 suggestions: ["$metadata[$level] $message"]
1053 type: {:list, :atom},
1054 suggestions: [:request_id]
1061 description: "Quack-related settings",
1065 type: {:dropdown, :atom},
1066 description: "Log level",
1067 suggestions: [:debug, :info, :warn, :error]
1071 type: {:list, :atom},
1072 description: "Configure which metadata you want to report on",
1090 description: "Configure the Slack incoming webhook",
1091 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1097 key: :frontend_configurations,
1100 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1101 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1102 "add your own configuration your settings all fields must be complete.",
1106 label: "Pleroma FE",
1108 description: "Settings for Pleroma FE",
1111 alwaysShowSubjectInput: true,
1112 background: "/static/aurora_borealis.jpg",
1113 collapseMessageWithSubject: false,
1116 hideFilteredStatuses: false,
1117 hideMutedPosts: false,
1118 hidePostStats: false,
1119 hideSitename: false,
1120 hideUserStats: false,
1121 loginMethod: "password",
1122 logo: "/static/logo.png",
1125 minimalScopesMode: false,
1126 noAttachmentLinks: false,
1127 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1128 postContentType: "text/plain",
1129 redirectRootLogin: "/main/friends",
1130 redirectRootNoLogin: "/main/all",
1132 sidebarRight: false,
1133 showFeaturesPanel: true,
1134 showInstanceSpecificPanel: false,
1135 subjectLineBehavior: "email",
1136 theme: "pleroma-dark",
1137 webPushNotifications: false
1142 key: :alwaysShowSubjectInput,
1143 label: "Always show subject input",
1145 description: "When disabled, auto-hide the subject field if it's empty"
1151 "URL of the background, unless viewing a user profile with a background that is set",
1152 suggestions: ["/images/city.jpg"]
1155 key: :collapseMessageWithSubject,
1156 label: "Collapse message with subject",
1159 "When a message has a subject (aka Content Warning), collapse it by default"
1163 label: "PleromaFE Chat",
1165 description: "Disables PleromaFE Chat component"
1171 description: "Enables green text on lines prefixed with the > character."
1174 key: :hideFilteredStatuses,
1175 label: "Hide Filtered Statuses",
1177 description: "Hides filtered statuses from timelines."
1180 key: :hideMutedPosts,
1181 label: "Hide Muted Posts",
1183 description: "Hides muted statuses from timelines."
1186 key: :hidePostStats,
1187 label: "Hide post stats",
1189 description: "Hide notices statistics (repeats, favorites, ...)"
1193 label: "Hide Sitename",
1195 description: "Hides instance name from PleromaFE banner."
1198 key: :hideUserStats,
1199 label: "Hide user stats",
1202 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1207 description: "URL of the logo, defaults to Pleroma's logo",
1208 suggestions: ["/static/logo.png"]
1212 label: "Logo margin",
1215 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1216 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1217 suggestions: [".1em"]
1224 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1225 "If you want a colorful logo you must disable logoMask."
1228 key: :minimalScopesMode,
1229 label: "Minimal scopes mode",
1232 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1233 "Also prevents replying to a DM with a public post from PleromaFE."
1236 key: :nsfwCensorImage,
1237 label: "NSFW Censor Image",
1240 "URL of the image to use for hiding NSFW media attachments in the timeline.",
1241 suggestions: ["/static/img/nsfw.74818f9.png"]
1244 key: :postContentType,
1245 label: "Post Content Type",
1246 type: {:dropdown, :atom},
1247 description: "Default post formatting option.",
1248 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1251 key: :redirectRootNoLogin,
1252 label: "Redirect root no login",
1255 "Relative URL which indicates where to redirect when a user isn't logged in",
1256 suggestions: ["/main/all"]
1259 key: :redirectRootLogin,
1260 label: "Redirect root login",
1263 "Relative URL which indicates where to redirect when a user is logged in",
1264 suggestions: ["/main/friends"]
1268 label: "Scope copy",
1270 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1274 label: "Sidebar on Right",
1276 description: "Change alignment of sidebar and panels to the right."
1279 key: :showFeaturesPanel,
1280 label: "Show instance features panel",
1283 "Enables panel displaying functionality of the instance on the About page."
1286 key: :showInstanceSpecificPanel,
1287 label: "Show instance specific panel",
1289 description: "Whether to show the instance's custom panel"
1292 key: :subjectLineBehavior,
1293 label: "Subject line behavior",
1295 description: "Allows changing the default behaviour of subject lines in replies.
1296 `email`: copy and preprend re:, as in email,
1297 `masto`: copy verbatim, as in Mastodon,
1298 `noop`: don't copy the subject.",
1299 suggestions: ["email", "masto", "noop"]
1304 description: "Which theme to use. Available themes are defined in styles.json",
1305 suggestions: ["pleroma-dark"]
1313 description: "Settings for Masto FE",
1316 showInstanceSpecificPanel: true
1321 key: :showInstanceSpecificPanel,
1322 label: "Show instance specific panel",
1324 description: "Whenether to show the instance's specific panel"
1335 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1339 type: {:keyword, :map},
1341 "Keyword of mascots, each element must contain both an url and a mime_type key",
1344 url: "/images/pleroma-fox-tan-smol.png",
1345 mime_type: "image/png"
1347 pleroma_fox_tan_shy: %{
1348 url: "/images/pleroma-fox-tan-shy.png",
1349 mime_type: "image/png"
1354 key: :default_mascot,
1357 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1363 key: :default_user_avatar,
1365 description: "URL of the default user avatar.",
1366 suggestions: ["/images/avi.png"]
1375 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1379 type: {:list, :map},
1380 description: "Describe the icons of the app",
1383 src: "/static/logo.png"
1386 src: "/static/icon.png",
1390 src: "/static/icon.ico",
1391 sizes: "72x72 96x96 128x128 256x256"
1398 description: "Describe the theme color of the app",
1399 suggestions: ["#282c37", "mediumpurple"]
1402 key: :background_color,
1404 description: "Describe the background color of the app",
1405 suggestions: ["#191b22", "aliceblue"]
1412 label: "MRF simple",
1414 description: "Message Rewrite Facility",
1417 key: :media_removal,
1418 type: {:list, :string},
1419 description: "List of instances to strip media attachments from",
1420 suggestions: ["example.com", "*.example.com"]
1424 label: "Media NSFW",
1425 type: {:list, :string},
1426 description: "List of instances to tag all media as NSFW (sensitive) from",
1427 suggestions: ["example.com", "*.example.com"]
1430 key: :federated_timeline_removal,
1431 type: {:list, :string},
1433 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1434 suggestions: ["example.com", "*.example.com"]
1438 type: {:list, :string},
1439 description: "List of instances to reject activities from (except deletes)",
1440 suggestions: ["example.com", "*.example.com"]
1444 type: {:list, :string},
1445 description: "List of instances to only accept activities from (except deletes)",
1446 suggestions: ["example.com", "*.example.com"]
1449 key: :report_removal,
1450 type: {:list, :string},
1451 description: "List of instances to reject reports from",
1452 suggestions: ["example.com", "*.example.com"]
1455 key: :avatar_removal,
1456 type: {:list, :string},
1457 description: "List of instances to strip avatars from",
1458 suggestions: ["example.com", "*.example.com"]
1461 key: :banner_removal,
1462 type: {:list, :string},
1463 description: "List of instances to strip banners from",
1464 suggestions: ["example.com", "*.example.com"]
1467 key: :reject_deletes,
1468 type: {:list, :string},
1469 description: "List of instances to reject deletions from",
1470 suggestions: ["example.com", "*.example.com"]
1476 key: :mrf_activity_expiration,
1477 label: "MRF Activity Expiration Policy",
1479 description: "Adds expiration to all local Create Note activities",
1484 description: "Default global expiration time for all local Create activities (in days)",
1485 suggestions: [90, 365]
1492 label: "MRF subchain",
1495 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1496 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1501 description: "Matches a series of regular expressions against the actor field",
1504 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1512 key: :mrf_rejectnonpublic,
1514 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1515 label: "MRF reject non public",
1519 key: :allow_followersonly,
1520 label: "Allow followers-only",
1522 description: "Whether to allow followers-only posts"
1527 description: "Whether to allow direct messages"
1533 key: :mrf_hellthread,
1534 label: "MRF hellthread",
1536 description: "Block messages with too much mentions",
1539 key: :delist_threshold,
1542 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1543 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1547 key: :reject_threshold,
1550 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1558 label: "MRF keyword",
1560 description: "Reject or Word-Replace messages with a keyword or regex",
1564 type: [:string, :regex],
1566 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1567 suggestions: ["foo", ~r/foo/iu]
1570 key: :federated_timeline_removal,
1571 type: [:string, :regex],
1573 "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.",
1574 suggestions: ["foo", ~r/foo/iu]
1578 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1580 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1581 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1588 label: "MRF mention",
1590 description: "Block messages which mention a user",
1594 type: {:list, :string},
1595 description: "A list of actors for which any post mentioning them will be dropped.",
1596 suggestions: ["actor1", "actor2"]
1602 key: :mrf_vocabulary,
1603 label: "MRF vocabulary",
1605 description: "Filter messages which belong to certain activity vocabularies",
1609 type: {:list, :string},
1611 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1612 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1616 type: {:list, :string},
1618 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1619 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1625 # key: :mrf_user_allowlist,
1628 # "The keys in this section are the domain names that the policy should apply to." <>
1629 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1631 # %{"example.org" => ["https://example.org/users/admin"]}
1639 description: "Media proxy",
1644 description: "Enables proxying of remote media to the instance's proxy"
1650 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1651 suggestions: ["https://example.com"]
1659 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1665 description: "Enables invalidate media cache"
1670 description: "Module which will be used to cache purge.",
1672 Pleroma.Web.MediaProxy.Invalidation.Script,
1673 Pleroma.Web.MediaProxy.Invalidation.Http
1681 description: "Options for Pleroma.ReverseProxy",
1683 redirect_on_failure: false,
1684 max_body_length: 25 * 1_048_576,
1686 follow_redirect: true,
1692 key: :redirect_on_failure,
1695 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1696 "Any error during body processing will not be redirected as the response is chunked."
1699 key: :max_body_length,
1702 "Limits the content length to be approximately the " <>
1703 "specified length. It is validated with the `content-length` header and also verified when proxying."
1708 description: "HTTP options",
1713 description: "Adapter specific options",
1718 label: "SSL Options",
1719 description: "SSL options for HTTP adapter",
1723 type: {:list, :atom},
1724 description: "List of TLS version to use",
1725 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1734 type: [:string, :tuple],
1735 description: "Proxy URL",
1736 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1744 type: {:list, :string},
1745 description: "List of domains to bypass the mediaproxy",
1746 suggestions: ["example.com"]
1752 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1754 description: "HTTP invalidate settings",
1759 description: "HTTP method of request. Default: :purge"
1763 type: {:list, :tuple},
1764 description: "HTTP headers of request.",
1765 suggestions: [{"x-refresh", 1}]
1770 description: "Request options.",
1771 suggestions: [params: %{ts: "xxx"}]
1777 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1779 description: "Script invalidate settings",
1784 description: "Path to shell script. Which will run purge cache.",
1785 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1793 description: "Gopher settings",
1798 description: "Enables the gopher interface"
1803 description: "IP address to bind to",
1804 suggestions: [{0, 0, 0, 0}]
1809 description: "Port to bind to",
1815 description: "Port advertised in urls (optional, defaults to port)",
1824 description: "ActivityPub-related settings",
1827 key: :unfollow_blocked,
1829 description: "Whether blocks result in people getting unfollowed"
1832 key: :outgoing_blocks,
1834 description: "Whether to federate blocks to other instances"
1837 key: :sign_object_fetches,
1839 description: "Sign object fetches with HTTP signatures"
1842 key: :note_replies_output_limit,
1845 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1848 key: :follow_handshake_timeout,
1850 description: "Following handshake timeout",
1857 key: :http_security,
1859 description: "HTTP security settings",
1864 description: "Whether the managed content security policy is enabled"
1870 description: "Whether to additionally send a Strict-Transport-Security header"
1874 label: "STS max age",
1876 description: "The maximum age for the Strict-Transport-Security header if sent",
1877 suggestions: [31_536_000]
1881 label: "CT max age",
1883 description: "The maximum age for the Expect-CT header if sent",
1884 suggestions: [2_592_000]
1887 key: :referrer_policy,
1889 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1890 suggestions: ["same-origin", "no-referrer"]
1894 label: "Report URI",
1896 description: "Adds the specified url to report-uri and report-to group in CSP header",
1897 suggestions: ["https://example.com/report-uri"]
1902 group: :web_push_encryption,
1903 key: :vapid_details,
1906 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1912 "A mailto link for the administrative contact." <>
1913 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1914 suggestions: ["mailto:moderators@pleroma.com"]
1919 description: "VAPID public key",
1920 suggestions: ["Public key"]
1925 description: "VAPID private key",
1926 suggestions: ["Private key"]
1932 key: Pleroma.Captcha,
1934 description: "Captcha-related settings",
1939 description: "Whether the captcha should be shown on registration"
1944 description: "The method/service to use for captcha",
1945 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1948 key: :seconds_valid,
1950 description: "The time in seconds for which the captcha is valid",
1957 key: Pleroma.Captcha.Kocaptcha,
1960 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1961 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1966 description: "The kocaptcha endpoint to use",
1967 suggestions: ["https://captcha.kotobank.ch"]
1975 "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",
1980 description: "Token",
1981 suggestions: ["We recommend a secure random string or UUID"]
1990 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1992 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1993 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1994 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1995 (see https://github.com/sorentwo/oban/issues/52).
2000 type: {:dropdown, :atom},
2001 description: "Logs verbose mode",
2002 suggestions: [false, :error, :warn, :info, :debug]
2006 type: [:atom, :tuple],
2008 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
2009 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
2013 type: {:keyword, :integer},
2015 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2017 activity_expiration: 10,
2018 attachments_cleanup: 5,
2020 federator_incoming: 50,
2021 federator_outgoing: 50,
2023 scheduled_activities: 10,
2029 key: :activity_expiration,
2031 description: "Activity expiration queue",
2035 key: :attachments_cleanup,
2037 description: "Attachment deletion queue",
2043 description: "Background queue",
2047 key: :federator_incoming,
2049 description: "Incoming federation queue",
2053 key: :federator_outgoing,
2055 description: "Outgoing federation queue",
2061 description: "Email sender queue, see Pleroma.Emails.Mailer",
2065 key: :scheduled_activities,
2067 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2071 key: :transmogrifier,
2073 description: "Transmogrifier queue",
2079 description: "Web push notifications queue",
2086 type: {:list, :tuple},
2087 description: "Settings for cron background jobs",
2089 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2090 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2091 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2092 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2093 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2102 description: "Includes custom worker options not interpretable directly by `Oban`",
2106 type: {:keyword, :integer},
2107 description: "Max retry attempts for failed jobs, per `Oban` queue",
2109 federator_incoming: 5,
2110 federator_outgoing: 5
2117 key: Pleroma.Web.Metadata,
2119 description: "Metadata-related settings",
2123 type: {:list, :module},
2124 description: "List of metadata providers to enable",
2126 Pleroma.Web.Metadata.Providers.OpenGraph,
2127 Pleroma.Web.Metadata.Providers.TwitterCard,
2128 Pleroma.Web.Metadata.Providers.RelMe,
2129 Pleroma.Web.Metadata.Providers.Feed
2134 label: "Unfurl NSFW",
2136 description: "When enabled NSFW attachments will be shown in previews"
2145 "If enabled the instance will parse metadata from attached links to generate link previews.",
2150 description: "Enables RichMedia parsing of URLs."
2154 type: {:list, :string},
2155 description: "List of hosts which will be ignored by the metadata parser.",
2156 suggestions: ["accounts.google.com", "xss.website"]
2160 label: "Ignore TLD",
2161 type: {:list, :string},
2162 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2163 suggestions: ["local", "localdomain", "lan"]
2167 type: {:list, :module},
2169 "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.",
2171 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2172 Pleroma.Web.RichMedia.Parsers.OEmbed,
2173 Pleroma.Web.RichMedia.Parsers.OGP,
2174 Pleroma.Web.RichMedia.Parsers.TwitterCard
2179 label: "TTL setters",
2180 type: {:list, :module},
2182 "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.",
2184 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2190 group: :auto_linker,
2193 description: "Configuration for the auto_linker library",
2197 type: [:string, false],
2198 description: "Specify the class to be added to the generated link. Disable to clear",
2199 suggestions: ["auto-linker", false]
2203 type: [:string, false],
2204 description: "Override the rel attribute. Disable to clear",
2205 suggestions: ["ugc", "noopener noreferrer", false]
2210 description: "Link urls will open in new window/tab"
2214 type: [:integer, false],
2216 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2217 suggestions: [15, false]
2222 description: "Strip the scheme prefix"
2227 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2233 key: Pleroma.ScheduledActivity,
2235 description: "Scheduled activities settings",
2238 key: :daily_user_limit,
2241 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2245 key: :total_user_limit,
2248 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2254 description: "Whether scheduled activities are sent to the job queue to be executed"
2260 key: Pleroma.ActivityExpiration,
2262 description: "Expired activity settings",
2267 description: "Whether expired activities will be sent to the job queue to be deleted"
2274 description: "Authenticator",
2277 key: Pleroma.Web.Auth.Authenticator,
2279 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2288 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2289 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2290 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2291 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2296 description: "Enables LDAP authentication"
2301 description: "LDAP server hostname",
2302 suggestions: ["localhosts"]
2307 description: "LDAP port, e.g. 389 or 636",
2308 suggestions: [389, 636]
2314 description: "Enable to use SSL, usually implies the port 636"
2318 label: "SSL options",
2320 description: "Additional SSL options",
2321 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2326 description: "Path to file with PEM encoded cacerts",
2327 suggestions: ["path/to/file/with/PEM/cacerts"]
2332 description: "Type of cert verification",
2333 suggestions: [:verify_peer]
2341 description: "Enable to use STARTTLS, usually implies the port 389"
2345 label: "TLS options",
2347 description: "Additional TLS options",
2348 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2353 description: "Path to file with PEM encoded cacerts",
2354 suggestions: ["path/to/file/with/PEM/cacerts"]
2359 description: "Type of cert verification",
2360 suggestions: [:verify_peer]
2367 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2368 suggestions: ["dc=example,dc=com"]
2374 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2383 description: "Authentication / authorization settings",
2386 key: :enforce_oauth_admin_scope_usage,
2389 "OAuth admin scope requirement toggle. " <>
2390 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2391 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2392 "`is_admin` user flag grants access to admin-specific actions."
2395 key: :auth_template,
2398 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2399 suggestions: ["show.html"]
2402 key: :oauth_consumer_template,
2405 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2406 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2407 suggestions: ["consumer.html"]
2410 key: :oauth_consumer_strategies,
2411 type: {:list, :string},
2413 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2414 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2415 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2416 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2422 key: :email_notifications,
2424 description: "Email notifications settings",
2430 "emails of \"what you've missed\" for users who have been inactive for a while",
2434 schedule: "0 0 * * 0",
2436 inactivity_threshold: 7
2444 description: "Globally enable or disable digest emails"
2450 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2451 suggestions: ["0 0 * * 0"]
2456 description: "Minimum interval between digest emails to one user",
2460 key: :inactivity_threshold,
2462 description: "Minimum user inactivity threshold",
2471 key: Pleroma.Emails.UserEmail,
2473 description: "Email template settings",
2478 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2479 suggestions: ["some/path/logo.png"]
2484 description: "a map with color settings for email templates.",
2487 link_color: "#d8a070",
2488 background_color: "#2C3645",
2489 content_background_color: "#1B2635",
2490 header_color: "#d8a070",
2491 text_color: "#b9b9ba",
2492 text_muted_color: "#b9b9ba"
2499 suggestions: ["#d8a070"]
2502 key: :background_color,
2504 suggestions: ["#2C3645"]
2507 key: :content_background_color,
2509 suggestions: ["#1B2635"]
2514 suggestions: ["#d8a070"]
2519 suggestions: ["#b9b9ba"]
2522 key: :text_muted_color,
2524 suggestions: ["#b9b9ba"]
2532 key: Pleroma.Emails.NewUsersDigestEmail,
2534 description: "New users admin email digest",
2539 description: "enables new users admin digest email when `true`",
2540 suggestions: [false]
2548 description: "Configure OAuth 2 provider capabilities",
2551 key: :token_expires_in,
2553 description: "The lifetime in seconds of the access token",
2557 key: :issue_new_refresh_token,
2560 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2563 key: :clean_expired_tokens,
2565 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2575 key: :shortcode_globs,
2576 type: {:list, :string},
2577 description: "Location of custom emoji files. * can be used as a wildcard.",
2578 suggestions: ["/emoji/custom/**/*.png"]
2581 key: :pack_extensions,
2582 type: {:list, :string},
2584 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2585 suggestions: [".png", ".gif"]
2589 type: {:keyword, :string, {:list, :string}},
2591 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2592 " and the value is the location or array of locations. * can be used as a wildcard.",
2594 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2598 key: :default_manifest,
2601 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2602 " Currently only one manifest can be added (no arrays).",
2603 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2606 key: :shared_pack_cache_seconds_per_file,
2607 label: "Shared pack cache s/file",
2610 "When an emoji pack is shared, the archive is created and cached in memory" <>
2611 " for this amount of seconds multiplied by the number of files.",
2621 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2625 type: [:tuple, {:list, :tuple}],
2626 description: "For the search requests (account & status search etc.)",
2627 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2631 type: [:tuple, {:list, :tuple}],
2632 description: "For requests to timelines (each timeline has it's own limiter)",
2633 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2636 key: :app_account_creation,
2637 type: [:tuple, {:list, :tuple}],
2638 description: "For registering user accounts from the same IP address",
2639 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2642 key: :relations_actions,
2643 type: [:tuple, {:list, :tuple}],
2644 description: "For actions on relationships with all users (follow, unfollow)",
2645 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2648 key: :relation_id_action,
2649 type: [:tuple, {:list, :tuple}],
2650 description: "For actions on relation with a specific user (follow, unfollow)",
2651 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2654 key: :statuses_actions,
2655 type: [:tuple, {:list, :tuple}],
2657 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2658 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2661 key: :status_id_action,
2662 type: [:tuple, {:list, :tuple}],
2664 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2665 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2668 key: :authentication,
2669 type: [:tuple, {:list, :tuple}],
2670 description: "For authentication create / password check / user existence check requests",
2671 suggestions: [{60_000, 15}]
2679 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2680 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2685 description: "Enables SSH"
2690 description: "Dir with SSH keys",
2691 suggestions: ["/some/path/ssh_keys"]
2696 description: "Handler module",
2697 suggestions: ["Pleroma.BBS.Handler"]
2702 description: "Port to connect",
2703 suggestions: [10_022]
2706 key: :password_authenticator,
2708 description: "Authenticator module",
2709 suggestions: ["Pleroma.BBS.Authenticator"]
2716 description: "Mime types",
2723 "application/xml" => ["xml"],
2724 "application/xrd+xml" => ["xrd+xml"],
2725 "application/jrd+json" => ["jrd+json"],
2726 "application/activity+json" => ["activity+json"],
2727 "application/ld+json" => ["activity+json"]
2732 key: "application/xml",
2733 type: {:list, :string},
2734 suggestions: ["xml"]
2737 key: "application/xrd+xml",
2738 type: {:list, :string},
2739 suggestions: ["xrd+xml"]
2742 key: "application/jrd+json",
2743 type: {:list, :string},
2744 suggestions: ["jrd+json"]
2747 key: "application/activity+json",
2748 type: {:list, :string},
2749 suggestions: ["activity+json"]
2752 key: "application/ld+json",
2753 type: {:list, :string},
2754 suggestions: ["activity+json"]
2764 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"]
2826 key: :allow_inline_images,
2830 key: :allow_headings,
2843 type: {:list, :module},
2845 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2846 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2856 key: :deny_follow_blocked,
2863 key: :mrf_normalize_markup,
2864 label: "MRF normalize markup",
2865 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2871 suggestions: [Pleroma.HTML.Scrubber.Default]
2881 key: :restricted_nicknames,
2882 type: {:list, :string},
2901 "ostatus_subscribe",
2925 suggestions: [86_400]
2929 type: {:list, :string},
2930 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2934 type: {:list, :string},
2937 "X-RateLimit-Reset",
2938 "X-RateLimit-Limit",
2939 "X-RateLimit-Remaining",
2950 type: {:list, :string},
2951 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2957 key: Pleroma.Plugs.RemoteIp,
2960 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2961 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2967 description: "Enable/disable the plug. Default: disabled."
2971 type: {:list, :string},
2973 "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]`."
2977 type: {:list, :string},
2979 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2983 type: {:list, :string},
2985 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2991 key: :web_cache_ttl,
2994 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3000 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3001 suggestions: [30_000, nil]
3004 key: :activity_pub_question,
3006 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3007 suggestions: [30_000]
3016 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3021 description: "Enables the rendering of static HTML. Default: disabled."
3029 description: "Configure feed rendering",
3034 description: "Configure title rendering.",
3039 description: "Maximum number of characters before truncating title.",
3045 description: "Replacement which will be used after truncating string.",
3046 suggestions: ["..."]
3054 key: :mrf_object_age,
3056 description: "Rejects or delists posts based on their age when received.",
3061 description: "Required age (in seconds) of a post before actions are taken.",
3062 suggestions: [172_800]
3066 type: {:list, :atom},
3068 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3069 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3070 "`:reject` rejects the message entirely",
3071 suggestions: [:delist, :strip_followers, :reject]
3079 description: "Custom Runtime Modules",
3084 description: "A path to custom Elixir modules (such as MRF policies)."
3092 description: "Settings for notifications streamer",
3097 description: "Number of workers to send notifications.",
3101 key: :overflow_workers,
3103 description: "Maximum number of workers created if pool is empty.",
3110 key: :connections_pool,
3112 description: "Advanced settings for `gun` connections pool",
3115 key: :checkin_timeout,
3117 description: "Timeout to checkin connection from pool. Default: 250ms.",
3121 key: :max_connections,
3123 description: "Maximum number of connections in the pool. Default: 250 connections.",
3130 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3134 key: :retry_timeout,
3137 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3141 key: :await_up_timeout,
3143 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3152 description: "Advanced settings for `gun` workers pools",
3157 description: "Settings for federation pool.",
3162 description: "Number workers in the pool.",
3168 description: "Number of additional workers if pool is under load.",
3174 description: "Timeout while `gun` will wait for response.",
3175 suggestions: [150_000]
3182 description: "Settings for media pool.",
3187 description: "Number workers in the pool.",
3193 description: "Number of additional workers if pool is under load.",
3199 description: "Timeout while `gun` will wait for response.",
3200 suggestions: [150_000]
3207 description: "Settings for upload pool.",
3212 description: "Number workers in the pool.",
3218 description: "Number of additional workers if pool is under load.",
3224 description: "Timeout while `gun` will wait for response.",
3225 suggestions: [300_000]
3232 description: "Settings for default pool.",
3237 description: "Number workers in the pool.",
3243 description: "Number of additional workers if pool is under load.",
3249 description: "Timeout while `gun` will wait for response.",
3250 suggestions: [10_000]
3258 key: :hackney_pools,
3260 description: "Advanced settings for `hackney` connections pools",
3265 description: "Settings for federation pool.",
3268 key: :max_connections,
3270 description: "Number workers in the pool.",
3276 description: "Timeout while `hackney` will wait for response.",
3277 suggestions: [150_000]
3284 description: "Settings for media pool.",
3287 key: :max_connections,
3289 description: "Number workers in the pool.",
3295 description: "Timeout while `hackney` will wait for response.",
3296 suggestions: [150_000]
3303 description: "Settings for upload pool.",
3306 key: :max_connections,
3308 description: "Number workers in the pool.",
3314 description: "Timeout while `hackney` will wait for response.",
3315 suggestions: [300_000]
3323 key: :restrict_unauthenticated,
3326 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3331 description: "Settings for public and federated timelines.",
3336 description: "Disallow view public timeline."
3341 description: "Disallow view federated timeline."
3348 description: "Settings for user profiles.",
3353 description: "Disallow view local user profiles."
3358 description: "Disallow view remote user profiles."
3365 description: "Settings for statuses.",
3370 description: "Disallow view local statuses."
3375 description: "Disallow view remote statuses."
3383 key: Pleroma.Web.ApiSpec.CastAndValidate,
3390 "Enables strict input validation (useful in development, not recommended in production)",
3391 suggestions: [false]