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 "
66 config :pleroma, :config_description, [
71 description: "Upload general settings",
76 description: "Module which will be used for uploads",
77 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
81 type: {:list, :module},
83 "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.",
84 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
90 "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`."
96 description: "Base URL for the uploads, needed if you use CDN",
98 "https://cdn-host.com"
105 Proxy requests to the remote uploader.\n
106 Useful if media upload endpoint is not internet accessible.
110 key: :filename_display_max_length,
112 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
118 key: Pleroma.Uploaders.Local,
120 description: "Local uploader-related settings",
125 description: "Path where user's uploads will be saved",
134 key: Pleroma.Uploaders.S3,
136 description: "S3 uploader-related settings",
141 description: "S3 bucket",
147 key: :bucket_namespace,
149 description: "S3 bucket namespace",
150 suggestions: ["pleroma"]
153 key: :public_endpoint,
155 description: "S3 endpoint",
156 suggestions: ["https://s3.amazonaws.com"]
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 public_endpoint."
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."
951 description: "Welcome messages settings",
954 key: :direct_message,
956 descpiption: "Direct message settings",
961 description: "Enables sending a direct message to newly registered users"
966 description: "A message that will be sent to newly registered users",
968 "Hi, @username! Welcome on board!"
972 key: :sender_nickname,
974 description: "The nickname of the local user that sends a welcome message",
984 descpiption: "Chat message settings",
989 description: "Enables sending a chat message to newly registered users"
995 "A message that will be sent to newly registered users as a chat message",
997 "Hello, welcome on board!"
1001 key: :sender_nickname,
1003 description: "The nickname of the local user that sends a welcome chat message",
1013 descpiption: "Email message settings",
1018 description: "Enables sending an email to newly registered users"
1022 type: [:string, :tuple],
1024 "Email address and/or nickname that will be used to send the welcome email.",
1026 {"Pleroma App", "welcome@pleroma.app"}
1033 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1034 suggestions: ["Welcome to <%= instance_name%>"]
1040 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1041 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1047 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1048 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1057 description: "Logger-related settings",
1061 type: [:atom, :tuple, :module],
1063 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1064 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1072 label: "ExSyslogger",
1073 description: "ExSyslogger-related settings",
1077 type: {:dropdown, :atom},
1078 description: "Log level",
1079 suggestions: [:debug, :info, :warn, :error]
1085 "A string that's prepended to every message, and is typically set to the app name",
1086 suggestions: ["pleroma"]
1091 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1092 suggestions: ["$metadata[$level] $message"]
1096 type: {:list, :atom},
1097 suggestions: [:request_id]
1105 label: "Console Logger",
1106 description: "Console logger settings",
1110 type: {:dropdown, :atom},
1111 description: "Log level",
1112 suggestions: [:debug, :info, :warn, :error]
1117 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1118 suggestions: ["$metadata[$level] $message"]
1122 type: {:list, :atom},
1123 suggestions: [:request_id]
1130 label: "Quack Logger",
1131 description: "Quack-related settings",
1135 type: {:dropdown, :atom},
1136 description: "Log level",
1137 suggestions: [:debug, :info, :warn, :error]
1141 type: {:list, :atom},
1142 description: "Configure which metadata you want to report on",
1159 label: "Webhook URL",
1161 description: "Configure the Slack incoming webhook",
1162 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1168 key: :frontend_configurations,
1171 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1172 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1173 "add your own configuration your settings all fields must be complete.",
1177 label: "Pleroma FE",
1179 description: "Settings for Pleroma FE",
1182 alwaysShowSubjectInput: true,
1183 background: "/static/aurora_borealis.jpg",
1184 collapseMessageWithSubject: false,
1187 hideFilteredStatuses: false,
1188 hideMutedPosts: false,
1189 hidePostStats: false,
1190 hideSitename: false,
1191 hideUserStats: false,
1192 loginMethod: "password",
1193 logo: "/static/logo.svg",
1196 minimalScopesMode: false,
1197 noAttachmentLinks: false,
1198 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1199 postContentType: "text/plain",
1200 redirectRootLogin: "/main/friends",
1201 redirectRootNoLogin: "/main/all",
1203 sidebarRight: false,
1204 showFeaturesPanel: true,
1205 showInstanceSpecificPanel: false,
1206 subjectLineBehavior: "email",
1207 theme: "pleroma-dark",
1208 webPushNotifications: false
1213 key: :alwaysShowSubjectInput,
1214 label: "Always show subject input",
1216 description: "When disabled, auto-hide the subject field if it's empty"
1220 type: {:string, :image},
1222 "URL of the background, unless viewing a user profile with a background that is set",
1223 suggestions: ["/images/city.jpg"]
1226 key: :collapseMessageWithSubject,
1227 label: "Collapse message with subject",
1230 "When a message has a subject (aka Content Warning), collapse it by default"
1234 label: "PleromaFE Chat",
1236 description: "Disables PleromaFE Chat component"
1242 description: "Enables green text on lines prefixed with the > character"
1245 key: :hideFilteredStatuses,
1246 label: "Hide Filtered Statuses",
1248 description: "Hides filtered statuses from timelines"
1251 key: :hideMutedPosts,
1252 label: "Hide Muted Posts",
1254 description: "Hides muted statuses from timelines"
1257 key: :hidePostStats,
1258 label: "Hide post stats",
1260 description: "Hide notices statistics (repeats, favorites, ...)"
1264 label: "Hide Sitename",
1266 description: "Hides instance name from PleromaFE banner"
1269 key: :hideUserStats,
1270 label: "Hide user stats",
1273 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1277 type: {:string, :image},
1278 description: "URL of the logo, defaults to Pleroma's logo",
1279 suggestions: ["/static/logo.svg"]
1283 label: "Logo margin",
1286 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1287 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1288 suggestions: [".1em"]
1295 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1296 "If you want a colorful logo you must disable logoMask."
1299 key: :minimalScopesMode,
1300 label: "Minimal scopes mode",
1303 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1304 "Also prevents replying to a DM with a public post from PleromaFE."
1307 key: :nsfwCensorImage,
1308 label: "NSFW Censor Image",
1309 type: {:string, :image},
1311 "URL of the image to use for hiding NSFW media attachments in the timeline",
1312 suggestions: ["/static/img/nsfw.74818f9.png"]
1315 key: :postContentType,
1316 label: "Post Content Type",
1317 type: {:dropdown, :atom},
1318 description: "Default post formatting option",
1319 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1322 key: :redirectRootNoLogin,
1323 label: "Redirect root no login",
1326 "Relative URL which indicates where to redirect when a user isn't logged in",
1327 suggestions: ["/main/all"]
1330 key: :redirectRootLogin,
1331 label: "Redirect root login",
1334 "Relative URL which indicates where to redirect when a user is logged in",
1335 suggestions: ["/main/friends"]
1339 label: "Scope copy",
1341 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1345 label: "Sidebar on Right",
1347 description: "Change alignment of sidebar and panels to the right"
1350 key: :showFeaturesPanel,
1351 label: "Show instance features panel",
1354 "Enables panel displaying functionality of the instance on the About page"
1357 key: :showInstanceSpecificPanel,
1358 label: "Show instance specific panel",
1360 description: "Whether to show the instance's custom panel"
1363 key: :subjectLineBehavior,
1364 label: "Subject line behavior",
1366 description: "Allows changing the default behaviour of subject lines in replies.
1367 `email`: copy and preprend re:, as in email,
1368 `masto`: copy verbatim, as in Mastodon,
1369 `noop`: don't copy the subject.",
1370 suggestions: ["email", "masto", "noop"]
1375 description: "Which theme to use. Available themes are defined in styles.json",
1376 suggestions: ["pleroma-dark"]
1384 description: "Settings for Masto FE",
1387 showInstanceSpecificPanel: true
1392 key: :showInstanceSpecificPanel,
1393 label: "Show instance specific panel",
1395 description: "Whenether to show the instance's specific panel"
1406 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1410 type: {:keyword, :map},
1412 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1415 url: "/images/pleroma-fox-tan-smol.png",
1416 mime_type: "image/png"
1418 pleroma_fox_tan_shy: %{
1419 url: "/images/pleroma-fox-tan-shy.png",
1420 mime_type: "image/png"
1425 key: :default_mascot,
1428 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1434 key: :default_user_avatar,
1435 type: {:string, :image},
1436 description: "URL of the default user avatar",
1437 suggestions: ["/images/avi.png"]
1446 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1450 type: {:list, :map},
1451 description: "Describe the icons of the app",
1454 src: "/static/logo.png"
1457 src: "/static/icon.png",
1461 src: "/static/icon.ico",
1462 sizes: "72x72 96x96 128x128 256x256"
1469 description: "Describe the theme color of the app",
1470 suggestions: ["#282c37", "mediumpurple"]
1473 key: :background_color,
1475 description: "Describe the background color of the app",
1476 suggestions: ["#191b22", "aliceblue"]
1484 description: "Media proxy",
1489 description: "Enables proxying of remote media via the instance's proxy"
1496 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1497 suggestions: ["https://example.com"]
1505 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1511 description: "Enables media cache object invalidation."
1516 description: "Module which will be used to purge objects from the cache.",
1518 Pleroma.Web.MediaProxy.Invalidation.Script,
1519 Pleroma.Web.MediaProxy.Invalidation.Http
1526 label: "Advanced MediaProxy Options",
1528 description: "Internal Pleroma.ReverseProxy settings",
1530 redirect_on_failure: false,
1531 max_body_length: 25 * 1_048_576,
1532 max_read_duration: 30_000
1536 key: :redirect_on_failure,
1539 Redirects the client to the origin server upon encountering HTTP errors.\n
1540 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1541 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1542 IP addresses of your users to the other servers, bypassing the MediaProxy.
1546 key: :max_body_length,
1548 description: "Maximum file size allowed through the Pleroma MediaProxy cache."
1551 key: :max_read_duration,
1553 description: "Timeout (in milliseconds) of GET request to the remote URI."
1559 type: {:list, :string},
1560 description: "List of hosts with scheme to bypass the MediaProxy",
1561 suggestions: ["http://example.com"]
1567 key: :media_preview_proxy,
1569 description: "Media preview proxy",
1575 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1578 key: :thumbnail_max_width,
1581 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1584 key: :thumbnail_max_height,
1587 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1590 key: :image_quality,
1592 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1595 key: :min_content_length,
1598 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1604 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1606 description: "HTTP invalidate settings",
1611 description: "HTTP method of request. Default: :purge"
1615 type: {:keyword, :string},
1616 description: "HTTP headers of request",
1617 suggestions: [{"x-refresh", 1}]
1622 description: "Request options",
1626 type: {:map, :string}
1634 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1636 description: "Script invalidate settings",
1641 description: "Path to shell script. Which will run purge cache.",
1642 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1650 description: "Gopher settings",
1655 description: "Enables the gopher interface"
1661 description: "IP address to bind to",
1662 suggestions: [{0, 0, 0, 0}]
1667 description: "Port to bind to",
1673 description: "Port advertised in URLs (optional, defaults to port)",
1681 label: "ActivityPub",
1683 description: "ActivityPub-related settings",
1686 key: :unfollow_blocked,
1688 description: "Whether blocks result in people getting unfollowed"
1691 key: :outgoing_blocks,
1693 description: "Whether to federate blocks to other instances"
1696 key: :blockers_visible,
1698 description: "Whether a user can see someone who has blocked them"
1701 key: :sign_object_fetches,
1703 description: "Sign object fetches with HTTP signatures"
1706 key: :note_replies_output_limit,
1709 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1712 key: :follow_handshake_timeout,
1714 description: "Following handshake timeout",
1721 key: :http_security,
1722 label: "HTTP security",
1724 description: "HTTP security settings",
1729 description: "Whether the managed content security policy is enabled"
1735 description: "Whether to additionally send a Strict-Transport-Security header"
1739 label: "STS max age",
1741 description: "The maximum age for the Strict-Transport-Security header if sent",
1742 suggestions: [31_536_000]
1746 label: "CT max age",
1748 description: "The maximum age for the Expect-CT header if sent",
1749 suggestions: [2_592_000]
1752 key: :referrer_policy,
1754 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1755 suggestions: ["same-origin", "no-referrer"]
1759 label: "Report URI",
1761 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1762 suggestions: ["https://example.com/report-uri"]
1767 group: :web_push_encryption,
1768 key: :vapid_details,
1769 label: "Vapid Details",
1772 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1778 "A mailto link for the administrative contact." <>
1779 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1780 suggestions: ["mailto:moderators@pleroma.com"]
1785 description: "VAPID public key",
1786 suggestions: ["Public key"]
1791 description: "VAPID private key",
1792 suggestions: ["Private key"]
1798 key: Pleroma.Captcha,
1800 description: "Captcha-related settings",
1805 description: "Whether the captcha should be shown on registration"
1810 description: "The method/service to use for captcha",
1811 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1814 key: :seconds_valid,
1816 description: "The time in seconds for which the captcha is valid",
1823 key: Pleroma.Captcha.Kocaptcha,
1826 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1827 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1832 description: "The kocaptcha endpoint to use",
1833 suggestions: ["https://captcha.kotobank.ch"]
1839 label: "Pleroma Admin Token",
1842 "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)",
1847 description: "Admin token",
1849 "Please use a high entropy string or UUID"
1859 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1863 type: {:dropdown, :atom},
1864 description: "Logs verbose mode",
1865 suggestions: [false, :error, :warn, :info, :debug]
1869 type: {:keyword, :integer},
1871 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1873 activity_expiration: 10,
1874 attachments_cleanup: 5,
1876 federator_incoming: 50,
1877 federator_outgoing: 50,
1879 scheduled_activities: 10,
1885 key: :activity_expiration,
1887 description: "Activity expiration queue",
1893 description: "Backup queue",
1897 key: :attachments_cleanup,
1899 description: "Attachment deletion queue",
1905 description: "Background queue",
1909 key: :federator_incoming,
1911 description: "Incoming federation queue",
1915 key: :federator_outgoing,
1917 description: "Outgoing federation queue",
1923 description: "Email sender queue, see Pleroma.Emails.Mailer",
1927 key: :scheduled_activities,
1929 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1933 key: :transmogrifier,
1935 description: "Transmogrifier queue",
1941 description: "Web push notifications queue",
1948 type: {:list, :tuple},
1949 description: "Settings for cron background jobs",
1951 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1952 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1961 description: "Includes custom worker options not interpretable directly by `Oban`",
1965 type: {:keyword, :integer},
1966 description: "Max retry attempts for failed jobs, per `Oban` queue",
1968 federator_incoming: 5,
1969 federator_outgoing: 5
1976 key: Pleroma.Web.Metadata,
1978 description: "Metadata-related settings",
1982 type: {:list, :module},
1983 description: "List of metadata providers to enable",
1985 Pleroma.Web.Metadata.Providers.OpenGraph,
1986 Pleroma.Web.Metadata.Providers.TwitterCard,
1987 Pleroma.Web.Metadata.Providers.RelMe,
1988 Pleroma.Web.Metadata.Providers.Feed
1993 label: "Unfurl NSFW",
1995 description: "When enabled NSFW attachments will be shown in previews"
2004 "If enabled the instance will parse metadata from attached links to generate link previews",
2009 description: "Enables RichMedia parsing of URLs"
2013 type: {:list, :string},
2014 description: "List of hosts which will be ignored by the metadata parser",
2015 suggestions: ["accounts.google.com", "xss.website"]
2019 label: "Ignore TLD",
2020 type: {:list, :string},
2021 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2022 suggestions: ["local", "localdomain", "lan"]
2026 type: {:list, :module},
2028 "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.",
2030 Pleroma.Web.RichMedia.Parsers.OEmbed,
2031 Pleroma.Web.RichMedia.Parsers.TwitterCard
2036 label: "TTL setters",
2037 type: {:list, :module},
2039 "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.",
2041 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2045 key: :failure_backoff,
2048 "Amount of milliseconds after request failure, during which the request will not be retried.",
2049 suggestions: [60_000]
2055 key: Pleroma.Formatter,
2059 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2063 type: [:string, :boolean],
2064 description: "Specify the class to be added to the generated link. Disable to clear.",
2065 suggestions: ["auto-linker", false]
2069 type: [:string, :boolean],
2070 description: "Override the rel attribute. Disable to clear.",
2071 suggestions: ["ugc", "noopener noreferrer", false]
2076 description: "Link URLs will open in a new window/tab."
2080 type: [:integer, :boolean],
2082 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2083 suggestions: [15, false]
2088 description: "Strip the scheme prefix."
2093 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2097 type: [:atom, :boolean],
2099 "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)",
2100 suggestions: [:no_scheme, true]
2106 key: Pleroma.ScheduledActivity,
2108 description: "Scheduled activities settings",
2111 key: :daily_user_limit,
2114 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2118 key: :total_user_limit,
2121 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2127 description: "Whether scheduled activities are sent to the job queue to be executed"
2133 key: Pleroma.Workers.PurgeExpiredActivity,
2135 description: "Expired activities settings",
2140 description: "Enables expired activities addition & deletion"
2145 description: "Minimum lifetime for ephemeral activity (in seconds)",
2152 label: "Pleroma Authenticator",
2154 description: "Authenticator",
2157 key: Pleroma.Web.Auth.Authenticator,
2159 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2169 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2170 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2171 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2172 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2177 description: "Enables LDAP authentication"
2182 description: "LDAP server hostname",
2183 suggestions: ["localhosts"]
2188 description: "LDAP port, e.g. 389 or 636",
2189 suggestions: [389, 636]
2195 description: "Enable to use SSL, usually implies the port 636"
2199 label: "SSL options",
2201 description: "Additional SSL options",
2202 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2207 description: "Path to file with PEM encoded cacerts",
2208 suggestions: ["path/to/file/with/PEM/cacerts"]
2213 description: "Type of cert verification",
2214 suggestions: [:verify_peer]
2222 description: "Enable to use STARTTLS, usually implies the port 389"
2226 label: "TLS options",
2228 description: "Additional TLS options",
2229 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2234 description: "Path to file with PEM encoded cacerts",
2235 suggestions: ["path/to/file/with/PEM/cacerts"]
2240 description: "Type of cert verification",
2241 suggestions: [:verify_peer]
2248 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2249 suggestions: ["dc=example,dc=com"]
2256 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2265 description: "Authentication / authorization settings",
2268 key: :enforce_oauth_admin_scope_usage,
2269 label: "Enforce OAuth admin scope usage",
2272 "OAuth admin scope requirement toggle. " <>
2273 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2274 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2275 "`is_admin` user flag grants access to admin-specific actions."
2278 key: :auth_template,
2281 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2282 suggestions: ["show.html"]
2285 key: :oauth_consumer_template,
2286 label: "OAuth consumer template",
2289 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2290 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2291 suggestions: ["consumer.html"]
2294 key: :oauth_consumer_strategies,
2295 label: "OAuth consumer strategies",
2296 type: {:list, :string},
2298 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2299 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2300 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2301 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2307 key: :email_notifications,
2309 description: "Email notifications settings",
2315 "emails of \"what you've missed\" for users who have been inactive for a while",
2319 schedule: "0 0 * * 0",
2321 inactivity_threshold: 7
2329 description: "Globally enable or disable digest emails"
2335 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2336 suggestions: ["0 0 * * 0"]
2341 description: "Minimum interval between digest emails to one user",
2345 key: :inactivity_threshold,
2347 description: "Minimum user inactivity threshold",
2356 key: Pleroma.Emails.UserEmail,
2358 description: "Email template settings",
2362 type: {:string, :image},
2363 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2364 suggestions: ["some/path/logo.png"]
2369 description: "A map with color settings for email templates.",
2372 link_color: "#d8a070",
2373 background_color: "#2C3645",
2374 content_background_color: "#1B2635",
2375 header_color: "#d8a070",
2376 text_color: "#b9b9ba",
2377 text_muted_color: "#b9b9ba"
2384 suggestions: ["#d8a070"]
2387 key: :background_color,
2389 suggestions: ["#2C3645"]
2392 key: :content_background_color,
2394 suggestions: ["#1B2635"]
2399 suggestions: ["#d8a070"]
2404 suggestions: ["#b9b9ba"]
2407 key: :text_muted_color,
2409 suggestions: ["#b9b9ba"]
2417 key: Pleroma.Emails.NewUsersDigestEmail,
2419 description: "New users admin email digest",
2424 description: "Enables new users admin digest email when `true`"
2433 description: "Configure OAuth 2 provider capabilities",
2436 key: :token_expires_in,
2438 description: "The lifetime in seconds of the access token",
2439 suggestions: [2_592_000]
2442 key: :issue_new_refresh_token,
2445 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2448 key: :clean_expired_tokens,
2450 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2460 key: :shortcode_globs,
2461 type: {:list, :string},
2462 description: "Location of custom emoji files. * can be used as a wildcard.",
2463 suggestions: ["/emoji/custom/**/*.png"]
2466 key: :pack_extensions,
2467 type: {:list, :string},
2469 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2470 suggestions: [".png", ".gif"]
2474 type: {:keyword, {:list, :string}},
2476 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2477 " and the value is the location or array of locations. * can be used as a wildcard.",
2479 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2483 key: :default_manifest,
2486 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2487 " Currently only one manifest can be added (no arrays).",
2488 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2491 key: :shared_pack_cache_seconds_per_file,
2492 label: "Shared pack cache s/file",
2495 "When an emoji pack is shared, the archive is created and cached in memory" <>
2496 " for this amount of seconds multiplied by the number of files.",
2506 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2510 type: [:tuple, {:list, :tuple}],
2511 description: "For the search requests (account & status search etc.)",
2512 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2516 type: [:tuple, {:list, :tuple}],
2517 description: "For requests to timelines (each timeline has it's own limiter)",
2518 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2521 key: :app_account_creation,
2522 type: [:tuple, {:list, :tuple}],
2523 description: "For registering user accounts from the same IP address",
2524 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2527 key: :relations_actions,
2528 type: [:tuple, {:list, :tuple}],
2529 description: "For actions on relationships with all users (follow, unfollow)",
2530 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2533 key: :relation_id_action,
2534 label: "Relation ID action",
2535 type: [:tuple, {:list, :tuple}],
2536 description: "For actions on relation with a specific user (follow, unfollow)",
2537 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2540 key: :statuses_actions,
2541 type: [:tuple, {:list, :tuple}],
2543 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2544 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2547 key: :status_id_action,
2548 label: "Status ID action",
2549 type: [:tuple, {:list, :tuple}],
2551 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2552 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2555 key: :authentication,
2556 type: [:tuple, {:list, :tuple}],
2557 description: "For authentication create / password check / user existence check requests",
2558 suggestions: [{60_000, 15}]
2567 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2568 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2573 description: "Enables SSH"
2578 description: "Dir with SSH keys",
2579 suggestions: ["/some/path/ssh_keys"]
2584 description: "Handler module",
2585 suggestions: ["Pleroma.BBS.Handler"]
2590 description: "Port to connect",
2591 suggestions: [10_022]
2594 key: :password_authenticator,
2596 description: "Authenticator module",
2597 suggestions: ["Pleroma.BBS.Authenticator"]
2603 label: "Mime Types",
2605 description: "Mime Types settings",
2612 "application/xml" => ["xml"],
2613 "application/xrd+xml" => ["xrd+xml"],
2614 "application/jrd+json" => ["jrd+json"],
2615 "application/activity+json" => ["activity+json"],
2616 "application/ld+json" => ["activity+json"]
2621 key: "application/xml",
2622 type: {:list, :string},
2623 suggestions: ["xml"]
2626 key: "application/xrd+xml",
2627 type: {:list, :string},
2628 suggestions: ["xrd+xml"]
2631 key: "application/jrd+json",
2632 type: {:list, :string},
2633 suggestions: ["jrd+json"]
2636 key: "application/activity+json",
2637 type: {:list, :string},
2638 suggestions: ["activity+json"]
2641 key: "application/ld+json",
2642 type: {:list, :string},
2643 suggestions: ["activity+json"]
2653 description: "Pleroma chat settings",
2666 description: "HTTP settings",
2671 type: [:string, :tuple],
2672 description: "Proxy URL",
2673 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2676 key: :send_user_agent,
2681 type: [:string, :atom],
2683 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2684 suggestions: ["Pleroma", :default]
2689 description: "Adapter specific options",
2695 label: "SSL Options",
2696 description: "SSL options for HTTP adapter",
2700 type: {:list, :atom},
2701 description: "List of TLS version to use",
2702 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2713 label: "Markup Settings",
2717 key: :allow_inline_images,
2721 key: :allow_headings,
2734 type: {:list, :module},
2736 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2737 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2747 key: :deny_follow_blocked,
2758 key: :restricted_nicknames,
2759 type: {:list, :string},
2760 description: "List of nicknames users may not register with.",
2779 "ostatus_subscribe",
2795 key: :email_blacklist,
2796 type: {:list, :string},
2797 description: "List of email domains users may not register with.",
2798 suggestions: ["mailinator.com", "maildrop.cc"]
2804 label: "CORS plug config",
2810 suggestions: [86_400]
2814 type: {:list, :string},
2815 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2819 type: {:list, :string},
2822 "X-RateLimit-Reset",
2823 "X-RateLimit-Limit",
2824 "X-RateLimit-Remaining",
2835 type: {:list, :string},
2836 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2842 key: Pleroma.Web.Plugs.RemoteIp,
2845 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2846 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2852 description: "Enable/disable the plug. Default: disabled."
2856 type: {:list, :string},
2858 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2863 type: {:list, :string},
2865 "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."
2869 type: {:list, :string},
2871 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"]`
2878 key: :web_cache_ttl,
2879 label: "Web cache TTL",
2882 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2888 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2889 suggestions: [30_000, nil]
2892 key: :activity_pub_question,
2894 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2895 suggestions: [30_000]
2905 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2910 description: "Enables the rendering of static HTML. Default: disabled."
2918 description: "Configure feed rendering",
2923 description: "Configure title rendering",
2928 description: "Maximum number of characters before truncating title",
2934 description: "Replacement which will be used after truncating string",
2935 suggestions: ["..."]
2945 description: "Custom Runtime Modules",
2950 description: "A path to custom Elixir modules (such as MRF policies)."
2958 description: "Settings for notifications streamer",
2963 description: "Number of workers to send notifications",
2967 key: :overflow_workers,
2969 description: "Maximum number of workers created if pool is empty",
2976 key: :connections_pool,
2978 description: "Advanced settings for `Gun` connections pool",
2981 key: :connection_acquisition_wait,
2984 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2988 key: :connection_acquisition_retries,
2991 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2995 key: :max_connections,
2997 description: "Maximum number of connections in the pool. Default: 250 connections.",
3001 key: :connect_timeout,
3003 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3007 key: :reclaim_multiplier,
3010 "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",
3019 description: "Advanced settings for `Gun` workers pools",
3021 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3025 description: "Settings for #{pool_name} pool.",
3030 description: "Maximum number of concurrent requests in the pool.",
3037 "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",
3043 description: "Timeout for the pool while gun will wait for response",
3044 suggestions: [10_000]
3052 key: :hackney_pools,
3054 description: "Advanced settings for `Hackney` connections pools",
3059 description: "Settings for federation pool.",
3062 key: :max_connections,
3064 description: "Number workers in the pool.",
3070 description: "Timeout while `hackney` will wait for response.",
3071 suggestions: [150_000]
3078 description: "Settings for media pool.",
3081 key: :max_connections,
3083 description: "Number workers in the pool.",
3089 description: "Timeout while `hackney` will wait for response.",
3090 suggestions: [150_000]
3097 description: "Settings for upload pool.",
3100 key: :max_connections,
3102 description: "Number workers in the pool.",
3108 description: "Timeout while `hackney` will wait for response.",
3109 suggestions: [300_000]
3117 key: :restrict_unauthenticated,
3118 label: "Restrict Unauthenticated",
3121 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3126 description: "Settings for public and federated timelines.",
3131 description: "Disallow view public timeline."
3136 description: "Disallow view federated timeline."
3143 description: "Settings for user profiles.",
3148 description: "Disallow view local user profiles."
3153 description: "Disallow view remote user profiles."
3160 description: "Settings for statuses.",
3165 description: "Disallow view local statuses."
3170 description: "Disallow view remote statuses."
3178 key: Pleroma.Web.ApiSpec.CastAndValidate,
3185 "Enables strict input validation (useful in development, not recommended in production)"
3191 key: :instances_favicons,
3193 description: "Control favicons for instances",
3198 description: "Allow/disallow displaying and getting instances favicons"
3206 descriptions: "S3 service related settings",
3209 key: :access_key_id,
3211 description: "S3 access key ID",
3212 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3215 key: :secret_access_key,
3217 description: "Secret access key",
3218 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3223 description: "S3 host",
3224 suggestions: ["s3.eu-central-1.amazonaws.com"]
3232 description: "Installed frontends management",
3237 description: "Primary frontend, the one that is served for all pages by default",
3238 children: installed_frontend_options
3243 description: "Admin frontend",
3244 children: installed_frontend_options
3250 "A map containing available frontends and parameters for their installation.",
3251 children: frontend_options
3257 key: Pleroma.Web.Preload,
3259 description: "Preload-related settings",
3263 type: {:list, :module},
3264 description: "List of preload providers to enable",
3266 Pleroma.Web.Preload.Providers.Instance,
3267 Pleroma.Web.Preload.Providers.User,
3268 Pleroma.Web.Preload.Providers.Timelines,
3269 Pleroma.Web.Preload.Providers.StatusNet
3278 description: "Majic/libmagic configuration",
3283 description: "Number of majic workers to start.",
3290 key: Pleroma.User.Backup,
3292 description: "Account Backup",
3295 key: :purge_after_days,
3297 description: "Remove backup achives after N days",
3303 description: "Limit user to export not more often than once per N days",
3310 key: Pleroma.Web.Endpoint.MetricsExporter,
3312 description: "Prometheus app metrics endpoint configuration",
3317 description: "[Pleroma extension] Enables app metrics endpoint."
3321 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3323 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3327 type: [:boolean, :tuple],
3328 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3329 suggestion: [false, {:basic, "myusername", "mypassword"}]
3334 description: "App metrics endpoint URI path.",
3335 suggestions: ["/api/pleroma/app_metrics"]
3340 description: "App metrics endpoint output format.",
3341 suggestions: [:text, :protobuf]