6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
105 "https://cdn-host.com"
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
117 key: :filename_display_max_length,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
125 key: Pleroma.Uploaders.Local,
127 description: "Local uploader-related settings",
132 description: "Path where user's uploads will be saved",
141 key: Pleroma.Uploaders.S3,
143 description: "S3 uploader-related settings",
148 description: "S3 bucket",
154 key: :bucket_namespace,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
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 Upload base_url."
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",
220 label: "Mailer Enabled",
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
229 Swoosh.Adapters.AmazonSES,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
244 group: {:subgroup, Swoosh.Adapters.SMTP},
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "SMTP port",
255 suggestions: ["1025"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "Use Implicit SSL/TLS. e.g. port 465"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "SMTP temporary (4xx) error retries",
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 label: "SendGrid API Key",
306 suggestions: ["YOUR_API_KEY"]
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
323 label: "Qmail compat mode",
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
329 label: "Mandrill API Key",
331 suggestions: ["YOUR_API_KEY"]
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
336 label: "Mailgun API Key",
338 suggestions: ["YOUR_API_KEY"]
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
344 suggestions: ["YOUR_DOMAIN_NAME"]
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
349 label: "MailJet Public API Key",
351 suggestions: ["MJ_APIKEY_PUBLIC"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
356 label: "MailJet Private API Key",
358 suggestions: ["MJ_APIKEY_PRIVATE"]
361 group: {:subgroup, Swoosh.Adapters.Postmark},
363 label: "Postmark API Key",
365 suggestions: ["X-Postmark-Server-Token"]
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
370 label: "SparkPost API key",
372 suggestions: ["YOUR_API_KEY"]
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 suggestions: ["https://api.sparkpost.com/api/v1"]
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
383 label: "AWS Access Key",
385 suggestions: ["AWS_ACCESS_KEY"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
390 label: "AWS Secret Key",
392 suggestions: ["AWS_SECRET_KEY"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.Dyn},
404 label: "Dyn API Key",
406 suggestions: ["apikey"]
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
411 label: "SocketLabs API Key",
413 suggestions: ["INJECTION_API_KEY"]
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 suggestions: ["SERVER_ID"]
423 group: {:subgroup, Swoosh.Adapters.Gmail},
425 label: "GMail API Access Token",
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
434 label: "URI Schemes",
436 description: "URI schemes related settings",
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
466 description: "Customizable features",
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
479 key: :populate_hashtags_table,
481 description: "`populate_hashtags_table` background migration settings",
484 key: :fault_rate_allowance,
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
491 key: :sleep_interval_ms,
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
500 key: :delete_context_objects,
502 description: "`delete_context_objects` background migration settings",
505 key: :fault_rate_allowance,
508 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if context object deletion failed for all records.",
512 key: :sleep_interval_ms,
515 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
523 description: "Instance-related settings",
528 description: "Name of the instance",
535 label: "Admin Email Address",
537 description: "Email used to reach an Administrator/Moderator of the instance",
544 label: "Sender Email Address",
546 description: "Envelope FROM address for mail sent via Pleroma",
555 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
561 key: :short_description,
564 "Shorter version of instance description. It can be seen on `/api/v1/instance`",
572 description: "Posts character limit (CW/Subject included in the counter)",
580 description: "Hard character limit beyond which remote posts will be dropped",
586 key: :max_media_attachments,
588 description: "Maximum number of post media attachments",
596 description: "File size limit of uploads (except for avatar, background, banner)",
602 key: :avatar_upload_limit,
604 description: "File size limit of user's profile avatars",
610 key: :background_upload_limit,
612 description: "File size limit of user's profile backgrounds",
618 key: :banner_upload_limit,
620 description: "File size limit of user's profile banners",
628 description: "A map with poll limits for local polls",
632 max_option_chars: 200,
634 max_expiration: 31_536_000
641 description: "Maximum number of options",
645 key: :max_option_chars,
647 description: "Maximum number of characters per option",
651 key: :min_expiration,
653 description: "Minimum expiration time (in seconds)",
657 key: :max_expiration,
659 description: "Maximum expiration time (in seconds)",
665 key: :registrations_open,
668 "Enable registrations for anyone. Invitations require this setting to be disabled."
671 key: :invites_enabled,
674 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
677 key: :account_activation_required,
679 description: "Require users to confirm their emails before signing in"
682 key: :account_approval_required,
684 description: "Require users to be manually approved by an admin before signing in"
689 description: "Enable federation with other instances"
692 key: :federation_incoming_replies_max_depth,
693 label: "Fed. incoming replies max depth",
696 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
697 " 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.",
703 key: :federation_reachability_timeout_days,
704 label: "Fed. reachability timeout days",
707 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
716 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
722 "Makes the client API in authenticated mode-only except for user-profiles." <>
723 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
724 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
727 key: :quarantined_instances,
728 type: {:list, :tuple},
729 key_placeholder: "instance",
730 value_placeholder: "reason",
732 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent and the reason for doing so",
734 {"quarantined.com", "Reason"},
735 {"*.quarantined.com", "Reason"}
741 description: "Instance static directory",
747 key: :allowed_post_formats,
748 type: {:list, :string},
749 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
758 key: :extended_nickname_format,
761 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
762 " This will break federation with older software for theses nicknames."
765 key: :cleanup_attachments,
768 Enable to remove associated attachments when status is removed.
769 This will not affect duplicates and attachments without status.
770 Enabling this will increase load to database when deleting statuses on larger instances.
774 key: :max_pinned_statuses,
776 description: "The maximum number of pinned statuses. 0 will disable the feature.",
784 key: :max_endorsed_users,
786 description: "The maximum number of recommended accounts. 0 will disable the feature.",
794 key: :autofollowed_nicknames,
795 type: {:list, :string},
797 "Set to nicknames of (local) users that every new user should automatically follow"
800 key: :autofollowing_nicknames,
801 type: {:list, :string},
803 "Set to nicknames of (local) users that automatically follows every newly registered user"
806 key: :attachment_links,
808 description: "Enable to automatically add attachment link text to statuses"
811 key: :max_report_comment_size,
813 description: "The maximum size of the report comment. Default: 1000.",
819 key: :report_strip_status,
820 label: "Report strip status",
823 "Strip associated statuses in reports to ids when closed/resolved, otherwise keep a copy"
826 key: :safe_dm_mentions,
827 label: "Safe DM mentions",
830 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
831 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
837 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
840 key: :remote_post_retention_days,
843 "The default amount of days to retain remote posts when pruning the database",
849 key: :user_bio_length,
851 description: "A user bio maximum length. Default: 5000.",
857 key: :user_name_length,
859 description: "A user name maximum length. Default: 100.",
865 key: :skip_thread_containment,
867 description: "Skip filtering out broken threads. Default: enabled."
870 key: :limit_to_local_content,
871 type: {:dropdown, :atom},
873 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
881 key: :max_account_fields,
883 description: "The maximum number of custom fields in the user profile. Default: 10.",
889 key: :max_remote_account_fields,
892 "The maximum number of custom fields in the remote user profile. Default: 20.",
898 key: :account_field_name_length,
900 description: "An account field name maximum length. Default: 512.",
906 key: :account_field_value_length,
908 description: "An account field value maximum length. Default: 2048.",
914 key: :registration_reason_length,
916 description: "Maximum registration reason length. Default: 500.",
922 key: :external_user_synchronization,
924 description: "Enabling following/followers counters synchronization for external users"
927 key: :multi_factor_authentication,
929 description: "Multi-factor authentication settings",
932 totp: [digits: 6, period: 30],
933 backup_codes: [number: 5, length: 16]
939 label: "TOTP settings",
941 description: "TOTP settings",
942 suggestions: [digits: 6, period: 30],
949 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
956 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
963 description: "MFA backup codes settings",
964 suggestions: [number: 5, length: 16],
970 description: "Number of backup codes to generate."
977 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
984 key: :instance_thumbnail,
985 type: {:string, :image},
987 "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.",
988 suggestions: ["/instance/thumbnail.jpeg"]
991 key: :show_reactions,
993 description: "Let favourites and emoji reactions be viewed through the API."
996 key: :profile_directory,
998 description: "Enable profile directory."
1001 key: :admin_privileges,
1002 type: {:list, :atom},
1005 :users_manage_invites,
1006 :users_manage_activation_state,
1008 :users_manage_credentials,
1013 :reports_manage_reports,
1014 :moderation_log_read,
1015 :announcements_manage_announcements,
1016 :emoji_manage_emoji,
1020 "What extra privileges to allow admins (e.g. updating user credentials, get password reset token, delete users, index and read private statuses and chats)"
1023 key: :moderator_privileges,
1024 type: {:list, :atom},
1027 :users_manage_invites,
1028 :users_manage_activation_state,
1030 :users_manage_credentials,
1035 :reports_manage_reports,
1036 :moderation_log_read,
1037 :announcements_manage_announcements,
1038 :emoji_manage_emoji,
1042 "What extra privileges to allow moderators (e.g. updating user credentials, get password reset token, delete users, index and read private statuses and chats)"
1045 key: :birthday_required,
1047 description: "Require users to enter their birthday."
1050 key: :birthday_min_age,
1053 "Minimum required age (in days) for users to create account. Only used if birthday is required.",
1062 description: "Welcome messages settings",
1065 key: :direct_message,
1067 descpiption: "Direct message settings",
1072 description: "Enables sending a direct message to newly registered users"
1077 description: "A message that will be sent to newly registered users",
1079 "Hi, @username! Welcome on board!"
1083 key: :sender_nickname,
1085 description: "The nickname of the local user that sends a welcome message",
1095 descpiption: "Chat message settings",
1100 description: "Enables sending a chat message to newly registered users"
1106 "A message that will be sent to newly registered users as a chat message",
1108 "Hello, welcome on board!"
1112 key: :sender_nickname,
1114 description: "The nickname of the local user that sends a welcome chat message",
1124 descpiption: "Email message settings",
1129 description: "Enables sending an email to newly registered users"
1133 type: [:string, :tuple],
1135 "Email address and/or nickname that will be used to send the welcome email.",
1137 {"Pleroma App", "welcome@pleroma.app"}
1144 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1145 suggestions: ["Welcome to <%= instance_name%>"]
1151 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1152 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1158 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1159 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1168 description: "Logger-related settings",
1172 type: [:atom, :tuple, :module],
1174 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1175 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1183 label: "ExSyslogger",
1184 description: "ExSyslogger-related settings",
1188 type: {:dropdown, :atom},
1189 description: "Log level",
1190 suggestions: [:debug, :info, :warn, :error]
1196 "A string that's prepended to every message, and is typically set to the app name",
1197 suggestions: ["pleroma"]
1202 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1203 suggestions: ["$metadata[$level] $message"]
1207 type: {:list, :atom},
1208 suggestions: [:request_id]
1216 label: "Console Logger",
1217 description: "Console logger settings",
1221 type: {:dropdown, :atom},
1222 description: "Log level",
1223 suggestions: [:debug, :info, :warn, :error]
1228 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1229 suggestions: ["$metadata[$level] $message"]
1233 type: {:list, :atom},
1234 suggestions: [:request_id]
1240 key: :frontend_configurations,
1243 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1244 "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
1245 "add your own configuration your settings all fields must be complete.",
1249 label: "Pleroma FE",
1251 description: "Settings for Pleroma FE",
1254 alwaysShowSubjectInput: true,
1255 background: "/static/aurora_borealis.jpg",
1256 collapseMessageWithSubject: false,
1258 hideFilteredStatuses: false,
1259 hideMutedPosts: false,
1260 hidePostStats: false,
1261 hideSitename: false,
1262 hideUserStats: false,
1263 loginMethod: "password",
1264 logo: "/static/logo.svg",
1267 minimalScopesMode: false,
1268 noAttachmentLinks: false,
1269 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1270 postContentType: "text/plain",
1271 redirectRootLogin: "/main/friends",
1272 redirectRootNoLogin: "/main/all",
1274 sidebarRight: false,
1275 showFeaturesPanel: true,
1276 showInstanceSpecificPanel: false,
1277 subjectLineBehavior: "email",
1278 theme: "pleroma-dark",
1279 webPushNotifications: false
1284 key: :alwaysShowSubjectInput,
1285 label: "Always show subject input",
1287 description: "When disabled, auto-hide the subject field if it's empty"
1291 type: {:string, :image},
1293 "URL of the background, unless viewing a user profile with a background that is set",
1294 suggestions: ["/images/city.jpg"]
1297 key: :collapseMessageWithSubject,
1298 label: "Collapse message with subject",
1301 "When a message has a subject (aka Content Warning), collapse it by default"
1307 description: "Enables green text on lines prefixed with the > character"
1310 key: :hideFilteredStatuses,
1311 label: "Hide Filtered Statuses",
1313 description: "Hides filtered statuses from timelines"
1316 key: :hideMutedPosts,
1317 label: "Hide Muted Posts",
1319 description: "Hides muted statuses from timelines"
1322 key: :hidePostStats,
1323 label: "Hide post stats",
1325 description: "Hide notices statistics (repeats, favorites, ...)"
1329 label: "Hide Sitename",
1331 description: "Hides instance name from PleromaFE banner"
1334 key: :hideUserStats,
1335 label: "Hide user stats",
1338 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1342 type: {:string, :image},
1343 description: "URL of the logo, defaults to Pleroma's logo",
1344 suggestions: ["/static/logo.svg"]
1348 label: "Logo margin",
1351 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1352 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1353 suggestions: [".1em"]
1360 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1361 "If you want a colorful logo you must disable logoMask."
1364 key: :minimalScopesMode,
1365 label: "Minimal scopes mode",
1368 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1369 "Also prevents replying to a DM with a public post from PleromaFE."
1372 key: :nsfwCensorImage,
1373 label: "NSFW Censor Image",
1374 type: {:string, :image},
1376 "URL of the image to use for hiding NSFW media attachments in the timeline",
1377 suggestions: ["/static/img/nsfw.74818f9.png"]
1380 key: :postContentType,
1381 label: "Post Content Type",
1382 type: {:dropdown, :atom},
1383 description: "Default post formatting option",
1384 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1387 key: :redirectRootNoLogin,
1388 label: "Redirect root no login",
1391 "Relative URL which indicates where to redirect when a user isn't logged in",
1392 suggestions: ["/main/all"]
1395 key: :redirectRootLogin,
1396 label: "Redirect root login",
1399 "Relative URL which indicates where to redirect when a user is logged in",
1400 suggestions: ["/main/friends"]
1404 label: "Scope copy",
1406 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1410 label: "Sidebar on Right",
1412 description: "Change alignment of sidebar and panels to the right"
1415 key: :showFeaturesPanel,
1416 label: "Show instance features panel",
1419 "Enables panel displaying functionality of the instance on the About page"
1422 key: :showInstanceSpecificPanel,
1423 label: "Show instance specific panel",
1425 description: "Whether to show the instance's custom panel"
1428 key: :subjectLineBehavior,
1429 label: "Subject line behavior",
1431 description: "Allows changing the default behaviour of subject lines in replies.
1432 `email`: copy and preprend re:, as in email,
1433 `masto`: copy verbatim, as in Mastodon,
1434 `noop`: don't copy the subject.",
1435 suggestions: ["email", "masto", "noop"]
1440 description: "Which theme to use. Available themes are defined in styles.json",
1441 suggestions: ["pleroma-dark"]
1452 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1456 type: {:keyword, :map},
1458 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1461 url: "/images/pleroma-fox-tan-smol.png",
1462 mime_type: "image/png"
1464 pleroma_fox_tan_shy: %{
1465 url: "/images/pleroma-fox-tan-shy.png",
1466 mime_type: "image/png"
1471 key: :default_mascot,
1474 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1480 key: :default_user_avatar,
1481 type: {:string, :image},
1482 description: "URL of the default user avatar",
1483 suggestions: ["/images/avi.png"]
1492 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1496 type: {:list, :map},
1497 description: "Describe the icons of the app",
1500 src: "/static/logo.png"
1503 src: "/static/icon.png",
1507 src: "/static/icon.ico",
1508 sizes: "72x72 96x96 128x128 256x256"
1515 description: "Describe the theme color of the app",
1516 suggestions: ["#282c37", "mediumpurple"]
1519 key: :background_color,
1521 description: "Describe the background color of the app",
1522 suggestions: ["#191b22", "aliceblue"]
1530 description: "Media proxy",
1535 description: "Enables proxying of remote media via the instance's proxy"
1542 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1543 suggestions: ["https://example.com"]
1551 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1557 description: "Enables media cache object invalidation."
1562 description: "Module which will be used to purge objects from the cache.",
1564 Pleroma.Web.MediaProxy.Invalidation.Script,
1565 Pleroma.Web.MediaProxy.Invalidation.Http
1572 label: "Advanced MediaProxy Options",
1574 description: "Internal Pleroma.ReverseProxy settings",
1576 redirect_on_failure: false,
1577 max_body_length: 25 * 1_048_576,
1578 max_read_duration: 30_000
1582 key: :redirect_on_failure,
1585 Redirects the client to the origin server upon encountering HTTP errors.\n
1586 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1587 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1588 IP addresses of your users to the other servers, bypassing the MediaProxy.
1592 key: :max_body_length,
1595 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1598 key: :max_read_duration,
1600 description: "Timeout (in milliseconds) of GET request to the remote URI."
1606 type: {:list, :string},
1607 description: "List of hosts with scheme to bypass the MediaProxy",
1608 suggestions: ["http://example.com"]
1614 key: :media_preview_proxy,
1616 description: "Media preview proxy",
1622 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1625 key: :thumbnail_max_width,
1628 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1631 key: :thumbnail_max_height,
1634 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1637 key: :image_quality,
1639 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1642 key: :min_content_length,
1645 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1651 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1653 description: "HTTP invalidate settings",
1658 description: "HTTP method of request. Default: :purge"
1662 type: {:keyword, :string},
1663 description: "HTTP headers of request",
1664 suggestions: [{"x-refresh", 1}]
1669 description: "Request options",
1673 type: {:map, :string}
1681 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1683 description: "Invalidation script settings",
1688 description: "Path to executable script which will purge cached items.",
1689 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1693 label: "URL Format",
1696 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1697 suggestions: [":htcacheclean"]
1705 description: "Gopher settings",
1710 description: "Enables the gopher interface"
1716 description: "IP address to bind to",
1717 suggestions: [{0, 0, 0, 0}]
1722 description: "Port to bind to",
1728 description: "Port advertised in URLs (optional, defaults to port)",
1736 label: "ActivityPub",
1738 description: "ActivityPub-related settings",
1741 key: :unfollow_blocked,
1743 description: "Whether blocks result in people getting unfollowed"
1746 key: :outgoing_blocks,
1748 description: "Whether to federate blocks to other instances"
1751 key: :blockers_visible,
1753 description: "Whether a user can see someone who has blocked them"
1756 key: :sign_object_fetches,
1758 description: "Sign object fetches with HTTP signatures"
1761 key: :authorized_fetch_mode,
1763 description: "Require HTTP signatures for AP fetches"
1766 key: :note_replies_output_limit,
1769 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1772 key: :follow_handshake_timeout,
1774 description: "Following handshake timeout",
1781 key: :http_security,
1782 label: "HTTP security",
1784 description: "HTTP security settings",
1789 description: "Whether the managed content security policy is enabled"
1795 description: "Whether to additionally send a Strict-Transport-Security header"
1799 label: "STS max age",
1801 description: "The maximum age for the Strict-Transport-Security header if sent",
1802 suggestions: [31_536_000]
1806 label: "CT max age",
1808 description: "The maximum age for the Expect-CT header if sent",
1809 suggestions: [2_592_000]
1812 key: :referrer_policy,
1814 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1815 suggestions: ["same-origin", "no-referrer"]
1819 label: "Report URI",
1821 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1822 suggestions: ["https://example.com/report-uri"]
1827 group: :web_push_encryption,
1828 key: :vapid_details,
1829 label: "Vapid Details",
1832 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1838 "A mailto link for the administrative contact." <>
1839 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1840 suggestions: ["mailto:moderators@pleroma.com"]
1845 description: "VAPID public key",
1846 suggestions: ["Public key"]
1851 description: "VAPID private key",
1852 suggestions: ["Private key"]
1858 key: Pleroma.Captcha,
1860 description: "Captcha-related settings",
1865 description: "Whether the captcha should be shown on registration"
1870 description: "The method/service to use for captcha",
1871 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1874 key: :seconds_valid,
1876 description: "The time in seconds for which the captcha is valid",
1883 key: Pleroma.Captcha.Kocaptcha,
1886 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1887 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1892 description: "The kocaptcha endpoint to use",
1893 suggestions: ["https://captcha.kotobank.ch"]
1899 label: "Pleroma Admin Token",
1902 "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)",
1907 description: "Admin token",
1909 "Please use a high entropy string or UUID"
1919 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1923 type: {:dropdown, :atom},
1924 description: "Logs verbose mode",
1925 suggestions: [false, :error, :warn, :info, :debug]
1929 type: {:keyword, :integer},
1931 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1933 activity_expiration: 10,
1934 attachments_cleanup: 5,
1936 federator_incoming: 50,
1937 federator_outgoing: 50,
1939 scheduled_activities: 10,
1945 key: :activity_expiration,
1947 description: "Activity expiration queue",
1953 description: "Backup queue",
1957 key: :attachments_cleanup,
1959 description: "Attachment deletion queue",
1965 description: "Background queue",
1969 key: :federator_incoming,
1971 description: "Incoming federation queue",
1975 key: :federator_outgoing,
1977 description: "Outgoing federation queue",
1983 description: "Email sender queue, see Pleroma.Emails.Mailer",
1987 key: :scheduled_activities,
1989 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1993 key: :transmogrifier,
1995 description: "Transmogrifier queue",
2001 description: "Web push notifications queue",
2008 type: {:list, :tuple},
2009 description: "Settings for cron background jobs",
2011 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2012 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2021 description: "Includes custom worker options not interpretable directly by `Oban`",
2025 type: {:keyword, :integer},
2026 description: "Max retry attempts for failed jobs, per `Oban` queue",
2028 federator_incoming: 5,
2029 federator_outgoing: 5
2036 key: Pleroma.Web.Metadata,
2038 description: "Metadata-related settings",
2042 type: {:list, :module},
2043 description: "List of metadata providers to enable",
2045 Pleroma.Web.Metadata.Providers.OpenGraph,
2046 Pleroma.Web.Metadata.Providers.TwitterCard,
2047 Pleroma.Web.Metadata.Providers.RelMe,
2048 Pleroma.Web.Metadata.Providers.Feed
2053 label: "Unfurl NSFW",
2055 description: "When enabled NSFW attachments will be shown in previews"
2064 "If enabled the instance will parse metadata from attached links to generate link previews",
2069 description: "Enables RichMedia parsing of URLs"
2073 type: {:list, :string},
2074 description: "List of hosts which will be ignored by the metadata parser",
2075 suggestions: ["accounts.google.com", "xss.website"]
2079 label: "Ignore TLD",
2080 type: {:list, :string},
2081 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2082 suggestions: ["local", "localdomain", "lan"]
2086 type: {:list, :module},
2088 "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.",
2090 Pleroma.Web.RichMedia.Parsers.OEmbed,
2091 Pleroma.Web.RichMedia.Parsers.TwitterCard
2096 label: "TTL setters",
2097 type: {:list, :module},
2099 "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.",
2101 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2105 key: :failure_backoff,
2108 "Amount of milliseconds after request failure, during which the request will not be retried.",
2109 suggestions: [60_000]
2115 key: Pleroma.Formatter,
2119 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2123 type: [:string, :boolean],
2124 description: "Specify the class to be added to the generated link. Disable to clear.",
2125 suggestions: ["auto-linker", false]
2129 type: [:string, :boolean],
2130 description: "Override the rel attribute. Disable to clear.",
2131 suggestions: ["ugc", "noopener noreferrer", false]
2136 description: "Link URLs will open in a new window/tab."
2140 type: [:integer, :boolean],
2142 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2143 suggestions: [15, false]
2148 description: "Strip the scheme prefix."
2153 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2157 type: [:atom, :boolean],
2159 "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)",
2160 suggestions: [:no_scheme, true]
2166 key: Pleroma.ScheduledActivity,
2168 description: "Scheduled activities settings",
2171 key: :daily_user_limit,
2174 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2178 key: :total_user_limit,
2181 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2187 description: "Whether scheduled activities are sent to the job queue to be executed"
2193 key: Pleroma.Workers.PurgeExpiredActivity,
2195 description: "Expired activities settings",
2200 description: "Enables expired activities addition & deletion"
2205 description: "Minimum lifetime for ephemeral activity (in seconds)",
2212 label: "Pleroma Authenticator",
2214 description: "Authenticator",
2217 key: Pleroma.Web.Auth.Authenticator,
2219 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2229 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2230 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2231 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2232 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2237 description: "Enables LDAP authentication"
2242 description: "LDAP server hostname",
2243 suggestions: ["localhosts"]
2248 description: "LDAP port, e.g. 389 or 636",
2249 suggestions: [389, 636]
2255 description: "Enable to use SSL, usually implies the port 636"
2259 label: "SSL options",
2261 description: "Additional SSL options",
2262 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2267 description: "Path to file with PEM encoded cacerts",
2268 suggestions: ["path/to/file/with/PEM/cacerts"]
2273 description: "Type of cert verification",
2274 suggestions: [:verify_peer]
2282 description: "Enable to use STARTTLS, usually implies the port 389"
2286 label: "TLS options",
2288 description: "Additional TLS options",
2289 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2294 description: "Path to file with PEM encoded cacerts",
2295 suggestions: ["path/to/file/with/PEM/cacerts"]
2300 description: "Type of cert verification",
2301 suggestions: [:verify_peer]
2308 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2309 suggestions: ["dc=example,dc=com"]
2316 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2325 description: "Authentication / authorization settings",
2328 key: :enforce_oauth_admin_scope_usage,
2329 label: "Enforce OAuth admin scope usage",
2332 "OAuth admin scope requirement toggle. " <>
2333 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2334 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2335 "`is_admin` user flag grants access to admin-specific actions."
2338 key: :auth_template,
2341 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2342 suggestions: ["show.html"]
2345 key: :oauth_consumer_template,
2346 label: "OAuth consumer template",
2349 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2350 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2351 suggestions: ["consumer.html"]
2354 key: :oauth_consumer_strategies,
2355 label: "OAuth consumer strategies",
2356 type: {:list, :string},
2358 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2359 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2360 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2361 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2367 key: :email_notifications,
2369 description: "Email notifications settings",
2375 "emails of \"what you've missed\" for users who have been inactive for a while",
2379 schedule: "0 0 * * 0",
2381 inactivity_threshold: 7
2389 description: "Globally enable or disable digest emails"
2395 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2396 suggestions: ["0 0 * * 0"]
2401 description: "Minimum interval between digest emails to one user",
2405 key: :inactivity_threshold,
2407 description: "Minimum user inactivity threshold",
2416 key: Pleroma.Emails.UserEmail,
2418 description: "Email template settings",
2422 type: {:string, :image},
2423 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2424 suggestions: ["some/path/logo.png"]
2429 description: "A map with color settings for email templates.",
2432 link_color: "#d8a070",
2433 background_color: "#2C3645",
2434 content_background_color: "#1B2635",
2435 header_color: "#d8a070",
2436 text_color: "#b9b9ba",
2437 text_muted_color: "#b9b9ba"
2444 suggestions: ["#d8a070"]
2447 key: :background_color,
2449 suggestions: ["#2C3645"]
2452 key: :content_background_color,
2454 suggestions: ["#1B2635"]
2459 suggestions: ["#d8a070"]
2464 suggestions: ["#b9b9ba"]
2467 key: :text_muted_color,
2469 suggestions: ["#b9b9ba"]
2477 key: Pleroma.Emails.NewUsersDigestEmail,
2479 description: "New users admin email digest",
2484 description: "Enables new users admin digest email when `true`"
2493 description: "Configure OAuth 2 provider capabilities",
2496 key: :token_expires_in,
2498 description: "The lifetime in seconds of the access token",
2499 suggestions: [2_592_000]
2502 key: :issue_new_refresh_token,
2505 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2508 key: :clean_expired_tokens,
2510 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2520 key: :shortcode_globs,
2521 type: {:list, :string},
2522 description: "Location of custom emoji files. * can be used as a wildcard.",
2523 suggestions: ["/emoji/custom/**/*.png"]
2526 key: :pack_extensions,
2527 type: {:list, :string},
2529 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2530 suggestions: [".png", ".gif"]
2534 type: {:keyword, {:list, :string}},
2536 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2537 " and the value is the location or array of locations. * can be used as a wildcard.",
2539 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2543 key: :default_manifest,
2546 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2547 " Currently only one manifest can be added (no arrays).",
2548 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2551 key: :shared_pack_cache_seconds_per_file,
2552 label: "Shared pack cache s/file",
2555 "When an emoji pack is shared, the archive is created and cached in memory" <>
2556 " for this amount of seconds multiplied by the number of files.",
2566 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2570 type: [:tuple, {:list, :tuple}],
2571 description: "For the search requests (account & status search etc.)",
2572 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2576 type: [:tuple, {:list, :tuple}],
2577 description: "For requests to timelines (each timeline has it's own limiter)",
2578 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2581 key: :app_account_creation,
2582 type: [:tuple, {:list, :tuple}],
2583 description: "For registering user accounts from the same IP address",
2584 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2587 key: :relations_actions,
2588 type: [:tuple, {:list, :tuple}],
2589 description: "For actions on relationships with all users (follow, unfollow)",
2590 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2593 key: :relation_id_action,
2594 label: "Relation ID action",
2595 type: [:tuple, {:list, :tuple}],
2596 description: "For actions on relation with a specific user (follow, unfollow)",
2597 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2600 key: :statuses_actions,
2601 type: [:tuple, {:list, :tuple}],
2603 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2604 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2607 key: :status_id_action,
2608 label: "Status ID action",
2609 type: [:tuple, {:list, :tuple}],
2611 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2612 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2615 key: :authentication,
2616 type: [:tuple, {:list, :tuple}],
2617 description: "For authentication create / password check / user existence check requests",
2618 suggestions: [{60_000, 15}]
2627 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2628 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2633 description: "Enables SSH"
2638 description: "Dir with SSH keys",
2639 suggestions: ["/some/path/ssh_keys"]
2644 description: "Handler module",
2645 suggestions: ["Pleroma.BBS.Handler"]
2650 description: "Port to connect",
2651 suggestions: [10_022]
2654 key: :password_authenticator,
2656 description: "Authenticator module",
2657 suggestions: ["Pleroma.BBS.Authenticator"]
2663 label: "Mime Types",
2665 description: "Mime Types settings",
2672 "application/xml" => ["xml"],
2673 "application/xrd+xml" => ["xrd+xml"],
2674 "application/jrd+json" => ["jrd+json"],
2675 "application/activity+json" => ["activity+json"],
2676 "application/ld+json" => ["activity+json"]
2681 key: "application/xml",
2682 type: {:list, :string},
2683 suggestions: ["xml"]
2686 key: "application/xrd+xml",
2687 type: {:list, :string},
2688 suggestions: ["xrd+xml"]
2691 key: "application/jrd+json",
2692 type: {:list, :string},
2693 suggestions: ["jrd+json"]
2696 key: "application/activity+json",
2697 type: {:list, :string},
2698 suggestions: ["activity+json"]
2701 key: "application/ld+json",
2702 type: {:list, :string},
2703 suggestions: ["activity+json"]
2713 description: "Pleroma shout settings",
2718 description: "Enables the backend Shoutbox chat feature."
2723 description: "Shout message character limit.",
2735 description: "HTTP settings",
2740 type: [:string, :tuple],
2741 description: "Proxy URL",
2742 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2745 key: :send_user_agent,
2750 type: [:string, :atom],
2752 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2753 suggestions: ["Pleroma", :default]
2758 description: "Adapter specific options",
2764 label: "SSL Options",
2765 description: "SSL options for HTTP adapter",
2769 type: {:list, :atom},
2770 description: "List of TLS version to use",
2771 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2", ":tlsv1.3"]
2782 label: "Markup Settings",
2786 key: :allow_inline_images,
2790 key: :allow_headings,
2803 type: {:list, :module},
2805 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2806 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2816 key: :deny_follow_blocked,
2827 key: :restricted_nicknames,
2828 type: {:list, :string},
2829 description: "List of nicknames users may not register with.",
2848 "ostatus_subscribe",
2864 key: :email_blacklist,
2865 type: {:list, :string},
2866 description: "List of email domains users may not register with.",
2867 suggestions: ["mailinator.com", "maildrop.cc"]
2873 label: "CORS plug config",
2879 suggestions: [86_400]
2883 type: {:list, :string},
2884 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2888 type: {:list, :string},
2891 "X-RateLimit-Reset",
2892 "X-RateLimit-Limit",
2893 "X-RateLimit-Remaining",
2904 type: {:list, :string},
2905 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2911 key: Pleroma.Web.Plugs.RemoteIp,
2914 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2915 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2921 description: "Enable/disable the plug. Default: disabled."
2925 type: {:list, :string},
2927 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2932 type: {:list, :string},
2934 "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."
2938 type: {:list, :string},
2940 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"]`
2947 key: :web_cache_ttl,
2948 label: "Web cache TTL",
2951 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2957 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2961 key: :activity_pub_question,
2963 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2964 suggestions: [30_000]
2974 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2979 description: "Enables the rendering of static HTML. Default: disabled."
2987 description: "Configure feed rendering",
2992 description: "Configure title rendering",
2997 description: "Maximum number of characters before truncating title",
3003 description: "Replacement which will be used after truncating string",
3004 suggestions: ["..."]
3012 key: :mrf_follow_bot,
3014 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
3015 label: "MRF FollowBot Policy",
3017 description: "Automatically follows newly discovered accounts.",
3020 key: :follower_nickname,
3022 description: "The name of the bot account to use for following newly discovered users.",
3023 suggestions: ["followbot"]
3031 description: "Custom Runtime Modules",
3036 description: "A path to custom Elixir modules (such as MRF policies)."
3044 description: "Settings for notifications streamer",
3049 description: "Number of workers to send notifications",
3053 key: :overflow_workers,
3055 description: "Maximum number of workers created if pool is empty",
3062 key: :connections_pool,
3064 description: "Advanced settings for `Gun` connections pool",
3067 key: :connection_acquisition_wait,
3070 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3074 key: :connection_acquisition_retries,
3077 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3081 key: :max_connections,
3083 description: "Maximum number of connections in the pool. Default: 250 connections.",
3087 key: :connect_timeout,
3089 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3093 key: :reclaim_multiplier,
3096 "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",
3105 description: "Advanced settings for `Gun` workers pools",
3107 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3111 description: "Settings for #{pool_name} pool.",
3116 description: "Maximum number of concurrent requests in the pool.",
3123 "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",
3129 description: "Timeout for the pool while gun will wait for response",
3130 suggestions: [10_000]
3138 key: :hackney_pools,
3140 description: "Advanced settings for `Hackney` connections pools",
3145 description: "Settings for federation pool.",
3148 key: :max_connections,
3150 description: "Number workers in the pool.",
3156 description: "Timeout while `hackney` will wait for response.",
3157 suggestions: [150_000]
3164 description: "Settings for media pool.",
3167 key: :max_connections,
3169 description: "Number workers in the pool.",
3175 description: "Timeout while `hackney` will wait for response.",
3176 suggestions: [150_000]
3183 description: "Settings for upload pool.",
3186 key: :max_connections,
3188 description: "Number workers in the pool.",
3194 description: "Timeout while `hackney` will wait for response.",
3195 suggestions: [300_000]
3203 key: :restrict_unauthenticated,
3204 label: "Restrict Unauthenticated",
3207 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3212 description: "Settings for public and federated timelines.",
3217 description: "Disallow view public timeline."
3222 description: "Disallow view federated timeline."
3229 description: "Settings for user profiles.",
3234 description: "Disallow view local user profiles."
3239 description: "Disallow view remote user profiles."
3246 description: "Settings for statuses.",
3251 description: "Disallow view local statuses."
3256 description: "Disallow view remote statuses."
3264 key: Pleroma.Web.ApiSpec.CastAndValidate,
3271 "Enables strict input validation (useful in development, not recommended in production)"
3277 key: :instances_favicons,
3279 description: "Control favicons for instances",
3284 description: "Allow/disallow displaying and getting instances favicons"
3292 descriptions: "S3 service related settings",
3295 key: :access_key_id,
3297 description: "S3 access key ID",
3298 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3301 key: :secret_access_key,
3303 description: "Secret access key",
3304 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3309 description: "S3 host",
3310 suggestions: ["s3.eu-central-1.amazonaws.com"]
3315 description: "S3 region (for AWS)",
3316 suggestions: ["us-east-1"]
3324 description: "Installed frontends management",
3329 description: "Primary frontend, the one that is served for all pages by default",
3330 children: installed_frontend_options
3335 description: "Admin frontend",
3336 children: installed_frontend_options
3342 "A map containing available frontends and parameters for their installation.",
3343 children: frontend_options
3349 key: Pleroma.Web.Preload,
3351 description: "Preload-related settings",
3355 type: {:list, :module},
3356 description: "List of preload providers to enable",
3358 Pleroma.Web.Preload.Providers.Instance,
3359 Pleroma.Web.Preload.Providers.User,
3360 Pleroma.Web.Preload.Providers.Timelines,
3361 Pleroma.Web.Preload.Providers.StatusNet
3370 description: "Majic/libmagic configuration",
3375 description: "Number of majic workers to start.",
3382 key: Pleroma.User.Backup,
3384 description: "Account Backup",
3387 key: :purge_after_days,
3389 description: "Remove backup achives after N days",
3395 description: "Limit user to export not more often than once per N days",
3402 key: Pleroma.Web.Endpoint.MetricsExporter,
3404 description: "Prometheus app metrics endpoint configuration",
3409 description: "[Pleroma extension] Enables app metrics endpoint."
3413 label: "IP Whitelist",
3414 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3415 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3419 type: [:boolean, :tuple],
3420 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3421 suggestion: [false, {:basic, "myusername", "mypassword"}]
3426 description: "App metrics endpoint URI path.",
3427 suggestions: ["/api/pleroma/app_metrics"]
3432 description: "App metrics endpoint output format.",
3433 suggestions: [:text, :protobuf]
3439 key: ConcurrentLimiter,
3441 description: "Limits configuration for background tasks.",
3444 key: Pleroma.Web.RichMedia.Helpers,
3446 description: "Concurrent limits configuration for getting RichMedia for activities.",
3447 suggestions: [max_running: 5, max_waiting: 5],
3452 description: "Max running concurrently jobs.",
3458 description: "Max waiting jobs.",
3464 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3466 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3467 suggestions: [max_running: 5, max_waiting: 5],
3472 description: "Max running concurrently jobs.",
3478 description: "Max waiting jobs.",