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`."
102 description: "Base URL for the uploads, needed if you use CDN",
104 "https://cdn-host.com"
111 Proxy requests to the remote uploader.\n
112 Useful if media upload endpoint is not internet accessible.
116 key: :filename_display_max_length,
118 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
124 key: Pleroma.Uploaders.Local,
126 description: "Local uploader-related settings",
131 description: "Path where user's uploads will be saved",
140 key: Pleroma.Uploaders.S3,
142 description: "S3 uploader-related settings",
147 description: "S3 bucket",
153 key: :bucket_namespace,
155 description: "S3 bucket namespace",
156 suggestions: ["pleroma"]
159 key: :truncated_namespace,
162 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
163 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
166 key: :streaming_enabled,
169 "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."
175 key: Pleroma.Upload.Filter.Mogrify,
177 description: "Uploads mogrify filter settings",
181 type: [:string, {:list, :string}, {:list, :tuple}],
183 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
184 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
195 key: Pleroma.Upload.Filter.AnonymizeFilename,
197 description: "Filter replaces the filename of the upload",
203 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
204 " filename extension by using {extension}, for example custom-file-name.{extension}.",
206 "custom-file-name.{extension}"
213 key: Pleroma.Emails.Mailer,
215 description: "Mailer-related settings",
221 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
222 " or Swoosh.Adapters.Local for in-memory mailbox",
224 Swoosh.Adapters.SMTP,
225 Swoosh.Adapters.Sendgrid,
226 Swoosh.Adapters.Sendmail,
227 Swoosh.Adapters.Mandrill,
228 Swoosh.Adapters.Mailgun,
229 Swoosh.Adapters.Mailjet,
230 Swoosh.Adapters.Postmark,
231 Swoosh.Adapters.SparkPost,
232 Swoosh.Adapters.AmazonSES,
234 Swoosh.Adapters.SocketLabs,
235 Swoosh.Adapters.Gmail,
236 Swoosh.Adapters.Local
242 description: "Allow/disallow send emails"
245 group: {:subgroup, Swoosh.Adapters.SMTP},
248 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
249 suggestions: ["smtp.gmail.com"]
252 group: {:subgroup, Swoosh.Adapters.SMTP},
255 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
256 suggestions: ["pleroma"]
259 group: {:subgroup, Swoosh.Adapters.SMTP},
262 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
263 suggestions: ["password"]
266 group: {:subgroup, Swoosh.Adapters.SMTP},
270 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
273 group: {:subgroup, Swoosh.Adapters.SMTP},
277 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
278 suggestions: [:always, :never, :if_available]
281 group: {:subgroup, Swoosh.Adapters.SMTP},
284 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
285 suggestions: [:always, :never, :if_available]
288 group: {:subgroup, Swoosh.Adapters.SMTP},
291 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
302 group: {:subgroup, Swoosh.Adapters.SMTP},
304 label: "No MX lookups",
306 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
309 group: {:subgroup, Swoosh.Adapters.Sendgrid},
313 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
314 suggestions: ["my-api-key"]
317 group: {:subgroup, Swoosh.Adapters.Sendmail},
320 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
321 suggestions: ["/usr/bin/sendmail"]
324 group: {:subgroup, Swoosh.Adapters.Sendmail},
327 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
328 suggestions: ["-N delay,failure,success"]
331 group: {:subgroup, Swoosh.Adapters.Sendmail},
334 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
337 group: {:subgroup, Swoosh.Adapters.Mandrill},
341 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
342 suggestions: ["my-api-key"]
345 group: {:subgroup, Swoosh.Adapters.Mailgun},
349 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
350 suggestions: ["my-api-key"]
353 group: {:subgroup, Swoosh.Adapters.Mailgun},
356 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
357 suggestions: ["pleroma.com"]
360 group: {:subgroup, Swoosh.Adapters.Mailjet},
364 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
365 suggestions: ["my-api-key"]
368 group: {:subgroup, Swoosh.Adapters.Mailjet},
371 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
372 suggestions: ["my-secret-key"]
375 group: {:subgroup, Swoosh.Adapters.Postmark},
379 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
380 suggestions: ["my-api-key"]
383 group: {:subgroup, Swoosh.Adapters.SparkPost},
387 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
388 suggestions: ["my-api-key"]
391 group: {:subgroup, Swoosh.Adapters.SparkPost},
394 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
395 suggestions: ["https://api.sparkpost.com/api/v1"]
398 group: {:subgroup, Swoosh.Adapters.AmazonSES},
401 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
402 suggestions: ["us-east-1", "us-east-2"]
405 group: {:subgroup, Swoosh.Adapters.AmazonSES},
408 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
409 suggestions: ["aws-access-key"]
412 group: {:subgroup, Swoosh.Adapters.AmazonSES},
415 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
416 suggestions: ["aws-secret-key"]
419 group: {:subgroup, Swoosh.Adapters.Dyn},
423 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
424 suggestions: ["my-api-key"]
427 group: {:subgroup, Swoosh.Adapters.SocketLabs},
430 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
433 group: {:subgroup, Swoosh.Adapters.SocketLabs},
437 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
440 group: {:subgroup, Swoosh.Adapters.Gmail},
443 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
450 description: "`Swoosh.Adapters.Local` adapter specific settings",
453 group: {:subgroup, Swoosh.Adapters.Local},
456 description: "Run the preview server together as part of your app"
459 group: {:subgroup, Swoosh.Adapters.Local},
462 description: "The preview server port",
470 label: "URI Schemes",
472 description: "URI schemes related settings",
476 type: {:list, :string},
477 description: "List of the scheme part that is considered valid to be an URL",
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 label: "Admin Email Address",
516 description: "Email used to reach an Administrator/Moderator of the instance",
523 label: "Sender Email Address",
525 description: "Envelope FROM address for mail sent via Pleroma",
534 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
542 description: "Posts character limit (CW/Subject included in the counter)",
550 description: "Character limit of the instance chat messages",
558 description: "Hard character limit beyond which remote posts will be dropped",
566 description: "File size limit of uploads (except for avatar, background, banner)",
572 key: :avatar_upload_limit,
574 description: "File size limit of user's profile avatars",
580 key: :background_upload_limit,
582 description: "File size limit of user's profile backgrounds",
588 key: :banner_upload_limit,
590 description: "File size limit of user's profile banners",
598 description: "A map with poll limits for local polls",
602 max_option_chars: 200,
604 max_expiration: 31_536_000
611 description: "Maximum number of options",
615 key: :max_option_chars,
617 description: "Maximum number of characters per option",
621 key: :min_expiration,
623 description: "Minimum expiration time (in seconds)",
627 key: :max_expiration,
629 description: "Maximum expiration time (in seconds)",
635 key: :registrations_open,
638 "Enable registrations for anyone. Invitations require this setting to be disabled."
641 key: :invites_enabled,
644 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
647 key: :account_activation_required,
649 description: "Require users to confirm their emails before signing in"
652 key: :account_approval_required,
654 description: "Require users to be manually approved by an admin before signing in"
659 description: "Enable federation with other instances"
662 key: :federation_incoming_replies_max_depth,
663 label: "Fed. incoming replies max depth",
666 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
667 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
673 key: :federation_reachability_timeout_days,
674 label: "Fed. reachability timeout days",
677 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
685 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
691 "Makes the client API in authenticated mode-only except for user-profiles." <>
692 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
693 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
696 key: :quarantined_instances,
697 type: {:list, :string},
699 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
708 description: "Instance static directory",
714 key: :allowed_post_formats,
715 type: {:list, :string},
716 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
725 key: :extended_nickname_format,
728 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
729 " This will break federation with older software for theses nicknames."
732 key: :cleanup_attachments,
735 Enable to remove associated attachments when status is removed.
736 This will not affect duplicates and attachments without status.
737 Enabling this will increase load to database when deleting statuses on larger instances.
741 key: :max_pinned_statuses,
743 description: "The maximum number of pinned statuses. 0 will disable the feature.",
751 key: :autofollowed_nicknames,
752 type: {:list, :string},
754 "Set to nicknames of (local) users that every new user should automatically follow"
757 key: :autofollowing_nicknames,
758 type: {:list, :string},
760 "Set to nicknames of (local) users that automatically follows every newly registered user"
763 key: :attachment_links,
765 description: "Enable to automatically add attachment link text to statuses"
768 key: :max_report_comment_size,
770 description: "The maximum size of the report comment. Default: 1000.",
776 key: :safe_dm_mentions,
777 label: "Safe DM mentions",
780 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
781 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
787 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
790 key: :remote_post_retention_days,
793 "The default amount of days to retain remote posts when pruning the database",
799 key: :user_bio_length,
801 description: "A user bio maximum length. Default: 5000.",
807 key: :user_name_length,
809 description: "A user name maximum length. Default: 100.",
815 key: :skip_thread_containment,
817 description: "Skip filtering out broken threads. Default: enabled."
820 key: :limit_to_local_content,
821 type: {:dropdown, :atom},
823 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
831 key: :max_account_fields,
833 description: "The maximum number of custom fields in the user profile. Default: 10.",
839 key: :max_remote_account_fields,
842 "The maximum number of custom fields in the remote user profile. Default: 20.",
848 key: :account_field_name_length,
850 description: "An account field name maximum length. Default: 512.",
856 key: :account_field_value_length,
858 description: "An account field value maximum length. Default: 2048.",
864 key: :registration_reason_length,
866 description: "Maximum registration reason length. Default: 500.",
872 key: :external_user_synchronization,
874 description: "Enabling following/followers counters synchronization for external users"
877 key: :multi_factor_authentication,
879 description: "Multi-factor authentication settings",
882 totp: [digits: 6, period: 30],
883 backup_codes: [number: 5, length: 16]
889 label: "TOTP settings",
891 description: "TOTP settings",
892 suggestions: [digits: 6, period: 30],
899 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
906 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
913 description: "MFA backup codes settings",
914 suggestions: [number: 5, length: 16],
920 description: "Number of backup codes to generate."
927 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
934 key: :instance_thumbnail,
935 type: {:string, :image},
937 "The instance thumbnail can be any image that represents your instance and is used by some apps or services when they display information about your instance.",
938 suggestions: ["/instance/thumbnail.jpeg"]
941 key: :show_reactions,
943 description: "Let favourites and emoji reactions be viewed through the API."
946 key: :improved_hashtag_timeline,
949 "If `true`, hashtags will be fetched from `hashtags` table for hashtags timeline. When `false`, object-embedded hashtags will be used (slower). Is auto-set to `true` (unless overridden) when HashtagsTableMigrator completes."
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 and masto_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,
1193 hideFilteredStatuses: false,
1194 hideMutedPosts: false,
1195 hidePostStats: false,
1196 hideSitename: false,
1197 hideUserStats: false,
1198 loginMethod: "password",
1199 logo: "/static/logo.svg",
1202 minimalScopesMode: false,
1203 noAttachmentLinks: false,
1204 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1205 postContentType: "text/plain",
1206 redirectRootLogin: "/main/friends",
1207 redirectRootNoLogin: "/main/all",
1209 sidebarRight: false,
1210 showFeaturesPanel: true,
1211 showInstanceSpecificPanel: false,
1212 subjectLineBehavior: "email",
1213 theme: "pleroma-dark",
1214 webPushNotifications: false
1219 key: :alwaysShowSubjectInput,
1220 label: "Always show subject input",
1222 description: "When disabled, auto-hide the subject field if it's empty"
1226 type: {:string, :image},
1228 "URL of the background, unless viewing a user profile with a background that is set",
1229 suggestions: ["/images/city.jpg"]
1232 key: :collapseMessageWithSubject,
1233 label: "Collapse message with subject",
1236 "When a message has a subject (aka Content Warning), collapse it by default"
1240 label: "PleromaFE Chat",
1242 description: "Disables PleromaFE Chat component"
1248 description: "Enables green text on lines prefixed with the > character"
1251 key: :hideFilteredStatuses,
1252 label: "Hide Filtered Statuses",
1254 description: "Hides filtered statuses from timelines"
1257 key: :hideMutedPosts,
1258 label: "Hide Muted Posts",
1260 description: "Hides muted statuses from timelines"
1263 key: :hidePostStats,
1264 label: "Hide post stats",
1266 description: "Hide notices statistics (repeats, favorites, ...)"
1270 label: "Hide Sitename",
1272 description: "Hides instance name from PleromaFE banner"
1275 key: :hideUserStats,
1276 label: "Hide user stats",
1279 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1283 type: {:string, :image},
1284 description: "URL of the logo, defaults to Pleroma's logo",
1285 suggestions: ["/static/logo.svg"]
1289 label: "Logo margin",
1292 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1293 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1294 suggestions: [".1em"]
1301 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1302 "If you want a colorful logo you must disable logoMask."
1305 key: :minimalScopesMode,
1306 label: "Minimal scopes mode",
1309 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1310 "Also prevents replying to a DM with a public post from PleromaFE."
1313 key: :nsfwCensorImage,
1314 label: "NSFW Censor Image",
1315 type: {:string, :image},
1317 "URL of the image to use for hiding NSFW media attachments in the timeline",
1318 suggestions: ["/static/img/nsfw.74818f9.png"]
1321 key: :postContentType,
1322 label: "Post Content Type",
1323 type: {:dropdown, :atom},
1324 description: "Default post formatting option",
1325 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1328 key: :redirectRootNoLogin,
1329 label: "Redirect root no login",
1332 "Relative URL which indicates where to redirect when a user isn't logged in",
1333 suggestions: ["/main/all"]
1336 key: :redirectRootLogin,
1337 label: "Redirect root login",
1340 "Relative URL which indicates where to redirect when a user is logged in",
1341 suggestions: ["/main/friends"]
1345 label: "Scope copy",
1347 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1351 label: "Sidebar on Right",
1353 description: "Change alignment of sidebar and panels to the right"
1356 key: :showFeaturesPanel,
1357 label: "Show instance features panel",
1360 "Enables panel displaying functionality of the instance on the About page"
1363 key: :showInstanceSpecificPanel,
1364 label: "Show instance specific panel",
1366 description: "Whether to show the instance's custom panel"
1369 key: :subjectLineBehavior,
1370 label: "Subject line behavior",
1372 description: "Allows changing the default behaviour of subject lines in replies.
1373 `email`: copy and preprend re:, as in email,
1374 `masto`: copy verbatim, as in Mastodon,
1375 `noop`: don't copy the subject.",
1376 suggestions: ["email", "masto", "noop"]
1381 description: "Which theme to use. Available themes are defined in styles.json",
1382 suggestions: ["pleroma-dark"]
1390 description: "Settings for Masto FE",
1393 showInstanceSpecificPanel: true
1398 key: :showInstanceSpecificPanel,
1399 label: "Show instance specific panel",
1401 description: "Whenether to show the instance's specific panel"
1412 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1416 type: {:keyword, :map},
1418 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1421 url: "/images/pleroma-fox-tan-smol.png",
1422 mime_type: "image/png"
1424 pleroma_fox_tan_shy: %{
1425 url: "/images/pleroma-fox-tan-shy.png",
1426 mime_type: "image/png"
1431 key: :default_mascot,
1434 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1440 key: :default_user_avatar,
1441 type: {:string, :image},
1442 description: "URL of the default user avatar",
1443 suggestions: ["/images/avi.png"]
1452 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1456 type: {:list, :map},
1457 description: "Describe the icons of the app",
1460 src: "/static/logo.png"
1463 src: "/static/icon.png",
1467 src: "/static/icon.ico",
1468 sizes: "72x72 96x96 128x128 256x256"
1475 description: "Describe the theme color of the app",
1476 suggestions: ["#282c37", "mediumpurple"]
1479 key: :background_color,
1481 description: "Describe the background color of the app",
1482 suggestions: ["#191b22", "aliceblue"]
1490 description: "Media proxy",
1495 description: "Enables proxying of remote media via the instance's proxy"
1502 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1503 suggestions: ["https://example.com"]
1511 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1517 description: "Enables media cache object invalidation."
1522 description: "Module which will be used to purge objects from the cache.",
1524 Pleroma.Web.MediaProxy.Invalidation.Script,
1525 Pleroma.Web.MediaProxy.Invalidation.Http
1532 label: "Advanced MediaProxy Options",
1534 description: "Internal Pleroma.ReverseProxy settings",
1536 redirect_on_failure: false,
1537 max_body_length: 25 * 1_048_576,
1538 max_read_duration: 30_000
1542 key: :redirect_on_failure,
1545 Redirects the client to the origin server upon encountering HTTP errors.\n
1546 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1547 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1548 IP addresses of your users to the other servers, bypassing the MediaProxy.
1552 key: :max_body_length,
1554 description: "Maximum file size allowed through the Pleroma MediaProxy cache."
1557 key: :max_read_duration,
1559 description: "Timeout (in milliseconds) of GET request to the remote URI."
1565 type: {:list, :string},
1566 description: "List of hosts with scheme to bypass the MediaProxy",
1567 suggestions: ["http://example.com"]
1573 key: :media_preview_proxy,
1575 description: "Media preview proxy",
1581 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1584 key: :thumbnail_max_width,
1587 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1590 key: :thumbnail_max_height,
1593 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1596 key: :image_quality,
1598 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1601 key: :min_content_length,
1604 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1610 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1612 description: "HTTP invalidate settings",
1617 description: "HTTP method of request. Default: :purge"
1621 type: {:keyword, :string},
1622 description: "HTTP headers of request",
1623 suggestions: [{"x-refresh", 1}]
1628 description: "Request options",
1632 type: {:map, :string}
1640 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1642 description: "Invalidation script settings",
1647 description: "Path to executable script which will purge cached items.",
1648 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1654 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1655 suggestions: [":htcacheclean"]
1663 description: "Gopher settings",
1668 description: "Enables the gopher interface"
1674 description: "IP address to bind to",
1675 suggestions: [{0, 0, 0, 0}]
1680 description: "Port to bind to",
1686 description: "Port advertised in URLs (optional, defaults to port)",
1694 label: "ActivityPub",
1696 description: "ActivityPub-related settings",
1699 key: :unfollow_blocked,
1701 description: "Whether blocks result in people getting unfollowed"
1704 key: :outgoing_blocks,
1706 description: "Whether to federate blocks to other instances"
1709 key: :sign_object_fetches,
1711 description: "Sign object fetches with HTTP signatures"
1714 key: :note_replies_output_limit,
1717 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1720 key: :follow_handshake_timeout,
1722 description: "Following handshake timeout",
1729 key: :http_security,
1730 label: "HTTP security",
1732 description: "HTTP security settings",
1737 description: "Whether the managed content security policy is enabled"
1743 description: "Whether to additionally send a Strict-Transport-Security header"
1747 label: "STS max age",
1749 description: "The maximum age for the Strict-Transport-Security header if sent",
1750 suggestions: [31_536_000]
1754 label: "CT max age",
1756 description: "The maximum age for the Expect-CT header if sent",
1757 suggestions: [2_592_000]
1760 key: :referrer_policy,
1762 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1763 suggestions: ["same-origin", "no-referrer"]
1767 label: "Report URI",
1769 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1770 suggestions: ["https://example.com/report-uri"]
1775 group: :web_push_encryption,
1776 key: :vapid_details,
1777 label: "Vapid Details",
1780 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1786 "A mailto link for the administrative contact." <>
1787 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1788 suggestions: ["mailto:moderators@pleroma.com"]
1793 description: "VAPID public key",
1794 suggestions: ["Public key"]
1799 description: "VAPID private key",
1800 suggestions: ["Private key"]
1806 key: Pleroma.Captcha,
1808 description: "Captcha-related settings",
1813 description: "Whether the captcha should be shown on registration"
1818 description: "The method/service to use for captcha",
1819 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1822 key: :seconds_valid,
1824 description: "The time in seconds for which the captcha is valid",
1831 key: Pleroma.Captcha.Kocaptcha,
1834 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1835 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1840 description: "The kocaptcha endpoint to use",
1841 suggestions: ["https://captcha.kotobank.ch"]
1847 label: "Pleroma Admin Token",
1850 "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)",
1855 description: "Admin token",
1857 "Please use a high entropy string or UUID"
1867 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1871 type: {:dropdown, :atom},
1872 description: "Logs verbose mode",
1873 suggestions: [false, :error, :warn, :info, :debug]
1877 type: {:keyword, :integer},
1879 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1881 activity_expiration: 10,
1882 attachments_cleanup: 5,
1884 federator_incoming: 50,
1885 federator_outgoing: 50,
1887 scheduled_activities: 10,
1893 key: :activity_expiration,
1895 description: "Activity expiration queue",
1901 description: "Backup queue",
1905 key: :attachments_cleanup,
1907 description: "Attachment deletion queue",
1913 description: "Background queue",
1917 key: :federator_incoming,
1919 description: "Incoming federation queue",
1923 key: :federator_outgoing,
1925 description: "Outgoing federation queue",
1931 description: "Email sender queue, see Pleroma.Emails.Mailer",
1935 key: :scheduled_activities,
1937 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1941 key: :transmogrifier,
1943 description: "Transmogrifier queue",
1949 description: "Web push notifications queue",
1956 type: {:list, :tuple},
1957 description: "Settings for cron background jobs",
1959 {"0 1 * * *", Pleroma.Workers.Cron.HashtagsCleanupWorker},
1960 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1961 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1970 description: "Includes custom worker options not interpretable directly by `Oban`",
1974 type: {:keyword, :integer},
1975 description: "Max retry attempts for failed jobs, per `Oban` queue",
1977 federator_incoming: 5,
1978 federator_outgoing: 5
1985 key: Pleroma.Web.Metadata,
1987 description: "Metadata-related settings",
1991 type: {:list, :module},
1992 description: "List of metadata providers to enable",
1994 Pleroma.Web.Metadata.Providers.OpenGraph,
1995 Pleroma.Web.Metadata.Providers.TwitterCard,
1996 Pleroma.Web.Metadata.Providers.RelMe,
1997 Pleroma.Web.Metadata.Providers.Feed
2002 label: "Unfurl NSFW",
2004 description: "When enabled NSFW attachments will be shown in previews"
2013 "If enabled the instance will parse metadata from attached links to generate link previews",
2018 description: "Enables RichMedia parsing of URLs"
2022 type: {:list, :string},
2023 description: "List of hosts which will be ignored by the metadata parser",
2024 suggestions: ["accounts.google.com", "xss.website"]
2028 label: "Ignore TLD",
2029 type: {:list, :string},
2030 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2031 suggestions: ["local", "localdomain", "lan"]
2035 type: {:list, :module},
2037 "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.",
2039 Pleroma.Web.RichMedia.Parsers.OEmbed,
2040 Pleroma.Web.RichMedia.Parsers.TwitterCard
2045 label: "TTL setters",
2046 type: {:list, :module},
2048 "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.",
2050 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2054 key: :failure_backoff,
2057 "Amount of milliseconds after request failure, during which the request will not be retried.",
2058 suggestions: [60_000]
2064 key: Pleroma.Formatter,
2068 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2072 type: [:string, :boolean],
2073 description: "Specify the class to be added to the generated link. Disable to clear.",
2074 suggestions: ["auto-linker", false]
2078 type: [:string, :boolean],
2079 description: "Override the rel attribute. Disable to clear.",
2080 suggestions: ["ugc", "noopener noreferrer", false]
2085 description: "Link URLs will open in a new window/tab."
2089 type: [:integer, :boolean],
2091 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2092 suggestions: [15, false]
2097 description: "Strip the scheme prefix."
2102 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2106 type: [:atom, :boolean],
2108 "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)",
2109 suggestions: [:no_scheme, true]
2115 key: Pleroma.ScheduledActivity,
2117 description: "Scheduled activities settings",
2120 key: :daily_user_limit,
2123 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2127 key: :total_user_limit,
2130 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2136 description: "Whether scheduled activities are sent to the job queue to be executed"
2142 key: Pleroma.Workers.PurgeExpiredActivity,
2144 description: "Expired activities settings",
2149 description: "Enables expired activities addition & deletion"
2154 description: "Minimum lifetime for ephemeral activity (in seconds)",
2161 label: "Pleroma Authenticator",
2163 description: "Authenticator",
2166 key: Pleroma.Web.Auth.Authenticator,
2168 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2178 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2179 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2180 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2181 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2186 description: "Enables LDAP authentication"
2191 description: "LDAP server hostname",
2192 suggestions: ["localhosts"]
2197 description: "LDAP port, e.g. 389 or 636",
2198 suggestions: [389, 636]
2204 description: "Enable to use SSL, usually implies the port 636"
2208 label: "SSL options",
2210 description: "Additional SSL options",
2211 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2216 description: "Path to file with PEM encoded cacerts",
2217 suggestions: ["path/to/file/with/PEM/cacerts"]
2222 description: "Type of cert verification",
2223 suggestions: [:verify_peer]
2231 description: "Enable to use STARTTLS, usually implies the port 389"
2235 label: "TLS options",
2237 description: "Additional TLS options",
2238 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2243 description: "Path to file with PEM encoded cacerts",
2244 suggestions: ["path/to/file/with/PEM/cacerts"]
2249 description: "Type of cert verification",
2250 suggestions: [:verify_peer]
2257 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2258 suggestions: ["dc=example,dc=com"]
2265 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2274 description: "Authentication / authorization settings",
2277 key: :enforce_oauth_admin_scope_usage,
2278 label: "Enforce OAuth admin scope usage",
2281 "OAuth admin scope requirement toggle. " <>
2282 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2283 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2284 "`is_admin` user flag grants access to admin-specific actions."
2287 key: :auth_template,
2290 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2291 suggestions: ["show.html"]
2294 key: :oauth_consumer_template,
2295 label: "OAuth consumer template",
2298 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2299 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2300 suggestions: ["consumer.html"]
2303 key: :oauth_consumer_strategies,
2304 label: "OAuth consumer strategies",
2305 type: {:list, :string},
2307 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2308 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2309 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2310 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2316 key: :email_notifications,
2318 description: "Email notifications settings",
2324 "emails of \"what you've missed\" for users who have been inactive for a while",
2328 schedule: "0 0 * * 0",
2330 inactivity_threshold: 7
2338 description: "Globally enable or disable digest emails"
2344 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2345 suggestions: ["0 0 * * 0"]
2350 description: "Minimum interval between digest emails to one user",
2354 key: :inactivity_threshold,
2356 description: "Minimum user inactivity threshold",
2365 key: Pleroma.Emails.UserEmail,
2367 description: "Email template settings",
2371 type: {:string, :image},
2372 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2373 suggestions: ["some/path/logo.png"]
2378 description: "A map with color settings for email templates.",
2381 link_color: "#d8a070",
2382 background_color: "#2C3645",
2383 content_background_color: "#1B2635",
2384 header_color: "#d8a070",
2385 text_color: "#b9b9ba",
2386 text_muted_color: "#b9b9ba"
2393 suggestions: ["#d8a070"]
2396 key: :background_color,
2398 suggestions: ["#2C3645"]
2401 key: :content_background_color,
2403 suggestions: ["#1B2635"]
2408 suggestions: ["#d8a070"]
2413 suggestions: ["#b9b9ba"]
2416 key: :text_muted_color,
2418 suggestions: ["#b9b9ba"]
2426 key: Pleroma.Emails.NewUsersDigestEmail,
2428 description: "New users admin email digest",
2433 description: "Enables new users admin digest email when `true`"
2442 description: "Configure OAuth 2 provider capabilities",
2445 key: :token_expires_in,
2447 description: "The lifetime in seconds of the access token",
2448 suggestions: [2_592_000]
2451 key: :issue_new_refresh_token,
2454 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2457 key: :clean_expired_tokens,
2459 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2469 key: :shortcode_globs,
2470 type: {:list, :string},
2471 description: "Location of custom emoji files. * can be used as a wildcard.",
2472 suggestions: ["/emoji/custom/**/*.png"]
2475 key: :pack_extensions,
2476 type: {:list, :string},
2478 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2479 suggestions: [".png", ".gif"]
2483 type: {:keyword, {:list, :string}},
2485 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2486 " and the value is the location or array of locations. * can be used as a wildcard.",
2488 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2492 key: :default_manifest,
2495 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2496 " Currently only one manifest can be added (no arrays).",
2497 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2500 key: :shared_pack_cache_seconds_per_file,
2501 label: "Shared pack cache s/file",
2504 "When an emoji pack is shared, the archive is created and cached in memory" <>
2505 " for this amount of seconds multiplied by the number of files.",
2515 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2519 type: [:tuple, {:list, :tuple}],
2520 description: "For the search requests (account & status search etc.)",
2521 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2525 type: [:tuple, {:list, :tuple}],
2526 description: "For requests to timelines (each timeline has it's own limiter)",
2527 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2530 key: :app_account_creation,
2531 type: [:tuple, {:list, :tuple}],
2532 description: "For registering user accounts from the same IP address",
2533 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2536 key: :relations_actions,
2537 type: [:tuple, {:list, :tuple}],
2538 description: "For actions on relationships with all users (follow, unfollow)",
2539 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2542 key: :relation_id_action,
2543 label: "Relation ID action",
2544 type: [:tuple, {:list, :tuple}],
2545 description: "For actions on relation with a specific user (follow, unfollow)",
2546 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2549 key: :statuses_actions,
2550 type: [:tuple, {:list, :tuple}],
2552 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2553 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2556 key: :status_id_action,
2557 label: "Status ID action",
2558 type: [:tuple, {:list, :tuple}],
2560 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2561 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2564 key: :authentication,
2565 type: [:tuple, {:list, :tuple}],
2566 description: "For authentication create / password check / user existence check requests",
2567 suggestions: [{60_000, 15}]
2576 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2577 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2582 description: "Enables SSH"
2587 description: "Dir with SSH keys",
2588 suggestions: ["/some/path/ssh_keys"]
2593 description: "Handler module",
2594 suggestions: ["Pleroma.BBS.Handler"]
2599 description: "Port to connect",
2600 suggestions: [10_022]
2603 key: :password_authenticator,
2605 description: "Authenticator module",
2606 suggestions: ["Pleroma.BBS.Authenticator"]
2612 label: "Mime Types",
2614 description: "Mime Types settings",
2621 "application/xml" => ["xml"],
2622 "application/xrd+xml" => ["xrd+xml"],
2623 "application/jrd+json" => ["jrd+json"],
2624 "application/activity+json" => ["activity+json"],
2625 "application/ld+json" => ["activity+json"]
2630 key: "application/xml",
2631 type: {:list, :string},
2632 suggestions: ["xml"]
2635 key: "application/xrd+xml",
2636 type: {:list, :string},
2637 suggestions: ["xrd+xml"]
2640 key: "application/jrd+json",
2641 type: {:list, :string},
2642 suggestions: ["jrd+json"]
2645 key: "application/activity+json",
2646 type: {:list, :string},
2647 suggestions: ["activity+json"]
2650 key: "application/ld+json",
2651 type: {:list, :string},
2652 suggestions: ["activity+json"]
2662 description: "Pleroma chat settings",
2675 description: "HTTP settings",
2680 type: [:string, :tuple],
2681 description: "Proxy URL",
2682 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2685 key: :send_user_agent,
2690 type: [:string, :atom],
2692 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2693 suggestions: ["Pleroma", :default]
2698 description: "Adapter specific options",
2704 label: "SSL Options",
2705 description: "SSL options for HTTP adapter",
2709 type: {:list, :atom},
2710 description: "List of TLS version to use",
2711 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2722 label: "Markup Settings",
2726 key: :allow_inline_images,
2730 key: :allow_headings,
2743 type: {:list, :module},
2745 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2746 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2756 key: :deny_follow_blocked,
2767 key: :restricted_nicknames,
2768 type: {:list, :string},
2769 description: "List of nicknames users may not register with.",
2788 "ostatus_subscribe",
2804 key: :email_blacklist,
2805 type: {:list, :string},
2806 description: "List of email domains users may not register with.",
2807 suggestions: ["mailinator.com", "maildrop.cc"]
2813 label: "CORS plug config",
2819 suggestions: [86_400]
2823 type: {:list, :string},
2824 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2828 type: {:list, :string},
2831 "X-RateLimit-Reset",
2832 "X-RateLimit-Limit",
2833 "X-RateLimit-Remaining",
2844 type: {:list, :string},
2845 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2851 key: Pleroma.Web.Plugs.RemoteIp,
2854 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2855 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2861 description: "Enable/disable the plug. Default: disabled."
2865 type: {:list, :string},
2867 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2872 type: {:list, :string},
2874 "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."
2878 type: {:list, :string},
2880 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"]`
2887 key: :web_cache_ttl,
2888 label: "Web cache TTL",
2891 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2897 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2898 suggestions: [30_000, nil]
2901 key: :activity_pub_question,
2903 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2904 suggestions: [30_000]
2914 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2919 description: "Enables the rendering of static HTML. Default: disabled."
2927 description: "Configure feed rendering",
2932 description: "Configure title rendering",
2937 description: "Maximum number of characters before truncating title",
2943 description: "Replacement which will be used after truncating string",
2944 suggestions: ["..."]
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 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3338 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to 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.",