6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "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.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "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`."
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
105 "https://cdn-host.com"
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
117 key: :filename_display_max_length,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
125 key: Pleroma.Uploaders.Local,
127 description: "Local uploader-related settings",
132 description: "Path where user's uploads will be saved",
141 key: Pleroma.Uploaders.S3,
143 description: "S3 uploader-related settings",
148 description: "S3 bucket",
154 key: :bucket_namespace,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
160 key: :truncated_namespace,
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
167 key: :streaming_enabled,
170 "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."
176 key: Pleroma.Upload.Filter.Mogrify,
178 description: "Uploads mogrify filter settings",
182 type: [:string, {:list, :string}, {:list, :tuple}],
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
198 description: "Filter replaces the filename of the upload",
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
207 "custom-file-name.{extension}"
214 key: Pleroma.Emails.Mailer,
216 description: "Mailer-related settings",
220 label: "Mailer Enabled",
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
229 Swoosh.Adapters.AmazonSES,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
244 group: {:subgroup, Swoosh.Adapters.SMTP},
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "SMTP port",
255 suggestions: ["1025"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "Use Implicit SSL/TLS. e.g. port 465"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "SMTP temporary (4xx) error retries",
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 label: "SendGrid API Key",
306 suggestions: ["YOUR_API_KEY"]
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
323 label: "Qmail compat mode",
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
329 label: "Mandrill API Key",
331 suggestions: ["YOUR_API_KEY"]
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
336 label: "Mailgun API Key",
338 suggestions: ["YOUR_API_KEY"]
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
344 suggestions: ["YOUR_DOMAIN_NAME"]
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
349 label: "MailJet Public API Key",
351 suggestions: ["MJ_APIKEY_PUBLIC"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
356 label: "MailJet Private API Key",
358 suggestions: ["MJ_APIKEY_PRIVATE"]
361 group: {:subgroup, Swoosh.Adapters.Postmark},
363 label: "Postmark API Key",
365 suggestions: ["X-Postmark-Server-Token"]
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
370 label: "SparkPost API key",
372 suggestions: ["YOUR_API_KEY"]
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 suggestions: ["https://api.sparkpost.com/api/v1"]
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
383 label: "AWS Access Key",
385 suggestions: ["AWS_ACCESS_KEY"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
390 label: "AWS Secret Key",
392 suggestions: ["AWS_SECRET_KEY"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.Dyn},
404 label: "Dyn API Key",
406 suggestions: ["apikey"]
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
411 label: "SocketLabs API Key",
413 suggestions: ["INJECTION_API_KEY"]
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 suggestions: ["SERVER_ID"]
423 group: {:subgroup, Swoosh.Adapters.Gmail},
425 label: "GMail API Access Token",
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
434 label: "URI Schemes",
436 description: "URI schemes related settings",
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
466 description: "Customizable features",
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
479 key: :populate_hashtags_table,
481 description: "`populate_hashtags_table` background migration settings",
484 key: :fault_rate_allowance,
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
491 key: :sleep_interval_ms,
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 label: "Admin Email Address",
516 description: "Email used to reach an Administrator/Moderator of the instance",
523 label: "Sender Email Address",
525 description: "Envelope FROM address for mail sent via Pleroma",
534 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
542 description: "Posts character limit (CW/Subject included in the counter)",
550 description: "Hard character limit beyond which remote posts will be dropped",
558 description: "File size limit of uploads (except for avatar, background, banner)",
564 key: :avatar_upload_limit,
566 description: "File size limit of user's profile avatars",
572 key: :background_upload_limit,
574 description: "File size limit of user's profile backgrounds",
580 key: :banner_upload_limit,
582 description: "File size limit of user's profile banners",
590 description: "A map with poll limits for local polls",
594 max_option_chars: 200,
596 max_expiration: 31_536_000
603 description: "Maximum number of options",
607 key: :max_option_chars,
609 description: "Maximum number of characters per option",
613 key: :min_expiration,
615 description: "Minimum expiration time (in seconds)",
619 key: :max_expiration,
621 description: "Maximum expiration time (in seconds)",
627 key: :registrations_open,
630 "Enable registrations for anyone. Invitations require this setting to be disabled."
633 key: :invites_enabled,
636 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
639 key: :account_activation_required,
641 description: "Require users to confirm their emails before signing in"
644 key: :account_approval_required,
646 description: "Require users to be manually approved by an admin before signing in"
651 description: "Enable federation with other instances"
654 key: :federation_incoming_replies_max_depth,
655 label: "Fed. incoming replies max depth",
658 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
659 " 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.",
665 key: :federation_reachability_timeout_days,
666 label: "Fed. reachability timeout days",
669 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
678 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
684 "Makes the client API in authenticated mode-only except for user-profiles." <>
685 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
686 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
689 key: :quarantined_instances,
690 type: {:list, :tuple},
691 key_placeholder: "instance",
692 value_placeholder: "reason",
694 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent and the reason for doing so",
696 {"quarantined.com", "Reason"},
697 {"*.quarantined.com", "Reason"}
703 description: "Instance static directory",
709 key: :allowed_post_formats,
710 type: {:list, :string},
711 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
720 key: :extended_nickname_format,
723 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
724 " This will break federation with older software for theses nicknames."
727 key: :cleanup_attachments,
730 Enable to remove associated attachments when status is removed.
731 This will not affect duplicates and attachments without status.
732 Enabling this will increase load to database when deleting statuses on larger instances.
736 key: :max_pinned_statuses,
738 description: "The maximum number of pinned statuses. 0 will disable the feature.",
746 key: :autofollowed_nicknames,
747 type: {:list, :string},
749 "Set to nicknames of (local) users that every new user should automatically follow"
752 key: :autofollowing_nicknames,
753 type: {:list, :string},
755 "Set to nicknames of (local) users that automatically follows every newly registered user"
758 key: :attachment_links,
760 description: "Enable to automatically add attachment link text to statuses"
763 key: :max_report_comment_size,
765 description: "The maximum size of the report comment. Default: 1000.",
771 key: :safe_dm_mentions,
772 label: "Safe DM mentions",
775 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
776 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
782 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
785 key: :remote_post_retention_days,
788 "The default amount of days to retain remote posts when pruning the database",
794 key: :user_bio_length,
796 description: "A user bio maximum length. Default: 5000.",
802 key: :user_name_length,
804 description: "A user name maximum length. Default: 100.",
810 key: :skip_thread_containment,
812 description: "Skip filtering out broken threads. Default: enabled."
815 key: :limit_to_local_content,
816 type: {:dropdown, :atom},
818 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
826 key: :max_account_fields,
828 description: "The maximum number of custom fields in the user profile. Default: 10.",
834 key: :max_remote_account_fields,
837 "The maximum number of custom fields in the remote user profile. Default: 20.",
843 key: :account_field_name_length,
845 description: "An account field name maximum length. Default: 512.",
851 key: :account_field_value_length,
853 description: "An account field value maximum length. Default: 2048.",
859 key: :registration_reason_length,
861 description: "Maximum registration reason length. Default: 500.",
867 key: :external_user_synchronization,
869 description: "Enabling following/followers counters synchronization for external users"
872 key: :multi_factor_authentication,
874 description: "Multi-factor authentication settings",
877 totp: [digits: 6, period: 30],
878 backup_codes: [number: 5, length: 16]
884 label: "TOTP settings",
886 description: "TOTP settings",
887 suggestions: [digits: 6, period: 30],
894 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
901 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
908 description: "MFA backup codes settings",
909 suggestions: [number: 5, length: 16],
915 description: "Number of backup codes to generate."
922 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
929 key: :instance_thumbnail,
930 type: {:string, :image},
932 "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.",
933 suggestions: ["/instance/thumbnail.jpeg"]
936 key: :show_reactions,
938 description: "Let favourites and emoji reactions be viewed through the API."
946 description: "Welcome messages settings",
949 key: :direct_message,
951 descpiption: "Direct message settings",
956 description: "Enables sending a direct message to newly registered users"
961 description: "A message that will be sent to newly registered users",
963 "Hi, @username! Welcome on board!"
967 key: :sender_nickname,
969 description: "The nickname of the local user that sends a welcome message",
979 descpiption: "Chat message settings",
984 description: "Enables sending a chat message to newly registered users"
990 "A message that will be sent to newly registered users as a chat message",
992 "Hello, welcome on board!"
996 key: :sender_nickname,
998 description: "The nickname of the local user that sends a welcome chat message",
1008 descpiption: "Email message settings",
1013 description: "Enables sending an email to newly registered users"
1017 type: [:string, :tuple],
1019 "Email address and/or nickname that will be used to send the welcome email.",
1021 {"Pleroma App", "welcome@pleroma.app"}
1028 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1029 suggestions: ["Welcome to <%= instance_name%>"]
1035 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1036 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1042 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1043 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1052 description: "Logger-related settings",
1056 type: [:atom, :tuple, :module],
1058 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1059 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1067 label: "ExSyslogger",
1068 description: "ExSyslogger-related settings",
1072 type: {:dropdown, :atom},
1073 description: "Log level",
1074 suggestions: [:debug, :info, :warn, :error]
1080 "A string that's prepended to every message, and is typically set to the app name",
1081 suggestions: ["pleroma"]
1086 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1087 suggestions: ["$metadata[$level] $message"]
1091 type: {:list, :atom},
1092 suggestions: [:request_id]
1100 label: "Console Logger",
1101 description: "Console logger settings",
1105 type: {:dropdown, :atom},
1106 description: "Log level",
1107 suggestions: [:debug, :info, :warn, :error]
1112 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1113 suggestions: ["$metadata[$level] $message"]
1117 type: {:list, :atom},
1118 suggestions: [:request_id]
1125 label: "Quack Logger",
1126 description: "Quack-related settings",
1130 type: {:dropdown, :atom},
1131 description: "Log level",
1132 suggestions: [:debug, :info, :warn, :error]
1136 type: {:list, :atom},
1137 description: "Configure which metadata you want to report on",
1154 label: "Webhook URL",
1156 description: "Configure the Slack incoming webhook",
1157 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1163 key: :frontend_configurations,
1166 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1167 "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
1168 "add your own configuration your settings all fields must be complete.",
1172 label: "Pleroma FE",
1174 description: "Settings for Pleroma FE",
1177 alwaysShowSubjectInput: true,
1178 background: "/static/aurora_borealis.jpg",
1179 collapseMessageWithSubject: false,
1181 hideFilteredStatuses: false,
1182 hideMutedPosts: false,
1183 hidePostStats: false,
1184 hideSitename: false,
1185 hideUserStats: false,
1186 loginMethod: "password",
1187 logo: "/static/logo.svg",
1190 minimalScopesMode: false,
1191 noAttachmentLinks: false,
1192 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1193 postContentType: "text/plain",
1194 redirectRootLogin: "/main/friends",
1195 redirectRootNoLogin: "/main/all",
1197 sidebarRight: false,
1198 showFeaturesPanel: true,
1199 showInstanceSpecificPanel: false,
1200 subjectLineBehavior: "email",
1201 theme: "pleroma-dark",
1202 webPushNotifications: false
1207 key: :alwaysShowSubjectInput,
1208 label: "Always show subject input",
1210 description: "When disabled, auto-hide the subject field if it's empty"
1214 type: {:string, :image},
1216 "URL of the background, unless viewing a user profile with a background that is set",
1217 suggestions: ["/images/city.jpg"]
1220 key: :collapseMessageWithSubject,
1221 label: "Collapse message with subject",
1224 "When a message has a subject (aka Content Warning), collapse it by default"
1230 description: "Enables green text on lines prefixed with the > character"
1233 key: :hideFilteredStatuses,
1234 label: "Hide Filtered Statuses",
1236 description: "Hides filtered statuses from timelines"
1239 key: :hideMutedPosts,
1240 label: "Hide Muted Posts",
1242 description: "Hides muted statuses from timelines"
1245 key: :hidePostStats,
1246 label: "Hide post stats",
1248 description: "Hide notices statistics (repeats, favorites, ...)"
1252 label: "Hide Sitename",
1254 description: "Hides instance name from PleromaFE banner"
1257 key: :hideUserStats,
1258 label: "Hide user stats",
1261 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1265 type: {:string, :image},
1266 description: "URL of the logo, defaults to Pleroma's logo",
1267 suggestions: ["/static/logo.svg"]
1271 label: "Logo margin",
1274 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1275 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1276 suggestions: [".1em"]
1283 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1284 "If you want a colorful logo you must disable logoMask."
1287 key: :minimalScopesMode,
1288 label: "Minimal scopes mode",
1291 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1292 "Also prevents replying to a DM with a public post from PleromaFE."
1295 key: :nsfwCensorImage,
1296 label: "NSFW Censor Image",
1297 type: {:string, :image},
1299 "URL of the image to use for hiding NSFW media attachments in the timeline",
1300 suggestions: ["/static/img/nsfw.74818f9.png"]
1303 key: :postContentType,
1304 label: "Post Content Type",
1305 type: {:dropdown, :atom},
1306 description: "Default post formatting option",
1307 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1310 key: :redirectRootNoLogin,
1311 label: "Redirect root no login",
1314 "Relative URL which indicates where to redirect when a user isn't logged in",
1315 suggestions: ["/main/all"]
1318 key: :redirectRootLogin,
1319 label: "Redirect root login",
1322 "Relative URL which indicates where to redirect when a user is logged in",
1323 suggestions: ["/main/friends"]
1327 label: "Scope copy",
1329 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1333 label: "Sidebar on Right",
1335 description: "Change alignment of sidebar and panels to the right"
1338 key: :showFeaturesPanel,
1339 label: "Show instance features panel",
1342 "Enables panel displaying functionality of the instance on the About page"
1345 key: :showInstanceSpecificPanel,
1346 label: "Show instance specific panel",
1348 description: "Whether to show the instance's custom panel"
1351 key: :subjectLineBehavior,
1352 label: "Subject line behavior",
1354 description: "Allows changing the default behaviour of subject lines in replies.
1355 `email`: copy and preprend re:, as in email,
1356 `masto`: copy verbatim, as in Mastodon,
1357 `noop`: don't copy the subject.",
1358 suggestions: ["email", "masto", "noop"]
1363 description: "Which theme to use. Available themes are defined in styles.json",
1364 suggestions: ["pleroma-dark"]
1375 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1379 type: {:keyword, :map},
1381 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1384 url: "/images/pleroma-fox-tan-smol.png",
1385 mime_type: "image/png"
1387 pleroma_fox_tan_shy: %{
1388 url: "/images/pleroma-fox-tan-shy.png",
1389 mime_type: "image/png"
1394 key: :default_mascot,
1397 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1403 key: :default_user_avatar,
1404 type: {:string, :image},
1405 description: "URL of the default user avatar",
1406 suggestions: ["/images/avi.png"]
1415 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1419 type: {:list, :map},
1420 description: "Describe the icons of the app",
1423 src: "/static/logo.png"
1426 src: "/static/icon.png",
1430 src: "/static/icon.ico",
1431 sizes: "72x72 96x96 128x128 256x256"
1438 description: "Describe the theme color of the app",
1439 suggestions: ["#282c37", "mediumpurple"]
1442 key: :background_color,
1444 description: "Describe the background color of the app",
1445 suggestions: ["#191b22", "aliceblue"]
1453 description: "Media proxy",
1458 description: "Enables proxying of remote media via the instance's proxy"
1465 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1466 suggestions: ["https://example.com"]
1474 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1480 description: "Enables media cache object invalidation."
1485 description: "Module which will be used to purge objects from the cache.",
1487 Pleroma.Web.MediaProxy.Invalidation.Script,
1488 Pleroma.Web.MediaProxy.Invalidation.Http
1495 label: "Advanced MediaProxy Options",
1497 description: "Internal Pleroma.ReverseProxy settings",
1499 redirect_on_failure: false,
1500 max_body_length: 25 * 1_048_576,
1501 max_read_duration: 30_000
1505 key: :redirect_on_failure,
1508 Redirects the client to the origin server upon encountering HTTP errors.\n
1509 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1510 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1511 IP addresses of your users to the other servers, bypassing the MediaProxy.
1515 key: :max_body_length,
1518 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1521 key: :max_read_duration,
1523 description: "Timeout (in milliseconds) of GET request to the remote URI."
1529 type: {:list, :string},
1530 description: "List of hosts with scheme to bypass the MediaProxy",
1531 suggestions: ["http://example.com"]
1537 key: :media_preview_proxy,
1539 description: "Media preview proxy",
1545 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1548 key: :thumbnail_max_width,
1551 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1554 key: :thumbnail_max_height,
1557 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1560 key: :image_quality,
1562 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1565 key: :min_content_length,
1568 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1574 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1576 description: "HTTP invalidate settings",
1581 description: "HTTP method of request. Default: :purge"
1585 type: {:keyword, :string},
1586 description: "HTTP headers of request",
1587 suggestions: [{"x-refresh", 1}]
1592 description: "Request options",
1596 type: {:map, :string}
1604 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1606 description: "Invalidation script settings",
1611 description: "Path to executable script which will purge cached items.",
1612 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1616 label: "URL Format",
1619 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1620 suggestions: [":htcacheclean"]
1628 description: "Gopher settings",
1633 description: "Enables the gopher interface"
1639 description: "IP address to bind to",
1640 suggestions: [{0, 0, 0, 0}]
1645 description: "Port to bind to",
1651 description: "Port advertised in URLs (optional, defaults to port)",
1659 label: "ActivityPub",
1661 description: "ActivityPub-related settings",
1664 key: :unfollow_blocked,
1666 description: "Whether blocks result in people getting unfollowed"
1669 key: :outgoing_blocks,
1671 description: "Whether to federate blocks to other instances"
1674 key: :sign_object_fetches,
1676 description: "Sign object fetches with HTTP signatures"
1679 key: :note_replies_output_limit,
1682 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1685 key: :follow_handshake_timeout,
1687 description: "Following handshake timeout",
1694 key: :http_security,
1695 label: "HTTP security",
1697 description: "HTTP security settings",
1702 description: "Whether the managed content security policy is enabled"
1708 description: "Whether to additionally send a Strict-Transport-Security header"
1712 label: "STS max age",
1714 description: "The maximum age for the Strict-Transport-Security header if sent",
1715 suggestions: [31_536_000]
1719 label: "CT max age",
1721 description: "The maximum age for the Expect-CT header if sent",
1722 suggestions: [2_592_000]
1725 key: :referrer_policy,
1727 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1728 suggestions: ["same-origin", "no-referrer"]
1732 label: "Report URI",
1734 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1735 suggestions: ["https://example.com/report-uri"]
1740 group: :web_push_encryption,
1741 key: :vapid_details,
1742 label: "Vapid Details",
1745 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1751 "A mailto link for the administrative contact." <>
1752 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1753 suggestions: ["mailto:moderators@pleroma.com"]
1758 description: "VAPID public key",
1759 suggestions: ["Public key"]
1764 description: "VAPID private key",
1765 suggestions: ["Private key"]
1771 key: Pleroma.Captcha,
1773 description: "Captcha-related settings",
1778 description: "Whether the captcha should be shown on registration"
1783 description: "The method/service to use for captcha",
1784 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1787 key: :seconds_valid,
1789 description: "The time in seconds for which the captcha is valid",
1796 key: Pleroma.Captcha.Kocaptcha,
1799 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1800 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1805 description: "The kocaptcha endpoint to use",
1806 suggestions: ["https://captcha.kotobank.ch"]
1812 label: "Pleroma Admin Token",
1815 "Allows setting a token that can be used to authenticate requests with admin privileges without a normal user account token. Append the `admin_token` parameter to requests to utilize it. (Please reconsider using HTTP Basic Auth or OAuth-based authentication if possible)",
1820 description: "Admin token",
1822 "Please use a high entropy string or UUID"
1832 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1836 type: {:dropdown, :atom},
1837 description: "Logs verbose mode",
1838 suggestions: [false, :error, :warn, :info, :debug]
1842 type: {:keyword, :integer},
1844 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1846 activity_expiration: 10,
1847 attachments_cleanup: 5,
1849 federator_incoming: 50,
1850 federator_outgoing: 50,
1852 scheduled_activities: 10,
1858 key: :activity_expiration,
1860 description: "Activity expiration queue",
1866 description: "Backup queue",
1870 key: :attachments_cleanup,
1872 description: "Attachment deletion queue",
1878 description: "Background queue",
1882 key: :federator_incoming,
1884 description: "Incoming federation queue",
1888 key: :federator_outgoing,
1890 description: "Outgoing federation queue",
1896 description: "Email sender queue, see Pleroma.Emails.Mailer",
1900 key: :scheduled_activities,
1902 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1906 key: :transmogrifier,
1908 description: "Transmogrifier queue",
1914 description: "Web push notifications queue",
1921 type: {:list, :tuple},
1922 description: "Settings for cron background jobs",
1924 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1925 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1934 description: "Includes custom worker options not interpretable directly by `Oban`",
1938 type: {:keyword, :integer},
1939 description: "Max retry attempts for failed jobs, per `Oban` queue",
1941 federator_incoming: 5,
1942 federator_outgoing: 5
1949 key: Pleroma.Web.Metadata,
1951 description: "Metadata-related settings",
1955 type: {:list, :module},
1956 description: "List of metadata providers to enable",
1958 Pleroma.Web.Metadata.Providers.OpenGraph,
1959 Pleroma.Web.Metadata.Providers.TwitterCard,
1960 Pleroma.Web.Metadata.Providers.RelMe,
1961 Pleroma.Web.Metadata.Providers.Feed
1966 label: "Unfurl NSFW",
1968 description: "When enabled NSFW attachments will be shown in previews"
1977 "If enabled the instance will parse metadata from attached links to generate link previews",
1982 description: "Enables RichMedia parsing of URLs"
1986 type: {:list, :string},
1987 description: "List of hosts which will be ignored by the metadata parser",
1988 suggestions: ["accounts.google.com", "xss.website"]
1992 label: "Ignore TLD",
1993 type: {:list, :string},
1994 description: "List TLDs (top-level domains) which will ignore for parse metadata",
1995 suggestions: ["local", "localdomain", "lan"]
1999 type: {:list, :module},
2001 "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.",
2003 Pleroma.Web.RichMedia.Parsers.OEmbed,
2004 Pleroma.Web.RichMedia.Parsers.TwitterCard
2009 label: "TTL setters",
2010 type: {:list, :module},
2012 "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.",
2014 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2018 key: :failure_backoff,
2021 "Amount of milliseconds after request failure, during which the request will not be retried.",
2022 suggestions: [60_000]
2028 key: Pleroma.Formatter,
2032 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2036 type: [:string, :boolean],
2037 description: "Specify the class to be added to the generated link. Disable to clear.",
2038 suggestions: ["auto-linker", false]
2042 type: [:string, :boolean],
2043 description: "Override the rel attribute. Disable to clear.",
2044 suggestions: ["ugc", "noopener noreferrer", false]
2049 description: "Link URLs will open in a new window/tab."
2053 type: [:integer, :boolean],
2055 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2056 suggestions: [15, false]
2061 description: "Strip the scheme prefix."
2066 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2070 type: [:atom, :boolean],
2072 "Set to false to disable TLD validation for URLs/emails. Can be set to :no_scheme to validate TLDs only for URLs without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't)",
2073 suggestions: [:no_scheme, true]
2079 key: Pleroma.ScheduledActivity,
2081 description: "Scheduled activities settings",
2084 key: :daily_user_limit,
2087 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2091 key: :total_user_limit,
2094 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2100 description: "Whether scheduled activities are sent to the job queue to be executed"
2106 key: Pleroma.Workers.PurgeExpiredActivity,
2108 description: "Expired activities settings",
2113 description: "Enables expired activities addition & deletion"
2118 description: "Minimum lifetime for ephemeral activity (in seconds)",
2125 label: "Pleroma Authenticator",
2127 description: "Authenticator",
2130 key: Pleroma.Web.Auth.Authenticator,
2132 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2142 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2143 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2144 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2145 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2150 description: "Enables LDAP authentication"
2155 description: "LDAP server hostname",
2156 suggestions: ["localhosts"]
2161 description: "LDAP port, e.g. 389 or 636",
2162 suggestions: [389, 636]
2168 description: "Enable to use SSL, usually implies the port 636"
2172 label: "SSL options",
2174 description: "Additional SSL options",
2175 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2180 description: "Path to file with PEM encoded cacerts",
2181 suggestions: ["path/to/file/with/PEM/cacerts"]
2186 description: "Type of cert verification",
2187 suggestions: [:verify_peer]
2195 description: "Enable to use STARTTLS, usually implies the port 389"
2199 label: "TLS options",
2201 description: "Additional TLS options",
2202 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2207 description: "Path to file with PEM encoded cacerts",
2208 suggestions: ["path/to/file/with/PEM/cacerts"]
2213 description: "Type of cert verification",
2214 suggestions: [:verify_peer]
2221 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2222 suggestions: ["dc=example,dc=com"]
2229 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2238 description: "Authentication / authorization settings",
2241 key: :enforce_oauth_admin_scope_usage,
2242 label: "Enforce OAuth admin scope usage",
2245 "OAuth admin scope requirement toggle. " <>
2246 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2247 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2248 "`is_admin` user flag grants access to admin-specific actions."
2251 key: :auth_template,
2254 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2255 suggestions: ["show.html"]
2258 key: :oauth_consumer_template,
2259 label: "OAuth consumer template",
2262 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2263 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2264 suggestions: ["consumer.html"]
2267 key: :oauth_consumer_strategies,
2268 label: "OAuth consumer strategies",
2269 type: {:list, :string},
2271 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2272 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2273 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2274 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2280 key: :email_notifications,
2282 description: "Email notifications settings",
2288 "emails of \"what you've missed\" for users who have been inactive for a while",
2292 schedule: "0 0 * * 0",
2294 inactivity_threshold: 7
2302 description: "Globally enable or disable digest emails"
2308 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2309 suggestions: ["0 0 * * 0"]
2314 description: "Minimum interval between digest emails to one user",
2318 key: :inactivity_threshold,
2320 description: "Minimum user inactivity threshold",
2329 key: Pleroma.Emails.UserEmail,
2331 description: "Email template settings",
2335 type: {:string, :image},
2336 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2337 suggestions: ["some/path/logo.png"]
2342 description: "A map with color settings for email templates.",
2345 link_color: "#d8a070",
2346 background_color: "#2C3645",
2347 content_background_color: "#1B2635",
2348 header_color: "#d8a070",
2349 text_color: "#b9b9ba",
2350 text_muted_color: "#b9b9ba"
2357 suggestions: ["#d8a070"]
2360 key: :background_color,
2362 suggestions: ["#2C3645"]
2365 key: :content_background_color,
2367 suggestions: ["#1B2635"]
2372 suggestions: ["#d8a070"]
2377 suggestions: ["#b9b9ba"]
2380 key: :text_muted_color,
2382 suggestions: ["#b9b9ba"]
2390 key: Pleroma.Emails.NewUsersDigestEmail,
2392 description: "New users admin email digest",
2397 description: "Enables new users admin digest email when `true`"
2406 description: "Configure OAuth 2 provider capabilities",
2409 key: :token_expires_in,
2411 description: "The lifetime in seconds of the access token",
2412 suggestions: [2_592_000]
2415 key: :issue_new_refresh_token,
2418 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2421 key: :clean_expired_tokens,
2423 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2433 key: :shortcode_globs,
2434 type: {:list, :string},
2435 description: "Location of custom emoji files. * can be used as a wildcard.",
2436 suggestions: ["/emoji/custom/**/*.png"]
2439 key: :pack_extensions,
2440 type: {:list, :string},
2442 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2443 suggestions: [".png", ".gif"]
2447 type: {:keyword, {:list, :string}},
2449 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2450 " and the value is the location or array of locations. * can be used as a wildcard.",
2452 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2456 key: :default_manifest,
2459 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2460 " Currently only one manifest can be added (no arrays).",
2461 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2464 key: :shared_pack_cache_seconds_per_file,
2465 label: "Shared pack cache s/file",
2468 "When an emoji pack is shared, the archive is created and cached in memory" <>
2469 " for this amount of seconds multiplied by the number of files.",
2479 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2483 type: [:tuple, {:list, :tuple}],
2484 description: "For the search requests (account & status search etc.)",
2485 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2489 type: [:tuple, {:list, :tuple}],
2490 description: "For requests to timelines (each timeline has it's own limiter)",
2491 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2494 key: :app_account_creation,
2495 type: [:tuple, {:list, :tuple}],
2496 description: "For registering user accounts from the same IP address",
2497 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2500 key: :relations_actions,
2501 type: [:tuple, {:list, :tuple}],
2502 description: "For actions on relationships with all users (follow, unfollow)",
2503 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2506 key: :relation_id_action,
2507 label: "Relation ID action",
2508 type: [:tuple, {:list, :tuple}],
2509 description: "For actions on relation with a specific user (follow, unfollow)",
2510 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2513 key: :statuses_actions,
2514 type: [:tuple, {:list, :tuple}],
2516 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2517 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2520 key: :status_id_action,
2521 label: "Status ID action",
2522 type: [:tuple, {:list, :tuple}],
2524 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2525 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2528 key: :authentication,
2529 type: [:tuple, {:list, :tuple}],
2530 description: "For authentication create / password check / user existence check requests",
2531 suggestions: [{60_000, 15}]
2540 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2541 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2546 description: "Enables SSH"
2551 description: "Dir with SSH keys",
2552 suggestions: ["/some/path/ssh_keys"]
2557 description: "Handler module",
2558 suggestions: ["Pleroma.BBS.Handler"]
2563 description: "Port to connect",
2564 suggestions: [10_022]
2567 key: :password_authenticator,
2569 description: "Authenticator module",
2570 suggestions: ["Pleroma.BBS.Authenticator"]
2576 label: "Mime Types",
2578 description: "Mime Types settings",
2585 "application/xml" => ["xml"],
2586 "application/xrd+xml" => ["xrd+xml"],
2587 "application/jrd+json" => ["jrd+json"],
2588 "application/activity+json" => ["activity+json"],
2589 "application/ld+json" => ["activity+json"]
2594 key: "application/xml",
2595 type: {:list, :string},
2596 suggestions: ["xml"]
2599 key: "application/xrd+xml",
2600 type: {:list, :string},
2601 suggestions: ["xrd+xml"]
2604 key: "application/jrd+json",
2605 type: {:list, :string},
2606 suggestions: ["jrd+json"]
2609 key: "application/activity+json",
2610 type: {:list, :string},
2611 suggestions: ["activity+json"]
2614 key: "application/ld+json",
2615 type: {:list, :string},
2616 suggestions: ["activity+json"]
2626 description: "Pleroma shout settings",
2631 description: "Enables the backend Shoutbox chat feature."
2636 description: "Shout message character limit.",
2648 description: "HTTP settings",
2653 type: [:string, :tuple],
2654 description: "Proxy URL",
2655 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2658 key: :send_user_agent,
2663 type: [:string, :atom],
2665 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2666 suggestions: ["Pleroma", :default]
2671 description: "Adapter specific options",
2677 label: "SSL Options",
2678 description: "SSL options for HTTP adapter",
2682 type: {:list, :atom},
2683 description: "List of TLS version to use",
2684 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2695 label: "Markup Settings",
2699 key: :allow_inline_images,
2703 key: :allow_headings,
2716 type: {:list, :module},
2718 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2719 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2729 key: :deny_follow_blocked,
2740 key: :restricted_nicknames,
2741 type: {:list, :string},
2742 description: "List of nicknames users may not register with.",
2761 "ostatus_subscribe",
2777 key: :email_blacklist,
2778 type: {:list, :string},
2779 description: "List of email domains users may not register with.",
2780 suggestions: ["mailinator.com", "maildrop.cc"]
2786 label: "CORS plug config",
2792 suggestions: [86_400]
2796 type: {:list, :string},
2797 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2801 type: {:list, :string},
2804 "X-RateLimit-Reset",
2805 "X-RateLimit-Limit",
2806 "X-RateLimit-Remaining",
2817 type: {:list, :string},
2818 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2824 key: Pleroma.Web.Plugs.RemoteIp,
2827 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2828 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2834 description: "Enable/disable the plug. Default: disabled."
2838 type: {:list, :string},
2840 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2845 type: {:list, :string},
2847 "A list of upstream proxy IP subnets in CIDR notation from which we will parse the content of `headers`. Defaults to `[]`. IPv4 entries without a bitmask will be assumed to be /32 and IPv6 /128."
2851 type: {:list, :string},
2853 A list of reserved IP subnets in CIDR notation which should be ignored if found in `headers`. Defaults to `["127.0.0.0/8", "::1/128", "fc00::/7", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]`
2860 key: :web_cache_ttl,
2861 label: "Web cache TTL",
2864 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2870 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2874 key: :activity_pub_question,
2876 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2877 suggestions: [30_000]
2887 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2892 description: "Enables the rendering of static HTML. Default: disabled."
2900 description: "Configure feed rendering",
2905 description: "Configure title rendering",
2910 description: "Maximum number of characters before truncating title",
2916 description: "Replacement which will be used after truncating string",
2917 suggestions: ["..."]
2925 key: :mrf_follow_bot,
2927 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2928 label: "MRF FollowBot Policy",
2930 description: "Automatically follows newly discovered accounts.",
2933 key: :follower_nickname,
2935 description: "The name of the bot account to use for following newly discovered users.",
2936 suggestions: ["followbot"]
2944 description: "Custom Runtime Modules",
2949 description: "A path to custom Elixir modules (such as MRF policies)."
2957 description: "Settings for notifications streamer",
2962 description: "Number of workers to send notifications",
2966 key: :overflow_workers,
2968 description: "Maximum number of workers created if pool is empty",
2975 key: :connections_pool,
2977 description: "Advanced settings for `Gun` connections pool",
2980 key: :connection_acquisition_wait,
2983 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2987 key: :connection_acquisition_retries,
2990 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2994 key: :max_connections,
2996 description: "Maximum number of connections in the pool. Default: 250 connections.",
3000 key: :connect_timeout,
3002 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3006 key: :reclaim_multiplier,
3009 "Multiplier for the number of idle connection to be reclaimed if the pool is full. For example if the pool maxes out at 250 connections and this setting is set to 0.3, the pool will reclaim at most 75 idle connections if it's overloaded. Default: 0.1",
3018 description: "Advanced settings for `Gun` workers pools",
3020 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3024 description: "Settings for #{pool_name} pool.",
3029 description: "Maximum number of concurrent requests in the pool.",
3036 "Maximum number of requests waiting for other requests to finish. After this number is reached, the pool will start returning errrors when a new request is made",
3042 description: "Timeout for the pool while gun will wait for response",
3043 suggestions: [10_000]
3051 key: :hackney_pools,
3053 description: "Advanced settings for `Hackney` connections pools",
3058 description: "Settings for federation pool.",
3061 key: :max_connections,
3063 description: "Number workers in the pool.",
3069 description: "Timeout while `hackney` will wait for response.",
3070 suggestions: [150_000]
3077 description: "Settings for media pool.",
3080 key: :max_connections,
3082 description: "Number workers in the pool.",
3088 description: "Timeout while `hackney` will wait for response.",
3089 suggestions: [150_000]
3096 description: "Settings for upload pool.",
3099 key: :max_connections,
3101 description: "Number workers in the pool.",
3107 description: "Timeout while `hackney` will wait for response.",
3108 suggestions: [300_000]
3116 key: :restrict_unauthenticated,
3117 label: "Restrict Unauthenticated",
3120 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3125 description: "Settings for public and federated timelines.",
3130 description: "Disallow view public timeline."
3135 description: "Disallow view federated timeline."
3142 description: "Settings for user profiles.",
3147 description: "Disallow view local user profiles."
3152 description: "Disallow view remote user profiles."
3159 description: "Settings for statuses.",
3164 description: "Disallow view local statuses."
3169 description: "Disallow view remote statuses."
3177 key: Pleroma.Web.ApiSpec.CastAndValidate,
3184 "Enables strict input validation (useful in development, not recommended in production)"
3190 key: :instances_favicons,
3192 description: "Control favicons for instances",
3197 description: "Allow/disallow displaying and getting instances favicons"
3205 descriptions: "S3 service related settings",
3208 key: :access_key_id,
3210 description: "S3 access key ID",
3211 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3214 key: :secret_access_key,
3216 description: "Secret access key",
3217 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3222 description: "S3 host",
3223 suggestions: ["s3.eu-central-1.amazonaws.com"]
3228 description: "S3 region (for AWS)",
3229 suggestions: ["us-east-1"]
3237 description: "Installed frontends management",
3242 description: "Primary frontend, the one that is served for all pages by default",
3243 children: installed_frontend_options
3248 description: "Admin frontend",
3249 children: installed_frontend_options
3255 "A map containing available frontends and parameters for their installation.",
3256 children: frontend_options
3262 key: Pleroma.Web.Preload,
3264 description: "Preload-related settings",
3268 type: {:list, :module},
3269 description: "List of preload providers to enable",
3271 Pleroma.Web.Preload.Providers.Instance,
3272 Pleroma.Web.Preload.Providers.User,
3273 Pleroma.Web.Preload.Providers.Timelines,
3274 Pleroma.Web.Preload.Providers.StatusNet
3283 description: "Majic/libmagic configuration",
3288 description: "Number of majic workers to start.",
3295 key: Pleroma.User.Backup,
3297 description: "Account Backup",
3300 key: :purge_after_days,
3302 description: "Remove backup achives after N days",
3308 description: "Limit user to export not more often than once per N days",
3315 key: Pleroma.Web.Endpoint.MetricsExporter,
3317 description: "Prometheus app metrics endpoint configuration",
3322 description: "[Pleroma extension] Enables app metrics endpoint."
3326 label: "IP Whitelist",
3327 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3328 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3332 type: [:boolean, :tuple],
3333 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3334 suggestion: [false, {:basic, "myusername", "mypassword"}]
3339 description: "App metrics endpoint URI path.",
3340 suggestions: ["/api/pleroma/app_metrics"]
3345 description: "App metrics endpoint output format.",
3346 suggestions: [:text, :protobuf]
3352 key: ConcurrentLimiter,
3354 description: "Limits configuration for background tasks.",
3357 key: Pleroma.Web.RichMedia.Helpers,
3359 description: "Concurrent limits configuration for getting RichMedia for activities.",
3360 suggestions: [max_running: 5, max_waiting: 5],
3365 description: "Max running concurrently jobs.",
3371 description: "Max waiting jobs.",
3377 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3379 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3380 suggestions: [max_running: 5, max_waiting: 5],
3385 description: "Max running concurrently jobs.",
3391 description: "Max waiting jobs.",