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)",
223 Swoosh.Adapters.SMTP,
224 Swoosh.Adapters.Sendgrid,
225 Swoosh.Adapters.Sendmail,
226 Swoosh.Adapters.Mandrill,
227 Swoosh.Adapters.Mailgun,
228 Swoosh.Adapters.Mailjet,
229 Swoosh.Adapters.Postmark,
230 Swoosh.Adapters.SparkPost,
231 Swoosh.Adapters.AmazonSES,
233 Swoosh.Adapters.SocketLabs,
234 Swoosh.Adapters.Gmail
240 description: "Allow/disallow send emails"
243 group: {:subgroup, Swoosh.Adapters.SMTP},
246 description: "Hostname or IP address",
247 suggestions: ["smtp.example.com"]
250 group: {:subgroup, Swoosh.Adapters.SMTP},
253 description: "SMTP port"
256 group: {:subgroup, Swoosh.Adapters.SMTP},
259 description: "SMTP auth username",
260 suggestions: ["user@example.com"]
263 group: {:subgroup, Swoosh.Adapters.SMTP},
266 description: "SMTP auth password",
267 suggestions: ["password"]
270 group: {:subgroup, Swoosh.Adapters.SMTP},
274 description: "Use implicit SSL/TLS: e.g., port 465",
277 group: {:subgroup, Swoosh.Adapters.SMTP},
280 type: {:dropdown, :atom},
281 description: "Explicit TLS (STARTTLS) mode",
282 suggestions: [:if_available, :always, :never]
285 group: {:subgroup, Swoosh.Adapters.SMTP},
287 type: {:dropdown, :atom},
288 description: "SMTP authentication mode",
289 suggestions: [:if_available, :always, :never]
292 group: {:subgroup, Swoosh.Adapters.SMTP},
295 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
299 group: {:subgroup, Swoosh.Adapters.SMTP},
301 label: "No MX lookups",
303 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
306 group: {:subgroup, Swoosh.Adapters.Sendgrid},
310 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
311 suggestions: ["my-api-key"]
314 group: {:subgroup, Swoosh.Adapters.Sendmail},
317 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
318 suggestions: ["/usr/bin/sendmail"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
324 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
325 suggestions: ["-N delay,failure,success"]
328 group: {:subgroup, Swoosh.Adapters.Sendmail},
331 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
334 group: {:subgroup, Swoosh.Adapters.Mandrill},
338 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
339 suggestions: ["my-api-key"]
342 group: {:subgroup, Swoosh.Adapters.Mailgun},
346 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
347 suggestions: ["my-api-key"]
350 group: {:subgroup, Swoosh.Adapters.Mailgun},
353 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
354 suggestions: ["pleroma.com"]
357 group: {:subgroup, Swoosh.Adapters.Mailjet},
361 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
362 suggestions: ["my-api-key"]
365 group: {:subgroup, Swoosh.Adapters.Mailjet},
368 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
369 suggestions: ["my-secret-key"]
372 group: {:subgroup, Swoosh.Adapters.Postmark},
376 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
377 suggestions: ["my-api-key"]
380 group: {:subgroup, Swoosh.Adapters.SparkPost},
384 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
385 suggestions: ["my-api-key"]
388 group: {:subgroup, Swoosh.Adapters.SparkPost},
391 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
392 suggestions: ["https://api.sparkpost.com/api/v1"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
398 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.AmazonSES},
405 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
406 suggestions: ["aws-access-key"]
409 group: {:subgroup, Swoosh.Adapters.AmazonSES},
412 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
413 suggestions: ["aws-secret-key"]
416 group: {:subgroup, Swoosh.Adapters.Dyn},
420 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
421 suggestions: ["my-api-key"]
424 group: {:subgroup, Swoosh.Adapters.SocketLabs},
427 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
430 group: {:subgroup, Swoosh.Adapters.SocketLabs},
434 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
437 group: {:subgroup, Swoosh.Adapters.Gmail},
440 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
447 description: "`Swoosh.Adapters.Local` adapter specific settings",
450 group: {:subgroup, Swoosh.Adapters.Local},
453 description: "Run the preview server together as part of your app"
456 group: {:subgroup, Swoosh.Adapters.Local},
459 description: "The preview server port",
467 label: "URI Schemes",
469 description: "URI schemes related settings",
473 type: {:list, :string},
474 description: "List of the scheme part that is considered valid to be an URL",
499 description: "Instance-related settings",
504 description: "Name of the instance",
511 label: "Admin Email Address",
513 description: "Email used to reach an Administrator/Moderator of the instance",
520 label: "Sender Email Address",
522 description: "Envelope FROM address for mail sent via Pleroma",
531 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
539 description: "Posts character limit (CW/Subject included in the counter)",
547 description: "Character limit of the instance chat messages",
555 description: "Hard character limit beyond which remote posts will be dropped",
563 description: "File size limit of uploads (except for avatar, background, banner)",
569 key: :avatar_upload_limit,
571 description: "File size limit of user's profile avatars",
577 key: :background_upload_limit,
579 description: "File size limit of user's profile backgrounds",
585 key: :banner_upload_limit,
587 description: "File size limit of user's profile banners",
595 description: "A map with poll limits for local polls",
599 max_option_chars: 200,
601 max_expiration: 31_536_000
608 description: "Maximum number of options",
612 key: :max_option_chars,
614 description: "Maximum number of characters per option",
618 key: :min_expiration,
620 description: "Minimum expiration time (in seconds)",
624 key: :max_expiration,
626 description: "Maximum expiration time (in seconds)",
632 key: :registrations_open,
635 "Enable registrations for anyone. Invitations require this setting to be disabled."
638 key: :invites_enabled,
641 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
644 key: :account_activation_required,
646 description: "Require users to confirm their emails before signing in"
649 key: :account_approval_required,
651 description: "Require users to be manually approved by an admin before signing in"
656 description: "Enable federation with other instances"
659 key: :federation_incoming_replies_max_depth,
660 label: "Fed. incoming replies max depth",
663 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
664 " 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.",
670 key: :federation_reachability_timeout_days,
671 label: "Fed. reachability timeout days",
674 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
682 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
688 "Makes the client API in authenticated mode-only except for user-profiles." <>
689 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
690 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
693 key: :quarantined_instances,
694 type: {:list, :string},
696 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
705 description: "Instance static directory",
711 key: :allowed_post_formats,
712 type: {:list, :string},
713 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
722 key: :extended_nickname_format,
725 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
726 " This will break federation with older software for theses nicknames."
729 key: :cleanup_attachments,
732 Enable to remove associated attachments when status is removed.
733 This will not affect duplicates and attachments without status.
734 Enabling this will increase load to database when deleting statuses on larger instances.
738 key: :max_pinned_statuses,
740 description: "The maximum number of pinned statuses. 0 will disable the feature.",
748 key: :autofollowed_nicknames,
749 type: {:list, :string},
751 "Set to nicknames of (local) users that every new user should automatically follow"
754 key: :autofollowing_nicknames,
755 type: {:list, :string},
757 "Set to nicknames of (local) users that automatically follows every newly registered user"
760 key: :attachment_links,
762 description: "Enable to automatically add attachment link text to statuses"
765 key: :max_report_comment_size,
767 description: "The maximum size of the report comment. Default: 1000.",
773 key: :safe_dm_mentions,
774 label: "Safe DM mentions",
777 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
778 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
784 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
787 key: :remote_post_retention_days,
790 "The default amount of days to retain remote posts when pruning the database",
796 key: :user_bio_length,
798 description: "A user bio maximum length. Default: 5000.",
804 key: :user_name_length,
806 description: "A user name maximum length. Default: 100.",
812 key: :skip_thread_containment,
814 description: "Skip filtering out broken threads. Default: enabled."
817 key: :limit_to_local_content,
818 type: {:dropdown, :atom},
820 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
828 key: :max_account_fields,
830 description: "The maximum number of custom fields in the user profile. Default: 10.",
836 key: :max_remote_account_fields,
839 "The maximum number of custom fields in the remote user profile. Default: 20.",
845 key: :account_field_name_length,
847 description: "An account field name maximum length. Default: 512.",
853 key: :account_field_value_length,
855 description: "An account field value maximum length. Default: 2048.",
861 key: :registration_reason_length,
863 description: "Maximum registration reason length. Default: 500.",
869 key: :external_user_synchronization,
871 description: "Enabling following/followers counters synchronization for external users"
874 key: :multi_factor_authentication,
876 description: "Multi-factor authentication settings",
879 totp: [digits: 6, period: 30],
880 backup_codes: [number: 5, length: 16]
886 label: "TOTP settings",
888 description: "TOTP settings",
889 suggestions: [digits: 6, period: 30],
896 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
903 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
910 description: "MFA backup codes settings",
911 suggestions: [number: 5, length: 16],
917 description: "Number of backup codes to generate."
924 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
931 key: :instance_thumbnail,
932 type: {:string, :image},
934 "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.",
935 suggestions: ["/instance/thumbnail.jpeg"]
938 key: :show_reactions,
940 description: "Let favourites and emoji reactions be viewed through the API."
948 description: "Welcome messages settings",
951 key: :direct_message,
953 descpiption: "Direct message settings",
958 description: "Enables sending a direct message to newly registered users"
963 description: "A message that will be sent to newly registered users",
965 "Hi, @username! Welcome on board!"
969 key: :sender_nickname,
971 description: "The nickname of the local user that sends a welcome message",
981 descpiption: "Chat message settings",
986 description: "Enables sending a chat message to newly registered users"
992 "A message that will be sent to newly registered users as a chat message",
994 "Hello, welcome on board!"
998 key: :sender_nickname,
1000 description: "The nickname of the local user that sends a welcome chat message",
1010 descpiption: "Email message settings",
1015 description: "Enables sending an email to newly registered users"
1019 type: [:string, :tuple],
1021 "Email address and/or nickname that will be used to send the welcome email.",
1023 {"Pleroma App", "welcome@pleroma.app"}
1030 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1031 suggestions: ["Welcome to <%= instance_name%>"]
1037 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1038 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1044 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1045 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1054 description: "Logger-related settings",
1058 type: [:atom, :tuple, :module],
1060 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1061 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1069 label: "ExSyslogger",
1070 description: "ExSyslogger-related settings",
1074 type: {:dropdown, :atom},
1075 description: "Log level",
1076 suggestions: [:debug, :info, :warn, :error]
1082 "A string that's prepended to every message, and is typically set to the app name",
1083 suggestions: ["pleroma"]
1088 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1089 suggestions: ["$metadata[$level] $message"]
1093 type: {:list, :atom},
1094 suggestions: [:request_id]
1102 label: "Console Logger",
1103 description: "Console logger settings",
1107 type: {:dropdown, :atom},
1108 description: "Log level",
1109 suggestions: [:debug, :info, :warn, :error]
1114 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1115 suggestions: ["$metadata[$level] $message"]
1119 type: {:list, :atom},
1120 suggestions: [:request_id]
1127 label: "Quack Logger",
1128 description: "Quack-related settings",
1132 type: {:dropdown, :atom},
1133 description: "Log level",
1134 suggestions: [:debug, :info, :warn, :error]
1138 type: {:list, :atom},
1139 description: "Configure which metadata you want to report on",
1156 label: "Webhook URL",
1158 description: "Configure the Slack incoming webhook",
1159 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1165 key: :frontend_configurations,
1168 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1169 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1170 "add your own configuration your settings all fields must be complete.",
1174 label: "Pleroma FE",
1176 description: "Settings for Pleroma FE",
1179 alwaysShowSubjectInput: true,
1180 background: "/static/aurora_borealis.jpg",
1181 collapseMessageWithSubject: false,
1184 hideFilteredStatuses: false,
1185 hideMutedPosts: false,
1186 hidePostStats: false,
1187 hideSitename: false,
1188 hideUserStats: false,
1189 loginMethod: "password",
1190 logo: "/static/logo.svg",
1193 minimalScopesMode: false,
1194 noAttachmentLinks: false,
1195 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1196 postContentType: "text/plain",
1197 redirectRootLogin: "/main/friends",
1198 redirectRootNoLogin: "/main/all",
1200 sidebarRight: false,
1201 showFeaturesPanel: true,
1202 showInstanceSpecificPanel: false,
1203 subjectLineBehavior: "email",
1204 theme: "pleroma-dark",
1205 webPushNotifications: false
1210 key: :alwaysShowSubjectInput,
1211 label: "Always show subject input",
1213 description: "When disabled, auto-hide the subject field if it's empty"
1217 type: {:string, :image},
1219 "URL of the background, unless viewing a user profile with a background that is set",
1220 suggestions: ["/images/city.jpg"]
1223 key: :collapseMessageWithSubject,
1224 label: "Collapse message with subject",
1227 "When a message has a subject (aka Content Warning), collapse it by default"
1231 label: "PleromaFE Chat",
1233 description: "Disables PleromaFE Chat component"
1239 description: "Enables green text on lines prefixed with the > character"
1242 key: :hideFilteredStatuses,
1243 label: "Hide Filtered Statuses",
1245 description: "Hides filtered statuses from timelines"
1248 key: :hideMutedPosts,
1249 label: "Hide Muted Posts",
1251 description: "Hides muted statuses from timelines"
1254 key: :hidePostStats,
1255 label: "Hide post stats",
1257 description: "Hide notices statistics (repeats, favorites, ...)"
1261 label: "Hide Sitename",
1263 description: "Hides instance name from PleromaFE banner"
1266 key: :hideUserStats,
1267 label: "Hide user stats",
1270 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1274 type: {:string, :image},
1275 description: "URL of the logo, defaults to Pleroma's logo",
1276 suggestions: ["/static/logo.svg"]
1280 label: "Logo margin",
1283 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1284 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1285 suggestions: [".1em"]
1292 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1293 "If you want a colorful logo you must disable logoMask."
1296 key: :minimalScopesMode,
1297 label: "Minimal scopes mode",
1300 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1301 "Also prevents replying to a DM with a public post from PleromaFE."
1304 key: :nsfwCensorImage,
1305 label: "NSFW Censor Image",
1306 type: {:string, :image},
1308 "URL of the image to use for hiding NSFW media attachments in the timeline",
1309 suggestions: ["/static/img/nsfw.74818f9.png"]
1312 key: :postContentType,
1313 label: "Post Content Type",
1314 type: {:dropdown, :atom},
1315 description: "Default post formatting option",
1316 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1319 key: :redirectRootNoLogin,
1320 label: "Redirect root no login",
1323 "Relative URL which indicates where to redirect when a user isn't logged in",
1324 suggestions: ["/main/all"]
1327 key: :redirectRootLogin,
1328 label: "Redirect root login",
1331 "Relative URL which indicates where to redirect when a user is logged in",
1332 suggestions: ["/main/friends"]
1336 label: "Scope copy",
1338 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1342 label: "Sidebar on Right",
1344 description: "Change alignment of sidebar and panels to the right"
1347 key: :showFeaturesPanel,
1348 label: "Show instance features panel",
1351 "Enables panel displaying functionality of the instance on the About page"
1354 key: :showInstanceSpecificPanel,
1355 label: "Show instance specific panel",
1357 description: "Whether to show the instance's custom panel"
1360 key: :subjectLineBehavior,
1361 label: "Subject line behavior",
1363 description: "Allows changing the default behaviour of subject lines in replies.
1364 `email`: copy and preprend re:, as in email,
1365 `masto`: copy verbatim, as in Mastodon,
1366 `noop`: don't copy the subject.",
1367 suggestions: ["email", "masto", "noop"]
1372 description: "Which theme to use. Available themes are defined in styles.json",
1373 suggestions: ["pleroma-dark"]
1381 description: "Settings for Masto FE",
1384 showInstanceSpecificPanel: true
1389 key: :showInstanceSpecificPanel,
1390 label: "Show instance specific panel",
1392 description: "Whenether to show the instance's specific panel"
1403 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1407 type: {:keyword, :map},
1409 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1412 url: "/images/pleroma-fox-tan-smol.png",
1413 mime_type: "image/png"
1415 pleroma_fox_tan_shy: %{
1416 url: "/images/pleroma-fox-tan-shy.png",
1417 mime_type: "image/png"
1422 key: :default_mascot,
1425 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1431 key: :default_user_avatar,
1432 type: {:string, :image},
1433 description: "URL of the default user avatar",
1434 suggestions: ["/images/avi.png"]
1443 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1447 type: {:list, :map},
1448 description: "Describe the icons of the app",
1451 src: "/static/logo.png"
1454 src: "/static/icon.png",
1458 src: "/static/icon.ico",
1459 sizes: "72x72 96x96 128x128 256x256"
1466 description: "Describe the theme color of the app",
1467 suggestions: ["#282c37", "mediumpurple"]
1470 key: :background_color,
1472 description: "Describe the background color of the app",
1473 suggestions: ["#191b22", "aliceblue"]
1481 description: "Media proxy",
1486 description: "Enables proxying of remote media via the instance's proxy"
1493 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1494 suggestions: ["https://example.com"]
1502 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1508 description: "Enables media cache object invalidation."
1513 description: "Module which will be used to purge objects from the cache.",
1515 Pleroma.Web.MediaProxy.Invalidation.Script,
1516 Pleroma.Web.MediaProxy.Invalidation.Http
1523 label: "Advanced MediaProxy Options",
1525 description: "Internal Pleroma.ReverseProxy settings",
1527 redirect_on_failure: false,
1528 max_body_length: 25 * 1_048_576,
1529 max_read_duration: 30_000
1533 key: :redirect_on_failure,
1536 Redirects the client to the origin server upon encountering HTTP errors.\n
1537 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1538 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1539 IP addresses of your users to the other servers, bypassing the MediaProxy.
1543 key: :max_body_length,
1545 description: "Maximum file size allowed through the Pleroma MediaProxy cache."
1548 key: :max_read_duration,
1550 description: "Timeout (in milliseconds) of GET request to the remote URI."
1556 type: {:list, :string},
1557 description: "List of hosts with scheme to bypass the MediaProxy",
1558 suggestions: ["http://example.com"]
1564 key: :media_preview_proxy,
1566 description: "Media preview proxy",
1572 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1575 key: :thumbnail_max_width,
1578 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1581 key: :thumbnail_max_height,
1584 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1587 key: :image_quality,
1589 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1592 key: :min_content_length,
1595 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1601 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1603 description: "HTTP invalidate settings",
1608 description: "HTTP method of request. Default: :purge"
1612 type: {:keyword, :string},
1613 description: "HTTP headers of request",
1614 suggestions: [{"x-refresh", 1}]
1619 description: "Request options",
1623 type: {:map, :string}
1631 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1633 description: "Invalidation script settings",
1638 description: "Path to executable script which will purge cached items.",
1639 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1645 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1646 suggestions: [":htcacheclean"]
1654 description: "Gopher settings",
1659 description: "Enables the gopher interface"
1665 description: "IP address to bind to",
1666 suggestions: [{0, 0, 0, 0}]
1671 description: "Port to bind to",
1677 description: "Port advertised in URLs (optional, defaults to port)",
1685 label: "ActivityPub",
1687 description: "ActivityPub-related settings",
1690 key: :unfollow_blocked,
1692 description: "Whether blocks result in people getting unfollowed"
1695 key: :outgoing_blocks,
1697 description: "Whether to federate blocks to other instances"
1700 key: :sign_object_fetches,
1702 description: "Sign object fetches with HTTP signatures"
1705 key: :note_replies_output_limit,
1708 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1711 key: :follow_handshake_timeout,
1713 description: "Following handshake timeout",
1720 key: :http_security,
1721 label: "HTTP security",
1723 description: "HTTP security settings",
1728 description: "Whether the managed content security policy is enabled"
1734 description: "Whether to additionally send a Strict-Transport-Security header"
1738 label: "STS max age",
1740 description: "The maximum age for the Strict-Transport-Security header if sent",
1741 suggestions: [31_536_000]
1745 label: "CT max age",
1747 description: "The maximum age for the Expect-CT header if sent",
1748 suggestions: [2_592_000]
1751 key: :referrer_policy,
1753 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1754 suggestions: ["same-origin", "no-referrer"]
1758 label: "Report URI",
1760 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1761 suggestions: ["https://example.com/report-uri"]
1766 group: :web_push_encryption,
1767 key: :vapid_details,
1768 label: "Vapid Details",
1771 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1777 "A mailto link for the administrative contact." <>
1778 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1779 suggestions: ["mailto:moderators@pleroma.com"]
1784 description: "VAPID public key",
1785 suggestions: ["Public key"]
1790 description: "VAPID private key",
1791 suggestions: ["Private key"]
1797 key: Pleroma.Captcha,
1799 description: "Captcha-related settings",
1804 description: "Whether the captcha should be shown on registration"
1809 description: "The method/service to use for captcha",
1810 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1813 key: :seconds_valid,
1815 description: "The time in seconds for which the captcha is valid",
1822 key: Pleroma.Captcha.Kocaptcha,
1825 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1826 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1831 description: "The kocaptcha endpoint to use",
1832 suggestions: ["https://captcha.kotobank.ch"]
1838 label: "Pleroma Admin Token",
1841 "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)",
1846 description: "Admin token",
1848 "Please use a high entropy string or UUID"
1858 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1862 type: {:dropdown, :atom},
1863 description: "Logs verbose mode",
1864 suggestions: [false, :error, :warn, :info, :debug]
1868 type: {:keyword, :integer},
1870 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1872 activity_expiration: 10,
1873 attachments_cleanup: 5,
1875 federator_incoming: 50,
1876 federator_outgoing: 50,
1878 scheduled_activities: 10,
1884 key: :activity_expiration,
1886 description: "Activity expiration queue",
1892 description: "Backup queue",
1896 key: :attachments_cleanup,
1898 description: "Attachment deletion queue",
1904 description: "Background queue",
1908 key: :federator_incoming,
1910 description: "Incoming federation queue",
1914 key: :federator_outgoing,
1916 description: "Outgoing federation queue",
1922 description: "Email sender queue, see Pleroma.Emails.Mailer",
1926 key: :scheduled_activities,
1928 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1932 key: :transmogrifier,
1934 description: "Transmogrifier queue",
1940 description: "Web push notifications queue",
1947 type: {:list, :tuple},
1948 description: "Settings for cron background jobs",
1950 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1951 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1960 description: "Includes custom worker options not interpretable directly by `Oban`",
1964 type: {:keyword, :integer},
1965 description: "Max retry attempts for failed jobs, per `Oban` queue",
1967 federator_incoming: 5,
1968 federator_outgoing: 5
1975 key: Pleroma.Web.Metadata,
1977 description: "Metadata-related settings",
1981 type: {:list, :module},
1982 description: "List of metadata providers to enable",
1984 Pleroma.Web.Metadata.Providers.OpenGraph,
1985 Pleroma.Web.Metadata.Providers.TwitterCard,
1986 Pleroma.Web.Metadata.Providers.RelMe,
1987 Pleroma.Web.Metadata.Providers.Feed
1992 label: "Unfurl NSFW",
1994 description: "When enabled NSFW attachments will be shown in previews"
2003 "If enabled the instance will parse metadata from attached links to generate link previews",
2008 description: "Enables RichMedia parsing of URLs"
2012 type: {:list, :string},
2013 description: "List of hosts which will be ignored by the metadata parser",
2014 suggestions: ["accounts.google.com", "xss.website"]
2018 label: "Ignore TLD",
2019 type: {:list, :string},
2020 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2021 suggestions: ["local", "localdomain", "lan"]
2025 type: {:list, :module},
2027 "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.",
2029 Pleroma.Web.RichMedia.Parsers.OEmbed,
2030 Pleroma.Web.RichMedia.Parsers.TwitterCard
2035 label: "TTL setters",
2036 type: {:list, :module},
2038 "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.",
2040 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2044 key: :failure_backoff,
2047 "Amount of milliseconds after request failure, during which the request will not be retried.",
2048 suggestions: [60_000]
2054 key: Pleroma.Formatter,
2058 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2062 type: [:string, :boolean],
2063 description: "Specify the class to be added to the generated link. Disable to clear.",
2064 suggestions: ["auto-linker", false]
2068 type: [:string, :boolean],
2069 description: "Override the rel attribute. Disable to clear.",
2070 suggestions: ["ugc", "noopener noreferrer", false]
2075 description: "Link URLs will open in a new window/tab."
2079 type: [:integer, :boolean],
2081 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2082 suggestions: [15, false]
2087 description: "Strip the scheme prefix."
2092 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2096 type: [:atom, :boolean],
2098 "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)",
2099 suggestions: [:no_scheme, true]
2105 key: Pleroma.ScheduledActivity,
2107 description: "Scheduled activities settings",
2110 key: :daily_user_limit,
2113 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2117 key: :total_user_limit,
2120 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2126 description: "Whether scheduled activities are sent to the job queue to be executed"
2132 key: Pleroma.Workers.PurgeExpiredActivity,
2134 description: "Expired activities settings",
2139 description: "Enables expired activities addition & deletion"
2144 description: "Minimum lifetime for ephemeral activity (in seconds)",
2151 label: "Pleroma Authenticator",
2153 description: "Authenticator",
2156 key: Pleroma.Web.Auth.Authenticator,
2158 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2168 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2169 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2170 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2171 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2176 description: "Enables LDAP authentication"
2181 description: "LDAP server hostname",
2182 suggestions: ["localhosts"]
2187 description: "LDAP port, e.g. 389 or 636",
2188 suggestions: [389, 636]
2194 description: "Enable to use SSL, usually implies the port 636"
2198 label: "SSL options",
2200 description: "Additional SSL options",
2201 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2206 description: "Path to file with PEM encoded cacerts",
2207 suggestions: ["path/to/file/with/PEM/cacerts"]
2212 description: "Type of cert verification",
2213 suggestions: [:verify_peer]
2221 description: "Enable to use STARTTLS, usually implies the port 389"
2225 label: "TLS options",
2227 description: "Additional TLS options",
2228 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2233 description: "Path to file with PEM encoded cacerts",
2234 suggestions: ["path/to/file/with/PEM/cacerts"]
2239 description: "Type of cert verification",
2240 suggestions: [:verify_peer]
2247 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2248 suggestions: ["dc=example,dc=com"]
2255 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2264 description: "Authentication / authorization settings",
2267 key: :enforce_oauth_admin_scope_usage,
2268 label: "Enforce OAuth admin scope usage",
2271 "OAuth admin scope requirement toggle. " <>
2272 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2273 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2274 "`is_admin` user flag grants access to admin-specific actions."
2277 key: :auth_template,
2280 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2281 suggestions: ["show.html"]
2284 key: :oauth_consumer_template,
2285 label: "OAuth consumer template",
2288 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2289 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2290 suggestions: ["consumer.html"]
2293 key: :oauth_consumer_strategies,
2294 label: "OAuth consumer strategies",
2295 type: {:list, :string},
2297 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2298 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2299 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2300 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2306 key: :email_notifications,
2308 description: "Email notifications settings",
2314 "emails of \"what you've missed\" for users who have been inactive for a while",
2318 schedule: "0 0 * * 0",
2320 inactivity_threshold: 7
2328 description: "Globally enable or disable digest emails"
2334 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2335 suggestions: ["0 0 * * 0"]
2340 description: "Minimum interval between digest emails to one user",
2344 key: :inactivity_threshold,
2346 description: "Minimum user inactivity threshold",
2355 key: Pleroma.Emails.UserEmail,
2357 description: "Email template settings",
2361 type: {:string, :image},
2362 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2363 suggestions: ["some/path/logo.png"]
2368 description: "A map with color settings for email templates.",
2371 link_color: "#d8a070",
2372 background_color: "#2C3645",
2373 content_background_color: "#1B2635",
2374 header_color: "#d8a070",
2375 text_color: "#b9b9ba",
2376 text_muted_color: "#b9b9ba"
2383 suggestions: ["#d8a070"]
2386 key: :background_color,
2388 suggestions: ["#2C3645"]
2391 key: :content_background_color,
2393 suggestions: ["#1B2635"]
2398 suggestions: ["#d8a070"]
2403 suggestions: ["#b9b9ba"]
2406 key: :text_muted_color,
2408 suggestions: ["#b9b9ba"]
2416 key: Pleroma.Emails.NewUsersDigestEmail,
2418 description: "New users admin email digest",
2423 description: "Enables new users admin digest email when `true`"
2432 description: "Configure OAuth 2 provider capabilities",
2435 key: :token_expires_in,
2437 description: "The lifetime in seconds of the access token",
2438 suggestions: [2_592_000]
2441 key: :issue_new_refresh_token,
2444 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2447 key: :clean_expired_tokens,
2449 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2459 key: :shortcode_globs,
2460 type: {:list, :string},
2461 description: "Location of custom emoji files. * can be used as a wildcard.",
2462 suggestions: ["/emoji/custom/**/*.png"]
2465 key: :pack_extensions,
2466 type: {:list, :string},
2468 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2469 suggestions: [".png", ".gif"]
2473 type: {:keyword, {:list, :string}},
2475 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2476 " and the value is the location or array of locations. * can be used as a wildcard.",
2478 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2482 key: :default_manifest,
2485 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2486 " Currently only one manifest can be added (no arrays).",
2487 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2490 key: :shared_pack_cache_seconds_per_file,
2491 label: "Shared pack cache s/file",
2494 "When an emoji pack is shared, the archive is created and cached in memory" <>
2495 " for this amount of seconds multiplied by the number of files.",
2505 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2509 type: [:tuple, {:list, :tuple}],
2510 description: "For the search requests (account & status search etc.)",
2511 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2515 type: [:tuple, {:list, :tuple}],
2516 description: "For requests to timelines (each timeline has it's own limiter)",
2517 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2520 key: :app_account_creation,
2521 type: [:tuple, {:list, :tuple}],
2522 description: "For registering user accounts from the same IP address",
2523 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2526 key: :relations_actions,
2527 type: [:tuple, {:list, :tuple}],
2528 description: "For actions on relationships with all users (follow, unfollow)",
2529 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2532 key: :relation_id_action,
2533 label: "Relation ID action",
2534 type: [:tuple, {:list, :tuple}],
2535 description: "For actions on relation with a specific user (follow, unfollow)",
2536 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2539 key: :statuses_actions,
2540 type: [:tuple, {:list, :tuple}],
2542 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2543 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2546 key: :status_id_action,
2547 label: "Status ID action",
2548 type: [:tuple, {:list, :tuple}],
2550 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2551 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2554 key: :authentication,
2555 type: [:tuple, {:list, :tuple}],
2556 description: "For authentication create / password check / user existence check requests",
2557 suggestions: [{60_000, 15}]
2566 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2567 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2572 description: "Enables SSH"
2577 description: "Dir with SSH keys",
2578 suggestions: ["/some/path/ssh_keys"]
2583 description: "Handler module",
2584 suggestions: ["Pleroma.BBS.Handler"]
2589 description: "Port to connect",
2590 suggestions: [10_022]
2593 key: :password_authenticator,
2595 description: "Authenticator module",
2596 suggestions: ["Pleroma.BBS.Authenticator"]
2602 label: "Mime Types",
2604 description: "Mime Types settings",
2611 "application/xml" => ["xml"],
2612 "application/xrd+xml" => ["xrd+xml"],
2613 "application/jrd+json" => ["jrd+json"],
2614 "application/activity+json" => ["activity+json"],
2615 "application/ld+json" => ["activity+json"]
2620 key: "application/xml",
2621 type: {:list, :string},
2622 suggestions: ["xml"]
2625 key: "application/xrd+xml",
2626 type: {:list, :string},
2627 suggestions: ["xrd+xml"]
2630 key: "application/jrd+json",
2631 type: {:list, :string},
2632 suggestions: ["jrd+json"]
2635 key: "application/activity+json",
2636 type: {:list, :string},
2637 suggestions: ["activity+json"]
2640 key: "application/ld+json",
2641 type: {:list, :string},
2642 suggestions: ["activity+json"]
2652 description: "Pleroma chat settings",
2665 description: "HTTP settings",
2670 type: [:string, :tuple],
2671 description: "Proxy URL",
2672 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2675 key: :send_user_agent,
2680 type: [:string, :atom],
2682 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2683 suggestions: ["Pleroma", :default]
2688 description: "Adapter specific options",
2694 label: "SSL Options",
2695 description: "SSL options for HTTP adapter",
2699 type: {:list, :atom},
2700 description: "List of TLS version to use",
2701 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2712 label: "Markup Settings",
2716 key: :allow_inline_images,
2720 key: :allow_headings,
2733 type: {:list, :module},
2735 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2736 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2746 key: :deny_follow_blocked,
2757 key: :restricted_nicknames,
2758 type: {:list, :string},
2759 description: "List of nicknames users may not register with.",
2778 "ostatus_subscribe",
2794 key: :email_blacklist,
2795 type: {:list, :string},
2796 description: "List of email domains users may not register with.",
2797 suggestions: ["mailinator.com", "maildrop.cc"]
2803 label: "CORS plug config",
2809 suggestions: [86_400]
2813 type: {:list, :string},
2814 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2818 type: {:list, :string},
2821 "X-RateLimit-Reset",
2822 "X-RateLimit-Limit",
2823 "X-RateLimit-Remaining",
2834 type: {:list, :string},
2835 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2841 key: Pleroma.Web.Plugs.RemoteIp,
2844 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2845 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2851 description: "Enable/disable the plug. Default: disabled."
2855 type: {:list, :string},
2857 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2862 type: {:list, :string},
2864 "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."
2868 type: {:list, :string},
2870 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"]`
2877 key: :web_cache_ttl,
2878 label: "Web cache TTL",
2881 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2887 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2888 suggestions: [30_000, nil]
2891 key: :activity_pub_question,
2893 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2894 suggestions: [30_000]
2904 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2909 description: "Enables the rendering of static HTML. Default: disabled."
2917 description: "Configure feed rendering",
2922 description: "Configure title rendering",
2927 description: "Maximum number of characters before truncating title",
2933 description: "Replacement which will be used after truncating string",
2934 suggestions: ["..."]
2944 description: "Custom Runtime Modules",
2949 description: "A path to custom Elixir modules (such as MRF policies)."
2957 description: "Settings for notifications streamer",
2962 description: "Number of workers to send notifications",
2966 key: :overflow_workers,
2968 description: "Maximum number of workers created if pool is empty",
2975 key: :connections_pool,
2977 description: "Advanced settings for `Gun` connections pool",
2980 key: :connection_acquisition_wait,
2983 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2987 key: :connection_acquisition_retries,
2990 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2994 key: :max_connections,
2996 description: "Maximum number of connections in the pool. Default: 250 connections.",
3000 key: :connect_timeout,
3002 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3006 key: :reclaim_multiplier,
3009 "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",
3018 description: "Advanced settings for `Gun` workers pools",
3020 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3024 description: "Settings for #{pool_name} pool.",
3029 description: "Maximum number of concurrent requests in the pool.",
3036 "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",
3042 description: "Timeout for the pool while gun will wait for response",
3043 suggestions: [10_000]
3051 key: :hackney_pools,
3053 description: "Advanced settings for `Hackney` connections pools",
3058 description: "Settings for federation pool.",
3061 key: :max_connections,
3063 description: "Number workers in the pool.",
3069 description: "Timeout while `hackney` will wait for response.",
3070 suggestions: [150_000]
3077 description: "Settings for media pool.",
3080 key: :max_connections,
3082 description: "Number workers in the pool.",
3088 description: "Timeout while `hackney` will wait for response.",
3089 suggestions: [150_000]
3096 description: "Settings for upload pool.",
3099 key: :max_connections,
3101 description: "Number workers in the pool.",
3107 description: "Timeout while `hackney` will wait for response.",
3108 suggestions: [300_000]
3116 key: :restrict_unauthenticated,
3117 label: "Restrict Unauthenticated",
3120 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3125 description: "Settings for public and federated timelines.",
3130 description: "Disallow view public timeline."
3135 description: "Disallow view federated timeline."
3142 description: "Settings for user profiles.",
3147 description: "Disallow view local user profiles."
3152 description: "Disallow view remote user profiles."
3159 description: "Settings for statuses.",
3164 description: "Disallow view local statuses."
3169 description: "Disallow view remote statuses."
3177 key: Pleroma.Web.ApiSpec.CastAndValidate,
3184 "Enables strict input validation (useful in development, not recommended in production)"
3190 key: :instances_favicons,
3192 description: "Control favicons for instances",
3197 description: "Allow/disallow displaying and getting instances favicons"
3205 descriptions: "S3 service related settings",
3208 key: :access_key_id,
3210 description: "S3 access key ID",
3211 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3214 key: :secret_access_key,
3216 description: "Secret access key",
3217 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3222 description: "S3 host",
3223 suggestions: ["s3.eu-central-1.amazonaws.com"]
3228 description: "S3 region (for AWS)",
3229 suggestions: ["us-east-1"]
3237 description: "Installed frontends management",
3242 description: "Primary frontend, the one that is served for all pages by default",
3243 children: installed_frontend_options
3248 description: "Admin frontend",
3249 children: installed_frontend_options
3255 "A map containing available frontends and parameters for their installation.",
3256 children: frontend_options
3262 key: Pleroma.Web.Preload,
3264 description: "Preload-related settings",
3268 type: {:list, :module},
3269 description: "List of preload providers to enable",
3271 Pleroma.Web.Preload.Providers.Instance,
3272 Pleroma.Web.Preload.Providers.User,
3273 Pleroma.Web.Preload.Providers.Timelines,
3274 Pleroma.Web.Preload.Providers.StatusNet
3283 description: "Majic/libmagic configuration",
3288 description: "Number of majic workers to start.",
3295 key: Pleroma.User.Backup,
3297 description: "Account Backup",
3300 key: :purge_after_days,
3302 description: "Remove backup achives after N days",
3308 description: "Limit user to export not more often than once per N days",
3315 key: Pleroma.Web.Endpoint.MetricsExporter,
3317 description: "Prometheus app metrics endpoint configuration",
3322 description: "[Pleroma extension] Enables app metrics endpoint."
3326 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3328 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3332 type: [:boolean, :tuple],
3333 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3334 suggestion: [false, {:basic, "myusername", "mypassword"}]
3339 description: "App metrics endpoint URI path.",
3340 suggestions: ["/api/pleroma/app_metrics"]
3345 description: "App metrics endpoint output format.",
3346 suggestions: [:text, :protobuf]
3352 key: ConcurrentLimiter,
3354 description: "Limits configuration for background tasks.",
3357 key: Pleroma.Web.RichMedia.Helpers,
3359 description: "Concurrent limits configuration for getting RichMedia for activities.",
3360 suggestions: [max_running: 5, max_waiting: 5],
3365 description: "Max running concurrently jobs.",
3371 description: "Max waiting jobs.",
3377 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3379 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3380 suggestions: [max_running: 5, max_waiting: 5],
3385 description: "Max running concurrently jobs.",
3391 description: "Max waiting jobs.",