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)."
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 type: {:list, :string},
515 description: "Languages the instance uses",
524 label: "Admin Email Address",
526 description: "Email used to reach an Administrator/Moderator of the instance",
533 label: "Sender Email Address",
535 description: "Envelope FROM address for mail sent via Pleroma",
544 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
552 description: "Posts character limit (CW/Subject included in the counter)",
560 description: "Hard character limit beyond which remote posts will be dropped",
568 description: "File size limit of uploads (except for avatar, background, banner)",
574 key: :avatar_upload_limit,
576 description: "File size limit of user's profile avatars",
582 key: :background_upload_limit,
584 description: "File size limit of user's profile backgrounds",
590 key: :banner_upload_limit,
592 description: "File size limit of user's profile banners",
600 description: "A map with poll limits for local polls",
604 max_option_chars: 200,
606 max_expiration: 31_536_000
613 description: "Maximum number of options",
617 key: :max_option_chars,
619 description: "Maximum number of characters per option",
623 key: :min_expiration,
625 description: "Minimum expiration time (in seconds)",
629 key: :max_expiration,
631 description: "Maximum expiration time (in seconds)",
637 key: :registrations_open,
640 "Enable registrations for anyone. Invitations require this setting to be disabled."
643 key: :invites_enabled,
646 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
649 key: :account_activation_required,
651 description: "Require users to confirm their emails before signing in"
654 key: :account_approval_required,
656 description: "Require users to be manually approved by an admin before signing in"
661 description: "Enable federation with other instances"
664 key: :federation_incoming_replies_max_depth,
665 label: "Fed. incoming replies max depth",
668 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
669 " 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.",
675 key: :federation_reachability_timeout_days,
676 label: "Fed. reachability timeout days",
679 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
688 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
694 "Switching this on will allow unauthenticated users access to all public resources on your instance" <>
695 " Switching it off is useful for disabling the Local Timeline and The Whole Known Network. " <>
696 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
699 key: :quarantined_instances,
700 type: {:list, :tuple},
701 key_placeholder: "instance",
702 value_placeholder: "reason",
704 "(Deprecated, will be removed in next release) List of ActivityPub instances where activities will not be sent, and the reason for doing so",
706 {"quarantined.com", "Reason"},
707 {"*.quarantined.com", "Reason"}
713 description: "Instance static directory",
719 key: :allowed_post_formats,
720 type: {:list, :string},
721 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
727 "text/x.misskeymarkdown"
731 key: :extended_nickname_format,
734 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
735 " This will break federation with older software for theses nicknames."
738 key: :cleanup_attachments,
741 Enable to remove associated attachments when status is removed.
742 This will not affect duplicates and attachments without status.
743 Enabling this will increase load to database when deleting statuses on larger instances.
747 key: :max_pinned_statuses,
749 description: "The maximum number of pinned statuses. 0 will disable the feature.",
757 key: :autofollowed_nicknames,
758 type: {:list, :string},
760 "Set to nicknames of (local) users that every new user should automatically follow"
763 key: :autofollowing_nicknames,
764 type: {:list, :string},
766 "Set to nicknames of (local) users that automatically follows every newly registered user"
769 key: :attachment_links,
771 description: "Enable to automatically add attachment link text to statuses"
774 key: :max_report_comment_size,
776 description: "The maximum size of the report comment. Default: 1000.",
782 key: :safe_dm_mentions,
783 label: "Safe DM mentions",
786 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
787 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
793 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
796 key: :remote_post_retention_days,
799 "The default amount of days to retain remote posts when pruning the database",
805 key: :user_bio_length,
807 description: "A user bio maximum length. Default: 5000.",
813 key: :user_name_length,
815 description: "A user name maximum length. Default: 100.",
821 key: :skip_thread_containment,
823 description: "Skip filtering out broken threads. Default: enabled."
826 key: :limit_to_local_content,
827 type: {:dropdown, :atom},
829 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
837 key: :max_account_fields,
839 description: "The maximum number of custom fields in the user profile. Default: 10.",
845 key: :max_remote_account_fields,
848 "The maximum number of custom fields in the remote user profile. Default: 20.",
854 key: :account_field_name_length,
856 description: "An account field name maximum length. Default: 512.",
862 key: :account_field_value_length,
864 description: "An account field value maximum length. Default: 2048.",
870 key: :registration_reason_length,
872 description: "Maximum registration reason length. Default: 500.",
878 key: :external_user_synchronization,
880 description: "Enabling following/followers counters synchronization for external users"
883 key: :multi_factor_authentication,
885 description: "Multi-factor authentication settings",
888 totp: [digits: 6, period: 30],
889 backup_codes: [number: 5, length: 16]
895 label: "TOTP settings",
897 description: "TOTP settings",
898 suggestions: [digits: 6, period: 30],
905 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
912 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
919 description: "MFA backup codes settings",
920 suggestions: [number: 5, length: 16],
926 description: "Number of backup codes to generate."
933 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
940 key: :instance_thumbnail,
941 type: {:string, :image},
943 "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.",
944 suggestions: ["/instance/thumbnail.jpeg"]
947 key: :show_reactions,
949 description: "Let favourites and emoji reactions be viewed through the API."
952 key: :profile_directory,
954 description: "Enable profile directory."
957 key: :privileged_staff,
960 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses)"
964 type: {:list, :string},
966 "List of instances that make up your local bubble (closely-related instances). Used to populate the 'bubble' timeline (domain only)."
974 description: "Welcome messages settings",
977 key: :direct_message,
979 descpiption: "Direct message settings",
984 description: "Enables sending a direct message to newly registered users"
989 description: "A message that will be sent to newly registered users",
991 "Hi, @username! Welcome on board!"
995 key: :sender_nickname,
997 description: "The nickname of the local user that sends a welcome 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,
1180 hideFilteredStatuses: false,
1181 hideMutedPosts: false,
1182 hidePostStats: false,
1183 hideUserStats: false,
1184 loginMethod: "password",
1185 logo: "/static/logo.svg",
1188 minimalScopesMode: false,
1189 noAttachmentLinks: false,
1190 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1191 postContentType: "text/plain",
1192 redirectRootLogin: "/main/friends",
1193 redirectRootNoLogin: "/main/all",
1195 sidebarRight: false,
1196 showFeaturesPanel: true,
1197 showInstanceSpecificPanel: false,
1198 subjectLineBehavior: "email",
1199 theme: "pleroma-dark",
1200 webPushNotifications: false
1205 key: :alwaysShowSubjectInput,
1206 label: "Always show subject input",
1208 description: "When disabled, auto-hide the subject field if it's empty"
1212 type: {:string, :image},
1214 "URL of the background, unless viewing a user profile with a background that is set",
1215 suggestions: ["/images/city.jpg"]
1218 key: :collapseMessageWithSubject,
1219 label: "Collapse message with subject",
1222 "When a message has a subject (aka Content Warning), collapse it by default"
1228 description: "Enables green text on lines prefixed with the > character"
1231 key: :conversationDisplay,
1232 label: "Conversation display style",
1234 description: "How to display conversations (linear or tree)",
1235 suggestions: ["linear", "tree"]
1238 key: :hideFilteredStatuses,
1239 label: "Hide Filtered Statuses",
1241 description: "Hides filtered statuses from timelines"
1244 key: :hideMutedPosts,
1245 label: "Hide Muted Posts",
1247 description: "Hides muted statuses from timelines"
1250 key: :hidePostStats,
1251 label: "Hide post stats",
1253 description: "Hide notices statistics (repeats, favorites, ...)"
1256 key: :hideUserStats,
1257 label: "Hide user stats",
1260 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1264 type: {:string, :image},
1265 description: "URL of the logo, defaults to Pleroma's logo",
1266 suggestions: ["/static/logo.svg"]
1270 label: "Logo margin",
1273 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1274 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1275 suggestions: [".1em"]
1282 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1283 "If you want a colorful logo you must disable logoMask."
1286 key: :nsfwCensorImage,
1287 label: "NSFW Censor Image",
1288 type: {:string, :image},
1290 "URL of the image to use for hiding NSFW media attachments in the timeline",
1291 suggestions: ["/static/img/nsfw.74818f9.png"]
1294 key: :postContentType,
1295 label: "Post Content Type",
1296 type: {:dropdown, :atom},
1297 description: "Default post formatting option",
1298 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode", "text/x.misskeymarkdown"]
1301 key: :redirectRootNoLogin,
1302 label: "Redirect root no login",
1305 "Relative URL which indicates where to redirect when a user isn't logged in",
1306 suggestions: ["/main/all"]
1309 key: :redirectRootLogin,
1310 label: "Redirect root login",
1313 "Relative URL which indicates where to redirect when a user is logged in",
1314 suggestions: ["/main/friends"]
1318 label: "Scope copy",
1320 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1324 label: "Sidebar on Right",
1326 description: "Change alignment of sidebar and panels to the right"
1329 key: :showFeaturesPanel,
1330 label: "Show instance features panel",
1333 "Enables panel displaying functionality of the instance on the About page"
1336 key: :showInstanceSpecificPanel,
1337 label: "Show instance specific panel",
1339 description: "Whether to show the instance's custom panel"
1342 key: :subjectLineBehavior,
1343 label: "Subject line behavior",
1345 description: "Allows changing the default behaviour of subject lines in replies.
1346 `email`: copy and preprend re:, as in email,
1347 `masto`: copy verbatim, as in Mastodon,
1348 `noop`: don't copy the subject.",
1349 suggestions: ["email", "masto", "noop"]
1354 description: "Which theme to use. Available themes are defined in styles.json",
1355 suggestions: ["pleroma-dark"]
1358 key: :showPanelNavShortcuts,
1359 label: "Show timeline panel nav shortcuts",
1361 description: "Whether to put timeline nav tabs on the top of the panel"
1364 key: :showNavShortcuts,
1365 label: "Show navbar shortcuts",
1367 description: "Whether to put extra navigation options on the navbar"
1370 key: :showWiderShortcuts,
1371 label: "Increase navbar shortcut spacing",
1373 description: "Whether to add extra space between navbar icons"
1376 key: :hideSiteFavicon,
1377 label: "Hide site favicon",
1379 description: "Whether to hide the instance favicon from the navbar"
1383 label: "Hide site name",
1385 description: "Whether to hide the site name from the navbar"
1388 key: :renderMisskeyMarkdown,
1389 label: "Render misskey markdown",
1391 description: "Whether to render Misskey-flavoured markdown"
1397 description: "Whether to pause animated images until they're hovered on"
1405 description: "Settings for Masto FE",
1408 showInstanceSpecificPanel: true
1413 key: :showInstanceSpecificPanel,
1414 label: "Show instance specific panel",
1416 description: "Whenether to show the instance's specific panel"
1427 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1431 type: {:keyword, :map},
1433 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1436 url: "/images/pleroma-fox-tan-smol.png",
1437 mime_type: "image/png"
1439 pleroma_fox_tan_shy: %{
1440 url: "/images/pleroma-fox-tan-shy.png",
1441 mime_type: "image/png"
1446 key: :default_mascot,
1449 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1455 key: :default_user_avatar,
1456 type: {:string, :image},
1457 description: "URL of the default user avatar",
1458 suggestions: ["/images/avi.png"]
1467 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1471 type: {:list, :map},
1472 description: "Describe the icons of the app",
1475 src: "/static/logo.png"
1478 src: "/static/icon.png",
1482 src: "/static/icon.ico",
1483 sizes: "72x72 96x96 128x128 256x256"
1490 description: "Describe the theme color of the app - this is only used for mastodon-fe",
1491 suggestions: ["#282c37", "mediumpurple"]
1494 key: :background_color,
1497 "Describe the background color of the app - this is only used for mastodon-fe",
1498 suggestions: ["#191b22", "aliceblue"]
1506 description: "Media proxy",
1511 description: "Enables proxying of remote media via the instance's proxy"
1518 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1519 suggestions: ["https://example.com"]
1527 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1533 description: "Enables media cache object invalidation."
1538 description: "Module which will be used to purge objects from the cache.",
1540 Pleroma.Web.MediaProxy.Invalidation.Script,
1541 Pleroma.Web.MediaProxy.Invalidation.Http
1548 label: "Advanced MediaProxy Options",
1550 description: "Internal Pleroma.ReverseProxy settings",
1552 redirect_on_failure: false,
1553 max_body_length: 25 * 1_048_576,
1554 max_read_duration: 30_000
1558 key: :redirect_on_failure,
1561 Redirects the client to the origin server upon encountering HTTP errors.\n
1562 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1563 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1564 IP addresses of your users to the other servers, bypassing the MediaProxy.
1568 key: :max_body_length,
1571 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1574 key: :max_read_duration,
1576 description: "Timeout (in milliseconds) of GET request to the remote URI."
1582 type: {:list, :string},
1583 description: "List of hosts with scheme to bypass the MediaProxy",
1584 suggestions: ["http://example.com"]
1590 key: :media_preview_proxy,
1592 description: "Media preview proxy",
1598 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1601 key: :thumbnail_max_width,
1604 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1607 key: :thumbnail_max_height,
1610 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1613 key: :image_quality,
1615 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1618 key: :min_content_length,
1621 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1627 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1629 description: "HTTP invalidate settings",
1634 description: "HTTP method of request. Default: :purge"
1638 type: {:keyword, :string},
1639 description: "HTTP headers of request",
1640 suggestions: [{"x-refresh", 1}]
1645 description: "Request options",
1649 type: {:map, :string}
1657 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1659 description: "Invalidation script settings",
1664 description: "Path to executable script which will purge cached items.",
1665 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1669 label: "URL Format",
1672 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1673 suggestions: [":htcacheclean"]
1680 label: "ActivityPub",
1682 description: "ActivityPub-related settings",
1685 key: :unfollow_blocked,
1687 description: "Whether blocks result in people getting unfollowed"
1690 key: :outgoing_blocks,
1692 description: "Whether to federate blocks to other instances"
1695 key: :blockers_visible,
1697 description: "Whether a user can see someone who has blocked them"
1700 key: :sign_object_fetches,
1702 description: "Sign object fetches with HTTP signatures"
1705 key: :authorized_fetch_mode,
1707 description: "Require HTTP signatures on AP fetches"
1710 key: :note_replies_output_limit,
1713 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1716 key: :follow_handshake_timeout,
1718 description: "Following handshake timeout",
1722 key: :max_collection_objects,
1725 "The maximum number of items to fetch from a remote collections. Setting this too low can lead to only getting partial collections, but too high and you can end up fetching far too many objects.",
1732 key: :http_security,
1733 label: "HTTP security",
1735 description: "HTTP security settings",
1740 description: "Whether the managed content security policy is enabled"
1746 description: "Whether to additionally send a Strict-Transport-Security header"
1750 label: "STS max age",
1752 description: "The maximum age for the Strict-Transport-Security header if sent",
1753 suggestions: [63_072_000]
1756 key: :referrer_policy,
1758 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1759 suggestions: ["same-origin", "no-referrer"]
1763 label: "Report URI",
1765 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1766 suggestions: ["https://example.com/report-uri"]
1771 group: :web_push_encryption,
1772 key: :vapid_details,
1773 label: "Vapid Details",
1776 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1782 "A mailto link for the administrative contact." <>
1783 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1784 suggestions: ["mailto:moderators@pleroma.com"]
1789 description: "VAPID public key",
1790 suggestions: ["Public key"]
1795 description: "VAPID private key",
1796 suggestions: ["Private key"]
1802 key: Pleroma.Captcha,
1804 description: "Captcha-related settings",
1809 description: "Whether the captcha should be shown on registration"
1814 description: "The method/service to use for captcha",
1815 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1818 key: :seconds_valid,
1820 description: "The time in seconds for which the captcha is valid",
1827 key: Pleroma.Captcha.Kocaptcha,
1830 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1831 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1836 description: "The kocaptcha endpoint to use",
1837 suggestions: ["https://captcha.kotobank.ch"]
1843 label: "Pleroma Admin Token",
1846 "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)",
1851 description: "Admin token",
1853 "Please use a high entropy string or UUID"
1863 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1867 type: {:dropdown, :atom},
1868 description: "Logs verbose mode",
1869 suggestions: [false, :error, :warn, :info, :debug]
1873 type: {:keyword, :integer},
1875 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1877 activity_expiration: 10,
1878 attachments_cleanup: 5,
1880 federator_incoming: 50,
1881 federator_outgoing: 50,
1883 scheduled_activities: 10,
1889 key: :activity_expiration,
1891 description: "Activity expiration queue",
1897 description: "Backup queue",
1901 key: :attachments_cleanup,
1903 description: "Attachment deletion queue",
1909 description: "Background queue",
1913 key: :federator_incoming,
1915 description: "Incoming federation queue",
1919 key: :federator_outgoing,
1921 description: "Outgoing federation queue",
1927 description: "Email sender queue, see Pleroma.Emails.Mailer",
1931 key: :scheduled_activities,
1933 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1937 key: :transmogrifier,
1939 description: "Transmogrifier queue",
1945 description: "Web push notifications queue",
1952 type: {:list, :tuple},
1953 description: "Settings for cron background jobs",
1955 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1956 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1965 description: "Includes custom worker options not interpretable directly by `Oban`",
1969 type: {:keyword, :integer},
1970 description: "Max retry attempts for failed jobs, per `Oban` queue",
1972 federator_incoming: 5,
1973 federator_outgoing: 5
1978 type: {:keyword, :integer},
1979 description: "Timeout for jobs, per `Oban` queue, in ms",
1981 activity_expiration: :timer.seconds(5),
1982 token_expiration: :timer.seconds(5),
1983 filter_expiration: :timer.seconds(5),
1984 backup: :timer.seconds(900),
1985 federator_incoming: :timer.seconds(10),
1986 federator_outgoing: :timer.seconds(10),
1987 ingestion_queue: :timer.seconds(5),
1988 web_push: :timer.seconds(5),
1989 mailer: :timer.seconds(5),
1990 transmogrifier: :timer.seconds(5),
1991 scheduled_activities: :timer.seconds(5),
1992 poll_notifications: :timer.seconds(5),
1993 background: :timer.seconds(5),
1994 remote_fetcher: :timer.seconds(10),
1995 attachments_cleanup: :timer.seconds(900),
1996 new_users_digest: :timer.seconds(10),
1997 mute_expire: :timer.seconds(5),
1998 search_indexing: :timer.seconds(5),
1999 nodeinfo_fetcher: :timer.seconds(10)
2006 key: Pleroma.Web.Metadata,
2008 description: "Metadata-related settings",
2012 type: {:list, :module},
2013 description: "List of metadata providers to enable",
2015 Pleroma.Web.Metadata.Providers.OpenGraph,
2016 Pleroma.Web.Metadata.Providers.TwitterCard,
2017 Pleroma.Web.Metadata.Providers.RelMe,
2018 Pleroma.Web.Metadata.Providers.Feed
2023 label: "Unfurl NSFW",
2025 description: "When enabled NSFW attachments will be shown in previews"
2031 key: Pleroma.Web.Metadata.Providers.Theme,
2033 description: "Specific provider to hand out themes to instances that scrape index.html",
2039 "The 'accent color' of the instance, used in places like misskey's instance ticker",
2040 suggestions: ["#593196"]
2049 "If enabled the instance will parse metadata from attached links to generate link previews",
2054 description: "Enables RichMedia parsing of URLs"
2058 type: {:list, :string},
2059 description: "List of hosts which will be ignored by the metadata parser",
2060 suggestions: ["accounts.google.com", "xss.website"]
2064 label: "Ignore TLD",
2065 type: {:list, :string},
2066 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2067 suggestions: ["local", "localdomain", "lan"]
2071 type: {:list, :module},
2073 "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.",
2075 Pleroma.Web.RichMedia.Parsers.OEmbed,
2076 Pleroma.Web.RichMedia.Parsers.TwitterCard
2081 label: "TTL setters",
2082 type: {:list, :module},
2084 "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.",
2086 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2090 key: :failure_backoff,
2093 "Amount of milliseconds after request failure, during which the request will not be retried.",
2094 suggestions: [60_000]
2100 key: Pleroma.Formatter,
2104 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2108 type: [:string, :boolean],
2109 description: "Specify the class to be added to the generated link. Disable to clear.",
2110 suggestions: ["auto-linker", false]
2114 type: [:string, :boolean],
2115 description: "Override the rel attribute. Disable to clear.",
2116 suggestions: ["ugc", "noopener noreferrer", false]
2121 description: "Link URLs will open in a new window/tab."
2125 type: [:integer, :boolean],
2127 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2128 suggestions: [15, false]
2133 description: "Strip the scheme prefix."
2138 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2142 type: [:atom, :boolean],
2144 "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)",
2145 suggestions: [:no_scheme, true]
2151 key: Pleroma.ScheduledActivity,
2153 description: "Scheduled activities settings",
2156 key: :daily_user_limit,
2159 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2163 key: :total_user_limit,
2166 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2172 description: "Whether scheduled activities are sent to the job queue to be executed"
2178 key: Pleroma.Workers.PurgeExpiredActivity,
2180 description: "Expired activities settings",
2185 description: "Enables expired activities addition & deletion"
2190 description: "Minimum lifetime for ephemeral activity (in seconds)",
2197 label: "Pleroma Authenticator",
2199 description: "Authenticator",
2202 key: Pleroma.Web.Auth.Authenticator,
2204 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2214 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2215 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2216 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2217 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2222 description: "Enables LDAP authentication"
2227 description: "LDAP server hostname",
2228 suggestions: ["localhosts"]
2233 description: "LDAP port, e.g. 389 or 636",
2234 suggestions: [389, 636]
2240 description: "Enable to use SSL, usually implies the port 636"
2244 label: "SSL options",
2246 description: "Additional SSL options",
2247 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2252 description: "Path to file with PEM encoded cacerts",
2253 suggestions: ["path/to/file/with/PEM/cacerts"]
2258 description: "Type of cert verification",
2259 suggestions: [:verify_peer]
2267 description: "Enable to use STARTTLS, usually implies the port 389"
2271 label: "TLS options",
2273 description: "Additional TLS options",
2274 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2279 description: "Path to file with PEM encoded cacerts",
2280 suggestions: ["path/to/file/with/PEM/cacerts"]
2285 description: "Type of cert verification",
2286 suggestions: [:verify_peer]
2293 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2294 suggestions: ["dc=example,dc=com"]
2301 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2310 description: "Authentication / authorization settings",
2313 key: :enforce_oauth_admin_scope_usage,
2314 label: "Enforce OAuth admin scope usage",
2317 "OAuth admin scope requirement toggle. " <>
2318 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2319 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2320 "`is_admin` user flag grants access to admin-specific actions."
2323 key: :auth_template,
2326 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2327 suggestions: ["show.html"]
2330 key: :oauth_consumer_template,
2331 label: "OAuth consumer template",
2334 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2335 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2336 suggestions: ["consumer.html"]
2339 key: :oauth_consumer_strategies,
2340 label: "OAuth consumer strategies",
2341 type: {:list, :string},
2343 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2344 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2345 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2346 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2352 key: :email_notifications,
2354 description: "Email notifications settings",
2360 "emails of \"what you've missed\" for users who have been inactive for a while",
2364 schedule: "0 0 * * 0",
2366 inactivity_threshold: 7
2374 description: "Globally enable or disable digest emails"
2380 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2381 suggestions: ["0 0 * * 0"]
2386 description: "Minimum interval between digest emails to one user",
2390 key: :inactivity_threshold,
2392 description: "Minimum user inactivity threshold",
2401 key: Pleroma.Emails.UserEmail,
2403 description: "Email template settings",
2407 type: {:string, :image},
2408 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2409 suggestions: ["some/path/logo.png"]
2414 description: "A map with color settings for email templates.",
2417 link_color: "#d8a070",
2418 background_color: "#2C3645",
2419 content_background_color: "#1B2635",
2420 header_color: "#d8a070",
2421 text_color: "#b9b9ba",
2422 text_muted_color: "#b9b9ba"
2429 suggestions: ["#d8a070"]
2432 key: :background_color,
2434 suggestions: ["#2C3645"]
2437 key: :content_background_color,
2439 suggestions: ["#1B2635"]
2444 suggestions: ["#d8a070"]
2449 suggestions: ["#b9b9ba"]
2452 key: :text_muted_color,
2454 suggestions: ["#b9b9ba"]
2462 key: Pleroma.Emails.NewUsersDigestEmail,
2464 description: "New users admin email digest",
2469 description: "Enables new users admin digest email when `true`"
2478 description: "Configure OAuth 2 provider capabilities",
2481 key: :token_expires_in,
2483 description: "The lifetime in seconds of the access token",
2484 suggestions: [2_592_000]
2487 key: :issue_new_refresh_token,
2490 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2493 key: :clean_expired_tokens,
2495 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2505 key: :shortcode_globs,
2506 type: {:list, :string},
2507 description: "Location of custom emoji files. * can be used as a wildcard.",
2508 suggestions: ["/emoji/custom/**/*.png"]
2511 key: :pack_extensions,
2512 type: {:list, :string},
2514 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2515 suggestions: [".png", ".gif"]
2519 type: {:keyword, {:list, :string}},
2521 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2522 " and the value is the location or array of locations. * can be used as a wildcard.",
2524 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2528 key: :default_manifest,
2531 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2532 " Currently only one manifest can be added (no arrays).",
2533 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2536 key: :shared_pack_cache_seconds_per_file,
2537 label: "Shared pack cache s/file",
2540 "When an emoji pack is shared, the archive is created and cached in memory" <>
2541 " for this amount of seconds multiplied by the number of files.",
2551 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2555 type: [:tuple, {:list, :tuple}],
2556 description: "For the search requests (account & status search etc.)",
2557 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2561 type: [:tuple, {:list, :tuple}],
2562 description: "For requests to timelines (each timeline has it's own limiter)",
2563 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2566 key: :app_account_creation,
2567 type: [:tuple, {:list, :tuple}],
2568 description: "For registering user accounts from the same IP address",
2569 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2572 key: :relations_actions,
2573 type: [:tuple, {:list, :tuple}],
2574 description: "For actions on relationships with all users (follow, unfollow)",
2575 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2578 key: :relation_id_action,
2579 label: "Relation ID action",
2580 type: [:tuple, {:list, :tuple}],
2581 description: "For actions on relation with a specific user (follow, unfollow)",
2582 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2585 key: :statuses_actions,
2586 type: [:tuple, {:list, :tuple}],
2588 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2589 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2592 key: :status_id_action,
2593 label: "Status ID action",
2594 type: [:tuple, {:list, :tuple}],
2596 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2597 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2600 key: :authentication,
2601 type: [:tuple, {:list, :tuple}],
2602 description: "For authentication create / password check / user existence check requests",
2603 suggestions: [{60_000, 15}]
2609 label: "Mime Types",
2611 description: "Mime Types settings",
2618 "application/xml" => ["xml"],
2619 "application/xrd+xml" => ["xrd+xml"],
2620 "application/jrd+json" => ["jrd+json"],
2621 "application/activity+json" => ["activity+json"],
2622 "application/ld+json" => ["activity+json"]
2627 key: "application/xml",
2628 type: {:list, :string},
2629 suggestions: ["xml"]
2632 key: "application/xrd+xml",
2633 type: {:list, :string},
2634 suggestions: ["xrd+xml"]
2637 key: "application/jrd+json",
2638 type: {:list, :string},
2639 suggestions: ["jrd+json"]
2642 key: "application/activity+json",
2643 type: {:list, :string},
2644 suggestions: ["activity+json"]
2647 key: "application/ld+json",
2648 type: {:list, :string},
2649 suggestions: ["activity+json"]
2660 description: "HTTP settings",
2664 label: "HTTP Pool Request Timeout",
2666 description: "Timeout for initiating HTTP requests (in ms, default 5000)",
2670 key: :receive_timeout,
2671 label: "HTTP Receive Timeout",
2674 "Timeout for waiting on remote servers to respond to HTTP requests (in ms, default 15000)",
2675 suggestions: [15000]
2682 "Proxy URL - of the format http://host:port. Advise setting in .exs instead of admin-fe due to this being set at boot-time.",
2683 suggestions: ["http://localhost:3128"]
2687 type: [:string, :atom],
2689 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2690 suggestions: ["Pleroma", :default]
2695 description: "Adapter specific options",
2701 label: "SSL Options",
2702 description: "SSL options for HTTP adapter",
2706 type: {:list, :atom},
2707 description: "List of TLS version to use",
2708 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2719 label: "Markup Settings",
2723 key: :allow_inline_images,
2727 key: :allow_headings,
2740 type: {:list, :module},
2742 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2743 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2753 key: :deny_follow_blocked,
2764 key: :restricted_nicknames,
2765 type: {:list, :string},
2766 description: "List of nicknames users may not register with.",
2785 "ostatus_subscribe",
2801 key: :email_blacklist,
2802 type: {:list, :string},
2803 description: "List of email domains users may not register with.",
2804 suggestions: ["mailinator.com", "maildrop.cc"]
2810 label: "CORS plug config",
2816 suggestions: [86_400]
2820 type: {:list, :string},
2821 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2825 type: {:list, :string},
2828 "X-RateLimit-Reset",
2829 "X-RateLimit-Limit",
2830 "X-RateLimit-Remaining",
2841 type: {:list, :string},
2842 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2848 key: Pleroma.Web.Plugs.RemoteIp,
2851 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2852 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2858 description: "Enable/disable the plug. Default: disabled."
2862 type: {:list, :string},
2864 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2869 type: {:list, :string},
2871 "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."
2875 type: {:list, :string},
2877 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"]`
2884 key: :web_cache_ttl,
2885 label: "Web cache TTL",
2888 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2894 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2898 key: :activity_pub_question,
2900 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2901 suggestions: [30_000]
2911 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2916 description: "Enables the rendering of static HTML. Default: disabled."
2924 description: "Configure feed rendering",
2929 description: "Configure title rendering",
2934 description: "Maximum number of characters before truncating title",
2940 description: "Replacement which will be used after truncating string",
2941 suggestions: ["..."]
2949 key: :mrf_follow_bot,
2951 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2952 label: "MRF FollowBot Policy",
2954 description: "Automatically follows newly discovered accounts.",
2957 key: :follower_nickname,
2959 description: "The name of the bot account to use for following newly discovered users.",
2960 suggestions: ["followbot"]
2968 description: "Custom Runtime Modules",
2973 description: "A path to custom Elixir modules (such as MRF policies)."
2981 description: "Settings for notifications streamer",
2986 description: "Number of workers to send notifications",
2990 key: :overflow_workers,
2992 description: "Maximum number of workers created if pool is empty",
2999 key: :restrict_unauthenticated,
3000 label: "Restrict Unauthenticated",
3002 description: "Disallow unauthenticated viewing of timelines, user profiles and statuses.",
3007 description: "Settings for public and federated timelines.",
3012 description: "Disallow viewing the public timeline."
3017 description: "Disallow viewing the whole known network timeline."
3024 description: "Settings for user profiles.",
3029 description: "Disallow viewing local user profiles."
3034 description: "Disallow viewing remote user profiles."
3041 description: "Settings for posts.",
3046 description: "Disallow viewing local posts."
3051 description: "Disallow viewing remote posts."
3059 key: Pleroma.Web.ApiSpec.CastAndValidate,
3066 "Enables strict input validation (useful in development, not recommended in production)"
3072 key: :instances_favicons,
3074 description: "Control favicons for instances",
3079 description: "Allow/disallow displaying and getting instances favicons"
3085 key: :instances_nodeinfo,
3087 description: "Control favicons for instances",
3092 description: "Allow/disallow getting instance nodeinfo"
3100 descriptions: "S3 service related settings",
3103 key: :access_key_id,
3105 description: "S3 access key ID",
3106 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3109 key: :secret_access_key,
3111 description: "Secret access key",
3112 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3117 description: "S3 host",
3118 suggestions: ["s3.eu-central-1.amazonaws.com"]
3123 description: "S3 region (for AWS)",
3124 suggestions: ["us-east-1"]
3132 description: "Installed frontends management",
3137 description: "Primary frontend, the one that is served for all pages by default",
3138 children: installed_frontend_options
3143 description: "Admin frontend",
3144 children: installed_frontend_options
3149 description: "Mastodon frontend",
3150 children: installed_frontend_options
3155 description: "Swagger API reference frontend",
3157 installed_frontend_options ++
3163 description: "Whether to have this enabled at all"
3171 "A map containing available frontends and parameters for their installation.",
3172 children: frontend_options
3178 key: Pleroma.Web.Preload,
3180 description: "Preload-related settings",
3184 type: {:list, :module},
3185 description: "List of preload providers to enable",
3187 Pleroma.Web.Preload.Providers.Instance,
3188 Pleroma.Web.Preload.Providers.User,
3189 Pleroma.Web.Preload.Providers.Timelines,
3190 Pleroma.Web.Preload.Providers.StatusNet
3199 description: "Majic/libmagic configuration",
3204 description: "Number of majic workers to start.",
3211 key: Pleroma.User.Backup,
3213 description: "Account Backup",
3216 key: :purge_after_days,
3218 description: "Remove backup achives after N days",
3224 description: "Limit user to export not more often than once per N days",
3231 key: ConcurrentLimiter,
3233 description: "Limits configuration for background tasks.",
3236 key: Pleroma.Web.RichMedia.Helpers,
3238 description: "Concurrent limits configuration for getting RichMedia for activities.",
3239 suggestions: [max_running: 5, max_waiting: 5],
3244 description: "Max running concurrently jobs.",
3250 description: "Max waiting jobs.",
3256 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3258 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3259 suggestions: [max_running: 5, max_waiting: 5],
3264 description: "Max running concurrently jobs.",
3270 description: "Max waiting jobs.",
3279 key: Pleroma.Search,
3282 description: "General search settings.",
3287 description: "Selected search module.",
3288 suggestions: {:list_behaviour_implementations, Pleroma.Search.SearchBackend}
3294 key: Pleroma.Search.Meilisearch,
3296 description: "Meilisearch settings.",
3301 description: "Meilisearch URL.",
3302 suggestion: ["http://127.0.0.1:7700/"]
3308 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3312 key: :initial_indexing_chunk_size,
3315 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3316 " since there's a limit on maximum insert size",
3317 suggestion: [100_000]
3323 key: Pleroma.Search.Elasticsearch.Cluster,
3324 label: "Elasticsearch",
3326 description: "Elasticsearch settings.",
3331 description: "Elasticsearch URL.",
3332 suggestion: ["http://127.0.0.1:9200/"]
3337 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3338 suggestion: ["elastic"]
3343 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3344 suggestion: ["changeme"]
3350 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3351 suggestion: [Elasticsearch.API.HTTP]
3357 "The JSON module used to encode/decode when communicating with Elasticsearch",
3363 description: "The indices to set up in Elasticsearch",
3368 description: "Config for the index to use for activities",
3374 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3375 suggestion: ["priv/es-mappings/activity.json"]
3380 description: "The internal store module",
3381 suggestion: [Pleroma.Search.Elasticsearch.Store]
3385 type: {:list, :module},
3386 description: "The internal types to use for this index",
3387 suggestion: [[Pleroma.Activity]]
3390 key: :bulk_page_size,
3392 description: "Size for bulk put requests, mostly used on building the index",
3396 key: :bulk_wait_interval,
3398 description: "Time to wait between bulk put requests (in ms)",
3399 suggestion: [15_000]
3411 description: "Translation Settings",
3416 description: "Is translation enabled?",
3417 suggestion: [true, false]
3422 description: "Translation module.",
3423 suggestions: {:list_behaviour_implementations, Pleroma.Akkoma.Translator}
3432 description: "DeepL Settings.",
3436 type: {:dropdown, :atom},
3437 description: "API Tier",
3438 suggestions: [:free, :pro]
3443 description: "API key for DeepL",
3450 key: :libre_translate,
3452 description: "LibreTranslate Settings.",
3457 description: "URL for libretranslate",
3463 description: "API key for libretranslate",