6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
105 "https://cdn-host.com"
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
117 key: :filename_display_max_length,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
125 key: Pleroma.Uploaders.Local,
127 description: "Local uploader-related settings",
132 description: "Path where user's uploads will be saved",
141 key: Pleroma.Uploaders.S3,
143 description: "S3 uploader-related settings",
148 description: "S3 bucket",
154 key: :bucket_namespace,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
160 key: :truncated_namespace,
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
167 key: :streaming_enabled,
170 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
176 key: Pleroma.Upload.Filter.Mogrify,
178 description: "Uploads mogrify filter settings",
182 type: [:string, {:list, :string}, {:list, :tuple}],
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
198 description: "Filter replaces the filename of the upload",
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
207 "custom-file-name.{extension}"
214 key: Pleroma.Emails.Mailer,
216 description: "Mailer-related settings",
220 label: "Mailer Enabled",
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
229 Swoosh.Adapters.AmazonSES,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
244 group: {:subgroup, Swoosh.Adapters.SMTP},
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "SMTP port",
255 suggestions: ["1025"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "Use Implicit SSL/TLS. e.g. port 465"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "SMTP temporary (4xx) error retries",
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 label: "SendGrid API Key",
306 suggestions: ["YOUR_API_KEY"]
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
323 label: "Qmail compat mode",
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
329 label: "Mandrill API Key",
331 suggestions: ["YOUR_API_KEY"]
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
336 label: "Mailgun API Key",
338 suggestions: ["YOUR_API_KEY"]
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
344 suggestions: ["YOUR_DOMAIN_NAME"]
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
349 label: "MailJet Public API Key",
351 suggestions: ["MJ_APIKEY_PUBLIC"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
356 label: "MailJet Private API Key",
358 suggestions: ["MJ_APIKEY_PRIVATE"]
361 group: {:subgroup, Swoosh.Adapters.Postmark},
363 label: "Postmark API Key",
365 suggestions: ["X-Postmark-Server-Token"]
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
370 label: "SparkPost API key",
372 suggestions: ["YOUR_API_KEY"]
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 suggestions: ["https://api.sparkpost.com/api/v1"]
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
383 label: "AWS Access Key",
385 suggestions: ["AWS_ACCESS_KEY"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
390 label: "AWS Secret Key",
392 suggestions: ["AWS_SECRET_KEY"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.Dyn},
404 label: "Dyn API Key",
406 suggestions: ["apikey"]
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
411 label: "SocketLabs API Key",
413 suggestions: ["INJECTION_API_KEY"]
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 suggestions: ["SERVER_ID"]
423 group: {:subgroup, Swoosh.Adapters.Gmail},
425 label: "GMail API Access Token",
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
434 label: "URI Schemes",
436 description: "URI schemes related settings",
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
466 description: "Customizable features",
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
479 key: :populate_hashtags_table,
481 description: "`populate_hashtags_table` background migration settings",
484 key: :fault_rate_allowance,
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
491 key: :sleep_interval_ms,
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 label: "Admin Email Address",
516 description: "Email used to reach an Administrator/Moderator of the instance",
523 label: "Sender Email Address",
525 description: "Envelope FROM address for mail sent via Pleroma",
534 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
542 description: "Posts character limit (CW/Subject included in the counter)",
550 description: "Hard character limit beyond which remote posts will be dropped",
558 description: "File size limit of uploads (except for avatar, background, banner)",
564 key: :avatar_upload_limit,
566 description: "File size limit of user's profile avatars",
572 key: :background_upload_limit,
574 description: "File size limit of user's profile backgrounds",
580 key: :banner_upload_limit,
582 description: "File size limit of user's profile banners",
590 description: "A map with poll limits for local polls",
594 max_option_chars: 200,
596 max_expiration: 31_536_000
603 description: "Maximum number of options",
607 key: :max_option_chars,
609 description: "Maximum number of characters per option",
613 key: :min_expiration,
615 description: "Minimum expiration time (in seconds)",
619 key: :max_expiration,
621 description: "Maximum expiration time (in seconds)",
627 key: :registrations_open,
630 "Enable registrations for anyone. Invitations require this setting to be disabled."
633 key: :invites_enabled,
636 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
639 key: :account_activation_required,
641 description: "Require users to confirm their emails before signing in"
644 key: :account_approval_required,
646 description: "Require users to be manually approved by an admin before signing in"
651 description: "Enable federation with other instances"
654 key: :federation_incoming_replies_max_depth,
655 label: "Fed. incoming replies max depth",
658 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
659 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
665 key: :federation_reachability_timeout_days,
666 label: "Fed. reachability timeout days",
669 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
678 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
684 "Makes the client API in authenticated mode-only except for user-profiles." <>
685 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
686 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
689 key: :quarantined_instances,
690 type: {:list, :tuple},
691 key_placeholder: "instance",
692 value_placeholder: "reason",
694 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent and the reason for doing so",
696 {"quarantined.com", "Reason"},
697 {"*.quarantined.com", "Reason"}
703 description: "Instance static directory",
709 key: :allowed_post_formats,
710 type: {:list, :string},
711 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
720 key: :extended_nickname_format,
723 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
724 " This will break federation with older software for theses nicknames."
727 key: :cleanup_attachments,
730 Enable to remove associated attachments when status is removed.
731 This will not affect duplicates and attachments without status.
732 Enabling this will increase load to database when deleting statuses on larger instances.
736 key: :max_pinned_statuses,
738 description: "The maximum number of pinned statuses. 0 will disable the feature.",
746 key: :autofollowed_nicknames,
747 type: {:list, :string},
749 "Set to nicknames of (local) users that every new user should automatically follow"
752 key: :autofollowing_nicknames,
753 type: {:list, :string},
755 "Set to nicknames of (local) users that automatically follows every newly registered user"
758 key: :attachment_links,
760 description: "Enable to automatically add attachment link text to statuses"
763 key: :max_report_comment_size,
765 description: "The maximum size of the report comment. Default: 1000.",
771 key: :safe_dm_mentions,
772 label: "Safe DM mentions",
775 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
776 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
782 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
785 key: :remote_post_retention_days,
788 "The default amount of days to retain remote posts when pruning the database",
794 key: :user_bio_length,
796 description: "A user bio maximum length. Default: 5000.",
802 key: :user_name_length,
804 description: "A user name maximum length. Default: 100.",
810 key: :skip_thread_containment,
812 description: "Skip filtering out broken threads. Default: enabled."
815 key: :limit_to_local_content,
816 type: {:dropdown, :atom},
818 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
826 key: :max_account_fields,
828 description: "The maximum number of custom fields in the user profile. Default: 10.",
834 key: :max_remote_account_fields,
837 "The maximum number of custom fields in the remote user profile. Default: 20.",
843 key: :account_field_name_length,
845 description: "An account field name maximum length. Default: 512.",
851 key: :account_field_value_length,
853 description: "An account field value maximum length. Default: 2048.",
859 key: :registration_reason_length,
861 description: "Maximum registration reason length. Default: 500.",
867 key: :external_user_synchronization,
869 description: "Enabling following/followers counters synchronization for external users"
872 key: :multi_factor_authentication,
874 description: "Multi-factor authentication settings",
877 totp: [digits: 6, period: 30],
878 backup_codes: [number: 5, length: 16]
884 label: "TOTP settings",
886 description: "TOTP settings",
887 suggestions: [digits: 6, period: 30],
894 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
901 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
908 description: "MFA backup codes settings",
909 suggestions: [number: 5, length: 16],
915 description: "Number of backup codes to generate."
922 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
929 key: :instance_thumbnail,
930 type: {:string, :image},
932 "The instance thumbnail can be any image that represents your instance and is used by some apps or services when they display information about your instance.",
933 suggestions: ["/instance/thumbnail.jpeg"]
936 key: :show_reactions,
938 description: "Let favourites and emoji reactions be viewed through the API."
941 key: :profile_directory,
943 description: "Enable profile directory."
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,
1186 hideFilteredStatuses: false,
1187 hideMutedPosts: false,
1188 hidePostStats: false,
1189 hideSitename: false,
1190 hideUserStats: false,
1191 loginMethod: "password",
1192 logo: "/static/logo.svg",
1195 minimalScopesMode: false,
1196 noAttachmentLinks: false,
1197 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1198 postContentType: "text/plain",
1199 redirectRootLogin: "/main/friends",
1200 redirectRootNoLogin: "/main/all",
1202 sidebarRight: false,
1203 showFeaturesPanel: true,
1204 showInstanceSpecificPanel: false,
1205 subjectLineBehavior: "email",
1206 theme: "pleroma-dark",
1207 webPushNotifications: false
1212 key: :alwaysShowSubjectInput,
1213 label: "Always show subject input",
1215 description: "When disabled, auto-hide the subject field if it's empty"
1219 type: {:string, :image},
1221 "URL of the background, unless viewing a user profile with a background that is set",
1222 suggestions: ["/images/city.jpg"]
1225 key: :collapseMessageWithSubject,
1226 label: "Collapse message with subject",
1229 "When a message has a subject (aka Content Warning), collapse it by default"
1235 description: "Enables green text on lines prefixed with the > character"
1238 key: :hideFilteredStatuses,
1239 label: "Hide Filtered Statuses",
1241 description: "Hides filtered statuses from timelines"
1244 key: :hideMutedPosts,
1245 label: "Hide Muted Posts",
1247 description: "Hides muted statuses from timelines"
1250 key: :hidePostStats,
1251 label: "Hide post stats",
1253 description: "Hide notices statistics (repeats, favorites, ...)"
1257 label: "Hide Sitename",
1259 description: "Hides instance name from PleromaFE banner"
1262 key: :hideUserStats,
1263 label: "Hide user stats",
1266 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1270 type: {:string, :image},
1271 description: "URL of the logo, defaults to Pleroma's logo",
1272 suggestions: ["/static/logo.svg"]
1276 label: "Logo margin",
1279 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1280 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1281 suggestions: [".1em"]
1288 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1289 "If you want a colorful logo you must disable logoMask."
1292 key: :minimalScopesMode,
1293 label: "Minimal scopes mode",
1296 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1297 "Also prevents replying to a DM with a public post from PleromaFE."
1300 key: :nsfwCensorImage,
1301 label: "NSFW Censor Image",
1302 type: {:string, :image},
1304 "URL of the image to use for hiding NSFW media attachments in the timeline",
1305 suggestions: ["/static/img/nsfw.74818f9.png"]
1308 key: :postContentType,
1309 label: "Post Content Type",
1310 type: {:dropdown, :atom},
1311 description: "Default post formatting option",
1312 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1315 key: :redirectRootNoLogin,
1316 label: "Redirect root no login",
1319 "Relative URL which indicates where to redirect when a user isn't logged in",
1320 suggestions: ["/main/all"]
1323 key: :redirectRootLogin,
1324 label: "Redirect root login",
1327 "Relative URL which indicates where to redirect when a user is logged in",
1328 suggestions: ["/main/friends"]
1332 label: "Scope copy",
1334 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1338 label: "Sidebar on Right",
1340 description: "Change alignment of sidebar and panels to the right"
1343 key: :showFeaturesPanel,
1344 label: "Show instance features panel",
1347 "Enables panel displaying functionality of the instance on the About page"
1350 key: :showInstanceSpecificPanel,
1351 label: "Show instance specific panel",
1353 description: "Whether to show the instance's custom panel"
1356 key: :subjectLineBehavior,
1357 label: "Subject line behavior",
1359 description: "Allows changing the default behaviour of subject lines in replies.
1360 `email`: copy and preprend re:, as in email,
1361 `masto`: copy verbatim, as in Mastodon,
1362 `noop`: don't copy the subject.",
1363 suggestions: ["email", "masto", "noop"]
1368 description: "Which theme to use. Available themes are defined in styles.json",
1369 suggestions: ["pleroma-dark"]
1380 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1384 type: {:keyword, :map},
1386 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1389 url: "/images/pleroma-fox-tan-smol.png",
1390 mime_type: "image/png"
1392 pleroma_fox_tan_shy: %{
1393 url: "/images/pleroma-fox-tan-shy.png",
1394 mime_type: "image/png"
1399 key: :default_mascot,
1402 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1408 key: :default_user_avatar,
1409 type: {:string, :image},
1410 description: "URL of the default user avatar",
1411 suggestions: ["/images/avi.png"]
1420 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1424 type: {:list, :map},
1425 description: "Describe the icons of the app",
1428 src: "/static/logo.png"
1431 src: "/static/icon.png",
1435 src: "/static/icon.ico",
1436 sizes: "72x72 96x96 128x128 256x256"
1443 description: "Describe the theme color of the app",
1444 suggestions: ["#282c37", "mediumpurple"]
1447 key: :background_color,
1449 description: "Describe the background color of the app",
1450 suggestions: ["#191b22", "aliceblue"]
1458 description: "Media proxy",
1463 description: "Enables proxying of remote media via the instance's proxy"
1470 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1471 suggestions: ["https://example.com"]
1479 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1485 description: "Enables media cache object invalidation."
1490 description: "Module which will be used to purge objects from the cache.",
1492 Pleroma.Web.MediaProxy.Invalidation.Script,
1493 Pleroma.Web.MediaProxy.Invalidation.Http
1500 label: "Advanced MediaProxy Options",
1502 description: "Internal Pleroma.ReverseProxy settings",
1504 redirect_on_failure: false,
1505 max_body_length: 25 * 1_048_576,
1506 max_read_duration: 30_000
1510 key: :redirect_on_failure,
1513 Redirects the client to the origin server upon encountering HTTP errors.\n
1514 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1515 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1516 IP addresses of your users to the other servers, bypassing the MediaProxy.
1520 key: :max_body_length,
1523 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1526 key: :max_read_duration,
1528 description: "Timeout (in milliseconds) of GET request to the remote URI."
1534 type: {:list, :string},
1535 description: "List of hosts with scheme to bypass the MediaProxy",
1536 suggestions: ["http://example.com"]
1542 key: :media_preview_proxy,
1544 description: "Media preview proxy",
1550 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1553 key: :thumbnail_max_width,
1556 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1559 key: :thumbnail_max_height,
1562 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1565 key: :image_quality,
1567 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1570 key: :min_content_length,
1573 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1579 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1581 description: "HTTP invalidate settings",
1586 description: "HTTP method of request. Default: :purge"
1590 type: {:keyword, :string},
1591 description: "HTTP headers of request",
1592 suggestions: [{"x-refresh", 1}]
1597 description: "Request options",
1601 type: {:map, :string}
1609 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1611 description: "Invalidation script settings",
1616 description: "Path to executable script which will purge cached items.",
1617 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1621 label: "URL Format",
1624 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1625 suggestions: [":htcacheclean"]
1633 description: "Gopher settings",
1638 description: "Enables the gopher interface"
1644 description: "IP address to bind to",
1645 suggestions: [{0, 0, 0, 0}]
1650 description: "Port to bind to",
1656 description: "Port advertised in URLs (optional, defaults to port)",
1664 label: "ActivityPub",
1666 description: "ActivityPub-related settings",
1669 key: :unfollow_blocked,
1671 description: "Whether blocks result in people getting unfollowed"
1674 key: :outgoing_blocks,
1676 description: "Whether to federate blocks to other instances"
1679 key: :blockers_visible,
1681 description: "Whether a user can see someone who has blocked them"
1684 key: :sign_object_fetches,
1686 description: "Sign object fetches with HTTP signatures"
1689 key: :note_replies_output_limit,
1692 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1695 key: :follow_handshake_timeout,
1697 description: "Following handshake timeout",
1704 key: :http_security,
1705 label: "HTTP security",
1707 description: "HTTP security settings",
1712 description: "Whether the managed content security policy is enabled"
1718 description: "Whether to additionally send a Strict-Transport-Security header"
1722 label: "STS max age",
1724 description: "The maximum age for the Strict-Transport-Security header if sent",
1725 suggestions: [31_536_000]
1729 label: "CT max age",
1731 description: "The maximum age for the Expect-CT header if sent",
1732 suggestions: [2_592_000]
1735 key: :referrer_policy,
1737 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1738 suggestions: ["same-origin", "no-referrer"]
1742 label: "Report URI",
1744 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1745 suggestions: ["https://example.com/report-uri"]
1750 group: :web_push_encryption,
1751 key: :vapid_details,
1752 label: "Vapid Details",
1755 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1761 "A mailto link for the administrative contact." <>
1762 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1763 suggestions: ["mailto:moderators@pleroma.com"]
1768 description: "VAPID public key",
1769 suggestions: ["Public key"]
1774 description: "VAPID private key",
1775 suggestions: ["Private key"]
1781 key: Pleroma.Captcha,
1783 description: "Captcha-related settings",
1788 description: "Whether the captcha should be shown on registration"
1793 description: "The method/service to use for captcha",
1794 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1797 key: :seconds_valid,
1799 description: "The time in seconds for which the captcha is valid",
1806 key: Pleroma.Captcha.Kocaptcha,
1809 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1810 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1815 description: "The kocaptcha endpoint to use",
1816 suggestions: ["https://captcha.kotobank.ch"]
1822 label: "Pleroma Admin Token",
1825 "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)",
1830 description: "Admin token",
1832 "Please use a high entropy string or UUID"
1842 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1846 type: {:dropdown, :atom},
1847 description: "Logs verbose mode",
1848 suggestions: [false, :error, :warn, :info, :debug]
1852 type: {:keyword, :integer},
1854 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1856 activity_expiration: 10,
1857 attachments_cleanup: 5,
1859 federator_incoming: 50,
1860 federator_outgoing: 50,
1862 scheduled_activities: 10,
1868 key: :activity_expiration,
1870 description: "Activity expiration queue",
1876 description: "Backup queue",
1880 key: :attachments_cleanup,
1882 description: "Attachment deletion queue",
1888 description: "Background queue",
1892 key: :federator_incoming,
1894 description: "Incoming federation queue",
1898 key: :federator_outgoing,
1900 description: "Outgoing federation queue",
1906 description: "Email sender queue, see Pleroma.Emails.Mailer",
1910 key: :scheduled_activities,
1912 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1916 key: :transmogrifier,
1918 description: "Transmogrifier queue",
1924 description: "Web push notifications queue",
1931 type: {:list, :tuple},
1932 description: "Settings for cron background jobs",
1934 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1935 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1944 description: "Includes custom worker options not interpretable directly by `Oban`",
1948 type: {:keyword, :integer},
1949 description: "Max retry attempts for failed jobs, per `Oban` queue",
1951 federator_incoming: 5,
1952 federator_outgoing: 5
1959 key: Pleroma.Web.Metadata,
1961 description: "Metadata-related settings",
1965 type: {:list, :module},
1966 description: "List of metadata providers to enable",
1968 Pleroma.Web.Metadata.Providers.OpenGraph,
1969 Pleroma.Web.Metadata.Providers.TwitterCard,
1970 Pleroma.Web.Metadata.Providers.RelMe,
1971 Pleroma.Web.Metadata.Providers.Feed
1976 label: "Unfurl NSFW",
1978 description: "When enabled NSFW attachments will be shown in previews"
1987 "If enabled the instance will parse metadata from attached links to generate link previews",
1992 description: "Enables RichMedia parsing of URLs"
1996 type: {:list, :string},
1997 description: "List of hosts which will be ignored by the metadata parser",
1998 suggestions: ["accounts.google.com", "xss.website"]
2002 label: "Ignore TLD",
2003 type: {:list, :string},
2004 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2005 suggestions: ["local", "localdomain", "lan"]
2009 type: {:list, :module},
2011 "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.",
2013 Pleroma.Web.RichMedia.Parsers.OEmbed,
2014 Pleroma.Web.RichMedia.Parsers.TwitterCard
2019 label: "TTL setters",
2020 type: {:list, :module},
2022 "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.",
2024 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2028 key: :failure_backoff,
2031 "Amount of milliseconds after request failure, during which the request will not be retried.",
2032 suggestions: [60_000]
2038 key: Pleroma.Formatter,
2042 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2046 type: [:string, :boolean],
2047 description: "Specify the class to be added to the generated link. Disable to clear.",
2048 suggestions: ["auto-linker", false]
2052 type: [:string, :boolean],
2053 description: "Override the rel attribute. Disable to clear.",
2054 suggestions: ["ugc", "noopener noreferrer", false]
2059 description: "Link URLs will open in a new window/tab."
2063 type: [:integer, :boolean],
2065 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2066 suggestions: [15, false]
2071 description: "Strip the scheme prefix."
2076 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2080 type: [:atom, :boolean],
2082 "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)",
2083 suggestions: [:no_scheme, true]
2089 key: Pleroma.ScheduledActivity,
2091 description: "Scheduled activities settings",
2094 key: :daily_user_limit,
2097 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2101 key: :total_user_limit,
2104 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2110 description: "Whether scheduled activities are sent to the job queue to be executed"
2116 key: Pleroma.Workers.PurgeExpiredActivity,
2118 description: "Expired activities settings",
2123 description: "Enables expired activities addition & deletion"
2128 description: "Minimum lifetime for ephemeral activity (in seconds)",
2135 label: "Pleroma Authenticator",
2137 description: "Authenticator",
2140 key: Pleroma.Web.Auth.Authenticator,
2142 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2152 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2153 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2154 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2155 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2160 description: "Enables LDAP authentication"
2165 description: "LDAP server hostname",
2166 suggestions: ["localhosts"]
2171 description: "LDAP port, e.g. 389 or 636",
2172 suggestions: [389, 636]
2178 description: "Enable to use SSL, usually implies the port 636"
2182 label: "SSL options",
2184 description: "Additional SSL options",
2185 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2190 description: "Path to file with PEM encoded cacerts",
2191 suggestions: ["path/to/file/with/PEM/cacerts"]
2196 description: "Type of cert verification",
2197 suggestions: [:verify_peer]
2205 description: "Enable to use STARTTLS, usually implies the port 389"
2209 label: "TLS options",
2211 description: "Additional TLS options",
2212 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2217 description: "Path to file with PEM encoded cacerts",
2218 suggestions: ["path/to/file/with/PEM/cacerts"]
2223 description: "Type of cert verification",
2224 suggestions: [:verify_peer]
2231 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2232 suggestions: ["dc=example,dc=com"]
2239 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2248 description: "Authentication / authorization settings",
2251 key: :enforce_oauth_admin_scope_usage,
2252 label: "Enforce OAuth admin scope usage",
2255 "OAuth admin scope requirement toggle. " <>
2256 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2257 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2258 "`is_admin` user flag grants access to admin-specific actions."
2261 key: :auth_template,
2264 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2265 suggestions: ["show.html"]
2268 key: :oauth_consumer_template,
2269 label: "OAuth consumer template",
2272 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2273 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2274 suggestions: ["consumer.html"]
2277 key: :oauth_consumer_strategies,
2278 label: "OAuth consumer strategies",
2279 type: {:list, :string},
2281 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2282 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2283 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2284 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2290 key: :email_notifications,
2292 description: "Email notifications settings",
2298 "emails of \"what you've missed\" for users who have been inactive for a while",
2302 schedule: "0 0 * * 0",
2304 inactivity_threshold: 7
2312 description: "Globally enable or disable digest emails"
2318 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2319 suggestions: ["0 0 * * 0"]
2324 description: "Minimum interval between digest emails to one user",
2328 key: :inactivity_threshold,
2330 description: "Minimum user inactivity threshold",
2339 key: Pleroma.Emails.UserEmail,
2341 description: "Email template settings",
2345 type: {:string, :image},
2346 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2347 suggestions: ["some/path/logo.png"]
2352 description: "A map with color settings for email templates.",
2355 link_color: "#d8a070",
2356 background_color: "#2C3645",
2357 content_background_color: "#1B2635",
2358 header_color: "#d8a070",
2359 text_color: "#b9b9ba",
2360 text_muted_color: "#b9b9ba"
2367 suggestions: ["#d8a070"]
2370 key: :background_color,
2372 suggestions: ["#2C3645"]
2375 key: :content_background_color,
2377 suggestions: ["#1B2635"]
2382 suggestions: ["#d8a070"]
2387 suggestions: ["#b9b9ba"]
2390 key: :text_muted_color,
2392 suggestions: ["#b9b9ba"]
2400 key: Pleroma.Emails.NewUsersDigestEmail,
2402 description: "New users admin email digest",
2407 description: "Enables new users admin digest email when `true`"
2416 description: "Configure OAuth 2 provider capabilities",
2419 key: :token_expires_in,
2421 description: "The lifetime in seconds of the access token",
2422 suggestions: [2_592_000]
2425 key: :issue_new_refresh_token,
2428 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2431 key: :clean_expired_tokens,
2433 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2443 key: :shortcode_globs,
2444 type: {:list, :string},
2445 description: "Location of custom emoji files. * can be used as a wildcard.",
2446 suggestions: ["/emoji/custom/**/*.png"]
2449 key: :pack_extensions,
2450 type: {:list, :string},
2452 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2453 suggestions: [".png", ".gif"]
2457 type: {:keyword, {:list, :string}},
2459 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2460 " and the value is the location or array of locations. * can be used as a wildcard.",
2462 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2466 key: :default_manifest,
2469 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2470 " Currently only one manifest can be added (no arrays).",
2471 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2474 key: :shared_pack_cache_seconds_per_file,
2475 label: "Shared pack cache s/file",
2478 "When an emoji pack is shared, the archive is created and cached in memory" <>
2479 " for this amount of seconds multiplied by the number of files.",
2489 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2493 type: [:tuple, {:list, :tuple}],
2494 description: "For the search requests (account & status search etc.)",
2495 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2499 type: [:tuple, {:list, :tuple}],
2500 description: "For requests to timelines (each timeline has it's own limiter)",
2501 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2504 key: :app_account_creation,
2505 type: [:tuple, {:list, :tuple}],
2506 description: "For registering user accounts from the same IP address",
2507 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2510 key: :relations_actions,
2511 type: [:tuple, {:list, :tuple}],
2512 description: "For actions on relationships with all users (follow, unfollow)",
2513 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2516 key: :relation_id_action,
2517 label: "Relation ID action",
2518 type: [:tuple, {:list, :tuple}],
2519 description: "For actions on relation with a specific user (follow, unfollow)",
2520 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2523 key: :statuses_actions,
2524 type: [:tuple, {:list, :tuple}],
2526 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2527 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2530 key: :status_id_action,
2531 label: "Status ID action",
2532 type: [:tuple, {:list, :tuple}],
2534 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2535 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2538 key: :authentication,
2539 type: [:tuple, {:list, :tuple}],
2540 description: "For authentication create / password check / user existence check requests",
2541 suggestions: [{60_000, 15}]
2550 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2551 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2556 description: "Enables SSH"
2561 description: "Dir with SSH keys",
2562 suggestions: ["/some/path/ssh_keys"]
2567 description: "Handler module",
2568 suggestions: ["Pleroma.BBS.Handler"]
2573 description: "Port to connect",
2574 suggestions: [10_022]
2577 key: :password_authenticator,
2579 description: "Authenticator module",
2580 suggestions: ["Pleroma.BBS.Authenticator"]
2586 label: "Mime Types",
2588 description: "Mime Types settings",
2595 "application/xml" => ["xml"],
2596 "application/xrd+xml" => ["xrd+xml"],
2597 "application/jrd+json" => ["jrd+json"],
2598 "application/activity+json" => ["activity+json"],
2599 "application/ld+json" => ["activity+json"]
2604 key: "application/xml",
2605 type: {:list, :string},
2606 suggestions: ["xml"]
2609 key: "application/xrd+xml",
2610 type: {:list, :string},
2611 suggestions: ["xrd+xml"]
2614 key: "application/jrd+json",
2615 type: {:list, :string},
2616 suggestions: ["jrd+json"]
2619 key: "application/activity+json",
2620 type: {:list, :string},
2621 suggestions: ["activity+json"]
2624 key: "application/ld+json",
2625 type: {:list, :string},
2626 suggestions: ["activity+json"]
2636 description: "Pleroma shout settings",
2641 description: "Enables the backend Shoutbox chat feature."
2646 description: "Shout message character limit.",
2658 description: "HTTP settings",
2663 type: [:string, :tuple],
2664 description: "Proxy URL",
2665 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2668 key: :send_user_agent,
2673 type: [:string, :atom],
2675 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2676 suggestions: ["Pleroma", :default]
2681 description: "Adapter specific options",
2687 label: "SSL Options",
2688 description: "SSL options for HTTP adapter",
2692 type: {:list, :atom},
2693 description: "List of TLS version to use",
2694 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2705 label: "Markup Settings",
2709 key: :allow_inline_images,
2713 key: :allow_headings,
2726 type: {:list, :module},
2728 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2729 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2739 key: :deny_follow_blocked,
2750 key: :restricted_nicknames,
2751 type: {:list, :string},
2752 description: "List of nicknames users may not register with.",
2771 "ostatus_subscribe",
2787 key: :email_blacklist,
2788 type: {:list, :string},
2789 description: "List of email domains users may not register with.",
2790 suggestions: ["mailinator.com", "maildrop.cc"]
2796 label: "CORS plug config",
2802 suggestions: [86_400]
2806 type: {:list, :string},
2807 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2811 type: {:list, :string},
2814 "X-RateLimit-Reset",
2815 "X-RateLimit-Limit",
2816 "X-RateLimit-Remaining",
2827 type: {:list, :string},
2828 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2834 key: Pleroma.Web.Plugs.RemoteIp,
2837 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2838 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2844 description: "Enable/disable the plug. Default: disabled."
2848 type: {:list, :string},
2850 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2855 type: {:list, :string},
2857 "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."
2861 type: {:list, :string},
2863 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"]`
2870 key: :web_cache_ttl,
2871 label: "Web cache TTL",
2874 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2880 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2884 key: :activity_pub_question,
2886 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2887 suggestions: [30_000]
2897 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2902 description: "Enables the rendering of static HTML. Default: disabled."
2910 description: "Configure feed rendering",
2915 description: "Configure title rendering",
2920 description: "Maximum number of characters before truncating title",
2926 description: "Replacement which will be used after truncating string",
2927 suggestions: ["..."]
2935 key: :mrf_follow_bot,
2937 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2938 label: "MRF FollowBot Policy",
2940 description: "Automatically follows newly discovered accounts.",
2943 key: :follower_nickname,
2945 description: "The name of the bot account to use for following newly discovered users.",
2946 suggestions: ["followbot"]
2954 description: "Custom Runtime Modules",
2959 description: "A path to custom Elixir modules (such as MRF policies)."
2967 description: "Settings for notifications streamer",
2972 description: "Number of workers to send notifications",
2976 key: :overflow_workers,
2978 description: "Maximum number of workers created if pool is empty",
2985 key: :connections_pool,
2987 description: "Advanced settings for `Gun` connections pool",
2990 key: :connection_acquisition_wait,
2993 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2997 key: :connection_acquisition_retries,
3000 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3004 key: :max_connections,
3006 description: "Maximum number of connections in the pool. Default: 250 connections.",
3010 key: :connect_timeout,
3012 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3016 key: :reclaim_multiplier,
3019 "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",
3028 description: "Advanced settings for `Gun` workers pools",
3030 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3034 description: "Settings for #{pool_name} pool.",
3039 description: "Maximum number of concurrent requests in the pool.",
3046 "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",
3052 description: "Timeout for the pool while gun will wait for response",
3053 suggestions: [10_000]
3061 key: :hackney_pools,
3063 description: "Advanced settings for `Hackney` connections pools",
3068 description: "Settings for federation pool.",
3071 key: :max_connections,
3073 description: "Number workers in the pool.",
3079 description: "Timeout while `hackney` will wait for response.",
3080 suggestions: [150_000]
3087 description: "Settings for media pool.",
3090 key: :max_connections,
3092 description: "Number workers in the pool.",
3098 description: "Timeout while `hackney` will wait for response.",
3099 suggestions: [150_000]
3106 description: "Settings for upload pool.",
3109 key: :max_connections,
3111 description: "Number workers in the pool.",
3117 description: "Timeout while `hackney` will wait for response.",
3118 suggestions: [300_000]
3126 key: :restrict_unauthenticated,
3127 label: "Restrict Unauthenticated",
3130 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3135 description: "Settings for public and federated timelines.",
3140 description: "Disallow view public timeline."
3145 description: "Disallow view federated timeline."
3152 description: "Settings for user profiles.",
3157 description: "Disallow view local user profiles."
3162 description: "Disallow view remote user profiles."
3169 description: "Settings for statuses.",
3174 description: "Disallow view local statuses."
3179 description: "Disallow view remote statuses."
3187 key: Pleroma.Web.ApiSpec.CastAndValidate,
3194 "Enables strict input validation (useful in development, not recommended in production)"
3200 key: :instances_favicons,
3202 description: "Control favicons for instances",
3207 description: "Allow/disallow displaying and getting instances favicons"
3215 descriptions: "S3 service related settings",
3218 key: :access_key_id,
3220 description: "S3 access key ID",
3221 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3224 key: :secret_access_key,
3226 description: "Secret access key",
3227 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3232 description: "S3 host",
3233 suggestions: ["s3.eu-central-1.amazonaws.com"]
3238 description: "S3 region (for AWS)",
3239 suggestions: ["us-east-1"]
3247 description: "Installed frontends management",
3252 description: "Primary frontend, the one that is served for all pages by default",
3253 children: installed_frontend_options
3258 description: "Admin frontend",
3259 children: installed_frontend_options
3265 "A map containing available frontends and parameters for their installation.",
3266 children: frontend_options
3272 key: Pleroma.Web.Preload,
3274 description: "Preload-related settings",
3278 type: {:list, :module},
3279 description: "List of preload providers to enable",
3281 Pleroma.Web.Preload.Providers.Instance,
3282 Pleroma.Web.Preload.Providers.User,
3283 Pleroma.Web.Preload.Providers.Timelines,
3284 Pleroma.Web.Preload.Providers.StatusNet
3293 description: "Majic/libmagic configuration",
3298 description: "Number of majic workers to start.",
3305 key: Pleroma.User.Backup,
3307 description: "Account Backup",
3310 key: :purge_after_days,
3312 description: "Remove backup achives after N days",
3318 description: "Limit user to export not more often than once per N days",
3325 key: Pleroma.Web.Endpoint.MetricsExporter,
3327 description: "Prometheus app metrics endpoint configuration",
3332 description: "[Pleroma extension] Enables app metrics endpoint."
3336 label: "IP Whitelist",
3337 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3338 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3342 type: [:boolean, :tuple],
3343 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3344 suggestion: [false, {:basic, "myusername", "mypassword"}]
3349 description: "App metrics endpoint URI path.",
3350 suggestions: ["/api/pleroma/app_metrics"]
3355 description: "App metrics endpoint output format.",
3356 suggestions: [:text, :protobuf]
3362 key: ConcurrentLimiter,
3364 description: "Limits configuration for background tasks.",
3367 key: Pleroma.Web.RichMedia.Helpers,
3369 description: "Concurrent limits configuration for getting RichMedia for activities.",
3370 suggestions: [max_running: 5, max_waiting: 5],
3375 description: "Max running concurrently jobs.",
3381 description: "Max waiting jobs.",
3387 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3389 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3390 suggestions: [max_running: 5, max_waiting: 5],
3395 description: "Max running concurrently jobs.",
3401 description: "Max waiting jobs.",