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: :conversationDisplay,
1231 label: "Conversation display style",
1233 description: "How to display conversations (linear or tree)",
1234 suggestions: ["linear", "tree"]
1237 key: :hideFilteredStatuses,
1238 label: "Hide Filtered Statuses",
1240 description: "Hides filtered statuses from timelines"
1243 key: :hideMutedPosts,
1244 label: "Hide Muted Posts",
1246 description: "Hides muted statuses from timelines"
1249 key: :hidePostStats,
1250 label: "Hide post stats",
1252 description: "Hide notices statistics (repeats, favorites, ...)"
1255 key: :hideUserStats,
1256 label: "Hide user stats",
1259 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1263 type: {:string, :image},
1264 description: "URL of the logo, defaults to Pleroma's logo",
1265 suggestions: ["/static/logo.svg"]
1269 label: "Logo margin",
1272 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1273 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1274 suggestions: [".1em"]
1281 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1282 "If you want a colorful logo you must disable logoMask."
1285 key: :nsfwCensorImage,
1286 label: "NSFW Censor Image",
1287 type: {:string, :image},
1289 "URL of the image to use for hiding NSFW media attachments in the timeline",
1290 suggestions: ["/static/img/nsfw.74818f9.png"]
1293 key: :postContentType,
1294 label: "Post Content Type",
1295 type: {:dropdown, :atom},
1296 description: "Default post formatting option",
1297 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1300 key: :redirectRootNoLogin,
1301 label: "Redirect root no login",
1304 "Relative URL which indicates where to redirect when a user isn't logged in",
1305 suggestions: ["/main/all"]
1308 key: :redirectRootLogin,
1309 label: "Redirect root login",
1312 "Relative URL which indicates where to redirect when a user is logged in",
1313 suggestions: ["/main/friends"]
1317 label: "Scope copy",
1319 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1323 label: "Sidebar on Right",
1325 description: "Change alignment of sidebar and panels to the right"
1328 key: :showFeaturesPanel,
1329 label: "Show instance features panel",
1332 "Enables panel displaying functionality of the instance on the About page"
1335 key: :showInstanceSpecificPanel,
1336 label: "Show instance specific panel",
1338 description: "Whether to show the instance's custom panel"
1341 key: :subjectLineBehavior,
1342 label: "Subject line behavior",
1344 description: "Allows changing the default behaviour of subject lines in replies.
1345 `email`: copy and preprend re:, as in email,
1346 `masto`: copy verbatim, as in Mastodon,
1347 `noop`: don't copy the subject.",
1348 suggestions: ["email", "masto", "noop"]
1353 description: "Which theme to use. Available themes are defined in styles.json",
1354 suggestions: ["pleroma-dark"]
1357 key: :showPanelNavShortcuts,
1358 label: "Show timeline panel nav shortcuts",
1360 description: "Whether to put timeline nav tabs on the top of the panel"
1363 key: :showNavShortcuts,
1364 label: "Show navbar shortcuts",
1366 description: "Whether to put extra navigation options on the navbar"
1369 key: :showWiderShortcuts,
1370 label: "Increase navbar shortcut spacing",
1372 description: "Whether to add extra space between navbar icons"
1375 key: :hideSiteFavicon,
1376 label: "Hide site favicon",
1378 description: "Whether to hide the instance favicon from the navbar"
1382 label: "Hide site name",
1384 description: "Whether to hide the site name from the navbar"
1387 key: :renderMisskeyMarkdown,
1388 label: "Render misskey markdown",
1390 description: "Whether to render Misskey-flavoured markdown"
1396 description: "Whether to pause animated images until they're hovered on"
1404 description: "Settings for Masto FE",
1407 showInstanceSpecificPanel: true
1412 key: :showInstanceSpecificPanel,
1413 label: "Show instance specific panel",
1415 description: "Whenether to show the instance's specific panel"
1426 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1430 type: {:keyword, :map},
1432 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1435 url: "/images/pleroma-fox-tan-smol.png",
1436 mime_type: "image/png"
1438 pleroma_fox_tan_shy: %{
1439 url: "/images/pleroma-fox-tan-shy.png",
1440 mime_type: "image/png"
1445 key: :default_mascot,
1448 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1454 key: :default_user_avatar,
1455 type: {:string, :image},
1456 description: "URL of the default user avatar",
1457 suggestions: ["/images/avi.png"]
1466 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1470 type: {:list, :map},
1471 description: "Describe the icons of the app",
1474 src: "/static/logo.png"
1477 src: "/static/icon.png",
1481 src: "/static/icon.ico",
1482 sizes: "72x72 96x96 128x128 256x256"
1489 description: "Describe the theme color of the app - this is only used for mastodon-fe",
1490 suggestions: ["#282c37", "mediumpurple"]
1493 key: :background_color,
1496 "Describe the background color of the app - this is only used for mastodon-fe",
1497 suggestions: ["#191b22", "aliceblue"]
1505 description: "Media proxy",
1510 description: "Enables proxying of remote media via the instance's proxy"
1517 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1518 suggestions: ["https://example.com"]
1526 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1532 description: "Enables media cache object invalidation."
1537 description: "Module which will be used to purge objects from the cache.",
1539 Pleroma.Web.MediaProxy.Invalidation.Script,
1540 Pleroma.Web.MediaProxy.Invalidation.Http
1547 label: "Advanced MediaProxy Options",
1549 description: "Internal Pleroma.ReverseProxy settings",
1551 redirect_on_failure: false,
1552 max_body_length: 25 * 1_048_576,
1553 max_read_duration: 30_000
1557 key: :redirect_on_failure,
1560 Redirects the client to the origin server upon encountering HTTP errors.\n
1561 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1562 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1563 IP addresses of your users to the other servers, bypassing the MediaProxy.
1567 key: :max_body_length,
1570 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1573 key: :max_read_duration,
1575 description: "Timeout (in milliseconds) of GET request to the remote URI."
1581 type: {:list, :string},
1582 description: "List of hosts with scheme to bypass the MediaProxy",
1583 suggestions: ["http://example.com"]
1589 key: :media_preview_proxy,
1591 description: "Media preview proxy",
1597 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1600 key: :thumbnail_max_width,
1603 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1606 key: :thumbnail_max_height,
1609 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1612 key: :image_quality,
1614 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1617 key: :min_content_length,
1620 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1626 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1628 description: "HTTP invalidate settings",
1633 description: "HTTP method of request. Default: :purge"
1637 type: {:keyword, :string},
1638 description: "HTTP headers of request",
1639 suggestions: [{"x-refresh", 1}]
1644 description: "Request options",
1648 type: {:map, :string}
1656 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1658 description: "Invalidation script settings",
1663 description: "Path to executable script which will purge cached items.",
1664 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1668 label: "URL Format",
1671 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1672 suggestions: [":htcacheclean"]
1679 label: "ActivityPub",
1681 description: "ActivityPub-related settings",
1684 key: :unfollow_blocked,
1686 description: "Whether blocks result in people getting unfollowed"
1689 key: :outgoing_blocks,
1691 description: "Whether to federate blocks to other instances"
1694 key: :blockers_visible,
1696 description: "Whether a user can see someone who has blocked them"
1699 key: :sign_object_fetches,
1701 description: "Sign object fetches with HTTP signatures"
1704 key: :authorized_fetch_mode,
1706 description: "Require HTTP signatures on AP fetches"
1709 key: :note_replies_output_limit,
1712 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1715 key: :follow_handshake_timeout,
1717 description: "Following handshake timeout",
1721 key: :max_collection_objects,
1724 "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.",
1731 key: :http_security,
1732 label: "HTTP security",
1734 description: "HTTP security settings",
1739 description: "Whether the managed content security policy is enabled"
1745 description: "Whether to additionally send a Strict-Transport-Security header"
1749 label: "STS max age",
1751 description: "The maximum age for the Strict-Transport-Security header if sent",
1752 suggestions: [63_072_000]
1755 key: :referrer_policy,
1757 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1758 suggestions: ["same-origin", "no-referrer"]
1762 label: "Report URI",
1764 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1765 suggestions: ["https://example.com/report-uri"]
1770 group: :web_push_encryption,
1771 key: :vapid_details,
1772 label: "Vapid Details",
1775 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1781 "A mailto link for the administrative contact." <>
1782 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1783 suggestions: ["mailto:moderators@pleroma.com"]
1788 description: "VAPID public key",
1789 suggestions: ["Public key"]
1794 description: "VAPID private key",
1795 suggestions: ["Private key"]
1801 key: Pleroma.Captcha,
1803 description: "Captcha-related settings",
1808 description: "Whether the captcha should be shown on registration"
1813 description: "The method/service to use for captcha",
1814 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1817 key: :seconds_valid,
1819 description: "The time in seconds for which the captcha is valid",
1826 key: Pleroma.Captcha.Kocaptcha,
1829 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1830 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1835 description: "The kocaptcha endpoint to use",
1836 suggestions: ["https://captcha.kotobank.ch"]
1842 label: "Pleroma Admin Token",
1845 "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)",
1850 description: "Admin token",
1852 "Please use a high entropy string or UUID"
1862 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1866 type: {:dropdown, :atom},
1867 description: "Logs verbose mode",
1868 suggestions: [false, :error, :warn, :info, :debug]
1872 type: {:keyword, :integer},
1874 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1876 activity_expiration: 10,
1877 attachments_cleanup: 5,
1879 federator_incoming: 50,
1880 federator_outgoing: 50,
1882 scheduled_activities: 10,
1888 key: :activity_expiration,
1890 description: "Activity expiration queue",
1896 description: "Backup queue",
1900 key: :attachments_cleanup,
1902 description: "Attachment deletion queue",
1908 description: "Background queue",
1912 key: :federator_incoming,
1914 description: "Incoming federation queue",
1918 key: :federator_outgoing,
1920 description: "Outgoing federation queue",
1926 description: "Email sender queue, see Pleroma.Emails.Mailer",
1930 key: :scheduled_activities,
1932 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1936 key: :transmogrifier,
1938 description: "Transmogrifier queue",
1944 description: "Web push notifications queue",
1951 type: {:list, :tuple},
1952 description: "Settings for cron background jobs",
1954 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1955 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1964 description: "Includes custom worker options not interpretable directly by `Oban`",
1968 type: {:keyword, :integer},
1969 description: "Max retry attempts for failed jobs, per `Oban` queue",
1971 federator_incoming: 5,
1972 federator_outgoing: 5
1977 type: {:keyword, :integer},
1978 description: "Timeout for jobs, per `Oban` queue, in ms",
1980 activity_expiration: :timer.seconds(5),
1981 token_expiration: :timer.seconds(5),
1982 filter_expiration: :timer.seconds(5),
1983 backup: :timer.seconds(900),
1984 federator_incoming: :timer.seconds(10),
1985 federator_outgoing: :timer.seconds(10),
1986 ingestion_queue: :timer.seconds(5),
1987 web_push: :timer.seconds(5),
1988 mailer: :timer.seconds(5),
1989 transmogrifier: :timer.seconds(5),
1990 scheduled_activities: :timer.seconds(5),
1991 poll_notifications: :timer.seconds(5),
1992 background: :timer.seconds(5),
1993 remote_fetcher: :timer.seconds(10),
1994 attachments_cleanup: :timer.seconds(900),
1995 new_users_digest: :timer.seconds(10),
1996 mute_expire: :timer.seconds(5),
1997 search_indexing: :timer.seconds(5),
1998 nodeinfo_fetcher: :timer.seconds(10)
2005 key: Pleroma.Web.Metadata,
2007 description: "Metadata-related settings",
2011 type: {:list, :module},
2012 description: "List of metadata providers to enable",
2014 Pleroma.Web.Metadata.Providers.OpenGraph,
2015 Pleroma.Web.Metadata.Providers.TwitterCard,
2016 Pleroma.Web.Metadata.Providers.RelMe,
2017 Pleroma.Web.Metadata.Providers.Feed
2022 label: "Unfurl NSFW",
2024 description: "When enabled NSFW attachments will be shown in previews"
2030 key: Pleroma.Web.Metadata.Providers.Theme,
2032 description: "Specific provider to hand out themes to instances that scrape index.html",
2038 "The 'accent color' of the instance, used in places like misskey's instance ticker",
2039 suggestions: ["#593196"]
2048 "If enabled the instance will parse metadata from attached links to generate link previews",
2053 description: "Enables RichMedia parsing of URLs"
2057 type: {:list, :string},
2058 description: "List of hosts which will be ignored by the metadata parser",
2059 suggestions: ["accounts.google.com", "xss.website"]
2063 label: "Ignore TLD",
2064 type: {:list, :string},
2065 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2066 suggestions: ["local", "localdomain", "lan"]
2070 type: {:list, :module},
2072 "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.",
2074 Pleroma.Web.RichMedia.Parsers.OEmbed,
2075 Pleroma.Web.RichMedia.Parsers.TwitterCard
2080 label: "TTL setters",
2081 type: {:list, :module},
2083 "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.",
2085 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2089 key: :failure_backoff,
2092 "Amount of milliseconds after request failure, during which the request will not be retried.",
2093 suggestions: [60_000]
2099 key: Pleroma.Formatter,
2103 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2107 type: [:string, :boolean],
2108 description: "Specify the class to be added to the generated link. Disable to clear.",
2109 suggestions: ["auto-linker", false]
2113 type: [:string, :boolean],
2114 description: "Override the rel attribute. Disable to clear.",
2115 suggestions: ["ugc", "noopener noreferrer", false]
2120 description: "Link URLs will open in a new window/tab."
2124 type: [:integer, :boolean],
2126 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2127 suggestions: [15, false]
2132 description: "Strip the scheme prefix."
2137 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2141 type: [:atom, :boolean],
2143 "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)",
2144 suggestions: [:no_scheme, true]
2150 key: Pleroma.ScheduledActivity,
2152 description: "Scheduled activities settings",
2155 key: :daily_user_limit,
2158 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2162 key: :total_user_limit,
2165 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2171 description: "Whether scheduled activities are sent to the job queue to be executed"
2177 key: Pleroma.Workers.PurgeExpiredActivity,
2179 description: "Expired activities settings",
2184 description: "Enables expired activities addition & deletion"
2189 description: "Minimum lifetime for ephemeral activity (in seconds)",
2196 label: "Pleroma Authenticator",
2198 description: "Authenticator",
2201 key: Pleroma.Web.Auth.Authenticator,
2203 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2213 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2214 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2215 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2216 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2221 description: "Enables LDAP authentication"
2226 description: "LDAP server hostname",
2227 suggestions: ["localhosts"]
2232 description: "LDAP port, e.g. 389 or 636",
2233 suggestions: [389, 636]
2239 description: "Enable to use SSL, usually implies the port 636"
2243 label: "SSL options",
2245 description: "Additional SSL options",
2246 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2251 description: "Path to file with PEM encoded cacerts",
2252 suggestions: ["path/to/file/with/PEM/cacerts"]
2257 description: "Type of cert verification",
2258 suggestions: [:verify_peer]
2266 description: "Enable to use STARTTLS, usually implies the port 389"
2270 label: "TLS options",
2272 description: "Additional TLS options",
2273 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2278 description: "Path to file with PEM encoded cacerts",
2279 suggestions: ["path/to/file/with/PEM/cacerts"]
2284 description: "Type of cert verification",
2285 suggestions: [:verify_peer]
2292 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2293 suggestions: ["dc=example,dc=com"]
2300 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2309 description: "Authentication / authorization settings",
2312 key: :enforce_oauth_admin_scope_usage,
2313 label: "Enforce OAuth admin scope usage",
2316 "OAuth admin scope requirement toggle. " <>
2317 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2318 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2319 "`is_admin` user flag grants access to admin-specific actions."
2322 key: :auth_template,
2325 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2326 suggestions: ["show.html"]
2329 key: :oauth_consumer_template,
2330 label: "OAuth consumer template",
2333 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2334 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2335 suggestions: ["consumer.html"]
2338 key: :oauth_consumer_strategies,
2339 label: "OAuth consumer strategies",
2340 type: {:list, :string},
2342 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2343 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2344 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2345 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2351 key: :email_notifications,
2353 description: "Email notifications settings",
2359 "emails of \"what you've missed\" for users who have been inactive for a while",
2363 schedule: "0 0 * * 0",
2365 inactivity_threshold: 7
2373 description: "Globally enable or disable digest emails"
2379 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2380 suggestions: ["0 0 * * 0"]
2385 description: "Minimum interval between digest emails to one user",
2389 key: :inactivity_threshold,
2391 description: "Minimum user inactivity threshold",
2400 key: Pleroma.Emails.UserEmail,
2402 description: "Email template settings",
2406 type: {:string, :image},
2407 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2408 suggestions: ["some/path/logo.png"]
2413 description: "A map with color settings for email templates.",
2416 link_color: "#d8a070",
2417 background_color: "#2C3645",
2418 content_background_color: "#1B2635",
2419 header_color: "#d8a070",
2420 text_color: "#b9b9ba",
2421 text_muted_color: "#b9b9ba"
2428 suggestions: ["#d8a070"]
2431 key: :background_color,
2433 suggestions: ["#2C3645"]
2436 key: :content_background_color,
2438 suggestions: ["#1B2635"]
2443 suggestions: ["#d8a070"]
2448 suggestions: ["#b9b9ba"]
2451 key: :text_muted_color,
2453 suggestions: ["#b9b9ba"]
2461 key: Pleroma.Emails.NewUsersDigestEmail,
2463 description: "New users admin email digest",
2468 description: "Enables new users admin digest email when `true`"
2477 description: "Configure OAuth 2 provider capabilities",
2480 key: :token_expires_in,
2482 description: "The lifetime in seconds of the access token",
2483 suggestions: [2_592_000]
2486 key: :issue_new_refresh_token,
2489 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2492 key: :clean_expired_tokens,
2494 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2504 key: :shortcode_globs,
2505 type: {:list, :string},
2506 description: "Location of custom emoji files. * can be used as a wildcard.",
2507 suggestions: ["/emoji/custom/**/*.png"]
2510 key: :pack_extensions,
2511 type: {:list, :string},
2513 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2514 suggestions: [".png", ".gif"]
2518 type: {:keyword, {:list, :string}},
2520 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2521 " and the value is the location or array of locations. * can be used as a wildcard.",
2523 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2527 key: :default_manifest,
2530 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2531 " Currently only one manifest can be added (no arrays).",
2532 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2535 key: :shared_pack_cache_seconds_per_file,
2536 label: "Shared pack cache s/file",
2539 "When an emoji pack is shared, the archive is created and cached in memory" <>
2540 " for this amount of seconds multiplied by the number of files.",
2550 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2554 type: [:tuple, {:list, :tuple}],
2555 description: "For the search requests (account & status search etc.)",
2556 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2560 type: [:tuple, {:list, :tuple}],
2561 description: "For requests to timelines (each timeline has it's own limiter)",
2562 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2565 key: :app_account_creation,
2566 type: [:tuple, {:list, :tuple}],
2567 description: "For registering user accounts from the same IP address",
2568 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2571 key: :relations_actions,
2572 type: [:tuple, {:list, :tuple}],
2573 description: "For actions on relationships with all users (follow, unfollow)",
2574 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2577 key: :relation_id_action,
2578 label: "Relation ID action",
2579 type: [:tuple, {:list, :tuple}],
2580 description: "For actions on relation with a specific user (follow, unfollow)",
2581 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2584 key: :statuses_actions,
2585 type: [:tuple, {:list, :tuple}],
2587 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2588 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2591 key: :status_id_action,
2592 label: "Status ID action",
2593 type: [:tuple, {:list, :tuple}],
2595 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2596 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2599 key: :authentication,
2600 type: [:tuple, {:list, :tuple}],
2601 description: "For authentication create / password check / user existence check requests",
2602 suggestions: [{60_000, 15}]
2608 label: "Mime Types",
2610 description: "Mime Types settings",
2617 "application/xml" => ["xml"],
2618 "application/xrd+xml" => ["xrd+xml"],
2619 "application/jrd+json" => ["jrd+json"],
2620 "application/activity+json" => ["activity+json"],
2621 "application/ld+json" => ["activity+json"]
2626 key: "application/xml",
2627 type: {:list, :string},
2628 suggestions: ["xml"]
2631 key: "application/xrd+xml",
2632 type: {:list, :string},
2633 suggestions: ["xrd+xml"]
2636 key: "application/jrd+json",
2637 type: {:list, :string},
2638 suggestions: ["jrd+json"]
2641 key: "application/activity+json",
2642 type: {:list, :string},
2643 suggestions: ["activity+json"]
2646 key: "application/ld+json",
2647 type: {:list, :string},
2648 suggestions: ["activity+json"]
2659 description: "HTTP settings",
2663 label: "HTTP Pool Request Timeout",
2665 description: "Timeout for initiating HTTP requests (in ms, default 5000)",
2669 key: :receive_timeout,
2670 label: "HTTP Receive Timeout",
2673 "Timeout for waiting on remote servers to respond to HTTP requests (in ms, default 15000)",
2674 suggestions: [15000]
2681 "Proxy URL - of the format http://host:port. Advise setting in .exs instead of admin-fe due to this being set at boot-time.",
2682 suggestions: ["http://localhost:3128"]
2686 type: [:string, :atom],
2688 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2689 suggestions: ["Pleroma", :default]
2694 description: "Adapter specific options",
2700 label: "SSL Options",
2701 description: "SSL options for HTTP adapter",
2705 type: {:list, :atom},
2706 description: "List of TLS version to use",
2707 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2718 label: "Markup Settings",
2722 key: :allow_inline_images,
2726 key: :allow_headings,
2739 type: {:list, :module},
2741 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2742 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2752 key: :deny_follow_blocked,
2763 key: :restricted_nicknames,
2764 type: {:list, :string},
2765 description: "List of nicknames users may not register with.",
2784 "ostatus_subscribe",
2800 key: :email_blacklist,
2801 type: {:list, :string},
2802 description: "List of email domains users may not register with.",
2803 suggestions: ["mailinator.com", "maildrop.cc"]
2809 label: "CORS plug config",
2815 suggestions: [86_400]
2819 type: {:list, :string},
2820 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2824 type: {:list, :string},
2827 "X-RateLimit-Reset",
2828 "X-RateLimit-Limit",
2829 "X-RateLimit-Remaining",
2840 type: {:list, :string},
2841 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2847 key: Pleroma.Web.Plugs.RemoteIp,
2850 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2851 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2857 description: "Enable/disable the plug. Default: disabled."
2861 type: {:list, :string},
2863 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2868 type: {:list, :string},
2870 "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."
2874 type: {:list, :string},
2876 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"]`
2883 key: :web_cache_ttl,
2884 label: "Web cache TTL",
2887 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2893 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2897 key: :activity_pub_question,
2899 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2900 suggestions: [30_000]
2910 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2915 description: "Enables the rendering of static HTML. Default: disabled."
2923 description: "Configure feed rendering",
2928 description: "Configure title rendering",
2933 description: "Maximum number of characters before truncating title",
2939 description: "Replacement which will be used after truncating string",
2940 suggestions: ["..."]
2948 key: :mrf_follow_bot,
2950 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2951 label: "MRF FollowBot Policy",
2953 description: "Automatically follows newly discovered accounts.",
2956 key: :follower_nickname,
2958 description: "The name of the bot account to use for following newly discovered users.",
2959 suggestions: ["followbot"]
2967 description: "Custom Runtime Modules",
2972 description: "A path to custom Elixir modules (such as MRF policies)."
2980 description: "Settings for notifications streamer",
2985 description: "Number of workers to send notifications",
2989 key: :overflow_workers,
2991 description: "Maximum number of workers created if pool is empty",
2998 key: :restrict_unauthenticated,
2999 label: "Restrict Unauthenticated",
3002 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3007 description: "Settings for public and federated timelines.",
3012 description: "Disallow view public timeline."
3017 description: "Disallow view federated timeline."
3024 description: "Settings for user profiles.",
3029 description: "Disallow view local user profiles."
3034 description: "Disallow view remote user profiles."
3041 description: "Settings for statuses.",
3046 description: "Disallow view local statuses."
3051 description: "Disallow view remote statuses."
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",