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"
106 Proxy requests to the remote uploader.\n
107 Useful if media upload endpoint is not internet accessible.
111 key: :filename_display_max_length,
113 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
119 key: Pleroma.Uploaders.Local,
121 description: "Local uploader-related settings",
126 description: "Path where user's uploads will be saved",
135 key: Pleroma.Uploaders.S3,
137 description: "S3 uploader-related settings",
142 description: "S3 bucket",
148 key: :bucket_namespace,
150 description: "S3 bucket namespace",
151 suggestions: ["pleroma"]
154 key: :public_endpoint,
156 description: "S3 endpoint",
157 suggestions: ["https://s3.amazonaws.com"]
160 key: :truncated_namespace,
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
167 key: :streaming_enabled,
170 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
176 key: Pleroma.Upload.Filter.Mogrify,
178 description: "Uploads mogrify filter settings",
182 type: [:string, {:list, :string}, {:list, :tuple}],
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
198 description: "Filter replaces the filename of the upload",
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
207 "custom-file-name.{extension}"
214 key: Pleroma.Emails.Mailer,
216 description: "Mailer-related settings",
222 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
223 " or Swoosh.Adapters.Local for in-memory mailbox",
225 Swoosh.Adapters.SMTP,
226 Swoosh.Adapters.Sendgrid,
227 Swoosh.Adapters.Sendmail,
228 Swoosh.Adapters.Mandrill,
229 Swoosh.Adapters.Mailgun,
230 Swoosh.Adapters.Mailjet,
231 Swoosh.Adapters.Postmark,
232 Swoosh.Adapters.SparkPost,
233 Swoosh.Adapters.AmazonSES,
235 Swoosh.Adapters.SocketLabs,
236 Swoosh.Adapters.Gmail,
237 Swoosh.Adapters.Local
243 description: "Allow/disallow send emails"
246 group: {:subgroup, Swoosh.Adapters.SMTP},
249 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
250 suggestions: ["smtp.gmail.com"]
253 group: {:subgroup, Swoosh.Adapters.SMTP},
256 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
257 suggestions: ["pleroma"]
260 group: {:subgroup, Swoosh.Adapters.SMTP},
263 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
264 suggestions: ["password"]
267 group: {:subgroup, Swoosh.Adapters.SMTP},
271 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
274 group: {:subgroup, Swoosh.Adapters.SMTP},
278 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
279 suggestions: [:always, :never, :if_available]
282 group: {:subgroup, Swoosh.Adapters.SMTP},
285 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
286 suggestions: [:always, :never, :if_available]
289 group: {:subgroup, Swoosh.Adapters.SMTP},
292 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
296 group: {:subgroup, Swoosh.Adapters.SMTP},
299 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
303 group: {:subgroup, Swoosh.Adapters.SMTP},
305 label: "No MX lookups",
307 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
310 group: {:subgroup, Swoosh.Adapters.Sendgrid},
314 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
315 suggestions: ["my-api-key"]
318 group: {:subgroup, Swoosh.Adapters.Sendmail},
321 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
322 suggestions: ["/usr/bin/sendmail"]
325 group: {:subgroup, Swoosh.Adapters.Sendmail},
328 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
329 suggestions: ["-N delay,failure,success"]
332 group: {:subgroup, Swoosh.Adapters.Sendmail},
335 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
338 group: {:subgroup, Swoosh.Adapters.Mandrill},
342 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
343 suggestions: ["my-api-key"]
346 group: {:subgroup, Swoosh.Adapters.Mailgun},
350 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
351 suggestions: ["my-api-key"]
354 group: {:subgroup, Swoosh.Adapters.Mailgun},
357 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
358 suggestions: ["pleroma.com"]
361 group: {:subgroup, Swoosh.Adapters.Mailjet},
365 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
366 suggestions: ["my-api-key"]
369 group: {:subgroup, Swoosh.Adapters.Mailjet},
372 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
373 suggestions: ["my-secret-key"]
376 group: {:subgroup, Swoosh.Adapters.Postmark},
380 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
381 suggestions: ["my-api-key"]
384 group: {:subgroup, Swoosh.Adapters.SparkPost},
388 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
389 suggestions: ["my-api-key"]
392 group: {:subgroup, Swoosh.Adapters.SparkPost},
395 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
396 suggestions: ["https://api.sparkpost.com/api/v1"]
399 group: {:subgroup, Swoosh.Adapters.AmazonSES},
402 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
403 suggestions: ["us-east-1", "us-east-2"]
406 group: {:subgroup, Swoosh.Adapters.AmazonSES},
409 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
410 suggestions: ["aws-access-key"]
413 group: {:subgroup, Swoosh.Adapters.AmazonSES},
416 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
417 suggestions: ["aws-secret-key"]
420 group: {:subgroup, Swoosh.Adapters.Dyn},
424 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
425 suggestions: ["my-api-key"]
428 group: {:subgroup, Swoosh.Adapters.SocketLabs},
431 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
434 group: {:subgroup, Swoosh.Adapters.SocketLabs},
438 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
441 group: {:subgroup, Swoosh.Adapters.Gmail},
444 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
451 description: "`Swoosh.Adapters.Local` adapter specific settings",
454 group: {:subgroup, Swoosh.Adapters.Local},
457 description: "Run the preview server together as part of your app"
460 group: {:subgroup, Swoosh.Adapters.Local},
463 description: "The preview server port",
471 label: "URI Schemes",
473 description: "URI schemes related settings",
477 type: {:list, :string},
478 description: "List of the scheme part that is considered valid to be an URL",
503 description: "Instance-related settings",
508 description: "Name of the instance",
515 label: "Admin Email Address",
517 description: "Email used to reach an Administrator/Moderator of the instance",
524 label: "Sender Email Address",
526 description: "Envelope FROM address for mail sent via Pleroma",
535 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
543 description: "Posts character limit (CW/Subject included in the counter)",
551 description: "Character limit of the instance chat messages",
559 description: "Hard character limit beyond which remote posts will be dropped",
567 description: "File size limit of uploads (except for avatar, background, banner)",
573 key: :avatar_upload_limit,
575 description: "File size limit of user's profile avatars",
581 key: :background_upload_limit,
583 description: "File size limit of user's profile backgrounds",
589 key: :banner_upload_limit,
591 description: "File size limit of user's profile banners",
599 description: "A map with poll limits for local polls",
603 max_option_chars: 200,
605 max_expiration: 31_536_000
612 description: "Maximum number of options",
616 key: :max_option_chars,
618 description: "Maximum number of characters per option",
622 key: :min_expiration,
624 description: "Minimum expiration time (in seconds)",
628 key: :max_expiration,
630 description: "Maximum expiration time (in seconds)",
636 key: :registrations_open,
639 "Enable registrations for anyone. Invitations require this setting to be disabled."
642 key: :invites_enabled,
645 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
648 key: :account_activation_required,
650 description: "Require users to confirm their emails before signing in"
653 key: :account_approval_required,
655 description: "Require users to be manually approved by an admin before signing in"
660 description: "Enable federation with other instances"
663 key: :federation_incoming_replies_max_depth,
664 label: "Fed. incoming replies max depth",
667 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
668 " 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.",
674 key: :federation_reachability_timeout_days,
675 label: "Fed. reachability timeout days",
678 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
686 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
692 "Makes the client API in authenticated mode-only except for user-profiles." <>
693 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
694 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
697 key: :quarantined_instances,
698 type: {:list, :string},
700 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
709 description: "Instance static directory",
715 key: :allowed_post_formats,
716 type: {:list, :string},
717 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
726 key: :extended_nickname_format,
729 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
730 " This will break federation with older software for theses nicknames."
733 key: :cleanup_attachments,
736 Enable to remove associated attachments when status is removed.
737 This will not affect duplicates and attachments without status.
738 Enabling this will increase load to database when deleting statuses on larger instances.
742 key: :max_pinned_statuses,
744 description: "The maximum number of pinned statuses. 0 will disable the feature.",
752 key: :autofollowed_nicknames,
753 type: {:list, :string},
755 "Set to nicknames of (local) users that every new user should automatically follow"
758 key: :autofollowing_nicknames,
759 type: {:list, :string},
761 "Set to nicknames of (local) users that automatically follows every newly registered user"
764 key: :attachment_links,
766 description: "Enable to automatically add attachment link text to statuses"
769 key: :max_report_comment_size,
771 description: "The maximum size of the report comment. Default: 1000.",
777 key: :safe_dm_mentions,
778 label: "Safe DM mentions",
781 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
782 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
788 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
791 key: :remote_post_retention_days,
794 "The default amount of days to retain remote posts when pruning the database",
800 key: :user_bio_length,
802 description: "A user bio maximum length. Default: 5000.",
808 key: :user_name_length,
810 description: "A user name maximum length. Default: 100.",
816 key: :skip_thread_containment,
818 description: "Skip filtering out broken threads. Default: enabled."
821 key: :limit_to_local_content,
822 type: {:dropdown, :atom},
824 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
832 key: :max_account_fields,
834 description: "The maximum number of custom fields in the user profile. Default: 10.",
840 key: :max_remote_account_fields,
843 "The maximum number of custom fields in the remote user profile. Default: 20.",
849 key: :account_field_name_length,
851 description: "An account field name maximum length. Default: 512.",
857 key: :account_field_value_length,
859 description: "An account field value maximum length. Default: 2048.",
865 key: :registration_reason_length,
867 description: "Maximum registration reason length. Default: 500.",
873 key: :external_user_synchronization,
875 description: "Enabling following/followers counters synchronization for external users"
878 key: :multi_factor_authentication,
880 description: "Multi-factor authentication settings",
883 totp: [digits: 6, period: 30],
884 backup_codes: [number: 5, length: 16]
890 label: "TOTP settings",
892 description: "TOTP settings",
893 suggestions: [digits: 6, period: 30],
900 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
907 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
914 description: "MFA backup codes settings",
915 suggestions: [number: 5, length: 16],
921 description: "Number of backup codes to generate."
928 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
935 key: :instance_thumbnail,
936 type: {:string, :image},
938 "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.",
939 suggestions: ["/instance/thumbnail.jpeg"]
942 key: :show_reactions,
944 description: "Let favourites and emoji reactions be viewed through the API."
952 description: "Welcome messages settings",
955 key: :direct_message,
957 descpiption: "Direct message settings",
962 description: "Enables sending a direct message to newly registered users"
967 description: "A message that will be sent to newly registered users",
969 "Hi, @username! Welcome on board!"
973 key: :sender_nickname,
975 description: "The nickname of the local user that sends a welcome message",
985 descpiption: "Chat message settings",
990 description: "Enables sending a chat message to newly registered users"
996 "A message that will be sent to newly registered users as a chat message",
998 "Hello, welcome on board!"
1002 key: :sender_nickname,
1004 description: "The nickname of the local user that sends a welcome chat message",
1014 descpiption: "Email message settings",
1019 description: "Enables sending an email to newly registered users"
1023 type: [:string, :tuple],
1025 "Email address and/or nickname that will be used to send the welcome email.",
1027 {"Pleroma App", "welcome@pleroma.app"}
1034 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1035 suggestions: ["Welcome to <%= instance_name%>"]
1041 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1042 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1048 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1049 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1058 description: "Logger-related settings",
1062 type: [:atom, :tuple, :module],
1064 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1065 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1073 label: "ExSyslogger",
1074 description: "ExSyslogger-related settings",
1078 type: {:dropdown, :atom},
1079 description: "Log level",
1080 suggestions: [:debug, :info, :warn, :error]
1086 "A string that's prepended to every message, and is typically set to the app name",
1087 suggestions: ["pleroma"]
1092 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1093 suggestions: ["$metadata[$level] $message"]
1097 type: {:list, :atom},
1098 suggestions: [:request_id]
1106 label: "Console Logger",
1107 description: "Console logger settings",
1111 type: {:dropdown, :atom},
1112 description: "Log level",
1113 suggestions: [:debug, :info, :warn, :error]
1118 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1119 suggestions: ["$metadata[$level] $message"]
1123 type: {:list, :atom},
1124 suggestions: [:request_id]
1131 label: "Quack Logger",
1132 description: "Quack-related settings",
1136 type: {:dropdown, :atom},
1137 description: "Log level",
1138 suggestions: [:debug, :info, :warn, :error]
1142 type: {:list, :atom},
1143 description: "Configure which metadata you want to report on",
1160 label: "Webhook URL",
1162 description: "Configure the Slack incoming webhook",
1163 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1169 key: :frontend_configurations,
1172 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1173 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1174 "add your own configuration your settings all fields must be complete.",
1178 label: "Pleroma FE",
1180 description: "Settings for Pleroma FE",
1183 alwaysShowSubjectInput: true,
1184 background: "/static/aurora_borealis.jpg",
1185 collapseMessageWithSubject: false,
1188 hideFilteredStatuses: false,
1189 hideMutedPosts: false,
1190 hidePostStats: false,
1191 hideSitename: false,
1192 hideUserStats: false,
1193 loginMethod: "password",
1194 logo: "/static/logo.svg",
1197 minimalScopesMode: false,
1198 noAttachmentLinks: false,
1199 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1200 postContentType: "text/plain",
1201 redirectRootLogin: "/main/friends",
1202 redirectRootNoLogin: "/main/all",
1204 sidebarRight: false,
1205 showFeaturesPanel: true,
1206 showInstanceSpecificPanel: false,
1207 subjectLineBehavior: "email",
1208 theme: "pleroma-dark",
1209 webPushNotifications: false
1214 key: :alwaysShowSubjectInput,
1215 label: "Always show subject input",
1217 description: "When disabled, auto-hide the subject field if it's empty"
1221 type: {:string, :image},
1223 "URL of the background, unless viewing a user profile with a background that is set",
1224 suggestions: ["/images/city.jpg"]
1227 key: :collapseMessageWithSubject,
1228 label: "Collapse message with subject",
1231 "When a message has a subject (aka Content Warning), collapse it by default"
1235 label: "PleromaFE Chat",
1237 description: "Disables PleromaFE Chat component"
1243 description: "Enables green text on lines prefixed with the > character"
1246 key: :hideFilteredStatuses,
1247 label: "Hide Filtered Statuses",
1249 description: "Hides filtered statuses from timelines"
1252 key: :hideMutedPosts,
1253 label: "Hide Muted Posts",
1255 description: "Hides muted statuses from timelines"
1258 key: :hidePostStats,
1259 label: "Hide post stats",
1261 description: "Hide notices statistics (repeats, favorites, ...)"
1265 label: "Hide Sitename",
1267 description: "Hides instance name from PleromaFE banner"
1270 key: :hideUserStats,
1271 label: "Hide user stats",
1274 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1278 type: {:string, :image},
1279 description: "URL of the logo, defaults to Pleroma's logo",
1280 suggestions: ["/static/logo.svg"]
1284 label: "Logo margin",
1287 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1288 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1289 suggestions: [".1em"]
1296 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1297 "If you want a colorful logo you must disable logoMask."
1300 key: :minimalScopesMode,
1301 label: "Minimal scopes mode",
1304 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1305 "Also prevents replying to a DM with a public post from PleromaFE."
1308 key: :nsfwCensorImage,
1309 label: "NSFW Censor Image",
1310 type: {:string, :image},
1312 "URL of the image to use for hiding NSFW media attachments in the timeline",
1313 suggestions: ["/static/img/nsfw.74818f9.png"]
1316 key: :postContentType,
1317 label: "Post Content Type",
1318 type: {:dropdown, :atom},
1319 description: "Default post formatting option",
1320 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1323 key: :redirectRootNoLogin,
1324 label: "Redirect root no login",
1327 "Relative URL which indicates where to redirect when a user isn't logged in",
1328 suggestions: ["/main/all"]
1331 key: :redirectRootLogin,
1332 label: "Redirect root login",
1335 "Relative URL which indicates where to redirect when a user is logged in",
1336 suggestions: ["/main/friends"]
1340 label: "Scope copy",
1342 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1346 label: "Sidebar on Right",
1348 description: "Change alignment of sidebar and panels to the right"
1351 key: :showFeaturesPanel,
1352 label: "Show instance features panel",
1355 "Enables panel displaying functionality of the instance on the About page"
1358 key: :showInstanceSpecificPanel,
1359 label: "Show instance specific panel",
1361 description: "Whether to show the instance's custom panel"
1364 key: :subjectLineBehavior,
1365 label: "Subject line behavior",
1367 description: "Allows changing the default behaviour of subject lines in replies.
1368 `email`: copy and preprend re:, as in email,
1369 `masto`: copy verbatim, as in Mastodon,
1370 `noop`: don't copy the subject.",
1371 suggestions: ["email", "masto", "noop"]
1376 description: "Which theme to use. Available themes are defined in styles.json",
1377 suggestions: ["pleroma-dark"]
1385 description: "Settings for Masto FE",
1388 showInstanceSpecificPanel: true
1393 key: :showInstanceSpecificPanel,
1394 label: "Show instance specific panel",
1396 description: "Whenether to show the instance's specific panel"
1407 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1411 type: {:keyword, :map},
1413 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1416 url: "/images/pleroma-fox-tan-smol.png",
1417 mime_type: "image/png"
1419 pleroma_fox_tan_shy: %{
1420 url: "/images/pleroma-fox-tan-shy.png",
1421 mime_type: "image/png"
1426 key: :default_mascot,
1429 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1435 key: :default_user_avatar,
1436 type: {:string, :image},
1437 description: "URL of the default user avatar",
1438 suggestions: ["/images/avi.png"]
1447 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1451 type: {:list, :map},
1452 description: "Describe the icons of the app",
1455 src: "/static/logo.png"
1458 src: "/static/icon.png",
1462 src: "/static/icon.ico",
1463 sizes: "72x72 96x96 128x128 256x256"
1470 description: "Describe the theme color of the app",
1471 suggestions: ["#282c37", "mediumpurple"]
1474 key: :background_color,
1476 description: "Describe the background color of the app",
1477 suggestions: ["#191b22", "aliceblue"]
1485 description: "Media proxy",
1490 description: "Enables proxying of remote media via the instance's proxy"
1497 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1498 suggestions: ["https://example.com"]
1506 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1512 description: "Enables media cache object invalidation."
1517 description: "Module which will be used to purge objects from the cache.",
1519 Pleroma.Web.MediaProxy.Invalidation.Script,
1520 Pleroma.Web.MediaProxy.Invalidation.Http
1527 label: "Advanced MediaProxy Options",
1529 description: "Internal Pleroma.ReverseProxy settings",
1531 redirect_on_failure: false,
1532 max_body_length: 25 * 1_048_576,
1533 max_read_duration: 30_000
1537 key: :redirect_on_failure,
1540 Redirects the client to the origin server upon encountering HTTP errors.\n
1541 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1542 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1543 IP addresses of your users to the other servers, bypassing the MediaProxy.
1547 key: :max_body_length,
1549 description: "Maximum file size allowed through the Pleroma MediaProxy cache."
1552 key: :max_read_duration,
1554 description: "Timeout (in milliseconds) of GET request to the remote URI."
1560 type: {:list, :string},
1561 description: "List of hosts with scheme to bypass the MediaProxy",
1562 suggestions: ["http://example.com"]
1568 key: :media_preview_proxy,
1570 description: "Media preview proxy",
1576 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1579 key: :thumbnail_max_width,
1582 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1585 key: :thumbnail_max_height,
1588 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1591 key: :image_quality,
1593 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1596 key: :min_content_length,
1599 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1605 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1607 description: "HTTP invalidate settings",
1612 description: "HTTP method of request. Default: :purge"
1616 type: {:keyword, :string},
1617 description: "HTTP headers of request",
1618 suggestions: [{"x-refresh", 1}]
1623 description: "Request options",
1627 type: {:map, :string}
1635 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1637 description: "Script invalidate settings",
1642 description: "Path to shell script. Which will run purge cache.",
1643 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1651 description: "Gopher settings",
1656 description: "Enables the gopher interface"
1662 description: "IP address to bind to",
1663 suggestions: [{0, 0, 0, 0}]
1668 description: "Port to bind to",
1674 description: "Port advertised in URLs (optional, defaults to port)",
1682 label: "ActivityPub",
1684 description: "ActivityPub-related settings",
1687 key: :unfollow_blocked,
1689 description: "Whether blocks result in people getting unfollowed"
1692 key: :outgoing_blocks,
1694 description: "Whether to federate blocks to other instances"
1697 key: :sign_object_fetches,
1699 description: "Sign object fetches with HTTP signatures"
1702 key: :note_replies_output_limit,
1705 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1708 key: :follow_handshake_timeout,
1710 description: "Following handshake timeout",
1717 key: :http_security,
1718 label: "HTTP security",
1720 description: "HTTP security settings",
1725 description: "Whether the managed content security policy is enabled"
1731 description: "Whether to additionally send a Strict-Transport-Security header"
1735 label: "STS max age",
1737 description: "The maximum age for the Strict-Transport-Security header if sent",
1738 suggestions: [31_536_000]
1742 label: "CT max age",
1744 description: "The maximum age for the Expect-CT header if sent",
1745 suggestions: [2_592_000]
1748 key: :referrer_policy,
1750 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1751 suggestions: ["same-origin", "no-referrer"]
1755 label: "Report URI",
1757 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1758 suggestions: ["https://example.com/report-uri"]
1763 group: :web_push_encryption,
1764 key: :vapid_details,
1765 label: "Vapid Details",
1768 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1774 "A mailto link for the administrative contact." <>
1775 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1776 suggestions: ["mailto:moderators@pleroma.com"]
1781 description: "VAPID public key",
1782 suggestions: ["Public key"]
1787 description: "VAPID private key",
1788 suggestions: ["Private key"]
1794 key: Pleroma.Captcha,
1796 description: "Captcha-related settings",
1801 description: "Whether the captcha should be shown on registration"
1806 description: "The method/service to use for captcha",
1807 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1810 key: :seconds_valid,
1812 description: "The time in seconds for which the captcha is valid",
1819 key: Pleroma.Captcha.Kocaptcha,
1822 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1823 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1828 description: "The kocaptcha endpoint to use",
1829 suggestions: ["https://captcha.kotobank.ch"]
1835 label: "Pleroma Admin Token",
1838 "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)",
1843 description: "Admin token",
1845 "Please use a high entropy string or UUID"
1855 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1859 type: {:dropdown, :atom},
1860 description: "Logs verbose mode",
1861 suggestions: [false, :error, :warn, :info, :debug]
1865 type: {:keyword, :integer},
1867 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1869 activity_expiration: 10,
1870 attachments_cleanup: 5,
1872 federator_incoming: 50,
1873 federator_outgoing: 50,
1875 scheduled_activities: 10,
1881 key: :activity_expiration,
1883 description: "Activity expiration queue",
1889 description: "Backup queue",
1893 key: :attachments_cleanup,
1895 description: "Attachment deletion queue",
1901 description: "Background queue",
1905 key: :federator_incoming,
1907 description: "Incoming federation queue",
1911 key: :federator_outgoing,
1913 description: "Outgoing federation queue",
1919 description: "Email sender queue, see Pleroma.Emails.Mailer",
1923 key: :scheduled_activities,
1925 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1929 key: :transmogrifier,
1931 description: "Transmogrifier queue",
1937 description: "Web push notifications queue",
1944 type: {:list, :tuple},
1945 description: "Settings for cron background jobs",
1947 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1948 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1957 description: "Includes custom worker options not interpretable directly by `Oban`",
1961 type: {:keyword, :integer},
1962 description: "Max retry attempts for failed jobs, per `Oban` queue",
1964 federator_incoming: 5,
1965 federator_outgoing: 5
1972 key: Pleroma.Web.Metadata,
1974 description: "Metadata-related settings",
1978 type: {:list, :module},
1979 description: "List of metadata providers to enable",
1981 Pleroma.Web.Metadata.Providers.OpenGraph,
1982 Pleroma.Web.Metadata.Providers.TwitterCard,
1983 Pleroma.Web.Metadata.Providers.RelMe,
1984 Pleroma.Web.Metadata.Providers.Feed
1989 label: "Unfurl NSFW",
1991 description: "When enabled NSFW attachments will be shown in previews"
2000 "If enabled the instance will parse metadata from attached links to generate link previews",
2005 description: "Enables RichMedia parsing of URLs"
2009 type: {:list, :string},
2010 description: "List of hosts which will be ignored by the metadata parser",
2011 suggestions: ["accounts.google.com", "xss.website"]
2015 label: "Ignore TLD",
2016 type: {:list, :string},
2017 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2018 suggestions: ["local", "localdomain", "lan"]
2022 type: {:list, :module},
2024 "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.",
2026 Pleroma.Web.RichMedia.Parsers.OEmbed,
2027 Pleroma.Web.RichMedia.Parsers.TwitterCard
2032 label: "TTL setters",
2033 type: {:list, :module},
2035 "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.",
2037 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2041 key: :failure_backoff,
2044 "Amount of milliseconds after request failure, during which the request will not be retried.",
2045 suggestions: [60_000]
2051 key: Pleroma.Formatter,
2055 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2059 type: [:string, :boolean],
2060 description: "Specify the class to be added to the generated link. Disable to clear.",
2061 suggestions: ["auto-linker", false]
2065 type: [:string, :boolean],
2066 description: "Override the rel attribute. Disable to clear.",
2067 suggestions: ["ugc", "noopener noreferrer", false]
2072 description: "Link URLs will open in a new window/tab."
2076 type: [:integer, :boolean],
2078 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2079 suggestions: [15, false]
2084 description: "Strip the scheme prefix."
2089 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2093 type: [:atom, :boolean],
2095 "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)",
2096 suggestions: [:no_scheme, true]
2102 key: Pleroma.ScheduledActivity,
2104 description: "Scheduled activities settings",
2107 key: :daily_user_limit,
2110 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2114 key: :total_user_limit,
2117 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2123 description: "Whether scheduled activities are sent to the job queue to be executed"
2129 key: Pleroma.Workers.PurgeExpiredActivity,
2131 description: "Expired activities settings",
2136 description: "Enables expired activities addition & deletion"
2141 description: "Minimum lifetime for ephemeral activity (in seconds)",
2148 label: "Pleroma Authenticator",
2150 description: "Authenticator",
2153 key: Pleroma.Web.Auth.Authenticator,
2155 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2165 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2166 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2167 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2168 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2173 description: "Enables LDAP authentication"
2178 description: "LDAP server hostname",
2179 suggestions: ["localhosts"]
2184 description: "LDAP port, e.g. 389 or 636",
2185 suggestions: [389, 636]
2191 description: "Enable to use SSL, usually implies the port 636"
2195 label: "SSL options",
2197 description: "Additional SSL options",
2198 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2203 description: "Path to file with PEM encoded cacerts",
2204 suggestions: ["path/to/file/with/PEM/cacerts"]
2209 description: "Type of cert verification",
2210 suggestions: [:verify_peer]
2218 description: "Enable to use STARTTLS, usually implies the port 389"
2222 label: "TLS options",
2224 description: "Additional TLS options",
2225 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2230 description: "Path to file with PEM encoded cacerts",
2231 suggestions: ["path/to/file/with/PEM/cacerts"]
2236 description: "Type of cert verification",
2237 suggestions: [:verify_peer]
2244 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2245 suggestions: ["dc=example,dc=com"]
2252 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2261 description: "Authentication / authorization settings",
2264 key: :enforce_oauth_admin_scope_usage,
2265 label: "Enforce OAuth admin scope usage",
2268 "OAuth admin scope requirement toggle. " <>
2269 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2270 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2271 "`is_admin` user flag grants access to admin-specific actions."
2274 key: :auth_template,
2277 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2278 suggestions: ["show.html"]
2281 key: :oauth_consumer_template,
2282 label: "OAuth consumer template",
2285 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2286 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2287 suggestions: ["consumer.html"]
2290 key: :oauth_consumer_strategies,
2291 label: "OAuth consumer strategies",
2292 type: {:list, :string},
2294 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2295 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2296 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2297 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2303 key: :email_notifications,
2305 description: "Email notifications settings",
2311 "emails of \"what you've missed\" for users who have been inactive for a while",
2315 schedule: "0 0 * * 0",
2317 inactivity_threshold: 7
2325 description: "Globally enable or disable digest emails"
2331 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2332 suggestions: ["0 0 * * 0"]
2337 description: "Minimum interval between digest emails to one user",
2341 key: :inactivity_threshold,
2343 description: "Minimum user inactivity threshold",
2352 key: Pleroma.Emails.UserEmail,
2354 description: "Email template settings",
2358 type: {:string, :image},
2359 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2360 suggestions: ["some/path/logo.png"]
2365 description: "A map with color settings for email templates.",
2368 link_color: "#d8a070",
2369 background_color: "#2C3645",
2370 content_background_color: "#1B2635",
2371 header_color: "#d8a070",
2372 text_color: "#b9b9ba",
2373 text_muted_color: "#b9b9ba"
2380 suggestions: ["#d8a070"]
2383 key: :background_color,
2385 suggestions: ["#2C3645"]
2388 key: :content_background_color,
2390 suggestions: ["#1B2635"]
2395 suggestions: ["#d8a070"]
2400 suggestions: ["#b9b9ba"]
2403 key: :text_muted_color,
2405 suggestions: ["#b9b9ba"]
2413 key: Pleroma.Emails.NewUsersDigestEmail,
2415 description: "New users admin email digest",
2420 description: "Enables new users admin digest email when `true`"
2429 description: "Configure OAuth 2 provider capabilities",
2432 key: :token_expires_in,
2434 description: "The lifetime in seconds of the access token",
2435 suggestions: [2_592_000]
2438 key: :issue_new_refresh_token,
2441 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2444 key: :clean_expired_tokens,
2446 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2456 key: :shortcode_globs,
2457 type: {:list, :string},
2458 description: "Location of custom emoji files. * can be used as a wildcard.",
2459 suggestions: ["/emoji/custom/**/*.png"]
2462 key: :pack_extensions,
2463 type: {:list, :string},
2465 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2466 suggestions: [".png", ".gif"]
2470 type: {:keyword, {:list, :string}},
2472 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2473 " and the value is the location or array of locations. * can be used as a wildcard.",
2475 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2479 key: :default_manifest,
2482 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2483 " Currently only one manifest can be added (no arrays).",
2484 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2487 key: :shared_pack_cache_seconds_per_file,
2488 label: "Shared pack cache s/file",
2491 "When an emoji pack is shared, the archive is created and cached in memory" <>
2492 " for this amount of seconds multiplied by the number of files.",
2502 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2506 type: [:tuple, {:list, :tuple}],
2507 description: "For the search requests (account & status search etc.)",
2508 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2512 type: [:tuple, {:list, :tuple}],
2513 description: "For requests to timelines (each timeline has it's own limiter)",
2514 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2517 key: :app_account_creation,
2518 type: [:tuple, {:list, :tuple}],
2519 description: "For registering user accounts from the same IP address",
2520 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2523 key: :relations_actions,
2524 type: [:tuple, {:list, :tuple}],
2525 description: "For actions on relationships with all users (follow, unfollow)",
2526 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2529 key: :relation_id_action,
2530 label: "Relation ID action",
2531 type: [:tuple, {:list, :tuple}],
2532 description: "For actions on relation with a specific user (follow, unfollow)",
2533 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2536 key: :statuses_actions,
2537 type: [:tuple, {:list, :tuple}],
2539 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2540 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2543 key: :status_id_action,
2544 label: "Status ID action",
2545 type: [:tuple, {:list, :tuple}],
2547 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2548 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2551 key: :authentication,
2552 type: [:tuple, {:list, :tuple}],
2553 description: "For authentication create / password check / user existence check requests",
2554 suggestions: [{60_000, 15}]
2563 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2564 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2569 description: "Enables SSH"
2574 description: "Dir with SSH keys",
2575 suggestions: ["/some/path/ssh_keys"]
2580 description: "Handler module",
2581 suggestions: ["Pleroma.BBS.Handler"]
2586 description: "Port to connect",
2587 suggestions: [10_022]
2590 key: :password_authenticator,
2592 description: "Authenticator module",
2593 suggestions: ["Pleroma.BBS.Authenticator"]
2599 label: "Mime Types",
2601 description: "Mime Types settings",
2608 "application/xml" => ["xml"],
2609 "application/xrd+xml" => ["xrd+xml"],
2610 "application/jrd+json" => ["jrd+json"],
2611 "application/activity+json" => ["activity+json"],
2612 "application/ld+json" => ["activity+json"]
2617 key: "application/xml",
2618 type: {:list, :string},
2619 suggestions: ["xml"]
2622 key: "application/xrd+xml",
2623 type: {:list, :string},
2624 suggestions: ["xrd+xml"]
2627 key: "application/jrd+json",
2628 type: {:list, :string},
2629 suggestions: ["jrd+json"]
2632 key: "application/activity+json",
2633 type: {:list, :string},
2634 suggestions: ["activity+json"]
2637 key: "application/ld+json",
2638 type: {:list, :string},
2639 suggestions: ["activity+json"]
2649 description: "Pleroma chat settings",
2662 description: "HTTP settings",
2667 type: [:string, :tuple],
2668 description: "Proxy URL",
2669 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2672 key: :send_user_agent,
2677 type: [:string, :atom],
2679 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2680 suggestions: ["Pleroma", :default]
2685 description: "Adapter specific options",
2691 label: "SSL Options",
2692 description: "SSL options for HTTP adapter",
2696 type: {:list, :atom},
2697 description: "List of TLS version to use",
2698 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2709 label: "Markup Settings",
2713 key: :allow_inline_images,
2717 key: :allow_headings,
2730 type: {:list, :module},
2732 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2733 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2743 key: :deny_follow_blocked,
2754 key: :restricted_nicknames,
2755 type: {:list, :string},
2756 description: "List of nicknames users may not register with.",
2775 "ostatus_subscribe",
2791 key: :email_blacklist,
2792 type: {:list, :string},
2793 description: "List of email domains users may not register with.",
2794 suggestions: ["mailinator.com", "maildrop.cc"]
2800 label: "CORS plug config",
2806 suggestions: [86_400]
2810 type: {:list, :string},
2811 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2815 type: {:list, :string},
2818 "X-RateLimit-Reset",
2819 "X-RateLimit-Limit",
2820 "X-RateLimit-Remaining",
2831 type: {:list, :string},
2832 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2838 key: Pleroma.Web.Plugs.RemoteIp,
2841 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2842 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2848 description: "Enable/disable the plug. Default: disabled."
2852 type: {:list, :string},
2854 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2859 type: {:list, :string},
2861 "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."
2865 type: {:list, :string},
2867 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"]`
2874 key: :web_cache_ttl,
2875 label: "Web cache TTL",
2878 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2884 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2885 suggestions: [30_000, nil]
2888 key: :activity_pub_question,
2890 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2891 suggestions: [30_000]
2901 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2906 description: "Enables the rendering of static HTML. Default: disabled."
2914 description: "Configure feed rendering",
2919 description: "Configure title rendering",
2924 description: "Maximum number of characters before truncating title",
2930 description: "Replacement which will be used after truncating string",
2931 suggestions: ["..."]
2941 description: "Custom Runtime Modules",
2946 description: "A path to custom Elixir modules (such as MRF policies)."
2954 description: "Settings for notifications streamer",
2959 description: "Number of workers to send notifications",
2963 key: :overflow_workers,
2965 description: "Maximum number of workers created if pool is empty",
2972 key: :connections_pool,
2974 description: "Advanced settings for `Gun` connections pool",
2977 key: :connection_acquisition_wait,
2980 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2984 key: :connection_acquisition_retries,
2987 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2991 key: :max_connections,
2993 description: "Maximum number of connections in the pool. Default: 250 connections.",
2997 key: :connect_timeout,
2999 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3003 key: :reclaim_multiplier,
3006 "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",
3015 description: "Advanced settings for `Gun` workers pools",
3017 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3021 description: "Settings for #{pool_name} pool.",
3026 description: "Maximum number of concurrent requests in the pool.",
3033 "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",
3039 description: "Timeout for the pool while gun will wait for response",
3040 suggestions: [10_000]
3048 key: :hackney_pools,
3050 description: "Advanced settings for `Hackney` connections pools",
3055 description: "Settings for federation pool.",
3058 key: :max_connections,
3060 description: "Number workers in the pool.",
3066 description: "Timeout while `hackney` will wait for response.",
3067 suggestions: [150_000]
3074 description: "Settings for media pool.",
3077 key: :max_connections,
3079 description: "Number workers in the pool.",
3085 description: "Timeout while `hackney` will wait for response.",
3086 suggestions: [150_000]
3093 description: "Settings for upload pool.",
3096 key: :max_connections,
3098 description: "Number workers in the pool.",
3104 description: "Timeout while `hackney` will wait for response.",
3105 suggestions: [300_000]
3113 key: :restrict_unauthenticated,
3114 label: "Restrict Unauthenticated",
3117 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3122 description: "Settings for public and federated timelines.",
3127 description: "Disallow view public timeline."
3132 description: "Disallow view federated timeline."
3139 description: "Settings for user profiles.",
3144 description: "Disallow view local user profiles."
3149 description: "Disallow view remote user profiles."
3156 description: "Settings for statuses.",
3161 description: "Disallow view local statuses."
3166 description: "Disallow view remote statuses."
3174 key: Pleroma.Web.ApiSpec.CastAndValidate,
3181 "Enables strict input validation (useful in development, not recommended in production)"
3187 key: :instances_favicons,
3189 description: "Control favicons for instances",
3194 description: "Allow/disallow displaying and getting instances favicons"
3202 descriptions: "S3 service related settings",
3205 key: :access_key_id,
3207 description: "S3 access key ID",
3208 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3211 key: :secret_access_key,
3213 description: "Secret access key",
3214 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3219 description: "S3 host",
3220 suggestions: ["s3.eu-central-1.amazonaws.com"]
3228 description: "Installed frontends management",
3233 description: "Primary frontend, the one that is served for all pages by default",
3234 children: installed_frontend_options
3239 description: "Admin frontend",
3240 children: installed_frontend_options
3246 "A map containing available frontends and parameters for their installation.",
3247 children: frontend_options
3253 key: Pleroma.Web.Preload,
3255 description: "Preload-related settings",
3259 type: {:list, :module},
3260 description: "List of preload providers to enable",
3262 Pleroma.Web.Preload.Providers.Instance,
3263 Pleroma.Web.Preload.Providers.User,
3264 Pleroma.Web.Preload.Providers.Timelines,
3265 Pleroma.Web.Preload.Providers.StatusNet
3274 description: "Majic/libmagic configuration",
3279 description: "Number of majic workers to start.",
3286 key: Pleroma.User.Backup,
3288 description: "Account Backup",
3291 key: :purge_after_days,
3293 description: "Remove backup achives after N days",
3299 description: "Limit user to export not more often than once per N days",
3306 key: Pleroma.Web.Endpoint.MetricsExporter,
3308 description: "Prometheus app metrics endpoint configuration",
3313 description: "[Pleroma extension] Enables app metrics endpoint."
3317 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3319 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3323 type: [:boolean, :tuple],
3324 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3325 suggestion: [false, {:basic, "myusername", "mypassword"}]
3330 description: "App metrics endpoint URI path.",
3331 suggestions: ["/api/pleroma/app_metrics"]
3336 description: "App metrics endpoint output format.",
3337 suggestions: [:text, :protobuf]