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: "Database-related settings",
469 key: :improved_hashtag_timeline,
472 "If `true`, hashtags will be fetched from `hashtags` table for hashtags timeline. When `false`, object-embedded hashtags will be used (slower). Is auto-set to `true` (unless overridden) when HashtagsTableMigrator completes."
478 key: :populate_hashtags_table,
480 description: "`populate_hashtags_table` background migration settings",
483 key: :fault_rate_allowance,
486 "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.",
490 key: :sleep_interval_ms,
493 "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)."
501 description: "Instance-related settings",
506 description: "Name of the instance",
513 label: "Admin Email Address",
515 description: "Email used to reach an Administrator/Moderator of the instance",
522 label: "Sender Email Address",
524 description: "Envelope FROM address for mail sent via Pleroma",
533 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
541 description: "Posts character limit (CW/Subject included in the counter)",
549 description: "Character limit of the instance chat messages",
557 description: "Hard character limit beyond which remote posts will be dropped",
565 description: "File size limit of uploads (except for avatar, background, banner)",
571 key: :avatar_upload_limit,
573 description: "File size limit of user's profile avatars",
579 key: :background_upload_limit,
581 description: "File size limit of user's profile backgrounds",
587 key: :banner_upload_limit,
589 description: "File size limit of user's profile banners",
597 description: "A map with poll limits for local polls",
601 max_option_chars: 200,
603 max_expiration: 31_536_000
610 description: "Maximum number of options",
614 key: :max_option_chars,
616 description: "Maximum number of characters per option",
620 key: :min_expiration,
622 description: "Minimum expiration time (in seconds)",
626 key: :max_expiration,
628 description: "Maximum expiration time (in seconds)",
634 key: :registrations_open,
637 "Enable registrations for anyone. Invitations require this setting to be disabled."
640 key: :invites_enabled,
643 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
646 key: :account_activation_required,
648 description: "Require users to confirm their emails before signing in"
651 key: :account_approval_required,
653 description: "Require users to be manually approved by an admin before signing in"
658 description: "Enable federation with other instances"
661 key: :federation_incoming_replies_max_depth,
662 label: "Fed. incoming replies max depth",
665 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
666 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
672 key: :federation_reachability_timeout_days,
673 label: "Fed. reachability timeout days",
676 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
684 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
690 "Makes the client API in authenticated mode-only except for user-profiles." <>
691 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
692 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
695 key: :quarantined_instances,
696 type: {:list, :string},
698 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
707 description: "Instance static directory",
713 key: :allowed_post_formats,
714 type: {:list, :string},
715 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
724 key: :extended_nickname_format,
727 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
728 " This will break federation with older software for theses nicknames."
731 key: :cleanup_attachments,
734 Enable to remove associated attachments when status is removed.
735 This will not affect duplicates and attachments without status.
736 Enabling this will increase load to database when deleting statuses on larger instances.
740 key: :max_pinned_statuses,
742 description: "The maximum number of pinned statuses. 0 will disable the feature.",
750 key: :autofollowed_nicknames,
751 type: {:list, :string},
753 "Set to nicknames of (local) users that every new user should automatically follow"
756 key: :autofollowing_nicknames,
757 type: {:list, :string},
759 "Set to nicknames of (local) users that automatically follows every newly registered user"
762 key: :attachment_links,
764 description: "Enable to automatically add attachment link text to statuses"
767 key: :max_report_comment_size,
769 description: "The maximum size of the report comment. Default: 1000.",
775 key: :safe_dm_mentions,
776 label: "Safe DM mentions",
779 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
780 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
786 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
789 key: :remote_post_retention_days,
792 "The default amount of days to retain remote posts when pruning the database",
798 key: :user_bio_length,
800 description: "A user bio maximum length. Default: 5000.",
806 key: :user_name_length,
808 description: "A user name maximum length. Default: 100.",
814 key: :skip_thread_containment,
816 description: "Skip filtering out broken threads. Default: enabled."
819 key: :limit_to_local_content,
820 type: {:dropdown, :atom},
822 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
830 key: :max_account_fields,
832 description: "The maximum number of custom fields in the user profile. Default: 10.",
838 key: :max_remote_account_fields,
841 "The maximum number of custom fields in the remote user profile. Default: 20.",
847 key: :account_field_name_length,
849 description: "An account field name maximum length. Default: 512.",
855 key: :account_field_value_length,
857 description: "An account field value maximum length. Default: 2048.",
863 key: :registration_reason_length,
865 description: "Maximum registration reason length. Default: 500.",
871 key: :external_user_synchronization,
873 description: "Enabling following/followers counters synchronization for external users"
876 key: :multi_factor_authentication,
878 description: "Multi-factor authentication settings",
881 totp: [digits: 6, period: 30],
882 backup_codes: [number: 5, length: 16]
888 label: "TOTP settings",
890 description: "TOTP settings",
891 suggestions: [digits: 6, period: 30],
898 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
905 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
912 description: "MFA backup codes settings",
913 suggestions: [number: 5, length: 16],
919 description: "Number of backup codes to generate."
926 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
933 key: :instance_thumbnail,
934 type: {:string, :image},
936 "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.",
937 suggestions: ["/instance/thumbnail.jpeg"]
940 key: :show_reactions,
942 description: "Let favourites and emoji reactions be viewed through the API."
950 description: "Welcome messages settings",
953 key: :direct_message,
955 descpiption: "Direct message settings",
960 description: "Enables sending a direct message to newly registered users"
965 description: "A message that will be sent to newly registered users",
967 "Hi, @username! Welcome on board!"
971 key: :sender_nickname,
973 description: "The nickname of the local user that sends a welcome message",
983 descpiption: "Chat message settings",
988 description: "Enables sending a chat message to newly registered users"
994 "A message that will be sent to newly registered users as a chat message",
996 "Hello, welcome on board!"
1000 key: :sender_nickname,
1002 description: "The nickname of the local user that sends a welcome chat message",
1012 descpiption: "Email message settings",
1017 description: "Enables sending an email to newly registered users"
1021 type: [:string, :tuple],
1023 "Email address and/or nickname that will be used to send the welcome email.",
1025 {"Pleroma App", "welcome@pleroma.app"}
1032 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1033 suggestions: ["Welcome to <%= instance_name%>"]
1039 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1040 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1046 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1047 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1056 description: "Logger-related settings",
1060 type: [:atom, :tuple, :module],
1062 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1063 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1071 label: "ExSyslogger",
1072 description: "ExSyslogger-related settings",
1076 type: {:dropdown, :atom},
1077 description: "Log level",
1078 suggestions: [:debug, :info, :warn, :error]
1084 "A string that's prepended to every message, and is typically set to the app name",
1085 suggestions: ["pleroma"]
1090 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1091 suggestions: ["$metadata[$level] $message"]
1095 type: {:list, :atom},
1096 suggestions: [:request_id]
1104 label: "Console Logger",
1105 description: "Console logger settings",
1109 type: {:dropdown, :atom},
1110 description: "Log level",
1111 suggestions: [:debug, :info, :warn, :error]
1116 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1117 suggestions: ["$metadata[$level] $message"]
1121 type: {:list, :atom},
1122 suggestions: [:request_id]
1129 label: "Quack Logger",
1130 description: "Quack-related settings",
1134 type: {:dropdown, :atom},
1135 description: "Log level",
1136 suggestions: [:debug, :info, :warn, :error]
1140 type: {:list, :atom},
1141 description: "Configure which metadata you want to report on",
1158 label: "Webhook URL",
1160 description: "Configure the Slack incoming webhook",
1161 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1167 key: :frontend_configurations,
1170 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1171 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1172 "add your own configuration your settings all fields must be complete.",
1176 label: "Pleroma FE",
1178 description: "Settings for Pleroma FE",
1181 alwaysShowSubjectInput: true,
1182 background: "/static/aurora_borealis.jpg",
1183 collapseMessageWithSubject: false,
1186 hideFilteredStatuses: false,
1187 hideMutedPosts: false,
1188 hidePostStats: false,
1189 hideSitename: false,
1190 hideUserStats: false,
1191 loginMethod: "password",
1192 logo: "/static/logo.svg",
1195 minimalScopesMode: false,
1196 noAttachmentLinks: false,
1197 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1198 postContentType: "text/plain",
1199 redirectRootLogin: "/main/friends",
1200 redirectRootNoLogin: "/main/all",
1202 sidebarRight: false,
1203 showFeaturesPanel: true,
1204 showInstanceSpecificPanel: false,
1205 subjectLineBehavior: "email",
1206 theme: "pleroma-dark",
1207 webPushNotifications: false
1212 key: :alwaysShowSubjectInput,
1213 label: "Always show subject input",
1215 description: "When disabled, auto-hide the subject field if it's empty"
1219 type: {:string, :image},
1221 "URL of the background, unless viewing a user profile with a background that is set",
1222 suggestions: ["/images/city.jpg"]
1225 key: :collapseMessageWithSubject,
1226 label: "Collapse message with subject",
1229 "When a message has a subject (aka Content Warning), collapse it by default"
1233 label: "PleromaFE Chat",
1235 description: "Disables PleromaFE Chat component"
1241 description: "Enables green text on lines prefixed with the > character"
1244 key: :hideFilteredStatuses,
1245 label: "Hide Filtered Statuses",
1247 description: "Hides filtered statuses from timelines"
1250 key: :hideMutedPosts,
1251 label: "Hide Muted Posts",
1253 description: "Hides muted statuses from timelines"
1256 key: :hidePostStats,
1257 label: "Hide post stats",
1259 description: "Hide notices statistics (repeats, favorites, ...)"
1263 label: "Hide Sitename",
1265 description: "Hides instance name from PleromaFE banner"
1268 key: :hideUserStats,
1269 label: "Hide user stats",
1272 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1276 type: {:string, :image},
1277 description: "URL of the logo, defaults to Pleroma's logo",
1278 suggestions: ["/static/logo.svg"]
1282 label: "Logo margin",
1285 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1286 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1287 suggestions: [".1em"]
1294 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1295 "If you want a colorful logo you must disable logoMask."
1298 key: :minimalScopesMode,
1299 label: "Minimal scopes mode",
1302 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1303 "Also prevents replying to a DM with a public post from PleromaFE."
1306 key: :nsfwCensorImage,
1307 label: "NSFW Censor Image",
1308 type: {:string, :image},
1310 "URL of the image to use for hiding NSFW media attachments in the timeline",
1311 suggestions: ["/static/img/nsfw.74818f9.png"]
1314 key: :postContentType,
1315 label: "Post Content Type",
1316 type: {:dropdown, :atom},
1317 description: "Default post formatting option",
1318 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1321 key: :redirectRootNoLogin,
1322 label: "Redirect root no login",
1325 "Relative URL which indicates where to redirect when a user isn't logged in",
1326 suggestions: ["/main/all"]
1329 key: :redirectRootLogin,
1330 label: "Redirect root login",
1333 "Relative URL which indicates where to redirect when a user is logged in",
1334 suggestions: ["/main/friends"]
1338 label: "Scope copy",
1340 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1344 label: "Sidebar on Right",
1346 description: "Change alignment of sidebar and panels to the right"
1349 key: :showFeaturesPanel,
1350 label: "Show instance features panel",
1353 "Enables panel displaying functionality of the instance on the About page"
1356 key: :showInstanceSpecificPanel,
1357 label: "Show instance specific panel",
1359 description: "Whether to show the instance's custom panel"
1362 key: :subjectLineBehavior,
1363 label: "Subject line behavior",
1365 description: "Allows changing the default behaviour of subject lines in replies.
1366 `email`: copy and preprend re:, as in email,
1367 `masto`: copy verbatim, as in Mastodon,
1368 `noop`: don't copy the subject.",
1369 suggestions: ["email", "masto", "noop"]
1374 description: "Which theme to use. Available themes are defined in styles.json",
1375 suggestions: ["pleroma-dark"]
1383 description: "Settings for Masto FE",
1386 showInstanceSpecificPanel: true
1391 key: :showInstanceSpecificPanel,
1392 label: "Show instance specific panel",
1394 description: "Whenether to show the instance's specific panel"
1405 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1409 type: {:keyword, :map},
1411 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1414 url: "/images/pleroma-fox-tan-smol.png",
1415 mime_type: "image/png"
1417 pleroma_fox_tan_shy: %{
1418 url: "/images/pleroma-fox-tan-shy.png",
1419 mime_type: "image/png"
1424 key: :default_mascot,
1427 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1433 key: :default_user_avatar,
1434 type: {:string, :image},
1435 description: "URL of the default user avatar",
1436 suggestions: ["/images/avi.png"]
1445 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1449 type: {:list, :map},
1450 description: "Describe the icons of the app",
1453 src: "/static/logo.png"
1456 src: "/static/icon.png",
1460 src: "/static/icon.ico",
1461 sizes: "72x72 96x96 128x128 256x256"
1468 description: "Describe the theme color of the app",
1469 suggestions: ["#282c37", "mediumpurple"]
1472 key: :background_color,
1474 description: "Describe the background color of the app",
1475 suggestions: ["#191b22", "aliceblue"]
1483 description: "Media proxy",
1488 description: "Enables proxying of remote media via the instance's proxy"
1495 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1496 suggestions: ["https://example.com"]
1504 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1510 description: "Enables media cache object invalidation."
1515 description: "Module which will be used to purge objects from the cache.",
1517 Pleroma.Web.MediaProxy.Invalidation.Script,
1518 Pleroma.Web.MediaProxy.Invalidation.Http
1525 label: "Advanced MediaProxy Options",
1527 description: "Internal Pleroma.ReverseProxy settings",
1529 redirect_on_failure: false,
1530 max_body_length: 25 * 1_048_576,
1531 max_read_duration: 30_000
1535 key: :redirect_on_failure,
1538 Redirects the client to the origin server upon encountering HTTP errors.\n
1539 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1540 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1541 IP addresses of your users to the other servers, bypassing the MediaProxy.
1545 key: :max_body_length,
1548 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1551 key: :max_read_duration,
1553 description: "Timeout (in milliseconds) of GET request to the remote URI."
1559 type: {:list, :string},
1560 description: "List of hosts with scheme to bypass the MediaProxy",
1561 suggestions: ["http://example.com"]
1567 key: :media_preview_proxy,
1569 description: "Media preview proxy",
1575 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1578 key: :thumbnail_max_width,
1581 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1584 key: :thumbnail_max_height,
1587 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1590 key: :image_quality,
1592 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1595 key: :min_content_length,
1598 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1604 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1606 description: "HTTP invalidate settings",
1611 description: "HTTP method of request. Default: :purge"
1615 type: {:keyword, :string},
1616 description: "HTTP headers of request",
1617 suggestions: [{"x-refresh", 1}]
1622 description: "Request options",
1626 type: {:map, :string}
1634 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1636 description: "Invalidation script settings",
1641 description: "Path to executable script which will purge cached items.",
1642 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1646 label: "URL Format",
1649 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1650 suggestions: [":htcacheclean"]
1658 description: "Gopher settings",
1663 description: "Enables the gopher interface"
1669 description: "IP address to bind to",
1670 suggestions: [{0, 0, 0, 0}]
1675 description: "Port to bind to",
1681 description: "Port advertised in URLs (optional, defaults to port)",
1689 label: "ActivityPub",
1691 description: "ActivityPub-related settings",
1694 key: :unfollow_blocked,
1696 description: "Whether blocks result in people getting unfollowed"
1699 key: :outgoing_blocks,
1701 description: "Whether to federate blocks to other instances"
1704 key: :sign_object_fetches,
1706 description: "Sign object fetches with HTTP signatures"
1709 key: :note_replies_output_limit,
1712 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1715 key: :follow_handshake_timeout,
1717 description: "Following handshake timeout",
1724 key: :http_security,
1725 label: "HTTP security",
1727 description: "HTTP security settings",
1732 description: "Whether the managed content security policy is enabled"
1738 description: "Whether to additionally send a Strict-Transport-Security header"
1742 label: "STS max age",
1744 description: "The maximum age for the Strict-Transport-Security header if sent",
1745 suggestions: [31_536_000]
1749 label: "CT max age",
1751 description: "The maximum age for the Expect-CT header if sent",
1752 suggestions: [2_592_000]
1755 key: :referrer_policy,
1757 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1758 suggestions: ["same-origin", "no-referrer"]
1762 label: "Report URI",
1764 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1765 suggestions: ["https://example.com/report-uri"]
1770 group: :web_push_encryption,
1771 key: :vapid_details,
1772 label: "Vapid Details",
1775 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1781 "A mailto link for the administrative contact." <>
1782 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1783 suggestions: ["mailto:moderators@pleroma.com"]
1788 description: "VAPID public key",
1789 suggestions: ["Public key"]
1794 description: "VAPID private key",
1795 suggestions: ["Private key"]
1801 key: Pleroma.Captcha,
1803 description: "Captcha-related settings",
1808 description: "Whether the captcha should be shown on registration"
1813 description: "The method/service to use for captcha",
1814 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1817 key: :seconds_valid,
1819 description: "The time in seconds for which the captcha is valid",
1826 key: Pleroma.Captcha.Kocaptcha,
1829 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1830 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1835 description: "The kocaptcha endpoint to use",
1836 suggestions: ["https://captcha.kotobank.ch"]
1842 label: "Pleroma Admin Token",
1845 "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)",
1850 description: "Admin token",
1852 "Please use a high entropy string or UUID"
1862 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1866 type: {:dropdown, :atom},
1867 description: "Logs verbose mode",
1868 suggestions: [false, :error, :warn, :info, :debug]
1872 type: {:keyword, :integer},
1874 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1876 activity_expiration: 10,
1877 attachments_cleanup: 5,
1879 federator_incoming: 50,
1880 federator_outgoing: 50,
1882 scheduled_activities: 10,
1888 key: :activity_expiration,
1890 description: "Activity expiration queue",
1896 description: "Backup queue",
1900 key: :attachments_cleanup,
1902 description: "Attachment deletion queue",
1908 description: "Background queue",
1912 key: :federator_incoming,
1914 description: "Incoming federation queue",
1918 key: :federator_outgoing,
1920 description: "Outgoing federation queue",
1926 description: "Email sender queue, see Pleroma.Emails.Mailer",
1930 key: :scheduled_activities,
1932 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1936 key: :transmogrifier,
1938 description: "Transmogrifier queue",
1944 description: "Web push notifications queue",
1951 type: {:list, :tuple},
1952 description: "Settings for cron background jobs",
1954 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1955 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1964 description: "Includes custom worker options not interpretable directly by `Oban`",
1968 type: {:keyword, :integer},
1969 description: "Max retry attempts for failed jobs, per `Oban` queue",
1971 federator_incoming: 5,
1972 federator_outgoing: 5
1979 key: Pleroma.Web.Metadata,
1981 description: "Metadata-related settings",
1985 type: {:list, :module},
1986 description: "List of metadata providers to enable",
1988 Pleroma.Web.Metadata.Providers.OpenGraph,
1989 Pleroma.Web.Metadata.Providers.TwitterCard,
1990 Pleroma.Web.Metadata.Providers.RelMe,
1991 Pleroma.Web.Metadata.Providers.Feed
1996 label: "Unfurl NSFW",
1998 description: "When enabled NSFW attachments will be shown in previews"
2007 "If enabled the instance will parse metadata from attached links to generate link previews",
2012 description: "Enables RichMedia parsing of URLs"
2016 type: {:list, :string},
2017 description: "List of hosts which will be ignored by the metadata parser",
2018 suggestions: ["accounts.google.com", "xss.website"]
2022 label: "Ignore TLD",
2023 type: {:list, :string},
2024 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2025 suggestions: ["local", "localdomain", "lan"]
2029 type: {:list, :module},
2031 "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.",
2033 Pleroma.Web.RichMedia.Parsers.OEmbed,
2034 Pleroma.Web.RichMedia.Parsers.TwitterCard
2039 label: "TTL setters",
2040 type: {:list, :module},
2042 "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.",
2044 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2048 key: :failure_backoff,
2051 "Amount of milliseconds after request failure, during which the request will not be retried.",
2052 suggestions: [60_000]
2058 key: Pleroma.Formatter,
2062 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2066 type: [:string, :boolean],
2067 description: "Specify the class to be added to the generated link. Disable to clear.",
2068 suggestions: ["auto-linker", false]
2072 type: [:string, :boolean],
2073 description: "Override the rel attribute. Disable to clear.",
2074 suggestions: ["ugc", "noopener noreferrer", false]
2079 description: "Link URLs will open in a new window/tab."
2083 type: [:integer, :boolean],
2085 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2086 suggestions: [15, false]
2091 description: "Strip the scheme prefix."
2096 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2100 type: [:atom, :boolean],
2102 "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)",
2103 suggestions: [:no_scheme, true]
2109 key: Pleroma.ScheduledActivity,
2111 description: "Scheduled activities settings",
2114 key: :daily_user_limit,
2117 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2121 key: :total_user_limit,
2124 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2130 description: "Whether scheduled activities are sent to the job queue to be executed"
2136 key: Pleroma.Workers.PurgeExpiredActivity,
2138 description: "Expired activities settings",
2143 description: "Enables expired activities addition & deletion"
2148 description: "Minimum lifetime for ephemeral activity (in seconds)",
2155 label: "Pleroma Authenticator",
2157 description: "Authenticator",
2160 key: Pleroma.Web.Auth.Authenticator,
2162 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2172 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2173 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2174 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2175 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2180 description: "Enables LDAP authentication"
2185 description: "LDAP server hostname",
2186 suggestions: ["localhosts"]
2191 description: "LDAP port, e.g. 389 or 636",
2192 suggestions: [389, 636]
2198 description: "Enable to use SSL, usually implies the port 636"
2202 label: "SSL options",
2204 description: "Additional SSL options",
2205 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2210 description: "Path to file with PEM encoded cacerts",
2211 suggestions: ["path/to/file/with/PEM/cacerts"]
2216 description: "Type of cert verification",
2217 suggestions: [:verify_peer]
2225 description: "Enable to use STARTTLS, usually implies the port 389"
2229 label: "TLS options",
2231 description: "Additional TLS options",
2232 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2237 description: "Path to file with PEM encoded cacerts",
2238 suggestions: ["path/to/file/with/PEM/cacerts"]
2243 description: "Type of cert verification",
2244 suggestions: [:verify_peer]
2251 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2252 suggestions: ["dc=example,dc=com"]
2259 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2268 description: "Authentication / authorization settings",
2271 key: :enforce_oauth_admin_scope_usage,
2272 label: "Enforce OAuth admin scope usage",
2275 "OAuth admin scope requirement toggle. " <>
2276 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2277 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2278 "`is_admin` user flag grants access to admin-specific actions."
2281 key: :auth_template,
2284 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2285 suggestions: ["show.html"]
2288 key: :oauth_consumer_template,
2289 label: "OAuth consumer template",
2292 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2293 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2294 suggestions: ["consumer.html"]
2297 key: :oauth_consumer_strategies,
2298 label: "OAuth consumer strategies",
2299 type: {:list, :string},
2301 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2302 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2303 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2304 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2310 key: :email_notifications,
2312 description: "Email notifications settings",
2318 "emails of \"what you've missed\" for users who have been inactive for a while",
2322 schedule: "0 0 * * 0",
2324 inactivity_threshold: 7
2332 description: "Globally enable or disable digest emails"
2338 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2339 suggestions: ["0 0 * * 0"]
2344 description: "Minimum interval between digest emails to one user",
2348 key: :inactivity_threshold,
2350 description: "Minimum user inactivity threshold",
2359 key: Pleroma.Emails.UserEmail,
2361 description: "Email template settings",
2365 type: {:string, :image},
2366 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2367 suggestions: ["some/path/logo.png"]
2372 description: "A map with color settings for email templates.",
2375 link_color: "#d8a070",
2376 background_color: "#2C3645",
2377 content_background_color: "#1B2635",
2378 header_color: "#d8a070",
2379 text_color: "#b9b9ba",
2380 text_muted_color: "#b9b9ba"
2387 suggestions: ["#d8a070"]
2390 key: :background_color,
2392 suggestions: ["#2C3645"]
2395 key: :content_background_color,
2397 suggestions: ["#1B2635"]
2402 suggestions: ["#d8a070"]
2407 suggestions: ["#b9b9ba"]
2410 key: :text_muted_color,
2412 suggestions: ["#b9b9ba"]
2420 key: Pleroma.Emails.NewUsersDigestEmail,
2422 description: "New users admin email digest",
2427 description: "Enables new users admin digest email when `true`"
2436 description: "Configure OAuth 2 provider capabilities",
2439 key: :token_expires_in,
2441 description: "The lifetime in seconds of the access token",
2442 suggestions: [2_592_000]
2445 key: :issue_new_refresh_token,
2448 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2451 key: :clean_expired_tokens,
2453 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2463 key: :shortcode_globs,
2464 type: {:list, :string},
2465 description: "Location of custom emoji files. * can be used as a wildcard.",
2466 suggestions: ["/emoji/custom/**/*.png"]
2469 key: :pack_extensions,
2470 type: {:list, :string},
2472 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2473 suggestions: [".png", ".gif"]
2477 type: {:keyword, {:list, :string}},
2479 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2480 " and the value is the location or array of locations. * can be used as a wildcard.",
2482 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2486 key: :default_manifest,
2489 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2490 " Currently only one manifest can be added (no arrays).",
2491 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2494 key: :shared_pack_cache_seconds_per_file,
2495 label: "Shared pack cache s/file",
2498 "When an emoji pack is shared, the archive is created and cached in memory" <>
2499 " for this amount of seconds multiplied by the number of files.",
2509 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2513 type: [:tuple, {:list, :tuple}],
2514 description: "For the search requests (account & status search etc.)",
2515 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2519 type: [:tuple, {:list, :tuple}],
2520 description: "For requests to timelines (each timeline has it's own limiter)",
2521 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2524 key: :app_account_creation,
2525 type: [:tuple, {:list, :tuple}],
2526 description: "For registering user accounts from the same IP address",
2527 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2530 key: :relations_actions,
2531 type: [:tuple, {:list, :tuple}],
2532 description: "For actions on relationships with all users (follow, unfollow)",
2533 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2536 key: :relation_id_action,
2537 label: "Relation ID action",
2538 type: [:tuple, {:list, :tuple}],
2539 description: "For actions on relation with a specific user (follow, unfollow)",
2540 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2543 key: :statuses_actions,
2544 type: [:tuple, {:list, :tuple}],
2546 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2547 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2550 key: :status_id_action,
2551 label: "Status ID action",
2552 type: [:tuple, {:list, :tuple}],
2554 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2555 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2558 key: :authentication,
2559 type: [:tuple, {:list, :tuple}],
2560 description: "For authentication create / password check / user existence check requests",
2561 suggestions: [{60_000, 15}]
2570 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2571 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2576 description: "Enables SSH"
2581 description: "Dir with SSH keys",
2582 suggestions: ["/some/path/ssh_keys"]
2587 description: "Handler module",
2588 suggestions: ["Pleroma.BBS.Handler"]
2593 description: "Port to connect",
2594 suggestions: [10_022]
2597 key: :password_authenticator,
2599 description: "Authenticator module",
2600 suggestions: ["Pleroma.BBS.Authenticator"]
2606 label: "Mime Types",
2608 description: "Mime Types settings",
2615 "application/xml" => ["xml"],
2616 "application/xrd+xml" => ["xrd+xml"],
2617 "application/jrd+json" => ["jrd+json"],
2618 "application/activity+json" => ["activity+json"],
2619 "application/ld+json" => ["activity+json"]
2624 key: "application/xml",
2625 type: {:list, :string},
2626 suggestions: ["xml"]
2629 key: "application/xrd+xml",
2630 type: {:list, :string},
2631 suggestions: ["xrd+xml"]
2634 key: "application/jrd+json",
2635 type: {:list, :string},
2636 suggestions: ["jrd+json"]
2639 key: "application/activity+json",
2640 type: {:list, :string},
2641 suggestions: ["activity+json"]
2644 key: "application/ld+json",
2645 type: {:list, :string},
2646 suggestions: ["activity+json"]
2656 description: "Pleroma chat settings",
2669 description: "HTTP settings",
2674 type: [:string, :tuple],
2675 description: "Proxy URL",
2676 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2679 key: :send_user_agent,
2684 type: [:string, :atom],
2686 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2687 suggestions: ["Pleroma", :default]
2692 description: "Adapter specific options",
2698 label: "SSL Options",
2699 description: "SSL options for HTTP adapter",
2703 type: {:list, :atom},
2704 description: "List of TLS version to use",
2705 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2716 label: "Markup Settings",
2720 key: :allow_inline_images,
2724 key: :allow_headings,
2737 type: {:list, :module},
2739 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2740 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2750 key: :deny_follow_blocked,
2761 key: :restricted_nicknames,
2762 type: {:list, :string},
2763 description: "List of nicknames users may not register with.",
2782 "ostatus_subscribe",
2798 key: :email_blacklist,
2799 type: {:list, :string},
2800 description: "List of email domains users may not register with.",
2801 suggestions: ["mailinator.com", "maildrop.cc"]
2807 label: "CORS plug config",
2813 suggestions: [86_400]
2817 type: {:list, :string},
2818 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2822 type: {:list, :string},
2825 "X-RateLimit-Reset",
2826 "X-RateLimit-Limit",
2827 "X-RateLimit-Remaining",
2838 type: {:list, :string},
2839 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2845 key: Pleroma.Web.Plugs.RemoteIp,
2848 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2849 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2855 description: "Enable/disable the plug. Default: disabled."
2859 type: {:list, :string},
2861 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2866 type: {:list, :string},
2868 "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."
2872 type: {:list, :string},
2874 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"]`
2881 key: :web_cache_ttl,
2882 label: "Web cache TTL",
2885 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2891 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2895 key: :activity_pub_question,
2897 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2898 suggestions: [30_000]
2908 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2913 description: "Enables the rendering of static HTML. Default: disabled."
2921 description: "Configure feed rendering",
2926 description: "Configure title rendering",
2931 description: "Maximum number of characters before truncating title",
2937 description: "Replacement which will be used after truncating string",
2938 suggestions: ["..."]
2948 description: "Custom Runtime Modules",
2953 description: "A path to custom Elixir modules (such as MRF policies)."
2961 description: "Settings for notifications streamer",
2966 description: "Number of workers to send notifications",
2970 key: :overflow_workers,
2972 description: "Maximum number of workers created if pool is empty",
2979 key: :connections_pool,
2981 description: "Advanced settings for `Gun` connections pool",
2984 key: :connection_acquisition_wait,
2987 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2991 key: :connection_acquisition_retries,
2994 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2998 key: :max_connections,
3000 description: "Maximum number of connections in the pool. Default: 250 connections.",
3004 key: :connect_timeout,
3006 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3010 key: :reclaim_multiplier,
3013 "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",
3022 description: "Advanced settings for `Gun` workers pools",
3024 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3028 description: "Settings for #{pool_name} pool.",
3033 description: "Maximum number of concurrent requests in the pool.",
3040 "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",
3046 description: "Timeout for the pool while gun will wait for response",
3047 suggestions: [10_000]
3055 key: :hackney_pools,
3057 description: "Advanced settings for `Hackney` connections pools",
3062 description: "Settings for federation pool.",
3065 key: :max_connections,
3067 description: "Number workers in the pool.",
3073 description: "Timeout while `hackney` will wait for response.",
3074 suggestions: [150_000]
3081 description: "Settings for media pool.",
3084 key: :max_connections,
3086 description: "Number workers in the pool.",
3092 description: "Timeout while `hackney` will wait for response.",
3093 suggestions: [150_000]
3100 description: "Settings for upload pool.",
3103 key: :max_connections,
3105 description: "Number workers in the pool.",
3111 description: "Timeout while `hackney` will wait for response.",
3112 suggestions: [300_000]
3120 key: :restrict_unauthenticated,
3121 label: "Restrict Unauthenticated",
3124 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3129 description: "Settings for public and federated timelines.",
3134 description: "Disallow view public timeline."
3139 description: "Disallow view federated timeline."
3146 description: "Settings for user profiles.",
3151 description: "Disallow view local user profiles."
3156 description: "Disallow view remote user profiles."
3163 description: "Settings for statuses.",
3168 description: "Disallow view local statuses."
3173 description: "Disallow view remote statuses."
3181 key: Pleroma.Web.ApiSpec.CastAndValidate,
3188 "Enables strict input validation (useful in development, not recommended in production)"
3194 key: :instances_favicons,
3196 description: "Control favicons for instances",
3201 description: "Allow/disallow displaying and getting instances favicons"
3209 descriptions: "S3 service related settings",
3212 key: :access_key_id,
3214 description: "S3 access key ID",
3215 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3218 key: :secret_access_key,
3220 description: "Secret access key",
3221 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3226 description: "S3 host",
3227 suggestions: ["s3.eu-central-1.amazonaws.com"]
3232 description: "S3 region (for AWS)",
3233 suggestions: ["us-east-1"]
3241 description: "Installed frontends management",
3246 description: "Primary frontend, the one that is served for all pages by default",
3247 children: installed_frontend_options
3252 description: "Admin frontend",
3253 children: installed_frontend_options
3259 "A map containing available frontends and parameters for their installation.",
3260 children: frontend_options
3266 key: Pleroma.Web.Preload,
3268 description: "Preload-related settings",
3272 type: {:list, :module},
3273 description: "List of preload providers to enable",
3275 Pleroma.Web.Preload.Providers.Instance,
3276 Pleroma.Web.Preload.Providers.User,
3277 Pleroma.Web.Preload.Providers.Timelines,
3278 Pleroma.Web.Preload.Providers.StatusNet
3287 description: "Majic/libmagic configuration",
3292 description: "Number of majic workers to start.",
3299 key: Pleroma.User.Backup,
3301 description: "Account Backup",
3304 key: :purge_after_days,
3306 description: "Remove backup achives after N days",
3312 description: "Limit user to export not more often than once per N days",
3319 key: Pleroma.Web.Endpoint.MetricsExporter,
3321 description: "Prometheus app metrics endpoint configuration",
3326 description: "[Pleroma extension] Enables app metrics endpoint."
3330 label: "IP Whitelist",
3331 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3332 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3336 type: [:boolean, :tuple],
3337 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3338 suggestion: [false, {:basic, "myusername", "mypassword"}]
3343 description: "App metrics endpoint URI path.",
3344 suggestions: ["/api/pleroma/app_metrics"]
3349 description: "App metrics endpoint output format.",
3350 suggestions: [:text, :protobuf]
3356 key: ConcurrentLimiter,
3358 description: "Limits configuration for background tasks.",
3361 key: Pleroma.Web.RichMedia.Helpers,
3363 description: "Concurrent limits configuration for getting RichMedia for activities.",
3364 suggestions: [max_running: 5, max_waiting: 5],
3369 description: "Max running concurrently jobs.",
3375 description: "Max waiting jobs.",
3381 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3383 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3384 suggestions: [max_running: 5, max_waiting: 5],
3389 description: "Max running concurrently jobs.",
3395 description: "Max waiting jobs.",