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: "Character limit of the instance chat messages",
558 description: "Hard character limit beyond which remote posts will be dropped",
566 description: "File size limit of uploads (except for avatar, background, banner)",
572 key: :avatar_upload_limit,
574 description: "File size limit of user's profile avatars",
580 key: :background_upload_limit,
582 description: "File size limit of user's profile backgrounds",
588 key: :banner_upload_limit,
590 description: "File size limit of user's profile banners",
598 description: "A map with poll limits for local polls",
602 max_option_chars: 200,
604 max_expiration: 31_536_000
611 description: "Maximum number of options",
615 key: :max_option_chars,
617 description: "Maximum number of characters per option",
621 key: :min_expiration,
623 description: "Minimum expiration time (in seconds)",
627 key: :max_expiration,
629 description: "Maximum expiration time (in seconds)",
635 key: :registrations_open,
638 "Enable registrations for anyone. Invitations require this setting to be disabled."
641 key: :invites_enabled,
644 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
647 key: :account_activation_required,
649 description: "Require users to confirm their emails before signing in"
652 key: :account_approval_required,
654 description: "Require users to be manually approved by an admin before signing in"
659 description: "Enable federation with other instances"
662 key: :federation_incoming_replies_max_depth,
663 label: "Fed. incoming replies max depth",
666 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
667 " 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.",
673 key: :federation_reachability_timeout_days,
674 label: "Fed. reachability timeout days",
677 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
685 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
691 "Makes the client API in authenticated mode-only except for user-profiles." <>
692 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
693 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
696 key: :quarantined_instances,
697 type: {:list, :string},
699 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
708 description: "Instance static directory",
714 key: :allowed_post_formats,
715 type: {:list, :string},
716 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
725 key: :extended_nickname_format,
728 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
729 " This will break federation with older software for theses nicknames."
732 key: :cleanup_attachments,
735 Enable to remove associated attachments when status is removed.
736 This will not affect duplicates and attachments without status.
737 Enabling this will increase load to database when deleting statuses on larger instances.
741 key: :max_pinned_statuses,
743 description: "The maximum number of pinned statuses. 0 will disable the feature.",
751 key: :autofollowed_nicknames,
752 type: {:list, :string},
754 "Set to nicknames of (local) users that every new user should automatically follow"
757 key: :autofollowing_nicknames,
758 type: {:list, :string},
760 "Set to nicknames of (local) users that automatically follows every newly registered user"
763 key: :attachment_links,
765 description: "Enable to automatically add attachment link text to statuses"
768 key: :max_report_comment_size,
770 description: "The maximum size of the report comment. Default: 1000.",
776 key: :safe_dm_mentions,
777 label: "Safe DM mentions",
780 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
781 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
787 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
790 key: :remote_post_retention_days,
793 "The default amount of days to retain remote posts when pruning the database",
799 key: :user_bio_length,
801 description: "A user bio maximum length. Default: 5000.",
807 key: :user_name_length,
809 description: "A user name maximum length. Default: 100.",
815 key: :skip_thread_containment,
817 description: "Skip filtering out broken threads. Default: enabled."
820 key: :limit_to_local_content,
821 type: {:dropdown, :atom},
823 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
831 key: :max_account_fields,
833 description: "The maximum number of custom fields in the user profile. Default: 10.",
839 key: :max_remote_account_fields,
842 "The maximum number of custom fields in the remote user profile. Default: 20.",
848 key: :account_field_name_length,
850 description: "An account field name maximum length. Default: 512.",
856 key: :account_field_value_length,
858 description: "An account field value maximum length. Default: 2048.",
864 key: :registration_reason_length,
866 description: "Maximum registration reason length. Default: 500.",
872 key: :external_user_synchronization,
874 description: "Enabling following/followers counters synchronization for external users"
877 key: :multi_factor_authentication,
879 description: "Multi-factor authentication settings",
882 totp: [digits: 6, period: 30],
883 backup_codes: [number: 5, length: 16]
889 label: "TOTP settings",
891 description: "TOTP settings",
892 suggestions: [digits: 6, period: 30],
899 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
906 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
913 description: "MFA backup codes settings",
914 suggestions: [number: 5, length: 16],
920 description: "Number of backup codes to generate."
927 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
934 key: :instance_thumbnail,
935 type: {:string, :image},
937 "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.",
938 suggestions: ["/instance/thumbnail.jpeg"]
941 key: :show_reactions,
943 description: "Let favourites and emoji reactions be viewed through the API."
951 description: "Welcome messages settings",
954 key: :direct_message,
956 descpiption: "Direct message settings",
961 description: "Enables sending a direct message to newly registered users"
966 description: "A message that will be sent to newly registered users",
968 "Hi, @username! Welcome on board!"
972 key: :sender_nickname,
974 description: "The nickname of the local user that sends a welcome message",
984 descpiption: "Chat message settings",
989 description: "Enables sending a chat message to newly registered users"
995 "A message that will be sent to newly registered users as a chat message",
997 "Hello, welcome on board!"
1001 key: :sender_nickname,
1003 description: "The nickname of the local user that sends a welcome chat message",
1013 descpiption: "Email message settings",
1018 description: "Enables sending an email to newly registered users"
1022 type: [:string, :tuple],
1024 "Email address and/or nickname that will be used to send the welcome email.",
1026 {"Pleroma App", "welcome@pleroma.app"}
1033 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1034 suggestions: ["Welcome to <%= instance_name%>"]
1040 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1041 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1047 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1048 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1057 description: "Logger-related settings",
1061 type: [:atom, :tuple, :module],
1063 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1064 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1072 label: "ExSyslogger",
1073 description: "ExSyslogger-related settings",
1077 type: {:dropdown, :atom},
1078 description: "Log level",
1079 suggestions: [:debug, :info, :warn, :error]
1085 "A string that's prepended to every message, and is typically set to the app name",
1086 suggestions: ["pleroma"]
1091 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1092 suggestions: ["$metadata[$level] $message"]
1096 type: {:list, :atom},
1097 suggestions: [:request_id]
1105 label: "Console Logger",
1106 description: "Console logger settings",
1110 type: {:dropdown, :atom},
1111 description: "Log level",
1112 suggestions: [:debug, :info, :warn, :error]
1117 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1118 suggestions: ["$metadata[$level] $message"]
1122 type: {:list, :atom},
1123 suggestions: [:request_id]
1130 label: "Quack Logger",
1131 description: "Quack-related settings",
1135 type: {:dropdown, :atom},
1136 description: "Log level",
1137 suggestions: [:debug, :info, :warn, :error]
1141 type: {:list, :atom},
1142 description: "Configure which metadata you want to report on",
1159 label: "Webhook URL",
1161 description: "Configure the Slack incoming webhook",
1162 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1168 key: :frontend_configurations,
1171 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1172 "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
1173 "add your own configuration your settings all fields must be complete.",
1177 label: "Pleroma FE",
1179 description: "Settings for Pleroma FE",
1182 alwaysShowSubjectInput: true,
1183 background: "/static/aurora_borealis.jpg",
1184 collapseMessageWithSubject: false,
1187 hideFilteredStatuses: false,
1188 hideMutedPosts: false,
1189 hidePostStats: false,
1190 hideSitename: false,
1191 hideUserStats: false,
1192 loginMethod: "password",
1193 logo: "/static/logo.svg",
1196 minimalScopesMode: false,
1197 noAttachmentLinks: false,
1198 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1199 postContentType: "text/plain",
1200 redirectRootLogin: "/main/friends",
1201 redirectRootNoLogin: "/main/all",
1203 sidebarRight: false,
1204 showFeaturesPanel: true,
1205 showInstanceSpecificPanel: false,
1206 subjectLineBehavior: "email",
1207 theme: "pleroma-dark",
1208 webPushNotifications: false
1213 key: :alwaysShowSubjectInput,
1214 label: "Always show subject input",
1216 description: "When disabled, auto-hide the subject field if it's empty"
1220 type: {:string, :image},
1222 "URL of the background, unless viewing a user profile with a background that is set",
1223 suggestions: ["/images/city.jpg"]
1226 key: :collapseMessageWithSubject,
1227 label: "Collapse message with subject",
1230 "When a message has a subject (aka Content Warning), collapse it by default"
1234 label: "PleromaFE Chat",
1236 description: "Disables PleromaFE Chat component"
1242 description: "Enables green text on lines prefixed with the > character"
1245 key: :hideFilteredStatuses,
1246 label: "Hide Filtered Statuses",
1248 description: "Hides filtered statuses from timelines"
1251 key: :hideMutedPosts,
1252 label: "Hide Muted Posts",
1254 description: "Hides muted statuses from timelines"
1257 key: :hidePostStats,
1258 label: "Hide post stats",
1260 description: "Hide notices statistics (repeats, favorites, ...)"
1264 label: "Hide Sitename",
1266 description: "Hides instance name from PleromaFE banner"
1269 key: :hideUserStats,
1270 label: "Hide user stats",
1273 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1277 type: {:string, :image},
1278 description: "URL of the logo, defaults to Pleroma's logo",
1279 suggestions: ["/static/logo.svg"]
1283 label: "Logo margin",
1286 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1287 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1288 suggestions: [".1em"]
1295 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1296 "If you want a colorful logo you must disable logoMask."
1299 key: :minimalScopesMode,
1300 label: "Minimal scopes mode",
1303 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1304 "Also prevents replying to a DM with a public post from PleromaFE."
1307 key: :nsfwCensorImage,
1308 label: "NSFW Censor Image",
1309 type: {:string, :image},
1311 "URL of the image to use for hiding NSFW media attachments in the timeline",
1312 suggestions: ["/static/img/nsfw.74818f9.png"]
1315 key: :postContentType,
1316 label: "Post Content Type",
1317 type: {:dropdown, :atom},
1318 description: "Default post formatting option",
1319 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1322 key: :redirectRootNoLogin,
1323 label: "Redirect root no login",
1326 "Relative URL which indicates where to redirect when a user isn't logged in",
1327 suggestions: ["/main/all"]
1330 key: :redirectRootLogin,
1331 label: "Redirect root login",
1334 "Relative URL which indicates where to redirect when a user is logged in",
1335 suggestions: ["/main/friends"]
1339 label: "Scope copy",
1341 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1345 label: "Sidebar on Right",
1347 description: "Change alignment of sidebar and panels to the right"
1350 key: :showFeaturesPanel,
1351 label: "Show instance features panel",
1354 "Enables panel displaying functionality of the instance on the About page"
1357 key: :showInstanceSpecificPanel,
1358 label: "Show instance specific panel",
1360 description: "Whether to show the instance's custom panel"
1363 key: :subjectLineBehavior,
1364 label: "Subject line behavior",
1366 description: "Allows changing the default behaviour of subject lines in replies.
1367 `email`: copy and preprend re:, as in email,
1368 `masto`: copy verbatim, as in Mastodon,
1369 `noop`: don't copy the subject.",
1370 suggestions: ["email", "masto", "noop"]
1375 description: "Which theme to use. Available themes are defined in styles.json",
1376 suggestions: ["pleroma-dark"]
1387 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1391 type: {:keyword, :map},
1393 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1396 url: "/images/pleroma-fox-tan-smol.png",
1397 mime_type: "image/png"
1399 pleroma_fox_tan_shy: %{
1400 url: "/images/pleroma-fox-tan-shy.png",
1401 mime_type: "image/png"
1406 key: :default_mascot,
1409 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1415 key: :default_user_avatar,
1416 type: {:string, :image},
1417 description: "URL of the default user avatar",
1418 suggestions: ["/images/avi.png"]
1427 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1431 type: {:list, :map},
1432 description: "Describe the icons of the app",
1435 src: "/static/logo.png"
1438 src: "/static/icon.png",
1442 src: "/static/icon.ico",
1443 sizes: "72x72 96x96 128x128 256x256"
1450 description: "Describe the theme color of the app",
1451 suggestions: ["#282c37", "mediumpurple"]
1454 key: :background_color,
1456 description: "Describe the background color of the app",
1457 suggestions: ["#191b22", "aliceblue"]
1465 description: "Media proxy",
1470 description: "Enables proxying of remote media via the instance's proxy"
1477 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1478 suggestions: ["https://example.com"]
1486 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1492 description: "Enables media cache object invalidation."
1497 description: "Module which will be used to purge objects from the cache.",
1499 Pleroma.Web.MediaProxy.Invalidation.Script,
1500 Pleroma.Web.MediaProxy.Invalidation.Http
1507 label: "Advanced MediaProxy Options",
1509 description: "Internal Pleroma.ReverseProxy settings",
1511 redirect_on_failure: false,
1512 max_body_length: 25 * 1_048_576,
1513 max_read_duration: 30_000
1517 key: :redirect_on_failure,
1520 Redirects the client to the origin server upon encountering HTTP errors.\n
1521 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1522 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1523 IP addresses of your users to the other servers, bypassing the MediaProxy.
1527 key: :max_body_length,
1530 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1533 key: :max_read_duration,
1535 description: "Timeout (in milliseconds) of GET request to the remote URI."
1541 type: {:list, :string},
1542 description: "List of hosts with scheme to bypass the MediaProxy",
1543 suggestions: ["http://example.com"]
1549 key: :media_preview_proxy,
1551 description: "Media preview proxy",
1557 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1560 key: :thumbnail_max_width,
1563 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1566 key: :thumbnail_max_height,
1569 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1572 key: :image_quality,
1574 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1577 key: :min_content_length,
1580 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1586 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1588 description: "HTTP invalidate settings",
1593 description: "HTTP method of request. Default: :purge"
1597 type: {:keyword, :string},
1598 description: "HTTP headers of request",
1599 suggestions: [{"x-refresh", 1}]
1604 description: "Request options",
1608 type: {:map, :string}
1616 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1618 description: "Invalidation script settings",
1623 description: "Path to executable script which will purge cached items.",
1624 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1628 label: "URL Format",
1631 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1632 suggestions: [":htcacheclean"]
1640 description: "Gopher settings",
1645 description: "Enables the gopher interface"
1651 description: "IP address to bind to",
1652 suggestions: [{0, 0, 0, 0}]
1657 description: "Port to bind to",
1663 description: "Port advertised in URLs (optional, defaults to port)",
1671 label: "ActivityPub",
1673 description: "ActivityPub-related settings",
1676 key: :unfollow_blocked,
1678 description: "Whether blocks result in people getting unfollowed"
1681 key: :outgoing_blocks,
1683 description: "Whether to federate blocks to other instances"
1686 key: :sign_object_fetches,
1688 description: "Sign object fetches with HTTP signatures"
1691 key: :note_replies_output_limit,
1694 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1697 key: :follow_handshake_timeout,
1699 description: "Following handshake timeout",
1706 key: :http_security,
1707 label: "HTTP security",
1709 description: "HTTP security settings",
1714 description: "Whether the managed content security policy is enabled"
1720 description: "Whether to additionally send a Strict-Transport-Security header"
1724 label: "STS max age",
1726 description: "The maximum age for the Strict-Transport-Security header if sent",
1727 suggestions: [31_536_000]
1731 label: "CT max age",
1733 description: "The maximum age for the Expect-CT header if sent",
1734 suggestions: [2_592_000]
1737 key: :referrer_policy,
1739 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1740 suggestions: ["same-origin", "no-referrer"]
1744 label: "Report URI",
1746 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1747 suggestions: ["https://example.com/report-uri"]
1752 group: :web_push_encryption,
1753 key: :vapid_details,
1754 label: "Vapid Details",
1757 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1763 "A mailto link for the administrative contact." <>
1764 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1765 suggestions: ["mailto:moderators@pleroma.com"]
1770 description: "VAPID public key",
1771 suggestions: ["Public key"]
1776 description: "VAPID private key",
1777 suggestions: ["Private key"]
1783 key: Pleroma.Captcha,
1785 description: "Captcha-related settings",
1790 description: "Whether the captcha should be shown on registration"
1795 description: "The method/service to use for captcha",
1796 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1799 key: :seconds_valid,
1801 description: "The time in seconds for which the captcha is valid",
1808 key: Pleroma.Captcha.Kocaptcha,
1811 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1812 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1817 description: "The kocaptcha endpoint to use",
1818 suggestions: ["https://captcha.kotobank.ch"]
1824 label: "Pleroma Admin Token",
1827 "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)",
1832 description: "Admin token",
1834 "Please use a high entropy string or UUID"
1844 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1848 type: {:dropdown, :atom},
1849 description: "Logs verbose mode",
1850 suggestions: [false, :error, :warn, :info, :debug]
1854 type: {:keyword, :integer},
1856 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1858 activity_expiration: 10,
1859 attachments_cleanup: 5,
1861 federator_incoming: 50,
1862 federator_outgoing: 50,
1864 scheduled_activities: 10,
1870 key: :activity_expiration,
1872 description: "Activity expiration queue",
1878 description: "Backup queue",
1882 key: :attachments_cleanup,
1884 description: "Attachment deletion queue",
1890 description: "Background queue",
1894 key: :federator_incoming,
1896 description: "Incoming federation queue",
1900 key: :federator_outgoing,
1902 description: "Outgoing federation queue",
1908 description: "Email sender queue, see Pleroma.Emails.Mailer",
1912 key: :scheduled_activities,
1914 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1918 key: :transmogrifier,
1920 description: "Transmogrifier queue",
1926 description: "Web push notifications queue",
1933 type: {:list, :tuple},
1934 description: "Settings for cron background jobs",
1936 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1937 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1946 description: "Includes custom worker options not interpretable directly by `Oban`",
1950 type: {:keyword, :integer},
1951 description: "Max retry attempts for failed jobs, per `Oban` queue",
1953 federator_incoming: 5,
1954 federator_outgoing: 5
1961 key: Pleroma.Web.Metadata,
1963 description: "Metadata-related settings",
1967 type: {:list, :module},
1968 description: "List of metadata providers to enable",
1970 Pleroma.Web.Metadata.Providers.OpenGraph,
1971 Pleroma.Web.Metadata.Providers.TwitterCard,
1972 Pleroma.Web.Metadata.Providers.RelMe,
1973 Pleroma.Web.Metadata.Providers.Feed
1978 label: "Unfurl NSFW",
1980 description: "When enabled NSFW attachments will be shown in previews"
1989 "If enabled the instance will parse metadata from attached links to generate link previews",
1994 description: "Enables RichMedia parsing of URLs"
1998 type: {:list, :string},
1999 description: "List of hosts which will be ignored by the metadata parser",
2000 suggestions: ["accounts.google.com", "xss.website"]
2004 label: "Ignore TLD",
2005 type: {:list, :string},
2006 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2007 suggestions: ["local", "localdomain", "lan"]
2011 type: {:list, :module},
2013 "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.",
2015 Pleroma.Web.RichMedia.Parsers.OEmbed,
2016 Pleroma.Web.RichMedia.Parsers.TwitterCard
2021 label: "TTL setters",
2022 type: {:list, :module},
2024 "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.",
2026 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2030 key: :failure_backoff,
2033 "Amount of milliseconds after request failure, during which the request will not be retried.",
2034 suggestions: [60_000]
2040 key: Pleroma.Formatter,
2044 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2048 type: [:string, :boolean],
2049 description: "Specify the class to be added to the generated link. Disable to clear.",
2050 suggestions: ["auto-linker", false]
2054 type: [:string, :boolean],
2055 description: "Override the rel attribute. Disable to clear.",
2056 suggestions: ["ugc", "noopener noreferrer", false]
2061 description: "Link URLs will open in a new window/tab."
2065 type: [:integer, :boolean],
2067 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2068 suggestions: [15, false]
2073 description: "Strip the scheme prefix."
2078 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2082 type: [:atom, :boolean],
2084 "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)",
2085 suggestions: [:no_scheme, true]
2091 key: Pleroma.ScheduledActivity,
2093 description: "Scheduled activities settings",
2096 key: :daily_user_limit,
2099 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2103 key: :total_user_limit,
2106 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2112 description: "Whether scheduled activities are sent to the job queue to be executed"
2118 key: Pleroma.Workers.PurgeExpiredActivity,
2120 description: "Expired activities settings",
2125 description: "Enables expired activities addition & deletion"
2130 description: "Minimum lifetime for ephemeral activity (in seconds)",
2137 label: "Pleroma Authenticator",
2139 description: "Authenticator",
2142 key: Pleroma.Web.Auth.Authenticator,
2144 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2154 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2155 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2156 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2157 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2162 description: "Enables LDAP authentication"
2167 description: "LDAP server hostname",
2168 suggestions: ["localhosts"]
2173 description: "LDAP port, e.g. 389 or 636",
2174 suggestions: [389, 636]
2180 description: "Enable to use SSL, usually implies the port 636"
2184 label: "SSL options",
2186 description: "Additional SSL options",
2187 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2192 description: "Path to file with PEM encoded cacerts",
2193 suggestions: ["path/to/file/with/PEM/cacerts"]
2198 description: "Type of cert verification",
2199 suggestions: [:verify_peer]
2207 description: "Enable to use STARTTLS, usually implies the port 389"
2211 label: "TLS options",
2213 description: "Additional TLS options",
2214 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2219 description: "Path to file with PEM encoded cacerts",
2220 suggestions: ["path/to/file/with/PEM/cacerts"]
2225 description: "Type of cert verification",
2226 suggestions: [:verify_peer]
2233 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2234 suggestions: ["dc=example,dc=com"]
2241 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2250 description: "Authentication / authorization settings",
2253 key: :enforce_oauth_admin_scope_usage,
2254 label: "Enforce OAuth admin scope usage",
2257 "OAuth admin scope requirement toggle. " <>
2258 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2259 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2260 "`is_admin` user flag grants access to admin-specific actions."
2263 key: :auth_template,
2266 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2267 suggestions: ["show.html"]
2270 key: :oauth_consumer_template,
2271 label: "OAuth consumer template",
2274 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2275 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2276 suggestions: ["consumer.html"]
2279 key: :oauth_consumer_strategies,
2280 label: "OAuth consumer strategies",
2281 type: {:list, :string},
2283 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2284 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2285 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2286 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2292 key: :email_notifications,
2294 description: "Email notifications settings",
2300 "emails of \"what you've missed\" for users who have been inactive for a while",
2304 schedule: "0 0 * * 0",
2306 inactivity_threshold: 7
2314 description: "Globally enable or disable digest emails"
2320 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2321 suggestions: ["0 0 * * 0"]
2326 description: "Minimum interval between digest emails to one user",
2330 key: :inactivity_threshold,
2332 description: "Minimum user inactivity threshold",
2341 key: Pleroma.Emails.UserEmail,
2343 description: "Email template settings",
2347 type: {:string, :image},
2348 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2349 suggestions: ["some/path/logo.png"]
2354 description: "A map with color settings for email templates.",
2357 link_color: "#d8a070",
2358 background_color: "#2C3645",
2359 content_background_color: "#1B2635",
2360 header_color: "#d8a070",
2361 text_color: "#b9b9ba",
2362 text_muted_color: "#b9b9ba"
2369 suggestions: ["#d8a070"]
2372 key: :background_color,
2374 suggestions: ["#2C3645"]
2377 key: :content_background_color,
2379 suggestions: ["#1B2635"]
2384 suggestions: ["#d8a070"]
2389 suggestions: ["#b9b9ba"]
2392 key: :text_muted_color,
2394 suggestions: ["#b9b9ba"]
2402 key: Pleroma.Emails.NewUsersDigestEmail,
2404 description: "New users admin email digest",
2409 description: "Enables new users admin digest email when `true`"
2418 description: "Configure OAuth 2 provider capabilities",
2421 key: :token_expires_in,
2423 description: "The lifetime in seconds of the access token",
2424 suggestions: [2_592_000]
2427 key: :issue_new_refresh_token,
2430 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2433 key: :clean_expired_tokens,
2435 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2445 key: :shortcode_globs,
2446 type: {:list, :string},
2447 description: "Location of custom emoji files. * can be used as a wildcard.",
2448 suggestions: ["/emoji/custom/**/*.png"]
2451 key: :pack_extensions,
2452 type: {:list, :string},
2454 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2455 suggestions: [".png", ".gif"]
2459 type: {:keyword, {:list, :string}},
2461 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2462 " and the value is the location or array of locations. * can be used as a wildcard.",
2464 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2468 key: :default_manifest,
2471 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2472 " Currently only one manifest can be added (no arrays).",
2473 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2476 key: :shared_pack_cache_seconds_per_file,
2477 label: "Shared pack cache s/file",
2480 "When an emoji pack is shared, the archive is created and cached in memory" <>
2481 " for this amount of seconds multiplied by the number of files.",
2491 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2495 type: [:tuple, {:list, :tuple}],
2496 description: "For the search requests (account & status search etc.)",
2497 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2501 type: [:tuple, {:list, :tuple}],
2502 description: "For requests to timelines (each timeline has it's own limiter)",
2503 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2506 key: :app_account_creation,
2507 type: [:tuple, {:list, :tuple}],
2508 description: "For registering user accounts from the same IP address",
2509 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2512 key: :relations_actions,
2513 type: [:tuple, {:list, :tuple}],
2514 description: "For actions on relationships with all users (follow, unfollow)",
2515 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2518 key: :relation_id_action,
2519 label: "Relation ID action",
2520 type: [:tuple, {:list, :tuple}],
2521 description: "For actions on relation with a specific user (follow, unfollow)",
2522 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2525 key: :statuses_actions,
2526 type: [:tuple, {:list, :tuple}],
2528 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2529 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2532 key: :status_id_action,
2533 label: "Status ID action",
2534 type: [:tuple, {:list, :tuple}],
2536 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2537 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2540 key: :authentication,
2541 type: [:tuple, {:list, :tuple}],
2542 description: "For authentication create / password check / user existence check requests",
2543 suggestions: [{60_000, 15}]
2552 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2553 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2558 description: "Enables SSH"
2563 description: "Dir with SSH keys",
2564 suggestions: ["/some/path/ssh_keys"]
2569 description: "Handler module",
2570 suggestions: ["Pleroma.BBS.Handler"]
2575 description: "Port to connect",
2576 suggestions: [10_022]
2579 key: :password_authenticator,
2581 description: "Authenticator module",
2582 suggestions: ["Pleroma.BBS.Authenticator"]
2588 label: "Mime Types",
2590 description: "Mime Types settings",
2597 "application/xml" => ["xml"],
2598 "application/xrd+xml" => ["xrd+xml"],
2599 "application/jrd+json" => ["jrd+json"],
2600 "application/activity+json" => ["activity+json"],
2601 "application/ld+json" => ["activity+json"]
2606 key: "application/xml",
2607 type: {:list, :string},
2608 suggestions: ["xml"]
2611 key: "application/xrd+xml",
2612 type: {:list, :string},
2613 suggestions: ["xrd+xml"]
2616 key: "application/jrd+json",
2617 type: {:list, :string},
2618 suggestions: ["jrd+json"]
2621 key: "application/activity+json",
2622 type: {:list, :string},
2623 suggestions: ["activity+json"]
2626 key: "application/ld+json",
2627 type: {:list, :string},
2628 suggestions: ["activity+json"]
2638 description: "Pleroma chat settings",
2651 description: "HTTP settings",
2656 type: [:string, :tuple],
2657 description: "Proxy URL",
2658 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2661 key: :send_user_agent,
2666 type: [:string, :atom],
2668 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2669 suggestions: ["Pleroma", :default]
2674 description: "Adapter specific options",
2680 label: "SSL Options",
2681 description: "SSL options for HTTP adapter",
2685 type: {:list, :atom},
2686 description: "List of TLS version to use",
2687 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2698 label: "Markup Settings",
2702 key: :allow_inline_images,
2706 key: :allow_headings,
2719 type: {:list, :module},
2721 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2722 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2732 key: :deny_follow_blocked,
2743 key: :restricted_nicknames,
2744 type: {:list, :string},
2745 description: "List of nicknames users may not register with.",
2764 "ostatus_subscribe",
2780 key: :email_blacklist,
2781 type: {:list, :string},
2782 description: "List of email domains users may not register with.",
2783 suggestions: ["mailinator.com", "maildrop.cc"]
2789 label: "CORS plug config",
2795 suggestions: [86_400]
2799 type: {:list, :string},
2800 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2804 type: {:list, :string},
2807 "X-RateLimit-Reset",
2808 "X-RateLimit-Limit",
2809 "X-RateLimit-Remaining",
2820 type: {:list, :string},
2821 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2827 key: Pleroma.Web.Plugs.RemoteIp,
2830 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2831 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2837 description: "Enable/disable the plug. Default: disabled."
2841 type: {:list, :string},
2843 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2848 type: {:list, :string},
2850 "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."
2854 type: {:list, :string},
2856 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"]`
2863 key: :web_cache_ttl,
2864 label: "Web cache TTL",
2867 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2873 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2877 key: :activity_pub_question,
2879 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2880 suggestions: [30_000]
2890 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2895 description: "Enables the rendering of static HTML. Default: disabled."
2903 description: "Configure feed rendering",
2908 description: "Configure title rendering",
2913 description: "Maximum number of characters before truncating title",
2919 description: "Replacement which will be used after truncating string",
2920 suggestions: ["..."]
2928 key: :mrf_follow_bot,
2930 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2931 label: "MRF FollowBot Policy",
2933 description: "Automatically follows newly discovered accounts.",
2936 key: :follower_nickname,
2938 description: "The name of the bot account to use for following newly discovered users.",
2939 suggestions: ["followbot"]
2947 description: "Custom Runtime Modules",
2952 description: "A path to custom Elixir modules (such as MRF policies)."
2960 description: "Settings for notifications streamer",
2965 description: "Number of workers to send notifications",
2969 key: :overflow_workers,
2971 description: "Maximum number of workers created if pool is empty",
2978 key: :connections_pool,
2980 description: "Advanced settings for `Gun` connections pool",
2983 key: :connection_acquisition_wait,
2986 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2990 key: :connection_acquisition_retries,
2993 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2997 key: :max_connections,
2999 description: "Maximum number of connections in the pool. Default: 250 connections.",
3003 key: :connect_timeout,
3005 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3009 key: :reclaim_multiplier,
3012 "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",
3021 description: "Advanced settings for `Gun` workers pools",
3023 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3027 description: "Settings for #{pool_name} pool.",
3032 description: "Maximum number of concurrent requests in the pool.",
3039 "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",
3045 description: "Timeout for the pool while gun will wait for response",
3046 suggestions: [10_000]
3054 key: :hackney_pools,
3056 description: "Advanced settings for `Hackney` connections pools",
3061 description: "Settings for federation pool.",
3064 key: :max_connections,
3066 description: "Number workers in the pool.",
3072 description: "Timeout while `hackney` will wait for response.",
3073 suggestions: [150_000]
3080 description: "Settings for media pool.",
3083 key: :max_connections,
3085 description: "Number workers in the pool.",
3091 description: "Timeout while `hackney` will wait for response.",
3092 suggestions: [150_000]
3099 description: "Settings for upload pool.",
3102 key: :max_connections,
3104 description: "Number workers in the pool.",
3110 description: "Timeout while `hackney` will wait for response.",
3111 suggestions: [300_000]
3119 key: :restrict_unauthenticated,
3120 label: "Restrict Unauthenticated",
3123 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3128 description: "Settings for public and federated timelines.",
3133 description: "Disallow view public timeline."
3138 description: "Disallow view federated timeline."
3145 description: "Settings for user profiles.",
3150 description: "Disallow view local user profiles."
3155 description: "Disallow view remote user profiles."
3162 description: "Settings for statuses.",
3167 description: "Disallow view local statuses."
3172 description: "Disallow view remote statuses."
3180 key: Pleroma.Web.ApiSpec.CastAndValidate,
3187 "Enables strict input validation (useful in development, not recommended in production)"
3193 key: :instances_favicons,
3195 description: "Control favicons for instances",
3200 description: "Allow/disallow displaying and getting instances favicons"
3208 descriptions: "S3 service related settings",
3211 key: :access_key_id,
3213 description: "S3 access key ID",
3214 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3217 key: :secret_access_key,
3219 description: "Secret access key",
3220 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3225 description: "S3 host",
3226 suggestions: ["s3.eu-central-1.amazonaws.com"]
3231 description: "S3 region (for AWS)",
3232 suggestions: ["us-east-1"]
3240 description: "Installed frontends management",
3245 description: "Primary frontend, the one that is served for all pages by default",
3246 children: installed_frontend_options
3251 description: "Admin frontend",
3252 children: installed_frontend_options
3258 "A map containing available frontends and parameters for their installation.",
3259 children: frontend_options
3265 key: Pleroma.Web.Preload,
3267 description: "Preload-related settings",
3271 type: {:list, :module},
3272 description: "List of preload providers to enable",
3274 Pleroma.Web.Preload.Providers.Instance,
3275 Pleroma.Web.Preload.Providers.User,
3276 Pleroma.Web.Preload.Providers.Timelines,
3277 Pleroma.Web.Preload.Providers.StatusNet
3286 description: "Majic/libmagic configuration",
3291 description: "Number of majic workers to start.",
3298 key: Pleroma.User.Backup,
3300 description: "Account Backup",
3303 key: :purge_after_days,
3305 description: "Remove backup achives after N days",
3311 description: "Limit user to export not more often than once per N days",
3318 key: Pleroma.Web.Endpoint.MetricsExporter,
3320 description: "Prometheus app metrics endpoint configuration",
3325 description: "[Pleroma extension] Enables app metrics endpoint."
3329 label: "IP Whitelist",
3330 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3331 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3335 type: [:boolean, :tuple],
3336 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3337 suggestion: [false, {:basic, "myusername", "mypassword"}]
3342 description: "App metrics endpoint URI path.",
3343 suggestions: ["/api/pleroma/app_metrics"]
3348 description: "App metrics endpoint output format.",
3349 suggestions: [:text, :protobuf]
3355 key: ConcurrentLimiter,
3357 description: "Limits configuration for background tasks.",
3360 key: Pleroma.Web.RichMedia.Helpers,
3362 description: "Concurrent limits configuration for getting RichMedia for activities.",
3363 suggestions: [max_running: 5, max_waiting: 5],
3368 description: "Max running concurrently jobs.",
3374 description: "Max waiting jobs.",
3380 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3382 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3383 suggestions: [max_running: 5, max_waiting: 5],
3388 description: "Max running concurrently jobs.",
3394 description: "Max waiting jobs.",