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."
946 key: :privileged_staff,
949 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses and chats)"
957 description: "Welcome messages settings",
960 key: :direct_message,
962 descpiption: "Direct message settings",
967 description: "Enables sending a direct message to newly registered users"
972 description: "A message that will be sent to newly registered users",
974 "Hi, @username! Welcome on board!"
978 key: :sender_nickname,
980 description: "The nickname of the local user that sends a welcome message",
990 descpiption: "Chat message settings",
995 description: "Enables sending a chat message to newly registered users"
1001 "A message that will be sent to newly registered users as a chat message",
1003 "Hello, welcome on board!"
1007 key: :sender_nickname,
1009 description: "The nickname of the local user that sends a welcome chat message",
1019 descpiption: "Email message settings",
1024 description: "Enables sending an email to newly registered users"
1028 type: [:string, :tuple],
1030 "Email address and/or nickname that will be used to send the welcome email.",
1032 {"Pleroma App", "welcome@pleroma.app"}
1039 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1040 suggestions: ["Welcome to <%= instance_name%>"]
1046 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1047 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1053 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1054 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1063 description: "Logger-related settings",
1067 type: [:atom, :tuple, :module],
1069 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1070 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1078 label: "ExSyslogger",
1079 description: "ExSyslogger-related settings",
1083 type: {:dropdown, :atom},
1084 description: "Log level",
1085 suggestions: [:debug, :info, :warn, :error]
1091 "A string that's prepended to every message, and is typically set to the app name",
1092 suggestions: ["pleroma"]
1097 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1098 suggestions: ["$metadata[$level] $message"]
1102 type: {:list, :atom},
1103 suggestions: [:request_id]
1111 label: "Console Logger",
1112 description: "Console logger settings",
1116 type: {:dropdown, :atom},
1117 description: "Log level",
1118 suggestions: [:debug, :info, :warn, :error]
1123 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1124 suggestions: ["$metadata[$level] $message"]
1128 type: {:list, :atom},
1129 suggestions: [:request_id]
1136 label: "Quack Logger",
1137 description: "Quack-related settings",
1141 type: {:dropdown, :atom},
1142 description: "Log level",
1143 suggestions: [:debug, :info, :warn, :error]
1147 type: {:list, :atom},
1148 description: "Configure which metadata you want to report on",
1165 label: "Webhook URL",
1167 description: "Configure the Slack incoming webhook",
1168 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1174 key: :frontend_configurations,
1177 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1178 "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
1179 "add your own configuration your settings all fields must be complete.",
1183 label: "Pleroma FE",
1185 description: "Settings for Pleroma FE",
1188 alwaysShowSubjectInput: true,
1189 background: "/static/aurora_borealis.jpg",
1190 collapseMessageWithSubject: false,
1192 hideFilteredStatuses: false,
1193 hideMutedPosts: false,
1194 hidePostStats: false,
1195 hideSitename: false,
1196 hideUserStats: false,
1197 loginMethod: "password",
1198 logo: "/static/logo.svg",
1201 minimalScopesMode: false,
1202 noAttachmentLinks: false,
1203 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1204 postContentType: "text/plain",
1205 redirectRootLogin: "/main/friends",
1206 redirectRootNoLogin: "/main/all",
1208 sidebarRight: false,
1209 showFeaturesPanel: true,
1210 showInstanceSpecificPanel: false,
1211 subjectLineBehavior: "email",
1212 theme: "pleroma-dark",
1213 webPushNotifications: false
1218 key: :alwaysShowSubjectInput,
1219 label: "Always show subject input",
1221 description: "When disabled, auto-hide the subject field if it's empty"
1225 type: {:string, :image},
1227 "URL of the background, unless viewing a user profile with a background that is set",
1228 suggestions: ["/images/city.jpg"]
1231 key: :collapseMessageWithSubject,
1232 label: "Collapse message with subject",
1235 "When a message has a subject (aka Content Warning), collapse it by default"
1241 description: "Enables green text on lines prefixed with the > character"
1244 key: :hideFilteredStatuses,
1245 label: "Hide Filtered Statuses",
1247 description: "Hides filtered statuses from timelines"
1250 key: :hideMutedPosts,
1251 label: "Hide Muted Posts",
1253 description: "Hides muted statuses from timelines"
1256 key: :hidePostStats,
1257 label: "Hide post stats",
1259 description: "Hide notices statistics (repeats, favorites, ...)"
1263 label: "Hide Sitename",
1265 description: "Hides instance name from PleromaFE banner"
1268 key: :hideUserStats,
1269 label: "Hide user stats",
1272 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1276 type: {:string, :image},
1277 description: "URL of the logo, defaults to Pleroma's logo",
1278 suggestions: ["/static/logo.svg"]
1282 label: "Logo margin",
1285 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1286 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1287 suggestions: [".1em"]
1294 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1295 "If you want a colorful logo you must disable logoMask."
1298 key: :minimalScopesMode,
1299 label: "Minimal scopes mode",
1302 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1303 "Also prevents replying to a DM with a public post from PleromaFE."
1306 key: :nsfwCensorImage,
1307 label: "NSFW Censor Image",
1308 type: {:string, :image},
1310 "URL of the image to use for hiding NSFW media attachments in the timeline",
1311 suggestions: ["/static/img/nsfw.74818f9.png"]
1314 key: :postContentType,
1315 label: "Post Content Type",
1316 type: {:dropdown, :atom},
1317 description: "Default post formatting option",
1318 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1321 key: :redirectRootNoLogin,
1322 label: "Redirect root no login",
1325 "Relative URL which indicates where to redirect when a user isn't logged in",
1326 suggestions: ["/main/all"]
1329 key: :redirectRootLogin,
1330 label: "Redirect root login",
1333 "Relative URL which indicates where to redirect when a user is logged in",
1334 suggestions: ["/main/friends"]
1338 label: "Scope copy",
1340 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1344 label: "Sidebar on Right",
1346 description: "Change alignment of sidebar and panels to the right"
1349 key: :showFeaturesPanel,
1350 label: "Show instance features panel",
1353 "Enables panel displaying functionality of the instance on the About page"
1356 key: :showInstanceSpecificPanel,
1357 label: "Show instance specific panel",
1359 description: "Whether to show the instance's custom panel"
1362 key: :subjectLineBehavior,
1363 label: "Subject line behavior",
1365 description: "Allows changing the default behaviour of subject lines in replies.
1366 `email`: copy and preprend re:, as in email,
1367 `masto`: copy verbatim, as in Mastodon,
1368 `noop`: don't copy the subject.",
1369 suggestions: ["email", "masto", "noop"]
1374 description: "Which theme to use. Available themes are defined in styles.json",
1375 suggestions: ["pleroma-dark"]
1386 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1390 type: {:keyword, :map},
1392 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1395 url: "/images/pleroma-fox-tan-smol.png",
1396 mime_type: "image/png"
1398 pleroma_fox_tan_shy: %{
1399 url: "/images/pleroma-fox-tan-shy.png",
1400 mime_type: "image/png"
1405 key: :default_mascot,
1408 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1414 key: :default_user_avatar,
1415 type: {:string, :image},
1416 description: "URL of the default user avatar",
1417 suggestions: ["/images/avi.png"]
1426 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1430 type: {:list, :map},
1431 description: "Describe the icons of the app",
1434 src: "/static/logo.png"
1437 src: "/static/icon.png",
1441 src: "/static/icon.ico",
1442 sizes: "72x72 96x96 128x128 256x256"
1449 description: "Describe the theme color of the app",
1450 suggestions: ["#282c37", "mediumpurple"]
1453 key: :background_color,
1455 description: "Describe the background color of the app",
1456 suggestions: ["#191b22", "aliceblue"]
1464 description: "Media proxy",
1469 description: "Enables proxying of remote media via the instance's proxy"
1476 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1477 suggestions: ["https://example.com"]
1485 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1491 description: "Enables media cache object invalidation."
1496 description: "Module which will be used to purge objects from the cache.",
1498 Pleroma.Web.MediaProxy.Invalidation.Script,
1499 Pleroma.Web.MediaProxy.Invalidation.Http
1506 label: "Advanced MediaProxy Options",
1508 description: "Internal Pleroma.ReverseProxy settings",
1510 redirect_on_failure: false,
1511 max_body_length: 25 * 1_048_576,
1512 max_read_duration: 30_000
1516 key: :redirect_on_failure,
1519 Redirects the client to the origin server upon encountering HTTP errors.\n
1520 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1521 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1522 IP addresses of your users to the other servers, bypassing the MediaProxy.
1526 key: :max_body_length,
1529 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1532 key: :max_read_duration,
1534 description: "Timeout (in milliseconds) of GET request to the remote URI."
1540 type: {:list, :string},
1541 description: "List of hosts with scheme to bypass the MediaProxy",
1542 suggestions: ["http://example.com"]
1548 key: :media_preview_proxy,
1550 description: "Media preview proxy",
1556 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1559 key: :thumbnail_max_width,
1562 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1565 key: :thumbnail_max_height,
1568 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1571 key: :image_quality,
1573 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1576 key: :min_content_length,
1579 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1585 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1587 description: "HTTP invalidate settings",
1592 description: "HTTP method of request. Default: :purge"
1596 type: {:keyword, :string},
1597 description: "HTTP headers of request",
1598 suggestions: [{"x-refresh", 1}]
1603 description: "Request options",
1607 type: {:map, :string}
1615 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1617 description: "Invalidation script settings",
1622 description: "Path to executable script which will purge cached items.",
1623 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1627 label: "URL Format",
1630 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1631 suggestions: [":htcacheclean"]
1639 description: "Gopher settings",
1644 description: "Enables the gopher interface"
1650 description: "IP address to bind to",
1651 suggestions: [{0, 0, 0, 0}]
1656 description: "Port to bind to",
1662 description: "Port advertised in URLs (optional, defaults to port)",
1670 label: "ActivityPub",
1672 description: "ActivityPub-related settings",
1675 key: :unfollow_blocked,
1677 description: "Whether blocks result in people getting unfollowed"
1680 key: :outgoing_blocks,
1682 description: "Whether to federate blocks to other instances"
1685 key: :blockers_visible,
1687 description: "Whether a user can see someone who has blocked them"
1690 key: :sign_object_fetches,
1692 description: "Sign object fetches with HTTP signatures"
1695 key: :note_replies_output_limit,
1698 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1701 key: :follow_handshake_timeout,
1703 description: "Following handshake timeout",
1710 key: :http_security,
1711 label: "HTTP security",
1713 description: "HTTP security settings",
1718 description: "Whether the managed content security policy is enabled"
1724 description: "Whether to additionally send a Strict-Transport-Security header"
1728 label: "STS max age",
1730 description: "The maximum age for the Strict-Transport-Security header if sent",
1731 suggestions: [31_536_000]
1735 label: "CT max age",
1737 description: "The maximum age for the Expect-CT header if sent",
1738 suggestions: [2_592_000]
1741 key: :referrer_policy,
1743 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1744 suggestions: ["same-origin", "no-referrer"]
1748 label: "Report URI",
1750 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1751 suggestions: ["https://example.com/report-uri"]
1756 group: :web_push_encryption,
1757 key: :vapid_details,
1758 label: "Vapid Details",
1761 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1767 "A mailto link for the administrative contact." <>
1768 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1769 suggestions: ["mailto:moderators@pleroma.com"]
1774 description: "VAPID public key",
1775 suggestions: ["Public key"]
1780 description: "VAPID private key",
1781 suggestions: ["Private key"]
1787 key: Pleroma.Captcha,
1789 description: "Captcha-related settings",
1794 description: "Whether the captcha should be shown on registration"
1799 description: "The method/service to use for captcha",
1800 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1803 key: :seconds_valid,
1805 description: "The time in seconds for which the captcha is valid",
1812 key: Pleroma.Captcha.Kocaptcha,
1815 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1816 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1821 description: "The kocaptcha endpoint to use",
1822 suggestions: ["https://captcha.kotobank.ch"]
1828 label: "Pleroma Admin Token",
1831 "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)",
1836 description: "Admin token",
1838 "Please use a high entropy string or UUID"
1848 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1852 type: {:dropdown, :atom},
1853 description: "Logs verbose mode",
1854 suggestions: [false, :error, :warn, :info, :debug]
1858 type: {:keyword, :integer},
1860 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1862 activity_expiration: 10,
1863 attachments_cleanup: 5,
1865 federator_incoming: 50,
1866 federator_outgoing: 50,
1868 scheduled_activities: 10,
1874 key: :activity_expiration,
1876 description: "Activity expiration queue",
1882 description: "Backup queue",
1886 key: :attachments_cleanup,
1888 description: "Attachment deletion queue",
1894 description: "Background queue",
1898 key: :federator_incoming,
1900 description: "Incoming federation queue",
1904 key: :federator_outgoing,
1906 description: "Outgoing federation queue",
1912 description: "Email sender queue, see Pleroma.Emails.Mailer",
1916 key: :scheduled_activities,
1918 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1922 key: :transmogrifier,
1924 description: "Transmogrifier queue",
1930 description: "Web push notifications queue",
1937 type: {:list, :tuple},
1938 description: "Settings for cron background jobs",
1940 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1941 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1950 description: "Includes custom worker options not interpretable directly by `Oban`",
1954 type: {:keyword, :integer},
1955 description: "Max retry attempts for failed jobs, per `Oban` queue",
1957 federator_incoming: 5,
1958 federator_outgoing: 5
1965 key: Pleroma.Web.Metadata,
1967 description: "Metadata-related settings",
1971 type: {:list, :module},
1972 description: "List of metadata providers to enable",
1974 Pleroma.Web.Metadata.Providers.OpenGraph,
1975 Pleroma.Web.Metadata.Providers.TwitterCard,
1976 Pleroma.Web.Metadata.Providers.RelMe,
1977 Pleroma.Web.Metadata.Providers.Feed
1982 label: "Unfurl NSFW",
1984 description: "When enabled NSFW attachments will be shown in previews"
1993 "If enabled the instance will parse metadata from attached links to generate link previews",
1998 description: "Enables RichMedia parsing of URLs"
2002 type: {:list, :string},
2003 description: "List of hosts which will be ignored by the metadata parser",
2004 suggestions: ["accounts.google.com", "xss.website"]
2008 label: "Ignore TLD",
2009 type: {:list, :string},
2010 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2011 suggestions: ["local", "localdomain", "lan"]
2015 type: {:list, :module},
2017 "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.",
2019 Pleroma.Web.RichMedia.Parsers.OEmbed,
2020 Pleroma.Web.RichMedia.Parsers.TwitterCard
2025 label: "TTL setters",
2026 type: {:list, :module},
2028 "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.",
2030 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2034 key: :failure_backoff,
2037 "Amount of milliseconds after request failure, during which the request will not be retried.",
2038 suggestions: [60_000]
2044 key: Pleroma.Formatter,
2048 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2052 type: [:string, :boolean],
2053 description: "Specify the class to be added to the generated link. Disable to clear.",
2054 suggestions: ["auto-linker", false]
2058 type: [:string, :boolean],
2059 description: "Override the rel attribute. Disable to clear.",
2060 suggestions: ["ugc", "noopener noreferrer", false]
2065 description: "Link URLs will open in a new window/tab."
2069 type: [:integer, :boolean],
2071 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2072 suggestions: [15, false]
2077 description: "Strip the scheme prefix."
2082 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2086 type: [:atom, :boolean],
2088 "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)",
2089 suggestions: [:no_scheme, true]
2095 key: Pleroma.ScheduledActivity,
2097 description: "Scheduled activities settings",
2100 key: :daily_user_limit,
2103 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2107 key: :total_user_limit,
2110 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2116 description: "Whether scheduled activities are sent to the job queue to be executed"
2122 key: Pleroma.Workers.PurgeExpiredActivity,
2124 description: "Expired activities settings",
2129 description: "Enables expired activities addition & deletion"
2134 description: "Minimum lifetime for ephemeral activity (in seconds)",
2141 label: "Pleroma Authenticator",
2143 description: "Authenticator",
2146 key: Pleroma.Web.Auth.Authenticator,
2148 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2158 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2159 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2160 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2161 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2166 description: "Enables LDAP authentication"
2171 description: "LDAP server hostname",
2172 suggestions: ["localhosts"]
2177 description: "LDAP port, e.g. 389 or 636",
2178 suggestions: [389, 636]
2184 description: "Enable to use SSL, usually implies the port 636"
2188 label: "SSL options",
2190 description: "Additional SSL options",
2191 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2196 description: "Path to file with PEM encoded cacerts",
2197 suggestions: ["path/to/file/with/PEM/cacerts"]
2202 description: "Type of cert verification",
2203 suggestions: [:verify_peer]
2211 description: "Enable to use STARTTLS, usually implies the port 389"
2215 label: "TLS options",
2217 description: "Additional TLS options",
2218 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2223 description: "Path to file with PEM encoded cacerts",
2224 suggestions: ["path/to/file/with/PEM/cacerts"]
2229 description: "Type of cert verification",
2230 suggestions: [:verify_peer]
2237 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2238 suggestions: ["dc=example,dc=com"]
2245 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2254 description: "Authentication / authorization settings",
2257 key: :enforce_oauth_admin_scope_usage,
2258 label: "Enforce OAuth admin scope usage",
2261 "OAuth admin scope requirement toggle. " <>
2262 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2263 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2264 "`is_admin` user flag grants access to admin-specific actions."
2267 key: :auth_template,
2270 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2271 suggestions: ["show.html"]
2274 key: :oauth_consumer_template,
2275 label: "OAuth consumer template",
2278 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2279 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2280 suggestions: ["consumer.html"]
2283 key: :oauth_consumer_strategies,
2284 label: "OAuth consumer strategies",
2285 type: {:list, :string},
2287 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2288 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2289 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2290 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2296 key: :email_notifications,
2298 description: "Email notifications settings",
2304 "emails of \"what you've missed\" for users who have been inactive for a while",
2308 schedule: "0 0 * * 0",
2310 inactivity_threshold: 7
2318 description: "Globally enable or disable digest emails"
2324 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2325 suggestions: ["0 0 * * 0"]
2330 description: "Minimum interval between digest emails to one user",
2334 key: :inactivity_threshold,
2336 description: "Minimum user inactivity threshold",
2345 key: Pleroma.Emails.UserEmail,
2347 description: "Email template settings",
2351 type: {:string, :image},
2352 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2353 suggestions: ["some/path/logo.png"]
2358 description: "A map with color settings for email templates.",
2361 link_color: "#d8a070",
2362 background_color: "#2C3645",
2363 content_background_color: "#1B2635",
2364 header_color: "#d8a070",
2365 text_color: "#b9b9ba",
2366 text_muted_color: "#b9b9ba"
2373 suggestions: ["#d8a070"]
2376 key: :background_color,
2378 suggestions: ["#2C3645"]
2381 key: :content_background_color,
2383 suggestions: ["#1B2635"]
2388 suggestions: ["#d8a070"]
2393 suggestions: ["#b9b9ba"]
2396 key: :text_muted_color,
2398 suggestions: ["#b9b9ba"]
2406 key: Pleroma.Emails.NewUsersDigestEmail,
2408 description: "New users admin email digest",
2413 description: "Enables new users admin digest email when `true`"
2422 description: "Configure OAuth 2 provider capabilities",
2425 key: :token_expires_in,
2427 description: "The lifetime in seconds of the access token",
2428 suggestions: [2_592_000]
2431 key: :issue_new_refresh_token,
2434 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2437 key: :clean_expired_tokens,
2439 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2449 key: :shortcode_globs,
2450 type: {:list, :string},
2451 description: "Location of custom emoji files. * can be used as a wildcard.",
2452 suggestions: ["/emoji/custom/**/*.png"]
2455 key: :pack_extensions,
2456 type: {:list, :string},
2458 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2459 suggestions: [".png", ".gif"]
2463 type: {:keyword, {:list, :string}},
2465 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2466 " and the value is the location or array of locations. * can be used as a wildcard.",
2468 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2472 key: :default_manifest,
2475 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2476 " Currently only one manifest can be added (no arrays).",
2477 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2480 key: :shared_pack_cache_seconds_per_file,
2481 label: "Shared pack cache s/file",
2484 "When an emoji pack is shared, the archive is created and cached in memory" <>
2485 " for this amount of seconds multiplied by the number of files.",
2495 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2499 type: [:tuple, {:list, :tuple}],
2500 description: "For the search requests (account & status search etc.)",
2501 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2505 type: [:tuple, {:list, :tuple}],
2506 description: "For requests to timelines (each timeline has it's own limiter)",
2507 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2510 key: :app_account_creation,
2511 type: [:tuple, {:list, :tuple}],
2512 description: "For registering user accounts from the same IP address",
2513 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2516 key: :relations_actions,
2517 type: [:tuple, {:list, :tuple}],
2518 description: "For actions on relationships with all users (follow, unfollow)",
2519 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2522 key: :relation_id_action,
2523 label: "Relation ID action",
2524 type: [:tuple, {:list, :tuple}],
2525 description: "For actions on relation with a specific user (follow, unfollow)",
2526 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2529 key: :statuses_actions,
2530 type: [:tuple, {:list, :tuple}],
2532 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2533 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2536 key: :status_id_action,
2537 label: "Status ID action",
2538 type: [:tuple, {:list, :tuple}],
2540 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2541 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2544 key: :authentication,
2545 type: [:tuple, {:list, :tuple}],
2546 description: "For authentication create / password check / user existence check requests",
2547 suggestions: [{60_000, 15}]
2556 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2557 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2562 description: "Enables SSH"
2567 description: "Dir with SSH keys",
2568 suggestions: ["/some/path/ssh_keys"]
2573 description: "Handler module",
2574 suggestions: ["Pleroma.BBS.Handler"]
2579 description: "Port to connect",
2580 suggestions: [10_022]
2583 key: :password_authenticator,
2585 description: "Authenticator module",
2586 suggestions: ["Pleroma.BBS.Authenticator"]
2592 label: "Mime Types",
2594 description: "Mime Types settings",
2601 "application/xml" => ["xml"],
2602 "application/xrd+xml" => ["xrd+xml"],
2603 "application/jrd+json" => ["jrd+json"],
2604 "application/activity+json" => ["activity+json"],
2605 "application/ld+json" => ["activity+json"]
2610 key: "application/xml",
2611 type: {:list, :string},
2612 suggestions: ["xml"]
2615 key: "application/xrd+xml",
2616 type: {:list, :string},
2617 suggestions: ["xrd+xml"]
2620 key: "application/jrd+json",
2621 type: {:list, :string},
2622 suggestions: ["jrd+json"]
2625 key: "application/activity+json",
2626 type: {:list, :string},
2627 suggestions: ["activity+json"]
2630 key: "application/ld+json",
2631 type: {:list, :string},
2632 suggestions: ["activity+json"]
2642 description: "Pleroma shout settings",
2647 description: "Enables the backend Shoutbox chat feature."
2652 description: "Shout message character limit.",
2664 description: "HTTP settings",
2669 type: [:string, :tuple],
2670 description: "Proxy URL",
2671 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2674 key: :send_user_agent,
2679 type: [:string, :atom],
2681 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2682 suggestions: ["Pleroma", :default]
2687 description: "Adapter specific options",
2693 label: "SSL Options",
2694 description: "SSL options for HTTP adapter",
2698 type: {:list, :atom},
2699 description: "List of TLS version to use",
2700 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2711 label: "Markup Settings",
2715 key: :allow_inline_images,
2719 key: :allow_headings,
2732 type: {:list, :module},
2734 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2735 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2745 key: :deny_follow_blocked,
2756 key: :restricted_nicknames,
2757 type: {:list, :string},
2758 description: "List of nicknames users may not register with.",
2777 "ostatus_subscribe",
2793 key: :email_blacklist,
2794 type: {:list, :string},
2795 description: "List of email domains users may not register with.",
2796 suggestions: ["mailinator.com", "maildrop.cc"]
2802 label: "CORS plug config",
2808 suggestions: [86_400]
2812 type: {:list, :string},
2813 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2817 type: {:list, :string},
2820 "X-RateLimit-Reset",
2821 "X-RateLimit-Limit",
2822 "X-RateLimit-Remaining",
2833 type: {:list, :string},
2834 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2840 key: Pleroma.Web.Plugs.RemoteIp,
2843 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2844 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2850 description: "Enable/disable the plug. Default: disabled."
2854 type: {:list, :string},
2856 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2861 type: {:list, :string},
2863 "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."
2867 type: {:list, :string},
2869 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"]`
2876 key: :web_cache_ttl,
2877 label: "Web cache TTL",
2880 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2886 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2890 key: :activity_pub_question,
2892 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2893 suggestions: [30_000]
2903 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2908 description: "Enables the rendering of static HTML. Default: disabled."
2916 description: "Configure feed rendering",
2921 description: "Configure title rendering",
2926 description: "Maximum number of characters before truncating title",
2932 description: "Replacement which will be used after truncating string",
2933 suggestions: ["..."]
2941 key: :mrf_follow_bot,
2943 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2944 label: "MRF FollowBot Policy",
2946 description: "Automatically follows newly discovered accounts.",
2949 key: :follower_nickname,
2951 description: "The name of the bot account to use for following newly discovered users.",
2952 suggestions: ["followbot"]
2960 description: "Custom Runtime Modules",
2965 description: "A path to custom Elixir modules (such as MRF policies)."
2973 description: "Settings for notifications streamer",
2978 description: "Number of workers to send notifications",
2982 key: :overflow_workers,
2984 description: "Maximum number of workers created if pool is empty",
2991 key: :connections_pool,
2993 description: "Advanced settings for `Gun` connections pool",
2996 key: :connection_acquisition_wait,
2999 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3003 key: :connection_acquisition_retries,
3006 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3010 key: :max_connections,
3012 description: "Maximum number of connections in the pool. Default: 250 connections.",
3016 key: :connect_timeout,
3018 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3022 key: :reclaim_multiplier,
3025 "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",
3034 description: "Advanced settings for `Gun` workers pools",
3036 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3040 description: "Settings for #{pool_name} pool.",
3045 description: "Maximum number of concurrent requests in the pool.",
3052 "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",
3058 description: "Timeout for the pool while gun will wait for response",
3059 suggestions: [10_000]
3067 key: :hackney_pools,
3069 description: "Advanced settings for `Hackney` connections pools",
3074 description: "Settings for federation pool.",
3077 key: :max_connections,
3079 description: "Number workers in the pool.",
3085 description: "Timeout while `hackney` will wait for response.",
3086 suggestions: [150_000]
3093 description: "Settings for media pool.",
3096 key: :max_connections,
3098 description: "Number workers in the pool.",
3104 description: "Timeout while `hackney` will wait for response.",
3105 suggestions: [150_000]
3112 description: "Settings for upload pool.",
3115 key: :max_connections,
3117 description: "Number workers in the pool.",
3123 description: "Timeout while `hackney` will wait for response.",
3124 suggestions: [300_000]
3132 key: :restrict_unauthenticated,
3133 label: "Restrict Unauthenticated",
3136 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3141 description: "Settings for public and federated timelines.",
3146 description: "Disallow view public timeline."
3151 description: "Disallow view federated timeline."
3158 description: "Settings for user profiles.",
3163 description: "Disallow view local user profiles."
3168 description: "Disallow view remote user profiles."
3175 description: "Settings for statuses.",
3180 description: "Disallow view local statuses."
3185 description: "Disallow view remote statuses."
3193 key: Pleroma.Web.ApiSpec.CastAndValidate,
3200 "Enables strict input validation (useful in development, not recommended in production)"
3206 key: :instances_favicons,
3208 description: "Control favicons for instances",
3213 description: "Allow/disallow displaying and getting instances favicons"
3221 descriptions: "S3 service related settings",
3224 key: :access_key_id,
3226 description: "S3 access key ID",
3227 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3230 key: :secret_access_key,
3232 description: "Secret access key",
3233 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3238 description: "S3 host",
3239 suggestions: ["s3.eu-central-1.amazonaws.com"]
3244 description: "S3 region (for AWS)",
3245 suggestions: ["us-east-1"]
3253 description: "Installed frontends management",
3258 description: "Primary frontend, the one that is served for all pages by default",
3259 children: installed_frontend_options
3264 description: "Admin frontend",
3265 children: installed_frontend_options
3271 "A map containing available frontends and parameters for their installation.",
3272 children: frontend_options
3278 key: Pleroma.Web.Preload,
3280 description: "Preload-related settings",
3284 type: {:list, :module},
3285 description: "List of preload providers to enable",
3287 Pleroma.Web.Preload.Providers.Instance,
3288 Pleroma.Web.Preload.Providers.User,
3289 Pleroma.Web.Preload.Providers.Timelines,
3290 Pleroma.Web.Preload.Providers.StatusNet
3299 description: "Majic/libmagic configuration",
3304 description: "Number of majic workers to start.",
3311 key: Pleroma.User.Backup,
3313 description: "Account Backup",
3316 key: :purge_after_days,
3318 description: "Remove backup achives after N days",
3324 description: "Limit user to export not more often than once per N days",
3331 key: Pleroma.Web.Endpoint.MetricsExporter,
3333 description: "Prometheus app metrics endpoint configuration",
3338 description: "[Pleroma extension] Enables app metrics endpoint."
3342 label: "IP Whitelist",
3343 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3344 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3348 type: [:boolean, :tuple],
3349 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3350 suggestion: [false, {:basic, "myusername", "mypassword"}]
3355 description: "App metrics endpoint URI path.",
3356 suggestions: ["/api/pleroma/app_metrics"]
3361 description: "App metrics endpoint output format.",
3362 suggestions: [:text, :protobuf]
3368 key: ConcurrentLimiter,
3370 description: "Limits configuration for background tasks.",
3373 key: Pleroma.Web.RichMedia.Helpers,
3375 description: "Concurrent limits configuration for getting RichMedia for activities.",
3376 suggestions: [max_running: 5, max_waiting: 5],
3381 description: "Max running concurrently jobs.",
3387 description: "Max waiting jobs.",
3393 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3395 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3396 suggestions: [max_running: 5, max_waiting: 5],
3401 description: "Max running concurrently jobs.",
3407 description: "Max waiting jobs.",