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 "Makes the client API in authenticated mode-only except for user-profiles." <>
695 " 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)",
730 key: :extended_nickname_format,
733 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
734 " This will break federation with older software for theses nicknames."
737 key: :cleanup_attachments,
740 Enable to remove associated attachments when status is removed.
741 This will not affect duplicates and attachments without status.
742 Enabling this will increase load to database when deleting statuses on larger instances.
746 key: :max_pinned_statuses,
748 description: "The maximum number of pinned statuses. 0 will disable the feature.",
756 key: :autofollowed_nicknames,
757 type: {:list, :string},
759 "Set to nicknames of (local) users that every new user should automatically follow"
762 key: :autofollowing_nicknames,
763 type: {:list, :string},
765 "Set to nicknames of (local) users that automatically follows every newly registered user"
768 key: :attachment_links,
770 description: "Enable to automatically add attachment link text to statuses"
773 key: :max_report_comment_size,
775 description: "The maximum size of the report comment. Default: 1000.",
781 key: :safe_dm_mentions,
782 label: "Safe DM mentions",
785 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
786 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
792 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
795 key: :remote_post_retention_days,
798 "The default amount of days to retain remote posts when pruning the database",
804 key: :user_bio_length,
806 description: "A user bio maximum length. Default: 5000.",
812 key: :user_name_length,
814 description: "A user name maximum length. Default: 100.",
820 key: :skip_thread_containment,
822 description: "Skip filtering out broken threads. Default: enabled."
825 key: :limit_to_local_content,
826 type: {:dropdown, :atom},
828 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
836 key: :max_account_fields,
838 description: "The maximum number of custom fields in the user profile. Default: 10.",
844 key: :max_remote_account_fields,
847 "The maximum number of custom fields in the remote user profile. Default: 20.",
853 key: :account_field_name_length,
855 description: "An account field name maximum length. Default: 512.",
861 key: :account_field_value_length,
863 description: "An account field value maximum length. Default: 2048.",
869 key: :registration_reason_length,
871 description: "Maximum registration reason length. Default: 500.",
877 key: :external_user_synchronization,
879 description: "Enabling following/followers counters synchronization for external users"
882 key: :multi_factor_authentication,
884 description: "Multi-factor authentication settings",
887 totp: [digits: 6, period: 30],
888 backup_codes: [number: 5, length: 16]
894 label: "TOTP settings",
896 description: "TOTP settings",
897 suggestions: [digits: 6, period: 30],
904 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
911 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
918 description: "MFA backup codes settings",
919 suggestions: [number: 5, length: 16],
925 description: "Number of backup codes to generate."
932 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
939 key: :instance_thumbnail,
940 type: {:string, :image},
942 "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.",
943 suggestions: ["/instance/thumbnail.jpeg"]
946 key: :show_reactions,
948 description: "Let favourites and emoji reactions be viewed through the API."
951 key: :profile_directory,
953 description: "Enable profile directory."
956 key: :privileged_staff,
959 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses)"
963 type: {:list, :string},
965 "List of instances that make up your local bubble (closely-related instances). Used to populate the 'bubble' timeline (domain only)."
973 description: "Welcome messages settings",
976 key: :direct_message,
978 descpiption: "Direct message settings",
983 description: "Enables sending a direct message to newly registered users"
988 description: "A message that will be sent to newly registered users",
990 "Hi, @username! Welcome on board!"
994 key: :sender_nickname,
996 description: "The nickname of the local user that sends a welcome message",
1006 descpiption: "Email message settings",
1011 description: "Enables sending an email to newly registered users"
1015 type: [:string, :tuple],
1017 "Email address and/or nickname that will be used to send the welcome email.",
1019 {"Pleroma App", "welcome@pleroma.app"}
1026 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1027 suggestions: ["Welcome to <%= instance_name%>"]
1033 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1034 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1040 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1041 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1050 description: "Logger-related settings",
1054 type: [:atom, :tuple, :module],
1056 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1057 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1065 label: "ExSyslogger",
1066 description: "ExSyslogger-related settings",
1070 type: {:dropdown, :atom},
1071 description: "Log level",
1072 suggestions: [:debug, :info, :warn, :error]
1078 "A string that's prepended to every message, and is typically set to the app name",
1079 suggestions: ["pleroma"]
1084 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1085 suggestions: ["$metadata[$level] $message"]
1089 type: {:list, :atom},
1090 suggestions: [:request_id]
1098 label: "Console Logger",
1099 description: "Console logger settings",
1103 type: {:dropdown, :atom},
1104 description: "Log level",
1105 suggestions: [:debug, :info, :warn, :error]
1110 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1111 suggestions: ["$metadata[$level] $message"]
1115 type: {:list, :atom},
1116 suggestions: [:request_id]
1123 label: "Quack Logger",
1124 description: "Quack-related settings",
1128 type: {:dropdown, :atom},
1129 description: "Log level",
1130 suggestions: [:debug, :info, :warn, :error]
1134 type: {:list, :atom},
1135 description: "Configure which metadata you want to report on",
1152 label: "Webhook URL",
1154 description: "Configure the Slack incoming webhook",
1155 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1161 key: :frontend_configurations,
1164 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1165 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1166 "add your own configuration your settings all fields must be complete.",
1170 label: "Pleroma FE",
1172 description: "Settings for Pleroma FE",
1175 alwaysShowSubjectInput: true,
1176 background: "/static/aurora_borealis.jpg",
1177 collapseMessageWithSubject: false,
1179 hideFilteredStatuses: false,
1180 hideMutedPosts: false,
1181 hidePostStats: false,
1182 hideUserStats: false,
1183 loginMethod: "password",
1184 logo: "/static/logo.svg",
1187 minimalScopesMode: false,
1188 noAttachmentLinks: false,
1189 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1190 postContentType: "text/plain",
1191 redirectRootLogin: "/main/friends",
1192 redirectRootNoLogin: "/main/all",
1194 sidebarRight: false,
1195 showFeaturesPanel: true,
1196 showInstanceSpecificPanel: false,
1197 subjectLineBehavior: "email",
1198 theme: "pleroma-dark",
1199 webPushNotifications: false
1204 key: :alwaysShowSubjectInput,
1205 label: "Always show subject input",
1207 description: "When disabled, auto-hide the subject field if it's empty"
1211 type: {:string, :image},
1213 "URL of the background, unless viewing a user profile with a background that is set",
1214 suggestions: ["/images/city.jpg"]
1217 key: :collapseMessageWithSubject,
1218 label: "Collapse message with subject",
1221 "When a message has a subject (aka Content Warning), collapse it by default"
1227 description: "Enables green text on lines prefixed with the > character"
1230 key: :hideFilteredStatuses,
1231 label: "Hide Filtered Statuses",
1233 description: "Hides filtered statuses from timelines"
1236 key: :hideMutedPosts,
1237 label: "Hide Muted Posts",
1239 description: "Hides muted statuses from timelines"
1242 key: :hidePostStats,
1243 label: "Hide post stats",
1245 description: "Hide notices statistics (repeats, favorites, ...)"
1248 key: :hideUserStats,
1249 label: "Hide user stats",
1252 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1256 type: {:string, :image},
1257 description: "URL of the logo, defaults to Pleroma's logo",
1258 suggestions: ["/static/logo.svg"]
1262 label: "Logo margin",
1265 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1266 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1267 suggestions: [".1em"]
1274 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1275 "If you want a colorful logo you must disable logoMask."
1278 key: :minimalScopesMode,
1279 label: "Minimal scopes mode",
1282 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1283 "Also prevents replying to a DM with a public post from PleromaFE."
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"]
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: [31_536_000]
1757 label: "CT max age",
1759 description: "The maximum age for the Expect-CT header if sent",
1760 suggestions: [2_592_000]
1763 key: :referrer_policy,
1765 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1766 suggestions: ["same-origin", "no-referrer"]
1770 label: "Report URI",
1772 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1773 suggestions: ["https://example.com/report-uri"]
1778 group: :web_push_encryption,
1779 key: :vapid_details,
1780 label: "Vapid Details",
1783 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1789 "A mailto link for the administrative contact." <>
1790 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1791 suggestions: ["mailto:moderators@pleroma.com"]
1796 description: "VAPID public key",
1797 suggestions: ["Public key"]
1802 description: "VAPID private key",
1803 suggestions: ["Private key"]
1809 key: Pleroma.Captcha,
1811 description: "Captcha-related settings",
1816 description: "Whether the captcha should be shown on registration"
1821 description: "The method/service to use for captcha",
1822 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1825 key: :seconds_valid,
1827 description: "The time in seconds for which the captcha is valid",
1834 key: Pleroma.Captcha.Kocaptcha,
1837 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1838 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1843 description: "The kocaptcha endpoint to use",
1844 suggestions: ["https://captcha.kotobank.ch"]
1850 label: "Pleroma Admin Token",
1853 "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)",
1858 description: "Admin token",
1860 "Please use a high entropy string or UUID"
1870 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1874 type: {:dropdown, :atom},
1875 description: "Logs verbose mode",
1876 suggestions: [false, :error, :warn, :info, :debug]
1880 type: {:keyword, :integer},
1882 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1884 activity_expiration: 10,
1885 attachments_cleanup: 5,
1887 federator_incoming: 50,
1888 federator_outgoing: 50,
1890 scheduled_activities: 10,
1896 key: :activity_expiration,
1898 description: "Activity expiration queue",
1904 description: "Backup queue",
1908 key: :attachments_cleanup,
1910 description: "Attachment deletion queue",
1916 description: "Background queue",
1920 key: :federator_incoming,
1922 description: "Incoming federation queue",
1926 key: :federator_outgoing,
1928 description: "Outgoing federation queue",
1934 description: "Email sender queue, see Pleroma.Emails.Mailer",
1938 key: :scheduled_activities,
1940 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1944 key: :transmogrifier,
1946 description: "Transmogrifier queue",
1952 description: "Web push notifications queue",
1959 type: {:list, :tuple},
1960 description: "Settings for cron background jobs",
1962 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1963 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1972 description: "Includes custom worker options not interpretable directly by `Oban`",
1976 type: {:keyword, :integer},
1977 description: "Max retry attempts for failed jobs, per `Oban` queue",
1979 federator_incoming: 5,
1980 federator_outgoing: 5
1987 key: Pleroma.Web.Metadata,
1989 description: "Metadata-related settings",
1993 type: {:list, :module},
1994 description: "List of metadata providers to enable",
1996 Pleroma.Web.Metadata.Providers.OpenGraph,
1997 Pleroma.Web.Metadata.Providers.TwitterCard,
1998 Pleroma.Web.Metadata.Providers.RelMe,
1999 Pleroma.Web.Metadata.Providers.Feed
2004 label: "Unfurl NSFW",
2006 description: "When enabled NSFW attachments will be shown in previews"
2012 key: Pleroma.Web.Metadata.Providers.Theme,
2014 description: "Specific provider to hand out themes to instances that scrape index.html",
2020 "The 'accent color' of the instance, used in places like misskey's instance ticker",
2021 suggestions: ["#593196"]
2030 "If enabled the instance will parse metadata from attached links to generate link previews",
2035 description: "Enables RichMedia parsing of URLs"
2039 type: {:list, :string},
2040 description: "List of hosts which will be ignored by the metadata parser",
2041 suggestions: ["accounts.google.com", "xss.website"]
2045 label: "Ignore TLD",
2046 type: {:list, :string},
2047 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2048 suggestions: ["local", "localdomain", "lan"]
2052 type: {:list, :module},
2054 "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.",
2056 Pleroma.Web.RichMedia.Parsers.OEmbed,
2057 Pleroma.Web.RichMedia.Parsers.TwitterCard
2062 label: "TTL setters",
2063 type: {:list, :module},
2065 "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.",
2067 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2071 key: :failure_backoff,
2074 "Amount of milliseconds after request failure, during which the request will not be retried.",
2075 suggestions: [60_000]
2081 key: Pleroma.Formatter,
2085 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2089 type: [:string, :boolean],
2090 description: "Specify the class to be added to the generated link. Disable to clear.",
2091 suggestions: ["auto-linker", false]
2095 type: [:string, :boolean],
2096 description: "Override the rel attribute. Disable to clear.",
2097 suggestions: ["ugc", "noopener noreferrer", false]
2102 description: "Link URLs will open in a new window/tab."
2106 type: [:integer, :boolean],
2108 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2109 suggestions: [15, false]
2114 description: "Strip the scheme prefix."
2119 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2123 type: [:atom, :boolean],
2125 "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)",
2126 suggestions: [:no_scheme, true]
2132 key: Pleroma.ScheduledActivity,
2134 description: "Scheduled activities settings",
2137 key: :daily_user_limit,
2140 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2144 key: :total_user_limit,
2147 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2153 description: "Whether scheduled activities are sent to the job queue to be executed"
2159 key: Pleroma.Workers.PurgeExpiredActivity,
2161 description: "Expired activities settings",
2166 description: "Enables expired activities addition & deletion"
2171 description: "Minimum lifetime for ephemeral activity (in seconds)",
2178 label: "Pleroma Authenticator",
2180 description: "Authenticator",
2183 key: Pleroma.Web.Auth.Authenticator,
2185 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2195 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2196 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2197 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2198 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2203 description: "Enables LDAP authentication"
2208 description: "LDAP server hostname",
2209 suggestions: ["localhosts"]
2214 description: "LDAP port, e.g. 389 or 636",
2215 suggestions: [389, 636]
2221 description: "Enable to use SSL, usually implies the port 636"
2225 label: "SSL options",
2227 description: "Additional SSL options",
2228 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2233 description: "Path to file with PEM encoded cacerts",
2234 suggestions: ["path/to/file/with/PEM/cacerts"]
2239 description: "Type of cert verification",
2240 suggestions: [:verify_peer]
2248 description: "Enable to use STARTTLS, usually implies the port 389"
2252 label: "TLS options",
2254 description: "Additional TLS options",
2255 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2260 description: "Path to file with PEM encoded cacerts",
2261 suggestions: ["path/to/file/with/PEM/cacerts"]
2266 description: "Type of cert verification",
2267 suggestions: [:verify_peer]
2274 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2275 suggestions: ["dc=example,dc=com"]
2282 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2291 description: "Authentication / authorization settings",
2294 key: :enforce_oauth_admin_scope_usage,
2295 label: "Enforce OAuth admin scope usage",
2298 "OAuth admin scope requirement toggle. " <>
2299 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2300 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2301 "`is_admin` user flag grants access to admin-specific actions."
2304 key: :auth_template,
2307 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2308 suggestions: ["show.html"]
2311 key: :oauth_consumer_template,
2312 label: "OAuth consumer template",
2315 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2316 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2317 suggestions: ["consumer.html"]
2320 key: :oauth_consumer_strategies,
2321 label: "OAuth consumer strategies",
2322 type: {:list, :string},
2324 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2325 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2326 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2327 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2333 key: :email_notifications,
2335 description: "Email notifications settings",
2341 "emails of \"what you've missed\" for users who have been inactive for a while",
2345 schedule: "0 0 * * 0",
2347 inactivity_threshold: 7
2355 description: "Globally enable or disable digest emails"
2361 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2362 suggestions: ["0 0 * * 0"]
2367 description: "Minimum interval between digest emails to one user",
2371 key: :inactivity_threshold,
2373 description: "Minimum user inactivity threshold",
2382 key: Pleroma.Emails.UserEmail,
2384 description: "Email template settings",
2388 type: {:string, :image},
2389 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2390 suggestions: ["some/path/logo.png"]
2395 description: "A map with color settings for email templates.",
2398 link_color: "#d8a070",
2399 background_color: "#2C3645",
2400 content_background_color: "#1B2635",
2401 header_color: "#d8a070",
2402 text_color: "#b9b9ba",
2403 text_muted_color: "#b9b9ba"
2410 suggestions: ["#d8a070"]
2413 key: :background_color,
2415 suggestions: ["#2C3645"]
2418 key: :content_background_color,
2420 suggestions: ["#1B2635"]
2425 suggestions: ["#d8a070"]
2430 suggestions: ["#b9b9ba"]
2433 key: :text_muted_color,
2435 suggestions: ["#b9b9ba"]
2443 key: Pleroma.Emails.NewUsersDigestEmail,
2445 description: "New users admin email digest",
2450 description: "Enables new users admin digest email when `true`"
2459 description: "Configure OAuth 2 provider capabilities",
2462 key: :token_expires_in,
2464 description: "The lifetime in seconds of the access token",
2465 suggestions: [2_592_000]
2468 key: :issue_new_refresh_token,
2471 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2474 key: :clean_expired_tokens,
2476 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2486 key: :shortcode_globs,
2487 type: {:list, :string},
2488 description: "Location of custom emoji files. * can be used as a wildcard.",
2489 suggestions: ["/emoji/custom/**/*.png"]
2492 key: :pack_extensions,
2493 type: {:list, :string},
2495 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2496 suggestions: [".png", ".gif"]
2500 type: {:keyword, {:list, :string}},
2502 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2503 " and the value is the location or array of locations. * can be used as a wildcard.",
2505 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2509 key: :default_manifest,
2512 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2513 " Currently only one manifest can be added (no arrays).",
2514 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2517 key: :shared_pack_cache_seconds_per_file,
2518 label: "Shared pack cache s/file",
2521 "When an emoji pack is shared, the archive is created and cached in memory" <>
2522 " for this amount of seconds multiplied by the number of files.",
2532 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2536 type: [:tuple, {:list, :tuple}],
2537 description: "For the search requests (account & status search etc.)",
2538 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2542 type: [:tuple, {:list, :tuple}],
2543 description: "For requests to timelines (each timeline has it's own limiter)",
2544 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2547 key: :app_account_creation,
2548 type: [:tuple, {:list, :tuple}],
2549 description: "For registering user accounts from the same IP address",
2550 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2553 key: :relations_actions,
2554 type: [:tuple, {:list, :tuple}],
2555 description: "For actions on relationships with all users (follow, unfollow)",
2556 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2559 key: :relation_id_action,
2560 label: "Relation ID action",
2561 type: [:tuple, {:list, :tuple}],
2562 description: "For actions on relation with a specific user (follow, unfollow)",
2563 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2566 key: :statuses_actions,
2567 type: [:tuple, {:list, :tuple}],
2569 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2570 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2573 key: :status_id_action,
2574 label: "Status ID action",
2575 type: [:tuple, {:list, :tuple}],
2577 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2578 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2581 key: :authentication,
2582 type: [:tuple, {:list, :tuple}],
2583 description: "For authentication create / password check / user existence check requests",
2584 suggestions: [{60_000, 15}]
2590 label: "Mime Types",
2592 description: "Mime Types settings",
2599 "application/xml" => ["xml"],
2600 "application/xrd+xml" => ["xrd+xml"],
2601 "application/jrd+json" => ["jrd+json"],
2602 "application/activity+json" => ["activity+json"],
2603 "application/ld+json" => ["activity+json"]
2608 key: "application/xml",
2609 type: {:list, :string},
2610 suggestions: ["xml"]
2613 key: "application/xrd+xml",
2614 type: {:list, :string},
2615 suggestions: ["xrd+xml"]
2618 key: "application/jrd+json",
2619 type: {:list, :string},
2620 suggestions: ["jrd+json"]
2623 key: "application/activity+json",
2624 type: {:list, :string},
2625 suggestions: ["activity+json"]
2628 key: "application/ld+json",
2629 type: {:list, :string},
2630 suggestions: ["activity+json"]
2641 description: "HTTP settings",
2648 "Proxy URL - of the format http://host:port. Advise setting in .exs instead of admin-fe due to this being set at boot-time.",
2649 suggestions: ["http://localhost:3128"]
2653 type: [:string, :atom],
2655 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2656 suggestions: ["Pleroma", :default]
2661 description: "Adapter specific options",
2667 label: "SSL Options",
2668 description: "SSL options for HTTP adapter",
2672 type: {:list, :atom},
2673 description: "List of TLS version to use",
2674 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2685 label: "Markup Settings",
2689 key: :allow_inline_images,
2693 key: :allow_headings,
2706 type: {:list, :module},
2708 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2709 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2719 key: :deny_follow_blocked,
2730 key: :restricted_nicknames,
2731 type: {:list, :string},
2732 description: "List of nicknames users may not register with.",
2751 "ostatus_subscribe",
2767 key: :email_blacklist,
2768 type: {:list, :string},
2769 description: "List of email domains users may not register with.",
2770 suggestions: ["mailinator.com", "maildrop.cc"]
2776 label: "CORS plug config",
2782 suggestions: [86_400]
2786 type: {:list, :string},
2787 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2791 type: {:list, :string},
2794 "X-RateLimit-Reset",
2795 "X-RateLimit-Limit",
2796 "X-RateLimit-Remaining",
2807 type: {:list, :string},
2808 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2814 key: Pleroma.Web.Plugs.RemoteIp,
2817 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2818 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2824 description: "Enable/disable the plug. Default: disabled."
2828 type: {:list, :string},
2830 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2835 type: {:list, :string},
2837 "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."
2841 type: {:list, :string},
2843 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"]`
2850 key: :web_cache_ttl,
2851 label: "Web cache TTL",
2854 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2860 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2864 key: :activity_pub_question,
2866 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2867 suggestions: [30_000]
2877 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2882 description: "Enables the rendering of static HTML. Default: disabled."
2890 description: "Configure feed rendering",
2895 description: "Configure title rendering",
2900 description: "Maximum number of characters before truncating title",
2906 description: "Replacement which will be used after truncating string",
2907 suggestions: ["..."]
2915 key: :mrf_follow_bot,
2917 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2918 label: "MRF FollowBot Policy",
2920 description: "Automatically follows newly discovered accounts.",
2923 key: :follower_nickname,
2925 description: "The name of the bot account to use for following newly discovered users.",
2926 suggestions: ["followbot"]
2934 description: "Custom Runtime Modules",
2939 description: "A path to custom Elixir modules (such as MRF policies)."
2947 description: "Settings for notifications streamer",
2952 description: "Number of workers to send notifications",
2956 key: :overflow_workers,
2958 description: "Maximum number of workers created if pool is empty",
2965 key: :restrict_unauthenticated,
2966 label: "Restrict Unauthenticated",
2969 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
2974 description: "Settings for public and federated timelines.",
2979 description: "Disallow view public timeline."
2984 description: "Disallow view federated timeline."
2991 description: "Settings for user profiles.",
2996 description: "Disallow view local user profiles."
3001 description: "Disallow view remote user profiles."
3008 description: "Settings for statuses.",
3013 description: "Disallow view local statuses."
3018 description: "Disallow view remote statuses."
3026 key: Pleroma.Web.ApiSpec.CastAndValidate,
3033 "Enables strict input validation (useful in development, not recommended in production)"
3039 key: :instances_favicons,
3041 description: "Control favicons for instances",
3046 description: "Allow/disallow displaying and getting instances favicons"
3054 descriptions: "S3 service related settings",
3057 key: :access_key_id,
3059 description: "S3 access key ID",
3060 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3063 key: :secret_access_key,
3065 description: "Secret access key",
3066 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3071 description: "S3 host",
3072 suggestions: ["s3.eu-central-1.amazonaws.com"]
3077 description: "S3 region (for AWS)",
3078 suggestions: ["us-east-1"]
3086 description: "Installed frontends management",
3091 description: "Primary frontend, the one that is served for all pages by default",
3092 children: installed_frontend_options
3097 description: "Admin frontend",
3098 children: installed_frontend_options
3103 description: "Mastodon frontend",
3104 children: installed_frontend_options
3109 description: "Swagger API reference frontend",
3111 installed_frontend_options ++
3117 description: "Whether to have this enabled at all"
3125 "A map containing available frontends and parameters for their installation.",
3126 children: frontend_options
3132 key: Pleroma.Web.Preload,
3134 description: "Preload-related settings",
3138 type: {:list, :module},
3139 description: "List of preload providers to enable",
3141 Pleroma.Web.Preload.Providers.Instance,
3142 Pleroma.Web.Preload.Providers.User,
3143 Pleroma.Web.Preload.Providers.Timelines,
3144 Pleroma.Web.Preload.Providers.StatusNet
3153 description: "Majic/libmagic configuration",
3158 description: "Number of majic workers to start.",
3165 key: Pleroma.User.Backup,
3167 description: "Account Backup",
3170 key: :purge_after_days,
3172 description: "Remove backup achives after N days",
3178 description: "Limit user to export not more often than once per N days",
3185 key: ConcurrentLimiter,
3187 description: "Limits configuration for background tasks.",
3190 key: Pleroma.Web.RichMedia.Helpers,
3192 description: "Concurrent limits configuration for getting RichMedia for activities.",
3193 suggestions: [max_running: 5, max_waiting: 5],
3198 description: "Max running concurrently jobs.",
3204 description: "Max waiting jobs.",
3210 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3212 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3213 suggestions: [max_running: 5, max_waiting: 5],
3218 description: "Max running concurrently jobs.",
3224 description: "Max waiting jobs.",
3233 key: Pleroma.Search,
3236 description: "General search settings.",
3241 description: "Selected search module.",
3242 suggestions: {:list_behaviour_implementations, Pleroma.Search.SearchBackend}
3248 key: Pleroma.Search.Meilisearch,
3250 description: "Meilisearch settings.",
3255 description: "Meilisearch URL.",
3256 suggestion: ["http://127.0.0.1:7700/"]
3262 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3266 key: :initial_indexing_chunk_size,
3269 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3270 " since there's a limit on maximum insert size",
3271 suggestion: [100_000]
3277 key: Pleroma.Search.Elasticsearch.Cluster,
3278 label: "Elasticsearch",
3280 description: "Elasticsearch settings.",
3285 description: "Elasticsearch URL.",
3286 suggestion: ["http://127.0.0.1:9200/"]
3291 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3292 suggestion: ["elastic"]
3297 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3298 suggestion: ["changeme"]
3304 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3305 suggestion: [Elasticsearch.API.HTTP]
3311 "The JSON module used to encode/decode when communicating with Elasticsearch",
3317 description: "The indices to set up in Elasticsearch",
3322 description: "Config for the index to use for activities",
3328 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3329 suggestion: ["priv/es-mappings/activity.json"]
3334 description: "The internal store module",
3335 suggestion: [Pleroma.Search.Elasticsearch.Store]
3339 type: {:list, :module},
3340 description: "The internal types to use for this index",
3341 suggestion: [[Pleroma.Activity]]
3344 key: :bulk_page_size,
3346 description: "Size for bulk put requests, mostly used on building the index",
3350 key: :bulk_wait_interval,
3352 description: "Time to wait between bulk put requests (in ms)",
3353 suggestion: [15_000]
3365 description: "Translation Settings",
3370 description: "Is translation enabled?",
3371 suggestion: [true, false]
3376 description: "Translation module.",
3377 suggestions: {:list_behaviour_implementations, Pleroma.Akkoma.Translator}
3386 description: "DeepL Settings.",
3390 type: {:dropdown, :atom},
3391 description: "API Tier",
3392 suggestions: [:free, :pro]
3397 description: "API key for DeepL",
3404 key: :libre_translate,
3406 description: "LibreTranslate Settings.",
3411 description: "URL for libretranslate",
3417 description: "API key for libretranslate",