6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
66 config :pleroma, :config_description, [
71 description: "Upload general settings",
76 description: "Module which will be used for uploads",
77 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
81 type: {:list, :module},
83 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
84 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
90 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
96 description: "Base URL for the uploads, needed if you use CDN",
98 "https://cdn-host.com"
105 Proxy requests to the remote uploader.\n
106 Useful if media upload endpoint is not internet accessible.
110 key: :filename_display_max_length,
112 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
118 key: Pleroma.Uploaders.Local,
120 description: "Local uploader-related settings",
125 description: "Path where user's uploads will be saved",
134 key: Pleroma.Uploaders.S3,
136 description: "S3 uploader-related settings",
141 description: "S3 bucket",
147 key: :bucket_namespace,
149 description: "S3 bucket namespace",
150 suggestions: ["pleroma"]
153 key: :truncated_namespace,
156 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
157 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
160 key: :streaming_enabled,
163 "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."
169 key: Pleroma.Upload.Filter.Mogrify,
171 description: "Uploads mogrify filter settings",
175 type: [:string, {:list, :string}, {:list, :tuple}],
177 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
178 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
189 key: Pleroma.Upload.Filter.AnonymizeFilename,
191 description: "Filter replaces the filename of the upload",
197 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
198 " filename extension by using {extension}, for example custom-file-name.{extension}.",
200 "custom-file-name.{extension}"
207 key: Pleroma.Emails.Mailer,
209 description: "Mailer-related settings",
215 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
216 " or Swoosh.Adapters.Local for in-memory mailbox",
218 Swoosh.Adapters.SMTP,
219 Swoosh.Adapters.Sendgrid,
220 Swoosh.Adapters.Sendmail,
221 Swoosh.Adapters.Mandrill,
222 Swoosh.Adapters.Mailgun,
223 Swoosh.Adapters.Mailjet,
224 Swoosh.Adapters.Postmark,
225 Swoosh.Adapters.SparkPost,
226 Swoosh.Adapters.AmazonSES,
228 Swoosh.Adapters.SocketLabs,
229 Swoosh.Adapters.Gmail,
230 Swoosh.Adapters.Local
236 description: "Allow/disallow send emails"
239 group: {:subgroup, Swoosh.Adapters.SMTP},
242 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
243 suggestions: ["smtp.gmail.com"]
246 group: {:subgroup, Swoosh.Adapters.SMTP},
249 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
250 suggestions: ["pleroma"]
253 group: {:subgroup, Swoosh.Adapters.SMTP},
256 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
257 suggestions: ["password"]
260 group: {:subgroup, Swoosh.Adapters.SMTP},
264 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
267 group: {:subgroup, Swoosh.Adapters.SMTP},
271 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
272 suggestions: [:always, :never, :if_available]
275 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",
289 group: {:subgroup, Swoosh.Adapters.SMTP},
292 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
296 group: {:subgroup, Swoosh.Adapters.SMTP},
298 label: "No MX lookups",
300 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
303 group: {:subgroup, Swoosh.Adapters.Sendgrid},
307 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
308 suggestions: ["my-api-key"]
311 group: {:subgroup, Swoosh.Adapters.Sendmail},
314 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
315 suggestions: ["/usr/bin/sendmail"]
318 group: {:subgroup, Swoosh.Adapters.Sendmail},
321 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
322 suggestions: ["-N delay,failure,success"]
325 group: {:subgroup, Swoosh.Adapters.Sendmail},
328 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
331 group: {:subgroup, Swoosh.Adapters.Mandrill},
335 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
336 suggestions: ["my-api-key"]
339 group: {:subgroup, Swoosh.Adapters.Mailgun},
343 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
344 suggestions: ["my-api-key"]
347 group: {:subgroup, Swoosh.Adapters.Mailgun},
350 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
351 suggestions: ["pleroma.com"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
358 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
359 suggestions: ["my-api-key"]
362 group: {:subgroup, Swoosh.Adapters.Mailjet},
365 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
366 suggestions: ["my-secret-key"]
369 group: {:subgroup, Swoosh.Adapters.Postmark},
373 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
374 suggestions: ["my-api-key"]
377 group: {:subgroup, Swoosh.Adapters.SparkPost},
381 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
382 suggestions: ["my-api-key"]
385 group: {:subgroup, Swoosh.Adapters.SparkPost},
388 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
389 suggestions: ["https://api.sparkpost.com/api/v1"]
392 group: {:subgroup, Swoosh.Adapters.AmazonSES},
395 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
396 suggestions: ["us-east-1", "us-east-2"]
399 group: {:subgroup, Swoosh.Adapters.AmazonSES},
402 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
403 suggestions: ["aws-access-key"]
406 group: {:subgroup, Swoosh.Adapters.AmazonSES},
409 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
410 suggestions: ["aws-secret-key"]
413 group: {:subgroup, Swoosh.Adapters.Dyn},
417 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
418 suggestions: ["my-api-key"]
421 group: {:subgroup, Swoosh.Adapters.SocketLabs},
424 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
427 group: {:subgroup, Swoosh.Adapters.SocketLabs},
431 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
434 group: {:subgroup, Swoosh.Adapters.Gmail},
437 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
444 description: "`Swoosh.Adapters.Local` adapter specific settings",
447 group: {:subgroup, Swoosh.Adapters.Local},
450 description: "Run the preview server together as part of your app"
453 group: {:subgroup, Swoosh.Adapters.Local},
456 description: "The preview server port",
464 label: "URI Schemes",
466 description: "URI schemes related settings",
470 type: {:list, :string},
471 description: "List of the scheme part that is considered valid to be an URL",
496 description: "Instance-related settings",
501 description: "Name of the instance",
508 label: "Admin Email Address",
510 description: "Email used to reach an Administrator/Moderator of the instance",
517 label: "Sender Email Address",
519 description: "Envelope FROM address for mail sent via Pleroma",
528 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
536 description: "Posts character limit (CW/Subject included in the counter)",
544 description: "Character limit of the instance chat messages",
552 description: "Hard character limit beyond which remote posts will be dropped",
560 description: "File size limit of uploads (except for avatar, background, banner)",
566 key: :avatar_upload_limit,
568 description: "File size limit of user's profile avatars",
574 key: :background_upload_limit,
576 description: "File size limit of user's profile backgrounds",
582 key: :banner_upload_limit,
584 description: "File size limit of user's profile banners",
592 description: "A map with poll limits for local polls",
596 max_option_chars: 200,
598 max_expiration: 31_536_000
605 description: "Maximum number of options",
609 key: :max_option_chars,
611 description: "Maximum number of characters per option",
615 key: :min_expiration,
617 description: "Minimum expiration time (in seconds)",
621 key: :max_expiration,
623 description: "Maximum expiration time (in seconds)",
629 key: :registrations_open,
632 "Enable registrations for anyone. Invitations require this setting to be disabled."
635 key: :invites_enabled,
638 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
641 key: :account_activation_required,
643 description: "Require users to confirm their emails before signing in"
646 key: :account_approval_required,
648 description: "Require users to be manually approved by an admin before signing in"
653 description: "Enable federation with other instances"
656 key: :federation_incoming_replies_max_depth,
657 label: "Fed. incoming replies max depth",
660 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
661 " 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.",
667 key: :federation_reachability_timeout_days,
668 label: "Fed. reachability timeout days",
671 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
679 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
685 "Makes the client API in authenticated mode-only except for user-profiles." <>
686 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
687 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
690 key: :quarantined_instances,
691 type: {:list, :string},
693 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
702 description: "Instance static directory",
708 key: :allowed_post_formats,
709 type: {:list, :string},
710 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
719 key: :extended_nickname_format,
722 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
723 " This will break federation with older software for theses nicknames."
726 key: :cleanup_attachments,
729 Enable to remove associated attachments when status is removed.
730 This will not affect duplicates and attachments without status.
731 Enabling this will increase load to database when deleting statuses on larger instances.
735 key: :max_pinned_statuses,
737 description: "The maximum number of pinned statuses. 0 will disable the feature.",
745 key: :autofollowed_nicknames,
746 type: {:list, :string},
748 "Set to nicknames of (local) users that every new user should automatically follow"
751 key: :autofollowing_nicknames,
752 type: {:list, :string},
754 "Set to nicknames of (local) users that automatically follows every newly registered user"
757 key: :attachment_links,
759 description: "Enable to automatically add attachment link text to statuses"
762 key: :max_report_comment_size,
764 description: "The maximum size of the report comment. Default: 1000.",
770 key: :safe_dm_mentions,
771 label: "Safe DM mentions",
774 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
775 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
781 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
784 key: :remote_post_retention_days,
787 "The default amount of days to retain remote posts when pruning the database",
793 key: :user_bio_length,
795 description: "A user bio maximum length. Default: 5000.",
801 key: :user_name_length,
803 description: "A user name maximum length. Default: 100.",
809 key: :skip_thread_containment,
811 description: "Skip filtering out broken threads. Default: enabled."
814 key: :limit_to_local_content,
815 type: {:dropdown, :atom},
817 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
825 key: :max_account_fields,
827 description: "The maximum number of custom fields in the user profile. Default: 10.",
833 key: :max_remote_account_fields,
836 "The maximum number of custom fields in the remote user profile. Default: 20.",
842 key: :account_field_name_length,
844 description: "An account field name maximum length. Default: 512.",
850 key: :account_field_value_length,
852 description: "An account field value maximum length. Default: 2048.",
858 key: :registration_reason_length,
860 description: "Maximum registration reason length. Default: 500.",
866 key: :external_user_synchronization,
868 description: "Enabling following/followers counters synchronization for external users"
871 key: :multi_factor_authentication,
873 description: "Multi-factor authentication settings",
876 totp: [digits: 6, period: 30],
877 backup_codes: [number: 5, length: 16]
883 label: "TOTP settings",
885 description: "TOTP settings",
886 suggestions: [digits: 6, period: 30],
893 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
900 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
907 description: "MFA backup codes settings",
908 suggestions: [number: 5, length: 16],
914 description: "Number of backup codes to generate."
921 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
928 key: :instance_thumbnail,
929 type: {:string, :image},
931 "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.",
932 suggestions: ["/instance/thumbnail.jpeg"]
935 key: :show_reactions,
937 description: "Let favourites and emoji reactions be viewed through the API."
945 description: "Welcome messages settings",
948 key: :direct_message,
950 descpiption: "Direct message settings",
955 description: "Enables sending a direct message to newly registered users"
960 description: "A message that will be sent to newly registered users",
962 "Hi, @username! Welcome on board!"
966 key: :sender_nickname,
968 description: "The nickname of the local user that sends a welcome message",
978 descpiption: "Chat message settings",
983 description: "Enables sending a chat message to newly registered users"
989 "A message that will be sent to newly registered users as a chat message",
991 "Hello, welcome on board!"
995 key: :sender_nickname,
997 description: "The nickname of the local user that sends a welcome chat message",
1007 descpiption: "Email message settings",
1012 description: "Enables sending an email to newly registered users"
1016 type: [:string, :tuple],
1018 "Email address and/or nickname that will be used to send the welcome email.",
1020 {"Pleroma App", "welcome@pleroma.app"}
1027 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1028 suggestions: ["Welcome to <%= instance_name%>"]
1034 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1035 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1041 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1042 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1051 description: "Logger-related settings",
1055 type: [:atom, :tuple, :module],
1057 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1058 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1066 label: "ExSyslogger",
1067 description: "ExSyslogger-related settings",
1071 type: {:dropdown, :atom},
1072 description: "Log level",
1073 suggestions: [:debug, :info, :warn, :error]
1079 "A string that's prepended to every message, and is typically set to the app name",
1080 suggestions: ["pleroma"]
1085 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1086 suggestions: ["$metadata[$level] $message"]
1090 type: {:list, :atom},
1091 suggestions: [:request_id]
1099 label: "Console Logger",
1100 description: "Console logger settings",
1104 type: {:dropdown, :atom},
1105 description: "Log level",
1106 suggestions: [:debug, :info, :warn, :error]
1111 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1112 suggestions: ["$metadata[$level] $message"]
1116 type: {:list, :atom},
1117 suggestions: [:request_id]
1124 label: "Quack Logger",
1125 description: "Quack-related settings",
1129 type: {:dropdown, :atom},
1130 description: "Log level",
1131 suggestions: [:debug, :info, :warn, :error]
1135 type: {:list, :atom},
1136 description: "Configure which metadata you want to report on",
1153 label: "Webhook URL",
1155 description: "Configure the Slack incoming webhook",
1156 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1162 key: :frontend_configurations,
1165 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1166 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1167 "add your own configuration your settings all fields must be complete.",
1171 label: "Pleroma FE",
1173 description: "Settings for Pleroma FE",
1176 alwaysShowSubjectInput: true,
1177 background: "/static/aurora_borealis.jpg",
1178 collapseMessageWithSubject: false,
1181 hideFilteredStatuses: false,
1182 hideMutedPosts: false,
1183 hidePostStats: false,
1184 hideSitename: false,
1185 hideUserStats: false,
1186 loginMethod: "password",
1187 logo: "/static/logo.svg",
1190 minimalScopesMode: false,
1191 noAttachmentLinks: false,
1192 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1193 postContentType: "text/plain",
1194 redirectRootLogin: "/main/friends",
1195 redirectRootNoLogin: "/main/all",
1197 sidebarRight: false,
1198 showFeaturesPanel: true,
1199 showInstanceSpecificPanel: false,
1200 subjectLineBehavior: "email",
1201 theme: "pleroma-dark",
1202 webPushNotifications: false
1207 key: :alwaysShowSubjectInput,
1208 label: "Always show subject input",
1210 description: "When disabled, auto-hide the subject field if it's empty"
1214 type: {:string, :image},
1216 "URL of the background, unless viewing a user profile with a background that is set",
1217 suggestions: ["/images/city.jpg"]
1220 key: :collapseMessageWithSubject,
1221 label: "Collapse message with subject",
1224 "When a message has a subject (aka Content Warning), collapse it by default"
1228 label: "PleromaFE Chat",
1230 description: "Disables PleromaFE Chat component"
1236 description: "Enables green text on lines prefixed with the > character"
1239 key: :hideFilteredStatuses,
1240 label: "Hide Filtered Statuses",
1242 description: "Hides filtered statuses from timelines"
1245 key: :hideMutedPosts,
1246 label: "Hide Muted Posts",
1248 description: "Hides muted statuses from timelines"
1251 key: :hidePostStats,
1252 label: "Hide post stats",
1254 description: "Hide notices statistics (repeats, favorites, ...)"
1258 label: "Hide Sitename",
1260 description: "Hides instance name from PleromaFE banner"
1263 key: :hideUserStats,
1264 label: "Hide user stats",
1267 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1271 type: {:string, :image},
1272 description: "URL of the logo, defaults to Pleroma's logo",
1273 suggestions: ["/static/logo.svg"]
1277 label: "Logo margin",
1280 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1281 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1282 suggestions: [".1em"]
1289 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1290 "If you want a colorful logo you must disable logoMask."
1293 key: :minimalScopesMode,
1294 label: "Minimal scopes mode",
1297 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1298 "Also prevents replying to a DM with a public post from PleromaFE."
1301 key: :nsfwCensorImage,
1302 label: "NSFW Censor Image",
1303 type: {:string, :image},
1305 "URL of the image to use for hiding NSFW media attachments in the timeline",
1306 suggestions: ["/static/img/nsfw.74818f9.png"]
1309 key: :postContentType,
1310 label: "Post Content Type",
1311 type: {:dropdown, :atom},
1312 description: "Default post formatting option",
1313 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1316 key: :redirectRootNoLogin,
1317 label: "Redirect root no login",
1320 "Relative URL which indicates where to redirect when a user isn't logged in",
1321 suggestions: ["/main/all"]
1324 key: :redirectRootLogin,
1325 label: "Redirect root login",
1328 "Relative URL which indicates where to redirect when a user is logged in",
1329 suggestions: ["/main/friends"]
1333 label: "Scope copy",
1335 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1339 label: "Sidebar on Right",
1341 description: "Change alignment of sidebar and panels to the right"
1344 key: :showFeaturesPanel,
1345 label: "Show instance features panel",
1348 "Enables panel displaying functionality of the instance on the About page"
1351 key: :showInstanceSpecificPanel,
1352 label: "Show instance specific panel",
1354 description: "Whether to show the instance's custom panel"
1357 key: :subjectLineBehavior,
1358 label: "Subject line behavior",
1360 description: "Allows changing the default behaviour of subject lines in replies.
1361 `email`: copy and preprend re:, as in email,
1362 `masto`: copy verbatim, as in Mastodon,
1363 `noop`: don't copy the subject.",
1364 suggestions: ["email", "masto", "noop"]
1369 description: "Which theme to use. Available themes are defined in styles.json",
1370 suggestions: ["pleroma-dark"]
1378 description: "Settings for Masto FE",
1381 showInstanceSpecificPanel: true
1386 key: :showInstanceSpecificPanel,
1387 label: "Show instance specific panel",
1389 description: "Whenether to show the instance's specific panel"
1400 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1404 type: {:keyword, :map},
1406 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1409 url: "/images/pleroma-fox-tan-smol.png",
1410 mime_type: "image/png"
1412 pleroma_fox_tan_shy: %{
1413 url: "/images/pleroma-fox-tan-shy.png",
1414 mime_type: "image/png"
1419 key: :default_mascot,
1422 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1428 key: :default_user_avatar,
1429 type: {:string, :image},
1430 description: "URL of the default user avatar",
1431 suggestions: ["/images/avi.png"]
1440 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1444 type: {:list, :map},
1445 description: "Describe the icons of the app",
1448 src: "/static/logo.png"
1451 src: "/static/icon.png",
1455 src: "/static/icon.ico",
1456 sizes: "72x72 96x96 128x128 256x256"
1463 description: "Describe the theme color of the app",
1464 suggestions: ["#282c37", "mediumpurple"]
1467 key: :background_color,
1469 description: "Describe the background color of the app",
1470 suggestions: ["#191b22", "aliceblue"]
1478 description: "Media proxy",
1483 description: "Enables proxying of remote media via the instance's proxy"
1490 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1491 suggestions: ["https://example.com"]
1499 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1505 description: "Enables media cache object invalidation."
1510 description: "Module which will be used to purge objects from the cache.",
1512 Pleroma.Web.MediaProxy.Invalidation.Script,
1513 Pleroma.Web.MediaProxy.Invalidation.Http
1520 label: "Advanced MediaProxy Options",
1522 description: "Internal Pleroma.ReverseProxy settings",
1524 redirect_on_failure: false,
1525 max_body_length: 25 * 1_048_576,
1526 max_read_duration: 30_000
1530 key: :redirect_on_failure,
1533 Redirects the client to the origin server upon encountering HTTP errors.\n
1534 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1535 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1536 IP addresses of your users to the other servers, bypassing the MediaProxy.
1540 key: :max_body_length,
1542 description: "Maximum file size allowed through the Pleroma MediaProxy cache."
1545 key: :max_read_duration,
1547 description: "Timeout (in milliseconds) of GET request to the remote URI."
1553 type: {:list, :string},
1554 description: "List of hosts with scheme to bypass the MediaProxy",
1555 suggestions: ["http://example.com"]
1561 key: :media_preview_proxy,
1563 description: "Media preview proxy",
1569 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1572 key: :thumbnail_max_width,
1575 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1578 key: :thumbnail_max_height,
1581 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1584 key: :image_quality,
1586 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1589 key: :min_content_length,
1592 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1598 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1600 description: "HTTP invalidate settings",
1605 description: "HTTP method of request. Default: :purge"
1609 type: {:keyword, :string},
1610 description: "HTTP headers of request",
1611 suggestions: [{"x-refresh", 1}]
1616 description: "Request options",
1620 type: {:map, :string}
1628 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1630 description: "Script invalidate settings",
1635 description: "Path to shell script. Which will run purge cache.",
1636 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1644 description: "Gopher settings",
1649 description: "Enables the gopher interface"
1655 description: "IP address to bind to",
1656 suggestions: [{0, 0, 0, 0}]
1661 description: "Port to bind to",
1667 description: "Port advertised in URLs (optional, defaults to port)",
1675 label: "ActivityPub",
1677 description: "ActivityPub-related settings",
1680 key: :unfollow_blocked,
1682 description: "Whether blocks result in people getting unfollowed"
1685 key: :outgoing_blocks,
1687 description: "Whether to federate blocks to other instances"
1690 key: :sign_object_fetches,
1692 description: "Sign object fetches with HTTP signatures"
1695 key: :note_replies_output_limit,
1698 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1701 key: :follow_handshake_timeout,
1703 description: "Following handshake timeout",
1710 key: :http_security,
1711 label: "HTTP security",
1713 description: "HTTP security settings",
1718 description: "Whether the managed content security policy is enabled"
1724 description: "Whether to additionally send a Strict-Transport-Security header"
1728 label: "STS max age",
1730 description: "The maximum age for the Strict-Transport-Security header if sent",
1731 suggestions: [31_536_000]
1735 label: "CT max age",
1737 description: "The maximum age for the Expect-CT header if sent",
1738 suggestions: [2_592_000]
1741 key: :referrer_policy,
1743 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1744 suggestions: ["same-origin", "no-referrer"]
1748 label: "Report URI",
1750 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1751 suggestions: ["https://example.com/report-uri"]
1754 key: :service_worker_allowed,
1755 label: "The Service-Worker-Allowed header",
1758 "Sets the Service-Worker-Allowed header which limits the maximum allowed Service Worker scope",
1764 group: :web_push_encryption,
1765 key: :vapid_details,
1766 label: "Vapid Details",
1769 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1775 "A mailto link for the administrative contact." <>
1776 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1777 suggestions: ["mailto:moderators@pleroma.com"]
1782 description: "VAPID public key",
1783 suggestions: ["Public key"]
1788 description: "VAPID private key",
1789 suggestions: ["Private key"]
1795 key: Pleroma.Captcha,
1797 description: "Captcha-related settings",
1802 description: "Whether the captcha should be shown on registration"
1807 description: "The method/service to use for captcha",
1808 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1811 key: :seconds_valid,
1813 description: "The time in seconds for which the captcha is valid",
1820 key: Pleroma.Captcha.Kocaptcha,
1823 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1824 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1829 description: "The kocaptcha endpoint to use",
1830 suggestions: ["https://captcha.kotobank.ch"]
1836 label: "Pleroma Admin Token",
1839 "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)",
1844 description: "Admin token",
1846 "Please use a high entropy string or UUID"
1856 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1860 type: {:dropdown, :atom},
1861 description: "Logs verbose mode",
1862 suggestions: [false, :error, :warn, :info, :debug]
1866 type: {:keyword, :integer},
1868 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1870 activity_expiration: 10,
1871 attachments_cleanup: 5,
1873 federator_incoming: 50,
1874 federator_outgoing: 50,
1876 scheduled_activities: 10,
1882 key: :activity_expiration,
1884 description: "Activity expiration queue",
1890 description: "Backup queue",
1894 key: :attachments_cleanup,
1896 description: "Attachment deletion queue",
1902 description: "Background queue",
1906 key: :federator_incoming,
1908 description: "Incoming federation queue",
1912 key: :federator_outgoing,
1914 description: "Outgoing federation queue",
1920 description: "Email sender queue, see Pleroma.Emails.Mailer",
1924 key: :scheduled_activities,
1926 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1930 key: :transmogrifier,
1932 description: "Transmogrifier queue",
1938 description: "Web push notifications queue",
1945 type: {:list, :tuple},
1946 description: "Settings for cron background jobs",
1948 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1949 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1958 description: "Includes custom worker options not interpretable directly by `Oban`",
1962 type: {:keyword, :integer},
1963 description: "Max retry attempts for failed jobs, per `Oban` queue",
1965 federator_incoming: 5,
1966 federator_outgoing: 5
1973 key: Pleroma.Web.Metadata,
1975 description: "Metadata-related settings",
1979 type: {:list, :module},
1980 description: "List of metadata providers to enable",
1982 Pleroma.Web.Metadata.Providers.OpenGraph,
1983 Pleroma.Web.Metadata.Providers.TwitterCard,
1984 Pleroma.Web.Metadata.Providers.RelMe,
1985 Pleroma.Web.Metadata.Providers.Feed
1990 label: "Unfurl NSFW",
1992 description: "When enabled NSFW attachments will be shown in previews"
2001 "If enabled the instance will parse metadata from attached links to generate link previews",
2006 description: "Enables RichMedia parsing of URLs"
2010 type: {:list, :string},
2011 description: "List of hosts which will be ignored by the metadata parser",
2012 suggestions: ["accounts.google.com", "xss.website"]
2016 label: "Ignore TLD",
2017 type: {:list, :string},
2018 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2019 suggestions: ["local", "localdomain", "lan"]
2023 type: {:list, :module},
2025 "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.",
2027 Pleroma.Web.RichMedia.Parsers.OEmbed,
2028 Pleroma.Web.RichMedia.Parsers.TwitterCard
2033 label: "TTL setters",
2034 type: {:list, :module},
2036 "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.",
2038 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2042 key: :failure_backoff,
2045 "Amount of milliseconds after request failure, during which the request will not be retried.",
2046 suggestions: [60_000]
2052 key: Pleroma.Formatter,
2056 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2060 type: [:string, :boolean],
2061 description: "Specify the class to be added to the generated link. Disable to clear.",
2062 suggestions: ["auto-linker", false]
2066 type: [:string, :boolean],
2067 description: "Override the rel attribute. Disable to clear.",
2068 suggestions: ["ugc", "noopener noreferrer", false]
2073 description: "Link URLs will open in a new window/tab."
2077 type: [:integer, :boolean],
2079 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2080 suggestions: [15, false]
2085 description: "Strip the scheme prefix."
2090 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2094 type: [:atom, :boolean],
2096 "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)",
2097 suggestions: [:no_scheme, true]
2103 key: Pleroma.ScheduledActivity,
2105 description: "Scheduled activities settings",
2108 key: :daily_user_limit,
2111 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2115 key: :total_user_limit,
2118 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2124 description: "Whether scheduled activities are sent to the job queue to be executed"
2130 key: Pleroma.Workers.PurgeExpiredActivity,
2132 description: "Expired activities settings",
2137 description: "Enables expired activities addition & deletion"
2142 description: "Minimum lifetime for ephemeral activity (in seconds)",
2149 label: "Pleroma Authenticator",
2151 description: "Authenticator",
2154 key: Pleroma.Web.Auth.Authenticator,
2156 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2166 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2167 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2168 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2169 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2174 description: "Enables LDAP authentication"
2179 description: "LDAP server hostname",
2180 suggestions: ["localhosts"]
2185 description: "LDAP port, e.g. 389 or 636",
2186 suggestions: [389, 636]
2192 description: "Enable to use SSL, usually implies the port 636"
2196 label: "SSL options",
2198 description: "Additional SSL options",
2199 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2204 description: "Path to file with PEM encoded cacerts",
2205 suggestions: ["path/to/file/with/PEM/cacerts"]
2210 description: "Type of cert verification",
2211 suggestions: [:verify_peer]
2219 description: "Enable to use STARTTLS, usually implies the port 389"
2223 label: "TLS options",
2225 description: "Additional TLS options",
2226 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2231 description: "Path to file with PEM encoded cacerts",
2232 suggestions: ["path/to/file/with/PEM/cacerts"]
2237 description: "Type of cert verification",
2238 suggestions: [:verify_peer]
2245 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2246 suggestions: ["dc=example,dc=com"]
2253 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2262 description: "Authentication / authorization settings",
2265 key: :enforce_oauth_admin_scope_usage,
2266 label: "Enforce OAuth admin scope usage",
2269 "OAuth admin scope requirement toggle. " <>
2270 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2271 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2272 "`is_admin` user flag grants access to admin-specific actions."
2275 key: :auth_template,
2278 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2279 suggestions: ["show.html"]
2282 key: :oauth_consumer_template,
2283 label: "OAuth consumer template",
2286 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2287 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2288 suggestions: ["consumer.html"]
2291 key: :oauth_consumer_strategies,
2292 label: "OAuth consumer strategies",
2293 type: {:list, :string},
2295 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2296 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2297 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2298 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2304 key: :email_notifications,
2306 description: "Email notifications settings",
2312 "emails of \"what you've missed\" for users who have been inactive for a while",
2316 schedule: "0 0 * * 0",
2318 inactivity_threshold: 7
2326 description: "Globally enable or disable digest emails"
2332 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2333 suggestions: ["0 0 * * 0"]
2338 description: "Minimum interval between digest emails to one user",
2342 key: :inactivity_threshold,
2344 description: "Minimum user inactivity threshold",
2353 key: Pleroma.Emails.UserEmail,
2355 description: "Email template settings",
2359 type: {:string, :image},
2360 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2361 suggestions: ["some/path/logo.png"]
2366 description: "A map with color settings for email templates.",
2369 link_color: "#d8a070",
2370 background_color: "#2C3645",
2371 content_background_color: "#1B2635",
2372 header_color: "#d8a070",
2373 text_color: "#b9b9ba",
2374 text_muted_color: "#b9b9ba"
2381 suggestions: ["#d8a070"]
2384 key: :background_color,
2386 suggestions: ["#2C3645"]
2389 key: :content_background_color,
2391 suggestions: ["#1B2635"]
2396 suggestions: ["#d8a070"]
2401 suggestions: ["#b9b9ba"]
2404 key: :text_muted_color,
2406 suggestions: ["#b9b9ba"]
2414 key: Pleroma.Emails.NewUsersDigestEmail,
2416 description: "New users admin email digest",
2421 description: "Enables new users admin digest email when `true`"
2430 description: "Configure OAuth 2 provider capabilities",
2433 key: :token_expires_in,
2435 description: "The lifetime in seconds of the access token",
2436 suggestions: [2_592_000]
2439 key: :issue_new_refresh_token,
2442 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2445 key: :clean_expired_tokens,
2447 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2457 key: :shortcode_globs,
2458 type: {:list, :string},
2459 description: "Location of custom emoji files. * can be used as a wildcard.",
2460 suggestions: ["/emoji/custom/**/*.png"]
2463 key: :pack_extensions,
2464 type: {:list, :string},
2466 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2467 suggestions: [".png", ".gif"]
2471 type: {:keyword, {:list, :string}},
2473 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2474 " and the value is the location or array of locations. * can be used as a wildcard.",
2476 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2480 key: :default_manifest,
2483 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2484 " Currently only one manifest can be added (no arrays).",
2485 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2488 key: :shared_pack_cache_seconds_per_file,
2489 label: "Shared pack cache s/file",
2492 "When an emoji pack is shared, the archive is created and cached in memory" <>
2493 " for this amount of seconds multiplied by the number of files.",
2503 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2507 type: [:tuple, {:list, :tuple}],
2508 description: "For the search requests (account & status search etc.)",
2509 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2513 type: [:tuple, {:list, :tuple}],
2514 description: "For requests to timelines (each timeline has it's own limiter)",
2515 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2518 key: :app_account_creation,
2519 type: [:tuple, {:list, :tuple}],
2520 description: "For registering user accounts from the same IP address",
2521 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2524 key: :relations_actions,
2525 type: [:tuple, {:list, :tuple}],
2526 description: "For actions on relationships with all users (follow, unfollow)",
2527 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2530 key: :relation_id_action,
2531 label: "Relation ID action",
2532 type: [:tuple, {:list, :tuple}],
2533 description: "For actions on relation with a specific user (follow, unfollow)",
2534 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2537 key: :statuses_actions,
2538 type: [:tuple, {:list, :tuple}],
2540 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2541 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2544 key: :status_id_action,
2545 label: "Status ID action",
2546 type: [:tuple, {:list, :tuple}],
2548 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2549 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2552 key: :authentication,
2553 type: [:tuple, {:list, :tuple}],
2554 description: "For authentication create / password check / user existence check requests",
2555 suggestions: [{60_000, 15}]
2564 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2565 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2570 description: "Enables SSH"
2575 description: "Dir with SSH keys",
2576 suggestions: ["/some/path/ssh_keys"]
2581 description: "Handler module",
2582 suggestions: ["Pleroma.BBS.Handler"]
2587 description: "Port to connect",
2588 suggestions: [10_022]
2591 key: :password_authenticator,
2593 description: "Authenticator module",
2594 suggestions: ["Pleroma.BBS.Authenticator"]
2600 label: "Mime Types",
2602 description: "Mime Types settings",
2609 "application/xml" => ["xml"],
2610 "application/xrd+xml" => ["xrd+xml"],
2611 "application/jrd+json" => ["jrd+json"],
2612 "application/activity+json" => ["activity+json"],
2613 "application/ld+json" => ["activity+json"]
2618 key: "application/xml",
2619 type: {:list, :string},
2620 suggestions: ["xml"]
2623 key: "application/xrd+xml",
2624 type: {:list, :string},
2625 suggestions: ["xrd+xml"]
2628 key: "application/jrd+json",
2629 type: {:list, :string},
2630 suggestions: ["jrd+json"]
2633 key: "application/activity+json",
2634 type: {:list, :string},
2635 suggestions: ["activity+json"]
2638 key: "application/ld+json",
2639 type: {:list, :string},
2640 suggestions: ["activity+json"]
2650 description: "Pleroma chat settings",
2663 description: "HTTP settings",
2668 type: [:string, :tuple],
2669 description: "Proxy URL",
2670 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2673 key: :send_user_agent,
2678 type: [:string, :atom],
2680 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2681 suggestions: ["Pleroma", :default]
2686 description: "Adapter specific options",
2692 label: "SSL Options",
2693 description: "SSL options for HTTP adapter",
2697 type: {:list, :atom},
2698 description: "List of TLS version to use",
2699 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2710 label: "Markup Settings",
2714 key: :allow_inline_images,
2718 key: :allow_headings,
2731 type: {:list, :module},
2733 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2734 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2744 key: :deny_follow_blocked,
2755 key: :restricted_nicknames,
2756 type: {:list, :string},
2757 description: "List of nicknames users may not register with.",
2776 "ostatus_subscribe",
2792 key: :email_blacklist,
2793 type: {:list, :string},
2794 description: "List of email domains users may not register with.",
2795 suggestions: ["mailinator.com", "maildrop.cc"]
2801 label: "CORS plug config",
2807 suggestions: [86_400]
2811 type: {:list, :string},
2812 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2816 type: {:list, :string},
2819 "X-RateLimit-Reset",
2820 "X-RateLimit-Limit",
2821 "X-RateLimit-Remaining",
2832 type: {:list, :string},
2833 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2839 key: Pleroma.Web.Plugs.RemoteIp,
2842 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2843 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2849 description: "Enable/disable the plug. Default: disabled."
2853 type: {:list, :string},
2855 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2860 type: {:list, :string},
2862 "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."
2866 type: {:list, :string},
2868 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"]`
2875 key: :web_cache_ttl,
2876 label: "Web cache TTL",
2879 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2885 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2886 suggestions: [30_000, nil]
2889 key: :activity_pub_question,
2891 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2892 suggestions: [30_000]
2902 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2907 description: "Enables the rendering of static HTML. Default: disabled."
2915 description: "Configure feed rendering",
2920 description: "Configure title rendering",
2925 description: "Maximum number of characters before truncating title",
2931 description: "Replacement which will be used after truncating string",
2932 suggestions: ["..."]
2942 description: "Custom Runtime Modules",
2947 description: "A path to custom Elixir modules (such as MRF policies)."
2955 description: "Settings for notifications streamer",
2960 description: "Number of workers to send notifications",
2964 key: :overflow_workers,
2966 description: "Maximum number of workers created if pool is empty",
2973 key: :connections_pool,
2975 description: "Advanced settings for `Gun` connections pool",
2978 key: :connection_acquisition_wait,
2981 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2985 key: :connection_acquisition_retries,
2988 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2992 key: :max_connections,
2994 description: "Maximum number of connections in the pool. Default: 250 connections.",
2998 key: :connect_timeout,
3000 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3004 key: :reclaim_multiplier,
3007 "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",
3016 description: "Advanced settings for `Gun` workers pools",
3018 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3022 description: "Settings for #{pool_name} pool.",
3027 description: "Maximum number of concurrent requests in the pool.",
3034 "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",
3040 description: "Timeout for the pool while gun will wait for response",
3041 suggestions: [10_000]
3049 key: :hackney_pools,
3051 description: "Advanced settings for `Hackney` connections pools",
3056 description: "Settings for federation pool.",
3059 key: :max_connections,
3061 description: "Number workers in the pool.",
3067 description: "Timeout while `hackney` will wait for response.",
3068 suggestions: [150_000]
3075 description: "Settings for media pool.",
3078 key: :max_connections,
3080 description: "Number workers in the pool.",
3086 description: "Timeout while `hackney` will wait for response.",
3087 suggestions: [150_000]
3094 description: "Settings for upload pool.",
3097 key: :max_connections,
3099 description: "Number workers in the pool.",
3105 description: "Timeout while `hackney` will wait for response.",
3106 suggestions: [300_000]
3114 key: :restrict_unauthenticated,
3115 label: "Restrict Unauthenticated",
3118 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3123 description: "Settings for public and federated timelines.",
3128 description: "Disallow view public timeline."
3133 description: "Disallow view federated timeline."
3140 description: "Settings for user profiles.",
3145 description: "Disallow view local user profiles."
3150 description: "Disallow view remote user profiles."
3157 description: "Settings for statuses.",
3162 description: "Disallow view local statuses."
3167 description: "Disallow view remote statuses."
3175 key: Pleroma.Web.ApiSpec.CastAndValidate,
3182 "Enables strict input validation (useful in development, not recommended in production)"
3188 key: :instances_favicons,
3190 description: "Control favicons for instances",
3195 description: "Allow/disallow displaying and getting instances favicons"
3203 descriptions: "S3 service related settings",
3206 key: :access_key_id,
3208 description: "S3 access key ID",
3209 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3212 key: :secret_access_key,
3214 description: "Secret access key",
3215 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3220 description: "S3 host",
3221 suggestions: ["s3.eu-central-1.amazonaws.com"]
3229 description: "Installed frontends management",
3234 description: "Primary frontend, the one that is served for all pages by default",
3235 children: installed_frontend_options
3240 description: "Admin frontend",
3241 children: installed_frontend_options
3247 "A map containing available frontends and parameters for their installation.",
3248 children: frontend_options
3254 key: Pleroma.Web.Preload,
3256 description: "Preload-related settings",
3260 type: {:list, :module},
3261 description: "List of preload providers to enable",
3263 Pleroma.Web.Preload.Providers.Instance,
3264 Pleroma.Web.Preload.Providers.User,
3265 Pleroma.Web.Preload.Providers.Timelines,
3266 Pleroma.Web.Preload.Providers.StatusNet
3275 description: "Majic/libmagic configuration",
3280 description: "Number of majic workers to start.",
3287 key: Pleroma.User.Backup,
3289 description: "Account Backup",
3292 key: :purge_after_days,
3294 description: "Remove backup achives after N days",
3300 description: "Limit user to export not more often than once per N days",
3307 key: Pleroma.Web.Endpoint.MetricsExporter,
3309 description: "Prometheus app metrics endpoint configuration",
3314 description: "[Pleroma extension] Enables app metrics endpoint."
3318 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3320 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3324 type: [:boolean, :tuple],
3325 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3326 suggestion: [false, {:basic, "myusername", "mypassword"}]
3331 description: "App metrics endpoint URI path.",
3332 suggestions: ["/api/pleroma/app_metrics"]
3337 description: "App metrics endpoint output format.",
3338 suggestions: [:text, :protobuf]
3344 key: ConcurrentLimiter,
3346 description: "Limits configuration for background tasks.",
3349 key: Pleroma.Web.RichMedia.Helpers,
3351 description: "Concurrent limits configuration for getting RichMedia for activities.",
3352 suggestions: [max_running: 5, max_waiting: 5],
3357 description: "Max running concurrently jobs.",
3363 description: "Max waiting jobs.",
3369 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3371 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3372 suggestions: [max_running: 5, max_waiting: 5],
3377 description: "Max running concurrently jobs.",
3383 description: "Max waiting jobs.",