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: "Database-related settings",
505 key: :improved_hashtag_timeline,
508 "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."
516 description: "Instance-related settings",
521 description: "Name of the instance",
528 label: "Admin Email Address",
530 description: "Email used to reach an Administrator/Moderator of the instance",
537 label: "Sender Email Address",
539 description: "Envelope FROM address for mail sent via Pleroma",
548 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
556 description: "Posts character limit (CW/Subject included in the counter)",
564 description: "Character limit of the instance chat messages",
572 description: "Hard character limit beyond which remote posts will be dropped",
580 description: "File size limit of uploads (except for avatar, background, banner)",
586 key: :avatar_upload_limit,
588 description: "File size limit of user's profile avatars",
594 key: :background_upload_limit,
596 description: "File size limit of user's profile backgrounds",
602 key: :banner_upload_limit,
604 description: "File size limit of user's profile banners",
612 description: "A map with poll limits for local polls",
616 max_option_chars: 200,
618 max_expiration: 31_536_000
625 description: "Maximum number of options",
629 key: :max_option_chars,
631 description: "Maximum number of characters per option",
635 key: :min_expiration,
637 description: "Minimum expiration time (in seconds)",
641 key: :max_expiration,
643 description: "Maximum expiration time (in seconds)",
649 key: :registrations_open,
652 "Enable registrations for anyone. Invitations require this setting to be disabled."
655 key: :invites_enabled,
658 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
661 key: :account_activation_required,
663 description: "Require users to confirm their emails before signing in"
666 key: :account_approval_required,
668 description: "Require users to be manually approved by an admin before signing in"
673 description: "Enable federation with other instances"
676 key: :federation_incoming_replies_max_depth,
677 label: "Fed. incoming replies max depth",
680 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
681 " 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.",
687 key: :federation_reachability_timeout_days,
688 label: "Fed. reachability timeout days",
691 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
699 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
705 "Makes the client API in authenticated mode-only except for user-profiles." <>
706 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
707 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
710 key: :quarantined_instances,
711 type: {:list, :string},
713 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
722 description: "Instance static directory",
728 key: :allowed_post_formats,
729 type: {:list, :string},
730 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
739 key: :extended_nickname_format,
742 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
743 " This will break federation with older software for theses nicknames."
746 key: :cleanup_attachments,
749 Enable to remove associated attachments when status is removed.
750 This will not affect duplicates and attachments without status.
751 Enabling this will increase load to database when deleting statuses on larger instances.
755 key: :max_pinned_statuses,
757 description: "The maximum number of pinned statuses. 0 will disable the feature.",
765 key: :autofollowed_nicknames,
766 type: {:list, :string},
768 "Set to nicknames of (local) users that every new user should automatically follow"
771 key: :autofollowing_nicknames,
772 type: {:list, :string},
774 "Set to nicknames of (local) users that automatically follows every newly registered user"
777 key: :attachment_links,
779 description: "Enable to automatically add attachment link text to statuses"
782 key: :max_report_comment_size,
784 description: "The maximum size of the report comment. Default: 1000.",
790 key: :safe_dm_mentions,
791 label: "Safe DM mentions",
794 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
795 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
801 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
804 key: :remote_post_retention_days,
807 "The default amount of days to retain remote posts when pruning the database",
813 key: :user_bio_length,
815 description: "A user bio maximum length. Default: 5000.",
821 key: :user_name_length,
823 description: "A user name maximum length. Default: 100.",
829 key: :skip_thread_containment,
831 description: "Skip filtering out broken threads. Default: enabled."
834 key: :limit_to_local_content,
835 type: {:dropdown, :atom},
837 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
845 key: :max_account_fields,
847 description: "The maximum number of custom fields in the user profile. Default: 10.",
853 key: :max_remote_account_fields,
856 "The maximum number of custom fields in the remote user profile. Default: 20.",
862 key: :account_field_name_length,
864 description: "An account field name maximum length. Default: 512.",
870 key: :account_field_value_length,
872 description: "An account field value maximum length. Default: 2048.",
878 key: :registration_reason_length,
880 description: "Maximum registration reason length. Default: 500.",
886 key: :external_user_synchronization,
888 description: "Enabling following/followers counters synchronization for external users"
891 key: :multi_factor_authentication,
893 description: "Multi-factor authentication settings",
896 totp: [digits: 6, period: 30],
897 backup_codes: [number: 5, length: 16]
903 label: "TOTP settings",
905 description: "TOTP settings",
906 suggestions: [digits: 6, period: 30],
913 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
920 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
927 description: "MFA backup codes settings",
928 suggestions: [number: 5, length: 16],
934 description: "Number of backup codes to generate."
941 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
948 key: :instance_thumbnail,
949 type: {:string, :image},
951 "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.",
952 suggestions: ["/instance/thumbnail.jpeg"]
955 key: :show_reactions,
957 description: "Let favourites and emoji reactions be viewed through the API."
965 description: "Welcome messages settings",
968 key: :direct_message,
970 descpiption: "Direct message settings",
975 description: "Enables sending a direct message to newly registered users"
980 description: "A message that will be sent to newly registered users",
982 "Hi, @username! Welcome on board!"
986 key: :sender_nickname,
988 description: "The nickname of the local user that sends a welcome message",
998 descpiption: "Chat message settings",
1003 description: "Enables sending a chat message to newly registered users"
1009 "A message that will be sent to newly registered users as a chat message",
1011 "Hello, welcome on board!"
1015 key: :sender_nickname,
1017 description: "The nickname of the local user that sends a welcome chat message",
1027 descpiption: "Email message settings",
1032 description: "Enables sending an email to newly registered users"
1036 type: [:string, :tuple],
1038 "Email address and/or nickname that will be used to send the welcome email.",
1040 {"Pleroma App", "welcome@pleroma.app"}
1047 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1048 suggestions: ["Welcome to <%= instance_name%>"]
1054 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1055 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1061 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1062 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1071 description: "Logger-related settings",
1075 type: [:atom, :tuple, :module],
1077 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1078 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1086 label: "ExSyslogger",
1087 description: "ExSyslogger-related settings",
1091 type: {:dropdown, :atom},
1092 description: "Log level",
1093 suggestions: [:debug, :info, :warn, :error]
1099 "A string that's prepended to every message, and is typically set to the app name",
1100 suggestions: ["pleroma"]
1105 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1106 suggestions: ["$metadata[$level] $message"]
1110 type: {:list, :atom},
1111 suggestions: [:request_id]
1119 label: "Console Logger",
1120 description: "Console logger settings",
1124 type: {:dropdown, :atom},
1125 description: "Log level",
1126 suggestions: [:debug, :info, :warn, :error]
1131 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1132 suggestions: ["$metadata[$level] $message"]
1136 type: {:list, :atom},
1137 suggestions: [:request_id]
1144 label: "Quack Logger",
1145 description: "Quack-related settings",
1149 type: {:dropdown, :atom},
1150 description: "Log level",
1151 suggestions: [:debug, :info, :warn, :error]
1155 type: {:list, :atom},
1156 description: "Configure which metadata you want to report on",
1173 label: "Webhook URL",
1175 description: "Configure the Slack incoming webhook",
1176 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1182 key: :frontend_configurations,
1185 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1186 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1187 "add your own configuration your settings all fields must be complete.",
1191 label: "Pleroma FE",
1193 description: "Settings for Pleroma FE",
1196 alwaysShowSubjectInput: true,
1197 background: "/static/aurora_borealis.jpg",
1198 collapseMessageWithSubject: false,
1201 hideFilteredStatuses: false,
1202 hideMutedPosts: false,
1203 hidePostStats: false,
1204 hideSitename: false,
1205 hideUserStats: false,
1206 loginMethod: "password",
1207 logo: "/static/logo.svg",
1210 minimalScopesMode: false,
1211 noAttachmentLinks: false,
1212 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1213 postContentType: "text/plain",
1214 redirectRootLogin: "/main/friends",
1215 redirectRootNoLogin: "/main/all",
1217 sidebarRight: false,
1218 showFeaturesPanel: true,
1219 showInstanceSpecificPanel: false,
1220 subjectLineBehavior: "email",
1221 theme: "pleroma-dark",
1222 webPushNotifications: false
1227 key: :alwaysShowSubjectInput,
1228 label: "Always show subject input",
1230 description: "When disabled, auto-hide the subject field if it's empty"
1234 type: {:string, :image},
1236 "URL of the background, unless viewing a user profile with a background that is set",
1237 suggestions: ["/images/city.jpg"]
1240 key: :collapseMessageWithSubject,
1241 label: "Collapse message with subject",
1244 "When a message has a subject (aka Content Warning), collapse it by default"
1248 label: "PleromaFE Chat",
1250 description: "Disables PleromaFE Chat component"
1256 description: "Enables green text on lines prefixed with the > character"
1259 key: :hideFilteredStatuses,
1260 label: "Hide Filtered Statuses",
1262 description: "Hides filtered statuses from timelines"
1265 key: :hideMutedPosts,
1266 label: "Hide Muted Posts",
1268 description: "Hides muted statuses from timelines"
1271 key: :hidePostStats,
1272 label: "Hide post stats",
1274 description: "Hide notices statistics (repeats, favorites, ...)"
1278 label: "Hide Sitename",
1280 description: "Hides instance name from PleromaFE banner"
1283 key: :hideUserStats,
1284 label: "Hide user stats",
1287 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1291 type: {:string, :image},
1292 description: "URL of the logo, defaults to Pleroma's logo",
1293 suggestions: ["/static/logo.svg"]
1297 label: "Logo margin",
1300 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1301 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1302 suggestions: [".1em"]
1309 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1310 "If you want a colorful logo you must disable logoMask."
1313 key: :minimalScopesMode,
1314 label: "Minimal scopes mode",
1317 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1318 "Also prevents replying to a DM with a public post from PleromaFE."
1321 key: :nsfwCensorImage,
1322 label: "NSFW Censor Image",
1323 type: {:string, :image},
1325 "URL of the image to use for hiding NSFW media attachments in the timeline",
1326 suggestions: ["/static/img/nsfw.74818f9.png"]
1329 key: :postContentType,
1330 label: "Post Content Type",
1331 type: {:dropdown, :atom},
1332 description: "Default post formatting option",
1333 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1336 key: :redirectRootNoLogin,
1337 label: "Redirect root no login",
1340 "Relative URL which indicates where to redirect when a user isn't logged in",
1341 suggestions: ["/main/all"]
1344 key: :redirectRootLogin,
1345 label: "Redirect root login",
1348 "Relative URL which indicates where to redirect when a user is logged in",
1349 suggestions: ["/main/friends"]
1353 label: "Scope copy",
1355 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1359 label: "Sidebar on Right",
1361 description: "Change alignment of sidebar and panels to the right"
1364 key: :showFeaturesPanel,
1365 label: "Show instance features panel",
1368 "Enables panel displaying functionality of the instance on the About page"
1371 key: :showInstanceSpecificPanel,
1372 label: "Show instance specific panel",
1374 description: "Whether to show the instance's custom panel"
1377 key: :subjectLineBehavior,
1378 label: "Subject line behavior",
1380 description: "Allows changing the default behaviour of subject lines in replies.
1381 `email`: copy and preprend re:, as in email,
1382 `masto`: copy verbatim, as in Mastodon,
1383 `noop`: don't copy the subject.",
1384 suggestions: ["email", "masto", "noop"]
1389 description: "Which theme to use. Available themes are defined in styles.json",
1390 suggestions: ["pleroma-dark"]
1398 description: "Settings for Masto FE",
1401 showInstanceSpecificPanel: true
1406 key: :showInstanceSpecificPanel,
1407 label: "Show instance specific panel",
1409 description: "Whenether to show the instance's specific panel"
1420 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1424 type: {:keyword, :map},
1426 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1429 url: "/images/pleroma-fox-tan-smol.png",
1430 mime_type: "image/png"
1432 pleroma_fox_tan_shy: %{
1433 url: "/images/pleroma-fox-tan-shy.png",
1434 mime_type: "image/png"
1439 key: :default_mascot,
1442 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1448 key: :default_user_avatar,
1449 type: {:string, :image},
1450 description: "URL of the default user avatar",
1451 suggestions: ["/images/avi.png"]
1460 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1464 type: {:list, :map},
1465 description: "Describe the icons of the app",
1468 src: "/static/logo.png"
1471 src: "/static/icon.png",
1475 src: "/static/icon.ico",
1476 sizes: "72x72 96x96 128x128 256x256"
1483 description: "Describe the theme color of the app",
1484 suggestions: ["#282c37", "mediumpurple"]
1487 key: :background_color,
1489 description: "Describe the background color of the app",
1490 suggestions: ["#191b22", "aliceblue"]
1498 description: "Media proxy",
1503 description: "Enables proxying of remote media via the instance's proxy"
1510 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1511 suggestions: ["https://example.com"]
1519 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1525 description: "Enables media cache object invalidation."
1530 description: "Module which will be used to purge objects from the cache.",
1532 Pleroma.Web.MediaProxy.Invalidation.Script,
1533 Pleroma.Web.MediaProxy.Invalidation.Http
1540 label: "Advanced MediaProxy Options",
1542 description: "Internal Pleroma.ReverseProxy settings",
1544 redirect_on_failure: false,
1545 max_body_length: 25 * 1_048_576,
1546 max_read_duration: 30_000
1550 key: :redirect_on_failure,
1553 Redirects the client to the origin server upon encountering HTTP errors.\n
1554 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1555 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1556 IP addresses of your users to the other servers, bypassing the MediaProxy.
1560 key: :max_body_length,
1562 description: "Maximum file size allowed through the Pleroma MediaProxy cache."
1565 key: :max_read_duration,
1567 description: "Timeout (in milliseconds) of GET request to the remote URI."
1573 type: {:list, :string},
1574 description: "List of hosts with scheme to bypass the MediaProxy",
1575 suggestions: ["http://example.com"]
1581 key: :media_preview_proxy,
1583 description: "Media preview proxy",
1589 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1592 key: :thumbnail_max_width,
1595 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1598 key: :thumbnail_max_height,
1601 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1604 key: :image_quality,
1606 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1609 key: :min_content_length,
1612 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1618 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1620 description: "HTTP invalidate settings",
1625 description: "HTTP method of request. Default: :purge"
1629 type: {:keyword, :string},
1630 description: "HTTP headers of request",
1631 suggestions: [{"x-refresh", 1}]
1636 description: "Request options",
1640 type: {:map, :string}
1648 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1650 description: "Invalidation script settings",
1655 description: "Path to executable script which will purge cached items.",
1656 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1662 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1663 suggestions: [":htcacheclean"]
1671 description: "Gopher settings",
1676 description: "Enables the gopher interface"
1682 description: "IP address to bind to",
1683 suggestions: [{0, 0, 0, 0}]
1688 description: "Port to bind to",
1694 description: "Port advertised in URLs (optional, defaults to port)",
1702 label: "ActivityPub",
1704 description: "ActivityPub-related settings",
1707 key: :unfollow_blocked,
1709 description: "Whether blocks result in people getting unfollowed"
1712 key: :outgoing_blocks,
1714 description: "Whether to federate blocks to other instances"
1717 key: :sign_object_fetches,
1719 description: "Sign object fetches with HTTP signatures"
1722 key: :note_replies_output_limit,
1725 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1728 key: :follow_handshake_timeout,
1730 description: "Following handshake timeout",
1737 key: :http_security,
1738 label: "HTTP security",
1740 description: "HTTP security settings",
1745 description: "Whether the managed content security policy is enabled"
1751 description: "Whether to additionally send a Strict-Transport-Security header"
1755 label: "STS max age",
1757 description: "The maximum age for the Strict-Transport-Security header if sent",
1758 suggestions: [31_536_000]
1762 label: "CT max age",
1764 description: "The maximum age for the Expect-CT header if sent",
1765 suggestions: [2_592_000]
1768 key: :referrer_policy,
1770 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1771 suggestions: ["same-origin", "no-referrer"]
1775 label: "Report URI",
1777 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1778 suggestions: ["https://example.com/report-uri"]
1783 group: :web_push_encryption,
1784 key: :vapid_details,
1785 label: "Vapid Details",
1788 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1794 "A mailto link for the administrative contact." <>
1795 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1796 suggestions: ["mailto:moderators@pleroma.com"]
1801 description: "VAPID public key",
1802 suggestions: ["Public key"]
1807 description: "VAPID private key",
1808 suggestions: ["Private key"]
1814 key: Pleroma.Captcha,
1816 description: "Captcha-related settings",
1821 description: "Whether the captcha should be shown on registration"
1826 description: "The method/service to use for captcha",
1827 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1830 key: :seconds_valid,
1832 description: "The time in seconds for which the captcha is valid",
1839 key: Pleroma.Captcha.Kocaptcha,
1842 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1843 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1848 description: "The kocaptcha endpoint to use",
1849 suggestions: ["https://captcha.kotobank.ch"]
1855 label: "Pleroma Admin Token",
1858 "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)",
1863 description: "Admin token",
1865 "Please use a high entropy string or UUID"
1875 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1879 type: {:dropdown, :atom},
1880 description: "Logs verbose mode",
1881 suggestions: [false, :error, :warn, :info, :debug]
1885 type: {:keyword, :integer},
1887 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1889 activity_expiration: 10,
1890 attachments_cleanup: 5,
1892 federator_incoming: 50,
1893 federator_outgoing: 50,
1895 scheduled_activities: 10,
1901 key: :activity_expiration,
1903 description: "Activity expiration queue",
1909 description: "Backup queue",
1913 key: :attachments_cleanup,
1915 description: "Attachment deletion queue",
1921 description: "Background queue",
1925 key: :federator_incoming,
1927 description: "Incoming federation queue",
1931 key: :federator_outgoing,
1933 description: "Outgoing federation queue",
1939 description: "Email sender queue, see Pleroma.Emails.Mailer",
1943 key: :scheduled_activities,
1945 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1949 key: :transmogrifier,
1951 description: "Transmogrifier queue",
1957 description: "Web push notifications queue",
1964 type: {:list, :tuple},
1965 description: "Settings for cron background jobs",
1967 {"0 1 * * *", Pleroma.Workers.Cron.HashtagsCleanupWorker},
1968 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1969 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1978 description: "Includes custom worker options not interpretable directly by `Oban`",
1982 type: {:keyword, :integer},
1983 description: "Max retry attempts for failed jobs, per `Oban` queue",
1985 federator_incoming: 5,
1986 federator_outgoing: 5
1993 key: Pleroma.Web.Metadata,
1995 description: "Metadata-related settings",
1999 type: {:list, :module},
2000 description: "List of metadata providers to enable",
2002 Pleroma.Web.Metadata.Providers.OpenGraph,
2003 Pleroma.Web.Metadata.Providers.TwitterCard,
2004 Pleroma.Web.Metadata.Providers.RelMe,
2005 Pleroma.Web.Metadata.Providers.Feed
2010 label: "Unfurl NSFW",
2012 description: "When enabled NSFW attachments will be shown in previews"
2021 "If enabled the instance will parse metadata from attached links to generate link previews",
2026 description: "Enables RichMedia parsing of URLs"
2030 type: {:list, :string},
2031 description: "List of hosts which will be ignored by the metadata parser",
2032 suggestions: ["accounts.google.com", "xss.website"]
2036 label: "Ignore TLD",
2037 type: {:list, :string},
2038 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2039 suggestions: ["local", "localdomain", "lan"]
2043 type: {:list, :module},
2045 "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.",
2047 Pleroma.Web.RichMedia.Parsers.OEmbed,
2048 Pleroma.Web.RichMedia.Parsers.TwitterCard
2053 label: "TTL setters",
2054 type: {:list, :module},
2056 "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.",
2058 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2062 key: :failure_backoff,
2065 "Amount of milliseconds after request failure, during which the request will not be retried.",
2066 suggestions: [60_000]
2072 key: Pleroma.Formatter,
2076 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2080 type: [:string, :boolean],
2081 description: "Specify the class to be added to the generated link. Disable to clear.",
2082 suggestions: ["auto-linker", false]
2086 type: [:string, :boolean],
2087 description: "Override the rel attribute. Disable to clear.",
2088 suggestions: ["ugc", "noopener noreferrer", false]
2093 description: "Link URLs will open in a new window/tab."
2097 type: [:integer, :boolean],
2099 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2100 suggestions: [15, false]
2105 description: "Strip the scheme prefix."
2110 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2114 type: [:atom, :boolean],
2116 "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)",
2117 suggestions: [:no_scheme, true]
2123 key: Pleroma.ScheduledActivity,
2125 description: "Scheduled activities settings",
2128 key: :daily_user_limit,
2131 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2135 key: :total_user_limit,
2138 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2144 description: "Whether scheduled activities are sent to the job queue to be executed"
2150 key: Pleroma.Workers.PurgeExpiredActivity,
2152 description: "Expired activities settings",
2157 description: "Enables expired activities addition & deletion"
2162 description: "Minimum lifetime for ephemeral activity (in seconds)",
2169 label: "Pleroma Authenticator",
2171 description: "Authenticator",
2174 key: Pleroma.Web.Auth.Authenticator,
2176 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2186 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2187 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2188 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2189 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2194 description: "Enables LDAP authentication"
2199 description: "LDAP server hostname",
2200 suggestions: ["localhosts"]
2205 description: "LDAP port, e.g. 389 or 636",
2206 suggestions: [389, 636]
2212 description: "Enable to use SSL, usually implies the port 636"
2216 label: "SSL options",
2218 description: "Additional SSL options",
2219 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2224 description: "Path to file with PEM encoded cacerts",
2225 suggestions: ["path/to/file/with/PEM/cacerts"]
2230 description: "Type of cert verification",
2231 suggestions: [:verify_peer]
2239 description: "Enable to use STARTTLS, usually implies the port 389"
2243 label: "TLS options",
2245 description: "Additional TLS options",
2246 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2251 description: "Path to file with PEM encoded cacerts",
2252 suggestions: ["path/to/file/with/PEM/cacerts"]
2257 description: "Type of cert verification",
2258 suggestions: [:verify_peer]
2265 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2266 suggestions: ["dc=example,dc=com"]
2273 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2282 description: "Authentication / authorization settings",
2285 key: :enforce_oauth_admin_scope_usage,
2286 label: "Enforce OAuth admin scope usage",
2289 "OAuth admin scope requirement toggle. " <>
2290 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2291 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2292 "`is_admin` user flag grants access to admin-specific actions."
2295 key: :auth_template,
2298 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2299 suggestions: ["show.html"]
2302 key: :oauth_consumer_template,
2303 label: "OAuth consumer template",
2306 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2307 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2308 suggestions: ["consumer.html"]
2311 key: :oauth_consumer_strategies,
2312 label: "OAuth consumer strategies",
2313 type: {:list, :string},
2315 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2316 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2317 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2318 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2324 key: :email_notifications,
2326 description: "Email notifications settings",
2332 "emails of \"what you've missed\" for users who have been inactive for a while",
2336 schedule: "0 0 * * 0",
2338 inactivity_threshold: 7
2346 description: "Globally enable or disable digest emails"
2352 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2353 suggestions: ["0 0 * * 0"]
2358 description: "Minimum interval between digest emails to one user",
2362 key: :inactivity_threshold,
2364 description: "Minimum user inactivity threshold",
2373 key: Pleroma.Emails.UserEmail,
2375 description: "Email template settings",
2379 type: {:string, :image},
2380 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2381 suggestions: ["some/path/logo.png"]
2386 description: "A map with color settings for email templates.",
2389 link_color: "#d8a070",
2390 background_color: "#2C3645",
2391 content_background_color: "#1B2635",
2392 header_color: "#d8a070",
2393 text_color: "#b9b9ba",
2394 text_muted_color: "#b9b9ba"
2401 suggestions: ["#d8a070"]
2404 key: :background_color,
2406 suggestions: ["#2C3645"]
2409 key: :content_background_color,
2411 suggestions: ["#1B2635"]
2416 suggestions: ["#d8a070"]
2421 suggestions: ["#b9b9ba"]
2424 key: :text_muted_color,
2426 suggestions: ["#b9b9ba"]
2434 key: Pleroma.Emails.NewUsersDigestEmail,
2436 description: "New users admin email digest",
2441 description: "Enables new users admin digest email when `true`"
2450 description: "Configure OAuth 2 provider capabilities",
2453 key: :token_expires_in,
2455 description: "The lifetime in seconds of the access token",
2456 suggestions: [2_592_000]
2459 key: :issue_new_refresh_token,
2462 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2465 key: :clean_expired_tokens,
2467 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2477 key: :shortcode_globs,
2478 type: {:list, :string},
2479 description: "Location of custom emoji files. * can be used as a wildcard.",
2480 suggestions: ["/emoji/custom/**/*.png"]
2483 key: :pack_extensions,
2484 type: {:list, :string},
2486 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2487 suggestions: [".png", ".gif"]
2491 type: {:keyword, {:list, :string}},
2493 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2494 " and the value is the location or array of locations. * can be used as a wildcard.",
2496 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2500 key: :default_manifest,
2503 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2504 " Currently only one manifest can be added (no arrays).",
2505 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2508 key: :shared_pack_cache_seconds_per_file,
2509 label: "Shared pack cache s/file",
2512 "When an emoji pack is shared, the archive is created and cached in memory" <>
2513 " for this amount of seconds multiplied by the number of files.",
2523 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2527 type: [:tuple, {:list, :tuple}],
2528 description: "For the search requests (account & status search etc.)",
2529 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2533 type: [:tuple, {:list, :tuple}],
2534 description: "For requests to timelines (each timeline has it's own limiter)",
2535 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2538 key: :app_account_creation,
2539 type: [:tuple, {:list, :tuple}],
2540 description: "For registering user accounts from the same IP address",
2541 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2544 key: :relations_actions,
2545 type: [:tuple, {:list, :tuple}],
2546 description: "For actions on relationships with all users (follow, unfollow)",
2547 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2550 key: :relation_id_action,
2551 label: "Relation ID action",
2552 type: [:tuple, {:list, :tuple}],
2553 description: "For actions on relation with a specific user (follow, unfollow)",
2554 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2557 key: :statuses_actions,
2558 type: [:tuple, {:list, :tuple}],
2560 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2561 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2564 key: :status_id_action,
2565 label: "Status ID action",
2566 type: [:tuple, {:list, :tuple}],
2568 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2569 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2572 key: :authentication,
2573 type: [:tuple, {:list, :tuple}],
2574 description: "For authentication create / password check / user existence check requests",
2575 suggestions: [{60_000, 15}]
2584 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2585 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2590 description: "Enables SSH"
2595 description: "Dir with SSH keys",
2596 suggestions: ["/some/path/ssh_keys"]
2601 description: "Handler module",
2602 suggestions: ["Pleroma.BBS.Handler"]
2607 description: "Port to connect",
2608 suggestions: [10_022]
2611 key: :password_authenticator,
2613 description: "Authenticator module",
2614 suggestions: ["Pleroma.BBS.Authenticator"]
2620 label: "Mime Types",
2622 description: "Mime Types settings",
2629 "application/xml" => ["xml"],
2630 "application/xrd+xml" => ["xrd+xml"],
2631 "application/jrd+json" => ["jrd+json"],
2632 "application/activity+json" => ["activity+json"],
2633 "application/ld+json" => ["activity+json"]
2638 key: "application/xml",
2639 type: {:list, :string},
2640 suggestions: ["xml"]
2643 key: "application/xrd+xml",
2644 type: {:list, :string},
2645 suggestions: ["xrd+xml"]
2648 key: "application/jrd+json",
2649 type: {:list, :string},
2650 suggestions: ["jrd+json"]
2653 key: "application/activity+json",
2654 type: {:list, :string},
2655 suggestions: ["activity+json"]
2658 key: "application/ld+json",
2659 type: {:list, :string},
2660 suggestions: ["activity+json"]
2670 description: "Pleroma chat settings",
2683 description: "HTTP settings",
2688 type: [:string, :tuple],
2689 description: "Proxy URL",
2690 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2693 key: :send_user_agent,
2698 type: [:string, :atom],
2700 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2701 suggestions: ["Pleroma", :default]
2706 description: "Adapter specific options",
2712 label: "SSL Options",
2713 description: "SSL options for HTTP adapter",
2717 type: {:list, :atom},
2718 description: "List of TLS version to use",
2719 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2730 label: "Markup Settings",
2734 key: :allow_inline_images,
2738 key: :allow_headings,
2751 type: {:list, :module},
2753 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2754 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2764 key: :deny_follow_blocked,
2775 key: :restricted_nicknames,
2776 type: {:list, :string},
2777 description: "List of nicknames users may not register with.",
2796 "ostatus_subscribe",
2812 key: :email_blacklist,
2813 type: {:list, :string},
2814 description: "List of email domains users may not register with.",
2815 suggestions: ["mailinator.com", "maildrop.cc"]
2821 label: "CORS plug config",
2827 suggestions: [86_400]
2831 type: {:list, :string},
2832 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2836 type: {:list, :string},
2839 "X-RateLimit-Reset",
2840 "X-RateLimit-Limit",
2841 "X-RateLimit-Remaining",
2852 type: {:list, :string},
2853 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2859 key: Pleroma.Web.Plugs.RemoteIp,
2862 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2863 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2869 description: "Enable/disable the plug. Default: disabled."
2873 type: {:list, :string},
2875 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2880 type: {:list, :string},
2882 "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."
2886 type: {:list, :string},
2888 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"]`
2895 key: :web_cache_ttl,
2896 label: "Web cache TTL",
2899 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2905 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2906 suggestions: [30_000, nil]
2909 key: :activity_pub_question,
2911 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2912 suggestions: [30_000]
2922 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2927 description: "Enables the rendering of static HTML. Default: disabled."
2935 description: "Configure feed rendering",
2940 description: "Configure title rendering",
2945 description: "Maximum number of characters before truncating title",
2951 description: "Replacement which will be used after truncating string",
2952 suggestions: ["..."]
2962 description: "Custom Runtime Modules",
2967 description: "A path to custom Elixir modules (such as MRF policies)."
2975 description: "Settings for notifications streamer",
2980 description: "Number of workers to send notifications",
2984 key: :overflow_workers,
2986 description: "Maximum number of workers created if pool is empty",
2993 key: :connections_pool,
2995 description: "Advanced settings for `Gun` connections pool",
2998 key: :connection_acquisition_wait,
3001 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3005 key: :connection_acquisition_retries,
3008 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3012 key: :max_connections,
3014 description: "Maximum number of connections in the pool. Default: 250 connections.",
3018 key: :connect_timeout,
3020 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3024 key: :reclaim_multiplier,
3027 "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",
3036 description: "Advanced settings for `Gun` workers pools",
3038 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3042 description: "Settings for #{pool_name} pool.",
3047 description: "Maximum number of concurrent requests in the pool.",
3054 "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",
3060 description: "Timeout for the pool while gun will wait for response",
3061 suggestions: [10_000]
3069 key: :hackney_pools,
3071 description: "Advanced settings for `Hackney` connections pools",
3076 description: "Settings for federation pool.",
3079 key: :max_connections,
3081 description: "Number workers in the pool.",
3087 description: "Timeout while `hackney` will wait for response.",
3088 suggestions: [150_000]
3095 description: "Settings for media pool.",
3098 key: :max_connections,
3100 description: "Number workers in the pool.",
3106 description: "Timeout while `hackney` will wait for response.",
3107 suggestions: [150_000]
3114 description: "Settings for upload pool.",
3117 key: :max_connections,
3119 description: "Number workers in the pool.",
3125 description: "Timeout while `hackney` will wait for response.",
3126 suggestions: [300_000]
3134 key: :restrict_unauthenticated,
3135 label: "Restrict Unauthenticated",
3138 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3143 description: "Settings for public and federated timelines.",
3148 description: "Disallow view public timeline."
3153 description: "Disallow view federated timeline."
3160 description: "Settings for user profiles.",
3165 description: "Disallow view local user profiles."
3170 description: "Disallow view remote user profiles."
3177 description: "Settings for statuses.",
3182 description: "Disallow view local statuses."
3187 description: "Disallow view remote statuses."
3195 key: Pleroma.Web.ApiSpec.CastAndValidate,
3202 "Enables strict input validation (useful in development, not recommended in production)"
3208 key: :instances_favicons,
3210 description: "Control favicons for instances",
3215 description: "Allow/disallow displaying and getting instances favicons"
3223 descriptions: "S3 service related settings",
3226 key: :access_key_id,
3228 description: "S3 access key ID",
3229 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3232 key: :secret_access_key,
3234 description: "Secret access key",
3235 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3240 description: "S3 host",
3241 suggestions: ["s3.eu-central-1.amazonaws.com"]
3246 description: "S3 region (for AWS)",
3247 suggestions: ["us-east-1"]
3255 description: "Installed frontends management",
3260 description: "Primary frontend, the one that is served for all pages by default",
3261 children: installed_frontend_options
3266 description: "Admin frontend",
3267 children: installed_frontend_options
3273 "A map containing available frontends and parameters for their installation.",
3274 children: frontend_options
3280 key: Pleroma.Web.Preload,
3282 description: "Preload-related settings",
3286 type: {:list, :module},
3287 description: "List of preload providers to enable",
3289 Pleroma.Web.Preload.Providers.Instance,
3290 Pleroma.Web.Preload.Providers.User,
3291 Pleroma.Web.Preload.Providers.Timelines,
3292 Pleroma.Web.Preload.Providers.StatusNet
3301 description: "Majic/libmagic configuration",
3306 description: "Number of majic workers to start.",
3313 key: Pleroma.User.Backup,
3315 description: "Account Backup",
3318 key: :purge_after_days,
3320 description: "Remove backup achives after N days",
3326 description: "Limit user to export not more often than once per N days",
3333 key: Pleroma.Web.Endpoint.MetricsExporter,
3335 description: "Prometheus app metrics endpoint configuration",
3340 description: "[Pleroma extension] Enables app metrics endpoint."
3344 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3346 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3350 type: [:boolean, :tuple],
3351 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3352 suggestion: [false, {:basic, "myusername", "mypassword"}]
3357 description: "App metrics endpoint URI path.",
3358 suggestions: ["/api/pleroma/app_metrics"]
3363 description: "App metrics endpoint output format.",
3364 suggestions: [:text, :protobuf]
3370 key: ConcurrentLimiter,
3372 description: "Limits configuration for background tasks.",
3375 key: Pleroma.Web.RichMedia.Helpers,
3377 description: "Concurrent limits configuration for getting RichMedia for activities.",
3378 suggestions: [max_running: 5, max_waiting: 5],
3383 description: "Max running concurrently jobs.",
3389 description: "Max waiting jobs.",
3395 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3397 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3398 suggestions: [max_running: 5, max_waiting: 5],
3403 description: "Max running concurrently jobs.",
3409 description: "Max waiting jobs.",