6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
105 "https://cdn-host.com"
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
117 key: :filename_display_max_length,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
125 key: Pleroma.Uploaders.Local,
127 description: "Local uploader-related settings",
132 description: "Path where user's uploads will be saved",
141 key: Pleroma.Uploaders.S3,
143 description: "S3 uploader-related settings",
148 description: "S3 bucket",
154 key: :bucket_namespace,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
160 key: :truncated_namespace,
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
167 key: :streaming_enabled,
170 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
176 key: Pleroma.Upload.Filter.Mogrify,
178 description: "Uploads mogrify filter settings",
182 type: [:string, {:list, :string}, {:list, :tuple}],
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
198 description: "Filter replaces the filename of the upload",
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
207 "custom-file-name.{extension}"
214 key: Pleroma.Emails.Mailer,
216 description: "Mailer-related settings",
220 label: "Mailer Enabled",
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
229 Swoosh.Adapters.AmazonSES,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
244 group: {:subgroup, Swoosh.Adapters.SMTP},
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "SMTP port",
255 suggestions: ["1025"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "Use Implicit SSL/TLS. e.g. port 465"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "SMTP temporary (4xx) error retries",
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 label: "SendGrid API Key",
306 suggestions: ["YOUR_API_KEY"]
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
323 label: "Qmail compat mode",
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
329 label: "Mandrill API Key",
331 suggestions: ["YOUR_API_KEY"]
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
336 label: "Mailgun API Key",
338 suggestions: ["YOUR_API_KEY"]
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
344 suggestions: ["YOUR_DOMAIN_NAME"]
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
349 label: "MailJet Public API Key",
351 suggestions: ["MJ_APIKEY_PUBLIC"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
356 label: "MailJet Private API Key",
358 suggestions: ["MJ_APIKEY_PRIVATE"]
361 group: {:subgroup, Swoosh.Adapters.Postmark},
363 label: "Postmark API Key",
365 suggestions: ["X-Postmark-Server-Token"]
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
370 label: "SparkPost API key",
372 suggestions: ["YOUR_API_KEY"]
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 suggestions: ["https://api.sparkpost.com/api/v1"]
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
383 label: "AWS Access Key",
385 suggestions: ["AWS_ACCESS_KEY"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
390 label: "AWS Secret Key",
392 suggestions: ["AWS_SECRET_KEY"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.Dyn},
404 label: "Dyn API Key",
406 suggestions: ["apikey"]
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
411 label: "SocketLabs API Key",
413 suggestions: ["INJECTION_API_KEY"]
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 suggestions: ["SERVER_ID"]
423 group: {:subgroup, Swoosh.Adapters.Gmail},
425 label: "GMail API Access Token",
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
434 label: "URI Schemes",
436 description: "URI schemes related settings",
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
466 description: "Customizable features",
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
479 key: :populate_hashtags_table,
481 description: "`populate_hashtags_table` background migration settings",
484 key: :fault_rate_allowance,
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
491 key: :sleep_interval_ms,
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 label: "Admin Email Address",
516 description: "Email used to reach an Administrator/Moderator of the instance",
523 label: "Sender Email Address",
525 description: "Envelope FROM address for mail sent via Pleroma",
534 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
542 description: "Posts character limit (CW/Subject included in the counter)",
550 description: "Hard character limit beyond which remote posts will be dropped",
558 description: "File size limit of uploads (except for avatar, background, banner)",
564 key: :avatar_upload_limit,
566 description: "File size limit of user's profile avatars",
572 key: :background_upload_limit,
574 description: "File size limit of user's profile backgrounds",
580 key: :banner_upload_limit,
582 description: "File size limit of user's profile banners",
590 description: "A map with poll limits for local polls",
594 max_option_chars: 200,
596 max_expiration: 31_536_000
603 description: "Maximum number of options",
607 key: :max_option_chars,
609 description: "Maximum number of characters per option",
613 key: :min_expiration,
615 description: "Minimum expiration time (in seconds)",
619 key: :max_expiration,
621 description: "Maximum expiration time (in seconds)",
627 key: :registrations_open,
630 "Enable registrations for anyone. Invitations require this setting to be disabled."
633 key: :invites_enabled,
636 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
639 key: :account_activation_required,
641 description: "Require users to confirm their emails before signing in"
644 key: :account_approval_required,
646 description: "Require users to be manually approved by an admin before signing in"
651 description: "Enable federation with other instances"
654 key: :federation_incoming_replies_max_depth,
655 label: "Fed. incoming replies max depth",
658 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
659 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
665 key: :federation_reachability_timeout_days,
666 label: "Fed. reachability timeout days",
669 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
678 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
684 "Makes the client API in authenticated mode-only except for user-profiles." <>
685 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
686 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
689 key: :quarantined_instances,
690 type: {:list, :string},
692 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
701 description: "Instance static directory",
707 key: :allowed_post_formats,
708 type: {:list, :string},
709 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
718 key: :extended_nickname_format,
721 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
722 " This will break federation with older software for theses nicknames."
725 key: :cleanup_attachments,
728 Enable to remove associated attachments when status is removed.
729 This will not affect duplicates and attachments without status.
730 Enabling this will increase load to database when deleting statuses on larger instances.
734 key: :max_pinned_statuses,
736 description: "The maximum number of pinned statuses. 0 will disable the feature.",
744 key: :autofollowed_nicknames,
745 type: {:list, :string},
747 "Set to nicknames of (local) users that every new user should automatically follow"
750 key: :autofollowing_nicknames,
751 type: {:list, :string},
753 "Set to nicknames of (local) users that automatically follows every newly registered user"
756 key: :attachment_links,
758 description: "Enable to automatically add attachment link text to statuses"
761 key: :max_report_comment_size,
763 description: "The maximum size of the report comment. Default: 1000.",
769 key: :safe_dm_mentions,
770 label: "Safe DM mentions",
773 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
774 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
780 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
783 key: :remote_post_retention_days,
786 "The default amount of days to retain remote posts when pruning the database",
792 key: :user_bio_length,
794 description: "A user bio maximum length. Default: 5000.",
800 key: :user_name_length,
802 description: "A user name maximum length. Default: 100.",
808 key: :skip_thread_containment,
810 description: "Skip filtering out broken threads. Default: enabled."
813 key: :limit_to_local_content,
814 type: {:dropdown, :atom},
816 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
824 key: :max_account_fields,
826 description: "The maximum number of custom fields in the user profile. Default: 10.",
832 key: :max_remote_account_fields,
835 "The maximum number of custom fields in the remote user profile. Default: 20.",
841 key: :account_field_name_length,
843 description: "An account field name maximum length. Default: 512.",
849 key: :account_field_value_length,
851 description: "An account field value maximum length. Default: 2048.",
857 key: :registration_reason_length,
859 description: "Maximum registration reason length. Default: 500.",
865 key: :external_user_synchronization,
867 description: "Enabling following/followers counters synchronization for external users"
870 key: :multi_factor_authentication,
872 description: "Multi-factor authentication settings",
875 totp: [digits: 6, period: 30],
876 backup_codes: [number: 5, length: 16]
882 label: "TOTP settings",
884 description: "TOTP settings",
885 suggestions: [digits: 6, period: 30],
892 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
899 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
906 description: "MFA backup codes settings",
907 suggestions: [number: 5, length: 16],
913 description: "Number of backup codes to generate."
920 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
927 key: :instance_thumbnail,
928 type: {:string, :image},
930 "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.",
931 suggestions: ["/instance/thumbnail.jpeg"]
934 key: :show_reactions,
936 description: "Let favourites and emoji reactions be viewed through the API."
944 description: "Welcome messages settings",
947 key: :direct_message,
949 descpiption: "Direct message settings",
954 description: "Enables sending a direct message to newly registered users"
959 description: "A message that will be sent to newly registered users",
961 "Hi, @username! Welcome on board!"
965 key: :sender_nickname,
967 description: "The nickname of the local user that sends a welcome message",
977 descpiption: "Chat message settings",
982 description: "Enables sending a chat message to newly registered users"
988 "A message that will be sent to newly registered users as a chat message",
990 "Hello, welcome on board!"
994 key: :sender_nickname,
996 description: "The nickname of the local user that sends a welcome chat message",
1006 descpiption: "Email message settings",
1011 description: "Enables sending an email to newly registered users"
1015 type: [:string, :tuple],
1017 "Email address and/or nickname that will be used to send the welcome email.",
1019 {"Pleroma App", "welcome@pleroma.app"}
1026 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1027 suggestions: ["Welcome to <%= instance_name%>"]
1033 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1034 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1040 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1041 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1050 description: "Logger-related settings",
1054 type: [:atom, :tuple, :module],
1056 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1057 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1065 label: "ExSyslogger",
1066 description: "ExSyslogger-related settings",
1070 type: {:dropdown, :atom},
1071 description: "Log level",
1072 suggestions: [:debug, :info, :warn, :error]
1078 "A string that's prepended to every message, and is typically set to the app name",
1079 suggestions: ["pleroma"]
1084 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1085 suggestions: ["$metadata[$level] $message"]
1089 type: {:list, :atom},
1090 suggestions: [:request_id]
1098 label: "Console Logger",
1099 description: "Console logger settings",
1103 type: {:dropdown, :atom},
1104 description: "Log level",
1105 suggestions: [:debug, :info, :warn, :error]
1110 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1111 suggestions: ["$metadata[$level] $message"]
1115 type: {:list, :atom},
1116 suggestions: [:request_id]
1123 label: "Quack Logger",
1124 description: "Quack-related settings",
1128 type: {:dropdown, :atom},
1129 description: "Log level",
1130 suggestions: [:debug, :info, :warn, :error]
1134 type: {:list, :atom},
1135 description: "Configure which metadata you want to report on",
1152 label: "Webhook URL",
1154 description: "Configure the Slack incoming webhook",
1155 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1161 key: :frontend_configurations,
1164 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1165 "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
1166 "add your own configuration your settings all fields must be complete.",
1170 label: "Pleroma FE",
1172 description: "Settings for Pleroma FE",
1175 alwaysShowSubjectInput: true,
1176 background: "/static/aurora_borealis.jpg",
1177 collapseMessageWithSubject: false,
1179 hideFilteredStatuses: false,
1180 hideMutedPosts: false,
1181 hidePostStats: false,
1182 hideSitename: false,
1183 hideUserStats: false,
1184 loginMethod: "password",
1185 logo: "/static/logo.svg",
1188 minimalScopesMode: false,
1189 noAttachmentLinks: false,
1190 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1191 postContentType: "text/plain",
1192 redirectRootLogin: "/main/friends",
1193 redirectRootNoLogin: "/main/all",
1195 sidebarRight: false,
1196 showFeaturesPanel: true,
1197 showInstanceSpecificPanel: false,
1198 subjectLineBehavior: "email",
1199 theme: "pleroma-dark",
1200 webPushNotifications: false
1205 key: :alwaysShowSubjectInput,
1206 label: "Always show subject input",
1208 description: "When disabled, auto-hide the subject field if it's empty"
1212 type: {:string, :image},
1214 "URL of the background, unless viewing a user profile with a background that is set",
1215 suggestions: ["/images/city.jpg"]
1218 key: :collapseMessageWithSubject,
1219 label: "Collapse message with subject",
1222 "When a message has a subject (aka Content Warning), collapse it by default"
1228 description: "Enables green text on lines prefixed with the > character"
1231 key: :hideFilteredStatuses,
1232 label: "Hide Filtered Statuses",
1234 description: "Hides filtered statuses from timelines"
1237 key: :hideMutedPosts,
1238 label: "Hide Muted Posts",
1240 description: "Hides muted statuses from timelines"
1243 key: :hidePostStats,
1244 label: "Hide post stats",
1246 description: "Hide notices statistics (repeats, favorites, ...)"
1250 label: "Hide Sitename",
1252 description: "Hides instance name from PleromaFE banner"
1255 key: :hideUserStats,
1256 label: "Hide user stats",
1259 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1263 type: {:string, :image},
1264 description: "URL of the logo, defaults to Pleroma's logo",
1265 suggestions: ["/static/logo.svg"]
1269 label: "Logo margin",
1272 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1273 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1274 suggestions: [".1em"]
1281 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1282 "If you want a colorful logo you must disable logoMask."
1285 key: :minimalScopesMode,
1286 label: "Minimal scopes mode",
1289 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1290 "Also prevents replying to a DM with a public post from PleromaFE."
1293 key: :nsfwCensorImage,
1294 label: "NSFW Censor Image",
1295 type: {:string, :image},
1297 "URL of the image to use for hiding NSFW media attachments in the timeline",
1298 suggestions: ["/static/img/nsfw.74818f9.png"]
1301 key: :postContentType,
1302 label: "Post Content Type",
1303 type: {:dropdown, :atom},
1304 description: "Default post formatting option",
1305 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1308 key: :redirectRootNoLogin,
1309 label: "Redirect root no login",
1312 "Relative URL which indicates where to redirect when a user isn't logged in",
1313 suggestions: ["/main/all"]
1316 key: :redirectRootLogin,
1317 label: "Redirect root login",
1320 "Relative URL which indicates where to redirect when a user is logged in",
1321 suggestions: ["/main/friends"]
1325 label: "Scope copy",
1327 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1331 label: "Sidebar on Right",
1333 description: "Change alignment of sidebar and panels to the right"
1336 key: :showFeaturesPanel,
1337 label: "Show instance features panel",
1340 "Enables panel displaying functionality of the instance on the About page"
1343 key: :showInstanceSpecificPanel,
1344 label: "Show instance specific panel",
1346 description: "Whether to show the instance's custom panel"
1349 key: :subjectLineBehavior,
1350 label: "Subject line behavior",
1352 description: "Allows changing the default behaviour of subject lines in replies.
1353 `email`: copy and preprend re:, as in email,
1354 `masto`: copy verbatim, as in Mastodon,
1355 `noop`: don't copy the subject.",
1356 suggestions: ["email", "masto", "noop"]
1361 description: "Which theme to use. Available themes are defined in styles.json",
1362 suggestions: ["pleroma-dark"]
1373 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1377 type: {:keyword, :map},
1379 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1382 url: "/images/pleroma-fox-tan-smol.png",
1383 mime_type: "image/png"
1385 pleroma_fox_tan_shy: %{
1386 url: "/images/pleroma-fox-tan-shy.png",
1387 mime_type: "image/png"
1392 key: :default_mascot,
1395 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1401 key: :default_user_avatar,
1402 type: {:string, :image},
1403 description: "URL of the default user avatar",
1404 suggestions: ["/images/avi.png"]
1413 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1417 type: {:list, :map},
1418 description: "Describe the icons of the app",
1421 src: "/static/logo.png"
1424 src: "/static/icon.png",
1428 src: "/static/icon.ico",
1429 sizes: "72x72 96x96 128x128 256x256"
1436 description: "Describe the theme color of the app",
1437 suggestions: ["#282c37", "mediumpurple"]
1440 key: :background_color,
1442 description: "Describe the background color of the app",
1443 suggestions: ["#191b22", "aliceblue"]
1451 description: "Media proxy",
1456 description: "Enables proxying of remote media via the instance's proxy"
1463 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1464 suggestions: ["https://example.com"]
1472 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1478 description: "Enables media cache object invalidation."
1483 description: "Module which will be used to purge objects from the cache.",
1485 Pleroma.Web.MediaProxy.Invalidation.Script,
1486 Pleroma.Web.MediaProxy.Invalidation.Http
1493 label: "Advanced MediaProxy Options",
1495 description: "Internal Pleroma.ReverseProxy settings",
1497 redirect_on_failure: false,
1498 max_body_length: 25 * 1_048_576,
1499 max_read_duration: 30_000
1503 key: :redirect_on_failure,
1506 Redirects the client to the origin server upon encountering HTTP errors.\n
1507 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1508 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1509 IP addresses of your users to the other servers, bypassing the MediaProxy.
1513 key: :max_body_length,
1516 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1519 key: :max_read_duration,
1521 description: "Timeout (in milliseconds) of GET request to the remote URI."
1527 type: {:list, :string},
1528 description: "List of hosts with scheme to bypass the MediaProxy",
1529 suggestions: ["http://example.com"]
1535 key: :media_preview_proxy,
1537 description: "Media preview proxy",
1543 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1546 key: :thumbnail_max_width,
1549 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1552 key: :thumbnail_max_height,
1555 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1558 key: :image_quality,
1560 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1563 key: :min_content_length,
1566 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1572 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1574 description: "HTTP invalidate settings",
1579 description: "HTTP method of request. Default: :purge"
1583 type: {:keyword, :string},
1584 description: "HTTP headers of request",
1585 suggestions: [{"x-refresh", 1}]
1590 description: "Request options",
1594 type: {:map, :string}
1602 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1604 description: "Invalidation script settings",
1609 description: "Path to executable script which will purge cached items.",
1610 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1614 label: "URL Format",
1617 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1618 suggestions: [":htcacheclean"]
1626 description: "Gopher settings",
1631 description: "Enables the gopher interface"
1637 description: "IP address to bind to",
1638 suggestions: [{0, 0, 0, 0}]
1643 description: "Port to bind to",
1649 description: "Port advertised in URLs (optional, defaults to port)",
1657 label: "ActivityPub",
1659 description: "ActivityPub-related settings",
1662 key: :unfollow_blocked,
1664 description: "Whether blocks result in people getting unfollowed"
1667 key: :outgoing_blocks,
1669 description: "Whether to federate blocks to other instances"
1672 key: :sign_object_fetches,
1674 description: "Sign object fetches with HTTP signatures"
1677 key: :note_replies_output_limit,
1680 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1683 key: :follow_handshake_timeout,
1685 description: "Following handshake timeout",
1692 key: :http_security,
1693 label: "HTTP security",
1695 description: "HTTP security settings",
1700 description: "Whether the managed content security policy is enabled"
1706 description: "Whether to additionally send a Strict-Transport-Security header"
1710 label: "STS max age",
1712 description: "The maximum age for the Strict-Transport-Security header if sent",
1713 suggestions: [31_536_000]
1717 label: "CT max age",
1719 description: "The maximum age for the Expect-CT header if sent",
1720 suggestions: [2_592_000]
1723 key: :referrer_policy,
1725 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1726 suggestions: ["same-origin", "no-referrer"]
1730 label: "Report URI",
1732 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1733 suggestions: ["https://example.com/report-uri"]
1738 group: :web_push_encryption,
1739 key: :vapid_details,
1740 label: "Vapid Details",
1743 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1749 "A mailto link for the administrative contact." <>
1750 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1751 suggestions: ["mailto:moderators@pleroma.com"]
1756 description: "VAPID public key",
1757 suggestions: ["Public key"]
1762 description: "VAPID private key",
1763 suggestions: ["Private key"]
1769 key: Pleroma.Captcha,
1771 description: "Captcha-related settings",
1776 description: "Whether the captcha should be shown on registration"
1781 description: "The method/service to use for captcha",
1782 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1785 key: :seconds_valid,
1787 description: "The time in seconds for which the captcha is valid",
1794 key: Pleroma.Captcha.Kocaptcha,
1797 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1798 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1803 description: "The kocaptcha endpoint to use",
1804 suggestions: ["https://captcha.kotobank.ch"]
1810 label: "Pleroma Admin Token",
1813 "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)",
1818 description: "Admin token",
1820 "Please use a high entropy string or UUID"
1830 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1834 type: {:dropdown, :atom},
1835 description: "Logs verbose mode",
1836 suggestions: [false, :error, :warn, :info, :debug]
1840 type: {:keyword, :integer},
1842 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1844 activity_expiration: 10,
1845 attachments_cleanup: 5,
1847 federator_incoming: 50,
1848 federator_outgoing: 50,
1850 scheduled_activities: 10,
1856 key: :activity_expiration,
1858 description: "Activity expiration queue",
1864 description: "Backup queue",
1868 key: :attachments_cleanup,
1870 description: "Attachment deletion queue",
1876 description: "Background queue",
1880 key: :federator_incoming,
1882 description: "Incoming federation queue",
1886 key: :federator_outgoing,
1888 description: "Outgoing federation queue",
1894 description: "Email sender queue, see Pleroma.Emails.Mailer",
1898 key: :scheduled_activities,
1900 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1904 key: :transmogrifier,
1906 description: "Transmogrifier queue",
1912 description: "Web push notifications queue",
1919 type: {:list, :tuple},
1920 description: "Settings for cron background jobs",
1922 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1923 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1932 description: "Includes custom worker options not interpretable directly by `Oban`",
1936 type: {:keyword, :integer},
1937 description: "Max retry attempts for failed jobs, per `Oban` queue",
1939 federator_incoming: 5,
1940 federator_outgoing: 5
1947 key: Pleroma.Web.Metadata,
1949 description: "Metadata-related settings",
1953 type: {:list, :module},
1954 description: "List of metadata providers to enable",
1956 Pleroma.Web.Metadata.Providers.OpenGraph,
1957 Pleroma.Web.Metadata.Providers.TwitterCard,
1958 Pleroma.Web.Metadata.Providers.RelMe,
1959 Pleroma.Web.Metadata.Providers.Feed
1964 label: "Unfurl NSFW",
1966 description: "When enabled NSFW attachments will be shown in previews"
1975 "If enabled the instance will parse metadata from attached links to generate link previews",
1980 description: "Enables RichMedia parsing of URLs"
1984 type: {:list, :string},
1985 description: "List of hosts which will be ignored by the metadata parser",
1986 suggestions: ["accounts.google.com", "xss.website"]
1990 label: "Ignore TLD",
1991 type: {:list, :string},
1992 description: "List TLDs (top-level domains) which will ignore for parse metadata",
1993 suggestions: ["local", "localdomain", "lan"]
1997 type: {:list, :module},
1999 "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.",
2001 Pleroma.Web.RichMedia.Parsers.OEmbed,
2002 Pleroma.Web.RichMedia.Parsers.TwitterCard
2007 label: "TTL setters",
2008 type: {:list, :module},
2010 "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.",
2012 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2016 key: :failure_backoff,
2019 "Amount of milliseconds after request failure, during which the request will not be retried.",
2020 suggestions: [60_000]
2026 key: Pleroma.Formatter,
2030 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2034 type: [:string, :boolean],
2035 description: "Specify the class to be added to the generated link. Disable to clear.",
2036 suggestions: ["auto-linker", false]
2040 type: [:string, :boolean],
2041 description: "Override the rel attribute. Disable to clear.",
2042 suggestions: ["ugc", "noopener noreferrer", false]
2047 description: "Link URLs will open in a new window/tab."
2051 type: [:integer, :boolean],
2053 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2054 suggestions: [15, false]
2059 description: "Strip the scheme prefix."
2064 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2068 type: [:atom, :boolean],
2070 "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)",
2071 suggestions: [:no_scheme, true]
2077 key: Pleroma.ScheduledActivity,
2079 description: "Scheduled activities settings",
2082 key: :daily_user_limit,
2085 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2089 key: :total_user_limit,
2092 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2098 description: "Whether scheduled activities are sent to the job queue to be executed"
2104 key: Pleroma.Workers.PurgeExpiredActivity,
2106 description: "Expired activities settings",
2111 description: "Enables expired activities addition & deletion"
2116 description: "Minimum lifetime for ephemeral activity (in seconds)",
2123 label: "Pleroma Authenticator",
2125 description: "Authenticator",
2128 key: Pleroma.Web.Auth.Authenticator,
2130 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2140 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2141 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2142 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2143 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2148 description: "Enables LDAP authentication"
2153 description: "LDAP server hostname",
2154 suggestions: ["localhosts"]
2159 description: "LDAP port, e.g. 389 or 636",
2160 suggestions: [389, 636]
2166 description: "Enable to use SSL, usually implies the port 636"
2170 label: "SSL options",
2172 description: "Additional SSL options",
2173 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2178 description: "Path to file with PEM encoded cacerts",
2179 suggestions: ["path/to/file/with/PEM/cacerts"]
2184 description: "Type of cert verification",
2185 suggestions: [:verify_peer]
2193 description: "Enable to use STARTTLS, usually implies the port 389"
2197 label: "TLS options",
2199 description: "Additional TLS options",
2200 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2205 description: "Path to file with PEM encoded cacerts",
2206 suggestions: ["path/to/file/with/PEM/cacerts"]
2211 description: "Type of cert verification",
2212 suggestions: [:verify_peer]
2219 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2220 suggestions: ["dc=example,dc=com"]
2227 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2236 description: "Authentication / authorization settings",
2239 key: :enforce_oauth_admin_scope_usage,
2240 label: "Enforce OAuth admin scope usage",
2243 "OAuth admin scope requirement toggle. " <>
2244 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2245 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2246 "`is_admin` user flag grants access to admin-specific actions."
2249 key: :auth_template,
2252 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2253 suggestions: ["show.html"]
2256 key: :oauth_consumer_template,
2257 label: "OAuth consumer template",
2260 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2261 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2262 suggestions: ["consumer.html"]
2265 key: :oauth_consumer_strategies,
2266 label: "OAuth consumer strategies",
2267 type: {:list, :string},
2269 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2270 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2271 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2272 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2278 key: :email_notifications,
2280 description: "Email notifications settings",
2286 "emails of \"what you've missed\" for users who have been inactive for a while",
2290 schedule: "0 0 * * 0",
2292 inactivity_threshold: 7
2300 description: "Globally enable or disable digest emails"
2306 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2307 suggestions: ["0 0 * * 0"]
2312 description: "Minimum interval between digest emails to one user",
2316 key: :inactivity_threshold,
2318 description: "Minimum user inactivity threshold",
2327 key: Pleroma.Emails.UserEmail,
2329 description: "Email template settings",
2333 type: {:string, :image},
2334 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2335 suggestions: ["some/path/logo.png"]
2340 description: "A map with color settings for email templates.",
2343 link_color: "#d8a070",
2344 background_color: "#2C3645",
2345 content_background_color: "#1B2635",
2346 header_color: "#d8a070",
2347 text_color: "#b9b9ba",
2348 text_muted_color: "#b9b9ba"
2355 suggestions: ["#d8a070"]
2358 key: :background_color,
2360 suggestions: ["#2C3645"]
2363 key: :content_background_color,
2365 suggestions: ["#1B2635"]
2370 suggestions: ["#d8a070"]
2375 suggestions: ["#b9b9ba"]
2378 key: :text_muted_color,
2380 suggestions: ["#b9b9ba"]
2388 key: Pleroma.Emails.NewUsersDigestEmail,
2390 description: "New users admin email digest",
2395 description: "Enables new users admin digest email when `true`"
2404 description: "Configure OAuth 2 provider capabilities",
2407 key: :token_expires_in,
2409 description: "The lifetime in seconds of the access token",
2410 suggestions: [2_592_000]
2413 key: :issue_new_refresh_token,
2416 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2419 key: :clean_expired_tokens,
2421 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2431 key: :shortcode_globs,
2432 type: {:list, :string},
2433 description: "Location of custom emoji files. * can be used as a wildcard.",
2434 suggestions: ["/emoji/custom/**/*.png"]
2437 key: :pack_extensions,
2438 type: {:list, :string},
2440 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2441 suggestions: [".png", ".gif"]
2445 type: {:keyword, {:list, :string}},
2447 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2448 " and the value is the location or array of locations. * can be used as a wildcard.",
2450 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2454 key: :default_manifest,
2457 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2458 " Currently only one manifest can be added (no arrays).",
2459 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2462 key: :shared_pack_cache_seconds_per_file,
2463 label: "Shared pack cache s/file",
2466 "When an emoji pack is shared, the archive is created and cached in memory" <>
2467 " for this amount of seconds multiplied by the number of files.",
2477 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2481 type: [:tuple, {:list, :tuple}],
2482 description: "For the search requests (account & status search etc.)",
2483 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2487 type: [:tuple, {:list, :tuple}],
2488 description: "For requests to timelines (each timeline has it's own limiter)",
2489 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2492 key: :app_account_creation,
2493 type: [:tuple, {:list, :tuple}],
2494 description: "For registering user accounts from the same IP address",
2495 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2498 key: :relations_actions,
2499 type: [:tuple, {:list, :tuple}],
2500 description: "For actions on relationships with all users (follow, unfollow)",
2501 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2504 key: :relation_id_action,
2505 label: "Relation ID action",
2506 type: [:tuple, {:list, :tuple}],
2507 description: "For actions on relation with a specific user (follow, unfollow)",
2508 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2511 key: :statuses_actions,
2512 type: [:tuple, {:list, :tuple}],
2514 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2515 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2518 key: :status_id_action,
2519 label: "Status ID action",
2520 type: [:tuple, {:list, :tuple}],
2522 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2523 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2526 key: :authentication,
2527 type: [:tuple, {:list, :tuple}],
2528 description: "For authentication create / password check / user existence check requests",
2529 suggestions: [{60_000, 15}]
2538 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2539 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2544 description: "Enables SSH"
2549 description: "Dir with SSH keys",
2550 suggestions: ["/some/path/ssh_keys"]
2555 description: "Handler module",
2556 suggestions: ["Pleroma.BBS.Handler"]
2561 description: "Port to connect",
2562 suggestions: [10_022]
2565 key: :password_authenticator,
2567 description: "Authenticator module",
2568 suggestions: ["Pleroma.BBS.Authenticator"]
2574 label: "Mime Types",
2576 description: "Mime Types settings",
2583 "application/xml" => ["xml"],
2584 "application/xrd+xml" => ["xrd+xml"],
2585 "application/jrd+json" => ["jrd+json"],
2586 "application/activity+json" => ["activity+json"],
2587 "application/ld+json" => ["activity+json"]
2592 key: "application/xml",
2593 type: {:list, :string},
2594 suggestions: ["xml"]
2597 key: "application/xrd+xml",
2598 type: {:list, :string},
2599 suggestions: ["xrd+xml"]
2602 key: "application/jrd+json",
2603 type: {:list, :string},
2604 suggestions: ["jrd+json"]
2607 key: "application/activity+json",
2608 type: {:list, :string},
2609 suggestions: ["activity+json"]
2612 key: "application/ld+json",
2613 type: {:list, :string},
2614 suggestions: ["activity+json"]
2624 description: "Pleroma shout settings",
2629 description: "Enables the backend Shoutbox chat feature."
2634 description: "Shout message character limit.",
2646 description: "HTTP settings",
2651 type: [:string, :tuple],
2652 description: "Proxy URL",
2653 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2656 key: :send_user_agent,
2661 type: [:string, :atom],
2663 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2664 suggestions: ["Pleroma", :default]
2669 description: "Adapter specific options",
2675 label: "SSL Options",
2676 description: "SSL options for HTTP adapter",
2680 type: {:list, :atom},
2681 description: "List of TLS version to use",
2682 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2693 label: "Markup Settings",
2697 key: :allow_inline_images,
2701 key: :allow_headings,
2714 type: {:list, :module},
2716 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2717 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2727 key: :deny_follow_blocked,
2738 key: :restricted_nicknames,
2739 type: {:list, :string},
2740 description: "List of nicknames users may not register with.",
2759 "ostatus_subscribe",
2775 key: :email_blacklist,
2776 type: {:list, :string},
2777 description: "List of email domains users may not register with.",
2778 suggestions: ["mailinator.com", "maildrop.cc"]
2784 label: "CORS plug config",
2790 suggestions: [86_400]
2794 type: {:list, :string},
2795 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2799 type: {:list, :string},
2802 "X-RateLimit-Reset",
2803 "X-RateLimit-Limit",
2804 "X-RateLimit-Remaining",
2815 type: {:list, :string},
2816 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2822 key: Pleroma.Web.Plugs.RemoteIp,
2825 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2826 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2832 description: "Enable/disable the plug. Default: disabled."
2836 type: {:list, :string},
2838 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2843 type: {:list, :string},
2845 "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."
2849 type: {:list, :string},
2851 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"]`
2858 key: :web_cache_ttl,
2859 label: "Web cache TTL",
2862 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2868 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2872 key: :activity_pub_question,
2874 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2875 suggestions: [30_000]
2885 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2890 description: "Enables the rendering of static HTML. Default: disabled."
2898 description: "Configure feed rendering",
2903 description: "Configure title rendering",
2908 description: "Maximum number of characters before truncating title",
2914 description: "Replacement which will be used after truncating string",
2915 suggestions: ["..."]
2923 key: :mrf_follow_bot,
2925 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2926 label: "MRF FollowBot Policy",
2928 description: "Automatically follows newly discovered accounts.",
2931 key: :follower_nickname,
2933 description: "The name of the bot account to use for following newly discovered users.",
2934 suggestions: ["followbot"]
2942 description: "Custom Runtime Modules",
2947 description: "A path to custom Elixir modules (such as MRF policies)."
2955 description: "Settings for notifications streamer",
2960 description: "Number of workers to send notifications",
2964 key: :overflow_workers,
2966 description: "Maximum number of workers created if pool is empty",
2973 key: :connections_pool,
2975 description: "Advanced settings for `Gun` connections pool",
2978 key: :connection_acquisition_wait,
2981 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2985 key: :connection_acquisition_retries,
2988 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2992 key: :max_connections,
2994 description: "Maximum number of connections in the pool. Default: 250 connections.",
2998 key: :connect_timeout,
3000 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3004 key: :reclaim_multiplier,
3007 "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",
3016 description: "Advanced settings for `Gun` workers pools",
3018 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3022 description: "Settings for #{pool_name} pool.",
3027 description: "Maximum number of concurrent requests in the pool.",
3034 "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",
3040 description: "Timeout for the pool while gun will wait for response",
3041 suggestions: [10_000]
3049 key: :hackney_pools,
3051 description: "Advanced settings for `Hackney` connections pools",
3056 description: "Settings for federation pool.",
3059 key: :max_connections,
3061 description: "Number workers in the pool.",
3067 description: "Timeout while `hackney` will wait for response.",
3068 suggestions: [150_000]
3075 description: "Settings for media pool.",
3078 key: :max_connections,
3080 description: "Number workers in the pool.",
3086 description: "Timeout while `hackney` will wait for response.",
3087 suggestions: [150_000]
3094 description: "Settings for upload pool.",
3097 key: :max_connections,
3099 description: "Number workers in the pool.",
3105 description: "Timeout while `hackney` will wait for response.",
3106 suggestions: [300_000]
3114 key: :restrict_unauthenticated,
3115 label: "Restrict Unauthenticated",
3118 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3123 description: "Settings for public and federated timelines.",
3128 description: "Disallow view public timeline."
3133 description: "Disallow view federated timeline."
3140 description: "Settings for user profiles.",
3145 description: "Disallow view local user profiles."
3150 description: "Disallow view remote user profiles."
3157 description: "Settings for statuses.",
3162 description: "Disallow view local statuses."
3167 description: "Disallow view remote statuses."
3175 key: Pleroma.Web.ApiSpec.CastAndValidate,
3182 "Enables strict input validation (useful in development, not recommended in production)"
3188 key: :instances_favicons,
3190 description: "Control favicons for instances",
3195 description: "Allow/disallow displaying and getting instances favicons"
3203 descriptions: "S3 service related settings",
3206 key: :access_key_id,
3208 description: "S3 access key ID",
3209 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3212 key: :secret_access_key,
3214 description: "Secret access key",
3215 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3220 description: "S3 host",
3221 suggestions: ["s3.eu-central-1.amazonaws.com"]
3226 description: "S3 region (for AWS)",
3227 suggestions: ["us-east-1"]
3235 description: "Installed frontends management",
3240 description: "Primary frontend, the one that is served for all pages by default",
3241 children: installed_frontend_options
3246 description: "Admin frontend",
3247 children: installed_frontend_options
3253 "A map containing available frontends and parameters for their installation.",
3254 children: frontend_options
3260 key: Pleroma.Web.Preload,
3262 description: "Preload-related settings",
3266 type: {:list, :module},
3267 description: "List of preload providers to enable",
3269 Pleroma.Web.Preload.Providers.Instance,
3270 Pleroma.Web.Preload.Providers.User,
3271 Pleroma.Web.Preload.Providers.Timelines,
3272 Pleroma.Web.Preload.Providers.StatusNet
3281 description: "Majic/libmagic configuration",
3286 description: "Number of majic workers to start.",
3293 key: Pleroma.User.Backup,
3295 description: "Account Backup",
3298 key: :purge_after_days,
3300 description: "Remove backup achives after N days",
3306 description: "Limit user to export not more often than once per N days",
3313 key: Pleroma.Web.Endpoint.MetricsExporter,
3315 description: "Prometheus app metrics endpoint configuration",
3320 description: "[Pleroma extension] Enables app metrics endpoint."
3324 label: "IP Whitelist",
3325 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3326 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3330 type: [:boolean, :tuple],
3331 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3332 suggestion: [false, {:basic, "myusername", "mypassword"}]
3337 description: "App metrics endpoint URI path.",
3338 suggestions: ["/api/pleroma/app_metrics"]
3343 description: "App metrics endpoint output format.",
3344 suggestions: [:text, :protobuf]
3350 key: ConcurrentLimiter,
3352 description: "Limits configuration for background tasks.",
3355 key: Pleroma.Web.RichMedia.Helpers,
3357 description: "Concurrent limits configuration for getting RichMedia for activities.",
3358 suggestions: [max_running: 5, max_waiting: 5],
3363 description: "Max running concurrently jobs.",
3369 description: "Max waiting jobs.",
3375 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3377 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3378 suggestions: [max_running: 5, max_waiting: 5],
3383 description: "Max running concurrently jobs.",
3389 description: "Max waiting jobs.",