6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
105 "https://cdn-host.com"
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
117 key: :filename_display_max_length,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
125 key: Pleroma.Uploaders.Local,
127 description: "Local uploader-related settings",
132 description: "Path where user's uploads will be saved",
141 key: Pleroma.Uploaders.S3,
143 description: "S3 uploader-related settings",
148 description: "S3 bucket",
154 key: :bucket_namespace,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
160 key: :truncated_namespace,
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
167 key: :streaming_enabled,
170 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
176 key: Pleroma.Upload.Filter.Mogrify,
178 description: "Uploads mogrify filter settings",
182 type: [:string, {:list, :string}, {:list, :tuple}],
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
198 description: "Filter replaces the filename of the upload",
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
207 "custom-file-name.{extension}"
214 key: Pleroma.Emails.Mailer,
216 description: "Mailer-related settings",
220 label: "Mailer Enabled",
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
229 Swoosh.Adapters.AmazonSES,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
244 group: {:subgroup, Swoosh.Adapters.SMTP},
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "SMTP port",
255 suggestions: ["1025"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "Use Implicit SSL/TLS. e.g. port 465"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "SMTP temporary (4xx) error retries",
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 label: "SendGrid API Key",
306 suggestions: ["YOUR_API_KEY"]
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
323 label: "Qmail compat mode",
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
329 label: "Mandrill API Key",
331 suggestions: ["YOUR_API_KEY"]
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
336 label: "Mailgun API Key",
338 suggestions: ["YOUR_API_KEY"]
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
344 suggestions: ["YOUR_DOMAIN_NAME"]
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
349 label: "MailJet Public API Key",
351 suggestions: ["MJ_APIKEY_PUBLIC"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
356 label: "MailJet Private API Key",
358 suggestions: ["MJ_APIKEY_PRIVATE"]
361 group: {:subgroup, Swoosh.Adapters.Postmark},
363 label: "Postmark API Key",
365 suggestions: ["X-Postmark-Server-Token"]
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
370 label: "SparkPost API key",
372 suggestions: ["YOUR_API_KEY"]
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 suggestions: ["https://api.sparkpost.com/api/v1"]
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
383 label: "AWS Access Key",
385 suggestions: ["AWS_ACCESS_KEY"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
390 label: "AWS Secret Key",
392 suggestions: ["AWS_SECRET_KEY"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.Dyn},
404 label: "Dyn API Key",
406 suggestions: ["apikey"]
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
411 label: "SocketLabs API Key",
413 suggestions: ["INJECTION_API_KEY"]
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 suggestions: ["SERVER_ID"]
423 group: {:subgroup, Swoosh.Adapters.Gmail},
425 label: "GMail API Access Token",
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
434 label: "URI Schemes",
436 description: "URI schemes related settings",
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
466 description: "Customizable features",
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
479 key: :populate_hashtags_table,
481 description: "`populate_hashtags_table` background migration settings",
484 key: :fault_rate_allowance,
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
491 key: :sleep_interval_ms,
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 type: {:list, :string},
515 description: "Languages the instance uses",
524 label: "Admin Email Address",
526 description: "Email used to reach an Administrator/Moderator of the instance",
533 label: "Sender Email Address",
535 description: "Envelope FROM address for mail sent via Pleroma",
544 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
552 description: "Posts character limit (CW/Subject included in the counter)",
560 description: "Hard character limit beyond which remote posts will be dropped",
568 description: "File size limit of uploads (except for avatar, background, banner)",
574 key: :avatar_upload_limit,
576 description: "File size limit of user's profile avatars",
582 key: :background_upload_limit,
584 description: "File size limit of user's profile backgrounds",
590 key: :banner_upload_limit,
592 description: "File size limit of user's profile banners",
600 description: "A map with poll limits for local polls",
604 max_option_chars: 200,
606 max_expiration: 31_536_000
613 description: "Maximum number of options",
617 key: :max_option_chars,
619 description: "Maximum number of characters per option",
623 key: :min_expiration,
625 description: "Minimum expiration time (in seconds)",
629 key: :max_expiration,
631 description: "Maximum expiration time (in seconds)",
637 key: :registrations_open,
640 "Enable registrations for anyone. Invitations require this setting to be disabled."
643 key: :invites_enabled,
646 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
649 key: :account_activation_required,
651 description: "Require users to confirm their emails before signing in"
654 key: :account_approval_required,
656 description: "Require users to be manually approved by an admin before signing in"
661 description: "Enable federation with other instances"
664 key: :federation_incoming_replies_max_depth,
665 label: "Fed. incoming replies max depth",
668 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
669 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
675 key: :federation_reachability_timeout_days,
676 label: "Fed. reachability timeout days",
679 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
688 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
694 "Switching this on will allow unauthenticated users access to all public resources on your instance" <>
695 " Switching it off is useful for disabling the Local Timeline and The Whole Known Network. " <>
696 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
699 key: :quarantined_instances,
700 type: {:list, :tuple},
701 key_placeholder: "instance",
702 value_placeholder: "reason",
704 "(Deprecated, will be removed in next release) List of ActivityPub instances where activities will not be sent, and the reason for doing so",
706 {"quarantined.com", "Reason"},
707 {"*.quarantined.com", "Reason"}
713 description: "Instance static directory",
719 key: :allowed_post_formats,
720 type: {:list, :string},
721 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
727 "text/x.misskeymarkdown"
731 key: :extended_nickname_format,
734 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
735 " This will break federation with older software for theses nicknames."
738 key: :cleanup_attachments,
741 Enable to remove associated attachments when status is removed.
742 This will not affect duplicates and attachments without status.
743 Enabling this will increase load to database when deleting statuses on larger instances.
747 key: :max_pinned_statuses,
749 description: "The maximum number of pinned statuses. 0 will disable the feature.",
757 key: :autofollowed_nicknames,
758 type: {:list, :string},
760 "Set to nicknames of (local) users that every new user should automatically follow"
763 key: :autofollowing_nicknames,
764 type: {:list, :string},
766 "Set to nicknames of (local) users that automatically follows every newly registered user"
769 key: :attachment_links,
771 description: "Enable to automatically add attachment link text to statuses"
774 key: :max_report_comment_size,
776 description: "The maximum size of the report comment. Default: 1000.",
782 key: :safe_dm_mentions,
783 label: "Safe DM mentions",
786 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
787 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
793 description: "If enabled, system data will be shown on `/api/v1/pleroma/healthcheck`"
796 key: :remote_post_retention_days,
799 "The default amount of days to retain remote posts when pruning the database",
805 key: :user_bio_length,
807 description: "A user bio maximum length. Default: 5000.",
813 key: :user_name_length,
815 description: "A user name maximum length. Default: 100.",
821 key: :skip_thread_containment,
823 description: "Skip filtering out broken threads. Default: enabled."
826 key: :limit_to_local_content,
827 type: {:dropdown, :atom},
829 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
837 key: :max_account_fields,
839 description: "The maximum number of custom fields in the user profile. Default: 10.",
845 key: :max_remote_account_fields,
848 "The maximum number of custom fields in the remote user profile. Default: 20.",
854 key: :account_field_name_length,
856 description: "An account field name maximum length. Default: 512.",
862 key: :account_field_value_length,
864 description: "An account field value maximum length. Default: 2048.",
870 key: :registration_reason_length,
872 description: "Maximum registration reason length. Default: 500.",
878 key: :external_user_synchronization,
880 description: "Enabling following/followers counters synchronization for external users"
883 key: :multi_factor_authentication,
885 description: "Multi-factor authentication settings",
888 totp: [digits: 6, period: 30],
889 backup_codes: [number: 5, length: 16]
895 label: "TOTP settings",
897 description: "TOTP settings",
898 suggestions: [digits: 6, period: 30],
905 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
912 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
919 description: "MFA backup codes settings",
920 suggestions: [number: 5, length: 16],
926 description: "Number of backup codes to generate."
933 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
940 key: :instance_thumbnail,
941 type: {:string, :image},
943 "The instance thumbnail can be any image that represents your instance and is used by some apps or services when they display information about your instance.",
944 suggestions: ["/instance/thumbnail.jpeg"]
947 key: :show_reactions,
949 description: "Let favourites and emoji reactions be viewed through the API."
952 key: :profile_directory,
954 description: "Enable profile directory."
957 key: :privileged_staff,
960 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses)"
964 type: {:list, :string},
966 "List of instances that make up your local bubble (closely-related instances). Used to populate the 'bubble' timeline (domain only)."
969 key: :export_prometheus_metrics,
971 description: "Enable prometheus metrics (at /api/v1/akkoma/metrics)"
974 key: :federated_timeline_available,
977 "Let people view the 'firehose' feed of all public statuses from all instances."
985 description: "Welcome messages settings",
988 key: :direct_message,
990 descpiption: "Direct message settings",
995 description: "Enables sending a direct message to newly registered users"
1000 description: "A message that will be sent to newly registered users",
1002 "Hi, @username! Welcome on board!"
1006 key: :sender_nickname,
1008 description: "The nickname of the local user that sends a welcome message",
1018 descpiption: "Email message settings",
1023 description: "Enables sending an email to newly registered users"
1027 type: [:string, :tuple],
1029 "Email address and/or nickname that will be used to send the welcome email.",
1031 {"Pleroma App", "welcome@pleroma.app"}
1038 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1039 suggestions: ["Welcome to <%= instance_name%>"]
1045 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1046 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1052 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1053 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1062 description: "Logger-related settings",
1066 type: [:atom, :tuple, :module],
1068 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1069 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1077 label: "ExSyslogger",
1078 description: "ExSyslogger-related settings",
1082 type: {:dropdown, :atom},
1083 description: "Log level",
1084 suggestions: [:debug, :info, :warn, :error]
1090 "A string that's prepended to every message, and is typically set to the app name",
1091 suggestions: ["pleroma"]
1096 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1097 suggestions: ["$metadata[$level] $message"]
1101 type: {:list, :atom},
1102 suggestions: [:request_id]
1110 label: "Console Logger",
1111 description: "Console logger settings",
1115 type: {:dropdown, :atom},
1116 description: "Log level",
1117 suggestions: [:debug, :info, :warn, :error]
1122 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1123 suggestions: ["$metadata[$level] $message"]
1127 type: {:list, :atom},
1128 suggestions: [:request_id]
1134 key: :frontend_configurations,
1137 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1138 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1139 "add your own configuration your settings all fields must be complete.",
1143 label: "Pleroma FE",
1145 description: "Settings for Pleroma FE",
1148 alwaysShowSubjectInput: true,
1149 background: "/static/aurora_borealis.jpg",
1150 collapseMessageWithSubject: false,
1152 hideFilteredStatuses: false,
1153 hideMutedPosts: false,
1154 hidePostStats: false,
1155 hideUserStats: false,
1156 loginMethod: "password",
1157 logo: "/static/logo.svg",
1160 minimalScopesMode: false,
1161 noAttachmentLinks: false,
1162 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1163 postContentType: "text/plain",
1164 redirectRootLogin: "/main/friends",
1165 redirectRootNoLogin: "/main/all",
1167 sidebarRight: false,
1168 showFeaturesPanel: true,
1169 showInstanceSpecificPanel: false,
1170 subjectLineBehavior: "email",
1171 theme: "pleroma-dark",
1172 webPushNotifications: false
1177 key: :alwaysShowSubjectInput,
1178 label: "Always show subject input",
1180 description: "When disabled, auto-hide the subject field if it's empty"
1184 type: {:string, :image},
1186 "URL of the background, unless viewing a user profile with a background that is set",
1187 suggestions: ["/images/city.jpg"]
1190 key: :collapseMessageWithSubject,
1191 label: "Collapse message with subject",
1194 "When a message has a subject (aka Content Warning), collapse it by default"
1200 description: "Enables green text on lines prefixed with the > character"
1203 key: :conversationDisplay,
1204 label: "Conversation display style",
1206 description: "How to display conversations (linear or tree)",
1207 suggestions: ["linear", "tree"]
1210 key: :hideFilteredStatuses,
1211 label: "Hide Filtered Statuses",
1213 description: "Hides filtered statuses from timelines"
1216 key: :hideMutedPosts,
1217 label: "Hide Muted Posts",
1219 description: "Hides muted statuses from timelines"
1222 key: :hidePostStats,
1223 label: "Hide post stats",
1225 description: "Hide notices statistics (repeats, favorites, ...)"
1228 key: :hideUserStats,
1229 label: "Hide user stats",
1232 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1236 type: {:string, :image},
1237 description: "URL of the logo, defaults to Pleroma's logo",
1238 suggestions: ["/static/logo.svg"]
1242 label: "Logo margin",
1245 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1246 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1247 suggestions: [".1em"]
1254 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1255 "If you want a colorful logo you must disable logoMask."
1258 key: :nsfwCensorImage,
1259 label: "NSFW Censor Image",
1260 type: {:string, :image},
1262 "URL of the image to use for hiding NSFW media attachments in the timeline",
1263 suggestions: ["/static/img/nsfw.74818f9.png"]
1266 key: :postContentType,
1267 label: "Post Content Type",
1268 type: {:dropdown, :atom},
1269 description: "Default post formatting option",
1275 "text/x.misskeymarkdown"
1279 key: :redirectRootNoLogin,
1280 label: "Redirect root no login",
1283 "Relative URL which indicates where to redirect when a user isn't logged in",
1284 suggestions: ["/main/all"]
1287 key: :redirectRootLogin,
1288 label: "Redirect root login",
1291 "Relative URL which indicates where to redirect when a user is logged in",
1292 suggestions: ["/main/friends"]
1296 label: "Scope copy",
1298 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1302 label: "Sidebar on Right",
1304 description: "Change alignment of sidebar and panels to the right"
1307 key: :showFeaturesPanel,
1308 label: "Show instance features panel",
1311 "Enables panel displaying functionality of the instance on the About page"
1314 key: :showInstanceSpecificPanel,
1315 label: "Show instance specific panel",
1317 description: "Whether to show the instance's custom panel"
1320 key: :subjectLineBehavior,
1321 label: "Subject line behavior",
1323 description: "Allows changing the default behaviour of subject lines in replies.
1324 `email`: copy and preprend re:, as in email,
1325 `masto`: copy verbatim, as in Mastodon,
1326 `noop`: don't copy the subject.",
1327 suggestions: ["email", "masto", "noop"]
1332 description: "Which theme to use. Available themes are defined in styles.json",
1333 suggestions: ["pleroma-dark"]
1336 key: :showPanelNavShortcuts,
1337 label: "Show timeline panel nav shortcuts",
1339 description: "Whether to put timeline nav tabs on the top of the panel"
1342 key: :showNavShortcuts,
1343 label: "Show navbar shortcuts",
1345 description: "Whether to put extra navigation options on the navbar"
1348 key: :showWiderShortcuts,
1349 label: "Increase navbar shortcut spacing",
1351 description: "Whether to add extra space between navbar icons"
1354 key: :hideSiteFavicon,
1355 label: "Hide site favicon",
1357 description: "Whether to hide the instance favicon from the navbar"
1361 label: "Hide site name",
1363 description: "Whether to hide the site name from the navbar"
1366 key: :renderMisskeyMarkdown,
1367 label: "Render misskey markdown",
1369 description: "Whether to render Misskey-flavoured markdown"
1375 description: "Whether to pause animated images until they're hovered on"
1383 description: "Settings for Masto FE",
1386 showInstanceSpecificPanel: true
1391 key: :showInstanceSpecificPanel,
1392 label: "Show instance specific panel",
1394 description: "Whenether to show the instance's specific panel"
1405 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1409 type: {:keyword, :map},
1411 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1414 url: "/images/pleroma-fox-tan-smol.png",
1415 mime_type: "image/png"
1417 pleroma_fox_tan_shy: %{
1418 url: "/images/pleroma-fox-tan-shy.png",
1419 mime_type: "image/png"
1424 key: :default_mascot,
1427 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1433 key: :default_user_avatar,
1434 type: {:string, :image},
1435 description: "URL of the default user avatar",
1436 suggestions: ["/images/avi.png"]
1445 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1449 type: {:list, :map},
1450 description: "Describe the icons of the app",
1453 src: "/static/logo.png"
1456 src: "/static/icon.png",
1460 src: "/static/icon.ico",
1461 sizes: "72x72 96x96 128x128 256x256"
1468 description: "Describe the theme color of the app - this is only used for mastodon-fe",
1469 suggestions: ["#282c37", "mediumpurple"]
1472 key: :background_color,
1475 "Describe the background color of the app - this is only used for mastodon-fe",
1476 suggestions: ["#191b22", "aliceblue"]
1484 description: "Media proxy",
1489 description: "Enables proxying of remote media via the instance's proxy"
1496 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1497 suggestions: ["https://example.com"]
1505 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1511 description: "Enables media cache object invalidation."
1516 description: "Module which will be used to purge objects from the cache.",
1518 Pleroma.Web.MediaProxy.Invalidation.Script,
1519 Pleroma.Web.MediaProxy.Invalidation.Http
1526 label: "Advanced MediaProxy Options",
1528 description: "Internal Pleroma.ReverseProxy settings",
1530 redirect_on_failure: false,
1531 max_body_length: 25 * 1_048_576,
1532 max_read_duration: 30_000
1536 key: :redirect_on_failure,
1539 Redirects the client to the origin server upon encountering HTTP errors.\n
1540 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1541 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1542 IP addresses of your users to the other servers, bypassing the MediaProxy.
1546 key: :max_body_length,
1549 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1552 key: :max_read_duration,
1554 description: "Timeout (in milliseconds) of GET request to the remote URI."
1560 type: {:list, :string},
1561 description: "List of hosts with scheme to bypass the MediaProxy",
1562 suggestions: ["http://example.com"]
1568 key: :media_preview_proxy,
1570 description: "Media preview proxy",
1576 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1579 key: :thumbnail_max_width,
1582 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1585 key: :thumbnail_max_height,
1588 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1591 key: :image_quality,
1593 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1596 key: :min_content_length,
1599 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1605 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1607 description: "HTTP invalidate settings",
1612 description: "HTTP method of request. Default: :purge"
1616 type: {:keyword, :string},
1617 description: "HTTP headers of request",
1618 suggestions: [{"x-refresh", 1}]
1623 description: "Request options",
1627 type: {:map, :string}
1635 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1637 description: "Invalidation script settings",
1642 description: "Path to executable script which will purge cached items.",
1643 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1647 label: "URL Format",
1650 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1651 suggestions: [":htcacheclean"]
1658 label: "ActivityPub",
1660 description: "ActivityPub-related settings",
1663 key: :unfollow_blocked,
1665 description: "Whether blocks result in people getting unfollowed"
1668 key: :outgoing_blocks,
1670 description: "Whether to federate blocks to other instances"
1673 key: :blockers_visible,
1675 description: "Whether a user can see someone who has blocked them"
1678 key: :sign_object_fetches,
1680 description: "Sign object fetches with HTTP signatures"
1683 key: :authorized_fetch_mode,
1685 description: "Require HTTP signatures on AP fetches"
1688 key: :note_replies_output_limit,
1691 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1694 key: :follow_handshake_timeout,
1696 description: "Following handshake timeout",
1700 key: :max_collection_objects,
1703 "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.",
1710 key: :http_security,
1711 label: "HTTP security",
1713 description: "HTTP security settings",
1718 description: "Whether the managed content security policy is enabled"
1724 description: "Whether to additionally send a Strict-Transport-Security header"
1728 label: "STS max age",
1730 description: "The maximum age for the Strict-Transport-Security header if sent",
1731 suggestions: [63_072_000]
1734 key: :referrer_policy,
1736 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1737 suggestions: ["same-origin", "no-referrer"]
1741 label: "Report URI",
1743 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1744 suggestions: ["https://example.com/report-uri"]
1749 group: :web_push_encryption,
1750 key: :vapid_details,
1751 label: "Vapid Details",
1754 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1760 "A mailto link for the administrative contact." <>
1761 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1762 suggestions: ["mailto:moderators@pleroma.com"]
1767 description: "VAPID public key",
1768 suggestions: ["Public key"]
1773 description: "VAPID private key",
1774 suggestions: ["Private key"]
1780 key: Pleroma.Captcha,
1782 description: "Captcha-related settings",
1787 description: "Whether the captcha should be shown on registration"
1792 description: "The method/service to use for captcha",
1793 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1796 key: :seconds_valid,
1798 description: "The time in seconds for which the captcha is valid",
1805 key: Pleroma.Captcha.Kocaptcha,
1808 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1809 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1814 description: "The kocaptcha endpoint to use",
1815 suggestions: ["https://captcha.kotobank.ch"]
1821 label: "Pleroma Admin Token",
1824 "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)",
1829 description: "Admin token",
1831 "Please use a high entropy string or UUID"
1841 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1845 type: {:dropdown, :atom},
1846 description: "Logs verbose mode",
1847 suggestions: [false, :error, :warn, :info, :debug]
1851 type: {:keyword, :integer},
1853 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1855 activity_expiration: 10,
1856 attachments_cleanup: 5,
1858 federator_incoming: 50,
1859 federator_outgoing: 50,
1861 scheduled_activities: 10,
1867 key: :activity_expiration,
1869 description: "Activity expiration queue",
1875 description: "Backup queue",
1879 key: :attachments_cleanup,
1881 description: "Attachment deletion queue",
1887 description: "Background queue",
1891 key: :federator_incoming,
1893 description: "Incoming federation queue",
1897 key: :federator_outgoing,
1899 description: "Outgoing federation queue",
1905 description: "Email sender queue, see Pleroma.Emails.Mailer",
1909 key: :scheduled_activities,
1911 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1915 key: :transmogrifier,
1917 description: "Transmogrifier queue",
1923 description: "Web push notifications queue",
1930 type: {:list, :tuple},
1931 description: "Settings for cron background jobs",
1933 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1934 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1943 description: "Includes custom worker options not interpretable directly by `Oban`",
1947 type: {:keyword, :integer},
1948 description: "Max retry attempts for failed jobs, per `Oban` queue",
1950 federator_incoming: 5,
1951 federator_outgoing: 5
1956 type: {:keyword, :integer},
1957 description: "Timeout for jobs, per `Oban` queue, in ms",
1959 activity_expiration: :timer.seconds(5),
1960 token_expiration: :timer.seconds(5),
1961 filter_expiration: :timer.seconds(5),
1962 backup: :timer.seconds(900),
1963 federator_incoming: :timer.seconds(10),
1964 federator_outgoing: :timer.seconds(10),
1965 ingestion_queue: :timer.seconds(5),
1966 web_push: :timer.seconds(5),
1967 mailer: :timer.seconds(5),
1968 transmogrifier: :timer.seconds(5),
1969 scheduled_activities: :timer.seconds(5),
1970 poll_notifications: :timer.seconds(5),
1971 background: :timer.seconds(5),
1972 remote_fetcher: :timer.seconds(10),
1973 attachments_cleanup: :timer.seconds(900),
1974 new_users_digest: :timer.seconds(10),
1975 mute_expire: :timer.seconds(5),
1976 search_indexing: :timer.seconds(5),
1977 nodeinfo_fetcher: :timer.seconds(10)
1984 key: Pleroma.Web.Metadata,
1986 description: "Metadata-related settings",
1990 type: {:list, :module},
1991 description: "List of metadata providers to enable",
1993 Pleroma.Web.Metadata.Providers.OpenGraph,
1994 Pleroma.Web.Metadata.Providers.TwitterCard,
1995 Pleroma.Web.Metadata.Providers.RelMe,
1996 Pleroma.Web.Metadata.Providers.Feed
2001 label: "Unfurl NSFW",
2003 description: "When enabled NSFW attachments will be shown in previews"
2009 key: Pleroma.Web.Metadata.Providers.Theme,
2011 description: "Specific provider to hand out themes to instances that scrape index.html",
2017 "The 'accent color' of the instance, used in places like misskey's instance ticker",
2018 suggestions: ["#593196"]
2027 "If enabled the instance will parse metadata from attached links to generate link previews",
2032 description: "Enables RichMedia parsing of URLs"
2036 type: {:list, :string},
2037 description: "List of hosts which will be ignored by the metadata parser",
2038 suggestions: ["accounts.google.com", "xss.website"]
2042 label: "Ignore TLD",
2043 type: {:list, :string},
2044 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2045 suggestions: ["local", "localdomain", "lan"]
2049 type: {:list, :module},
2051 "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.",
2053 Pleroma.Web.RichMedia.Parsers.OEmbed,
2054 Pleroma.Web.RichMedia.Parsers.TwitterCard
2059 label: "TTL setters",
2060 type: {:list, :module},
2062 "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.",
2064 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2068 key: :failure_backoff,
2071 "Amount of milliseconds after request failure, during which the request will not be retried.",
2072 suggestions: [60_000]
2078 key: Pleroma.Formatter,
2082 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2086 type: [:string, :boolean],
2087 description: "Specify the class to be added to the generated link. Disable to clear.",
2088 suggestions: ["auto-linker", false]
2092 type: [:string, :boolean],
2093 description: "Override the rel attribute. Disable to clear.",
2094 suggestions: ["ugc", "noopener noreferrer", false]
2099 description: "Link URLs will open in a new window/tab."
2103 type: [:integer, :boolean],
2105 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2106 suggestions: [15, false]
2111 description: "Strip the scheme prefix."
2116 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2120 type: [:atom, :boolean],
2122 "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)",
2123 suggestions: [:no_scheme, true]
2129 key: Pleroma.ScheduledActivity,
2131 description: "Scheduled activities settings",
2134 key: :daily_user_limit,
2137 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2141 key: :total_user_limit,
2144 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2150 description: "Whether scheduled activities are sent to the job queue to be executed"
2156 key: Pleroma.Workers.PurgeExpiredActivity,
2158 description: "Expired activities settings",
2163 description: "Enables expired activities addition & deletion"
2168 description: "Minimum lifetime for ephemeral activity (in seconds)",
2175 label: "Pleroma Authenticator",
2177 description: "Authenticator",
2180 key: Pleroma.Web.Auth.Authenticator,
2182 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2192 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2193 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2194 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2195 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2200 description: "Enables LDAP authentication"
2205 description: "LDAP server hostname",
2206 suggestions: ["localhosts"]
2211 description: "LDAP port, e.g. 389 or 636",
2212 suggestions: [389, 636]
2218 description: "Enable to use SSL, usually implies the port 636"
2222 label: "SSL options",
2224 description: "Additional SSL options",
2225 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2230 description: "Path to file with PEM encoded cacerts",
2231 suggestions: ["path/to/file/with/PEM/cacerts"]
2236 description: "Type of cert verification",
2237 suggestions: [:verify_peer]
2245 description: "Enable to use STARTTLS, usually implies the port 389"
2249 label: "TLS options",
2251 description: "Additional TLS options",
2252 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2257 description: "Path to file with PEM encoded cacerts",
2258 suggestions: ["path/to/file/with/PEM/cacerts"]
2263 description: "Type of cert verification",
2264 suggestions: [:verify_peer]
2271 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2272 suggestions: ["dc=example,dc=com"]
2279 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2288 description: "Authentication / authorization settings",
2291 key: :enforce_oauth_admin_scope_usage,
2292 label: "Enforce OAuth admin scope usage",
2295 "OAuth admin scope requirement toggle. " <>
2296 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2297 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2298 "`is_admin` user flag grants access to admin-specific actions."
2301 key: :auth_template,
2304 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2305 suggestions: ["show.html"]
2308 key: :oauth_consumer_template,
2309 label: "OAuth consumer template",
2312 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2313 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2314 suggestions: ["consumer.html"]
2317 key: :oauth_consumer_strategies,
2318 label: "OAuth consumer strategies",
2319 type: {:list, :string},
2321 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2322 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2323 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2324 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2330 key: :email_notifications,
2332 description: "Email notifications settings",
2338 "emails of \"what you've missed\" for users who have been inactive for a while",
2342 schedule: "0 0 * * 0",
2344 inactivity_threshold: 7
2352 description: "Globally enable or disable digest emails"
2358 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2359 suggestions: ["0 0 * * 0"]
2364 description: "Minimum interval between digest emails to one user",
2368 key: :inactivity_threshold,
2370 description: "Minimum user inactivity threshold",
2379 key: Pleroma.Emails.UserEmail,
2381 description: "Email template settings",
2385 type: {:string, :image},
2386 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2387 suggestions: ["some/path/logo.png"]
2392 description: "A map with color settings for email templates.",
2395 link_color: "#d8a070",
2396 background_color: "#2C3645",
2397 content_background_color: "#1B2635",
2398 header_color: "#d8a070",
2399 text_color: "#b9b9ba",
2400 text_muted_color: "#b9b9ba"
2407 suggestions: ["#d8a070"]
2410 key: :background_color,
2412 suggestions: ["#2C3645"]
2415 key: :content_background_color,
2417 suggestions: ["#1B2635"]
2422 suggestions: ["#d8a070"]
2427 suggestions: ["#b9b9ba"]
2430 key: :text_muted_color,
2432 suggestions: ["#b9b9ba"]
2440 key: Pleroma.Emails.NewUsersDigestEmail,
2442 description: "New users admin email digest",
2447 description: "Enables new users admin digest email when `true`"
2456 description: "Configure OAuth 2 provider capabilities",
2459 key: :token_expires_in,
2461 description: "The lifetime in seconds of the access token",
2462 suggestions: [2_592_000]
2465 key: :issue_new_refresh_token,
2468 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2471 key: :clean_expired_tokens,
2473 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2483 key: :shortcode_globs,
2484 type: {:list, :string},
2485 description: "Location of custom emoji files. * can be used as a wildcard.",
2486 suggestions: ["/emoji/custom/**/*.png"]
2489 key: :pack_extensions,
2490 type: {:list, :string},
2492 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2493 suggestions: [".png", ".gif"]
2497 type: {:keyword, {:list, :string}},
2499 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2500 " and the value is the location or array of locations. * can be used as a wildcard.",
2502 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2506 key: :default_manifest,
2509 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2510 " Currently only one manifest can be added (no arrays).",
2511 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2514 key: :shared_pack_cache_seconds_per_file,
2515 label: "Shared pack cache s/file",
2518 "When an emoji pack is shared, the archive is created and cached in memory" <>
2519 " for this amount of seconds multiplied by the number of files.",
2529 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2533 type: [:tuple, {:list, :tuple}],
2534 description: "For the search requests (account & status search etc.)",
2535 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2539 type: [:tuple, {:list, :tuple}],
2540 description: "For requests to timelines (each timeline has it's own limiter)",
2541 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2544 key: :app_account_creation,
2545 type: [:tuple, {:list, :tuple}],
2546 description: "For registering user accounts from the same IP address",
2547 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2550 key: :relations_actions,
2551 type: [:tuple, {:list, :tuple}],
2552 description: "For actions on relationships with all users (follow, unfollow)",
2553 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2556 key: :relation_id_action,
2557 label: "Relation ID action",
2558 type: [:tuple, {:list, :tuple}],
2559 description: "For actions on relation with a specific user (follow, unfollow)",
2560 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2563 key: :statuses_actions,
2564 type: [:tuple, {:list, :tuple}],
2566 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2567 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2570 key: :status_id_action,
2571 label: "Status ID action",
2572 type: [:tuple, {:list, :tuple}],
2574 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2575 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2578 key: :authentication,
2579 type: [:tuple, {:list, :tuple}],
2580 description: "For authentication create / password check / user existence check requests",
2581 suggestions: [{60_000, 15}]
2587 label: "Mime Types",
2589 description: "Mime Types settings",
2596 "application/xml" => ["xml"],
2597 "application/xrd+xml" => ["xrd+xml"],
2598 "application/jrd+json" => ["jrd+json"],
2599 "application/activity+json" => ["activity+json"],
2600 "application/ld+json" => ["activity+json"]
2605 key: "application/xml",
2606 type: {:list, :string},
2607 suggestions: ["xml"]
2610 key: "application/xrd+xml",
2611 type: {:list, :string},
2612 suggestions: ["xrd+xml"]
2615 key: "application/jrd+json",
2616 type: {:list, :string},
2617 suggestions: ["jrd+json"]
2620 key: "application/activity+json",
2621 type: {:list, :string},
2622 suggestions: ["activity+json"]
2625 key: "application/ld+json",
2626 type: {:list, :string},
2627 suggestions: ["activity+json"]
2638 description: "HTTP settings",
2642 label: "HTTP Pool Request Timeout",
2644 description: "Timeout for initiating HTTP requests (in ms, default 5000)",
2648 key: :receive_timeout,
2649 label: "HTTP Receive Timeout",
2652 "Timeout for waiting on remote servers to respond to HTTP requests (in ms, default 15000)",
2653 suggestions: [15000]
2660 "Proxy URL - of the format http://host:port. Advise setting in .exs instead of admin-fe due to this being set at boot-time.",
2661 suggestions: ["http://localhost:3128"]
2665 type: [:string, :atom],
2667 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2668 suggestions: ["Pleroma", :default]
2673 description: "Number of concurrent outbound HTTP requests to allow. Default 50.",
2679 description: "Adapter specific options",
2685 label: "SSL Options",
2686 description: "SSL options for HTTP adapter",
2690 type: {:list, :atom},
2691 description: "List of TLS version to use",
2692 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2703 label: "Markup Settings",
2707 key: :allow_inline_images,
2711 key: :allow_headings,
2724 type: {:list, :module},
2726 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2727 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2737 key: :deny_follow_blocked,
2748 key: :restricted_nicknames,
2749 type: {:list, :string},
2750 description: "List of nicknames users may not register with.",
2769 "ostatus_subscribe",
2785 key: :email_blacklist,
2786 type: {:list, :string},
2787 description: "List of email domains users may not register with.",
2788 suggestions: ["mailinator.com", "maildrop.cc"]
2794 label: "CORS plug config",
2800 suggestions: [86_400]
2804 type: {:list, :string},
2805 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2809 type: {:list, :string},
2812 "X-RateLimit-Reset",
2813 "X-RateLimit-Limit",
2814 "X-RateLimit-Remaining",
2825 type: {:list, :string},
2826 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2832 key: Pleroma.Web.Plugs.RemoteIp,
2835 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2836 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2842 description: "Enable/disable the plug. Default: disabled."
2846 type: {:list, :string},
2848 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2853 type: {:list, :string},
2855 "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."
2859 type: {:list, :string},
2861 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"]`
2868 key: :web_cache_ttl,
2869 label: "Web cache TTL",
2872 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2878 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2882 key: :activity_pub_question,
2884 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2885 suggestions: [30_000]
2895 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2900 description: "Enables the rendering of static HTML. Default: disabled."
2908 description: "Configure feed rendering",
2913 description: "Configure title rendering",
2918 description: "Maximum number of characters before truncating title",
2924 description: "Replacement which will be used after truncating string",
2925 suggestions: ["..."]
2933 key: :mrf_follow_bot,
2935 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2936 label: "MRF FollowBot Policy",
2938 description: "Automatically follows newly discovered accounts.",
2941 key: :follower_nickname,
2943 description: "The name of the bot account to use for following newly discovered users.",
2944 suggestions: ["followbot"]
2952 description: "Custom Runtime Modules",
2957 description: "A path to custom Elixir modules (such as MRF policies)."
2965 description: "Settings for notifications streamer",
2970 description: "Number of workers to send notifications",
2974 key: :overflow_workers,
2976 description: "Maximum number of workers created if pool is empty",
2983 key: :restrict_unauthenticated,
2984 label: "Restrict Unauthenticated",
2986 description: "Disallow unauthenticated viewing of timelines, user profiles and statuses.",
2991 description: "Settings for public and federated timelines.",
2996 description: "Disallow viewing the public timeline."
3001 description: "Disallow viewing the whole known network timeline."
3006 description: "Disallow viewing the bubble timeline."
3013 description: "Settings for user profiles.",
3018 description: "Disallow viewing local user profiles."
3023 description: "Disallow viewing remote user profiles."
3030 description: "Settings for posts.",
3035 description: "Disallow viewing local posts."
3040 description: "Disallow viewing remote posts."
3048 key: Pleroma.Web.ApiSpec.CastAndValidate,
3055 "Enables strict input validation (useful in development, not recommended in production)"
3061 key: :instances_favicons,
3063 description: "Control favicons for instances",
3068 description: "Allow/disallow displaying and getting instances favicons"
3074 key: :instances_nodeinfo,
3076 description: "Control favicons for instances",
3081 description: "Allow/disallow getting instance nodeinfo"
3089 descriptions: "S3 service related settings",
3092 key: :access_key_id,
3094 description: "S3 access key ID",
3095 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3098 key: :secret_access_key,
3100 description: "Secret access key",
3101 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3106 description: "S3 host",
3107 suggestions: ["s3.eu-central-1.amazonaws.com"]
3112 description: "S3 region (for AWS)",
3113 suggestions: ["us-east-1"]
3121 description: "Installed frontends management",
3126 description: "Primary frontend, the one that is served for all pages by default",
3127 children: installed_frontend_options
3132 description: "Admin frontend",
3133 children: installed_frontend_options
3138 description: "Mastodon frontend",
3139 children: installed_frontend_options
3144 description: "Swagger API reference frontend",
3146 installed_frontend_options ++
3152 description: "Whether to have this enabled at all"
3160 "A map containing available frontends and parameters for their installation.",
3161 children: frontend_options
3165 type: {:list, :string},
3167 "A list containing all frontends users can pick as their preference, format is :name/:ref, e.g pleroma-fe/stable."
3173 key: Pleroma.Web.Preload,
3175 description: "Preload-related settings",
3179 type: {:list, :module},
3180 description: "List of preload providers to enable",
3182 Pleroma.Web.Preload.Providers.Instance,
3183 Pleroma.Web.Preload.Providers.User,
3184 Pleroma.Web.Preload.Providers.Timelines,
3185 Pleroma.Web.Preload.Providers.StatusNet
3194 description: "Majic/libmagic configuration",
3199 description: "Number of majic workers to start.",
3206 key: Pleroma.User.Backup,
3208 description: "Account Backup",
3211 key: :purge_after_days,
3213 description: "Remove backup achives after N days",
3219 description: "Limit user to export not more often than once per N days",
3226 key: ConcurrentLimiter,
3228 description: "Limits configuration for background tasks.",
3231 key: Pleroma.Web.RichMedia.Helpers,
3233 description: "Concurrent limits configuration for getting RichMedia for activities.",
3234 suggestions: [max_running: 5, max_waiting: 5],
3239 description: "Max running concurrently jobs.",
3245 description: "Max waiting jobs.",
3251 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3253 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3254 suggestions: [max_running: 5, max_waiting: 5],
3259 description: "Max running concurrently jobs.",
3265 description: "Max waiting jobs.",
3274 key: Pleroma.Search,
3277 description: "General search settings.",
3282 description: "Selected search module.",
3283 suggestions: {:list_behaviour_implementations, Pleroma.Search.SearchBackend}
3289 key: Pleroma.Search.Meilisearch,
3291 description: "Meilisearch settings.",
3296 description: "Meilisearch URL.",
3297 suggestion: ["http://127.0.0.1:7700/"]
3303 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3307 key: :initial_indexing_chunk_size,
3310 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3311 " since there's a limit on maximum insert size",
3312 suggestion: [100_000]
3318 key: Pleroma.Search.Elasticsearch.Cluster,
3319 label: "Elasticsearch",
3321 description: "Elasticsearch settings.",
3326 description: "Elasticsearch URL.",
3327 suggestion: ["http://127.0.0.1:9200/"]
3332 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3333 suggestion: ["elastic"]
3338 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3339 suggestion: ["changeme"]
3345 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3346 suggestion: [Elasticsearch.API.HTTP]
3352 "The JSON module used to encode/decode when communicating with Elasticsearch",
3358 description: "The indices to set up in Elasticsearch",
3363 description: "Config for the index to use for activities",
3369 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3370 suggestion: ["priv/es-mappings/activity.json"]
3375 description: "The internal store module",
3376 suggestion: [Pleroma.Search.Elasticsearch.Store]
3380 type: {:list, :module},
3381 description: "The internal types to use for this index",
3382 suggestion: [[Pleroma.Activity]]
3385 key: :bulk_page_size,
3387 description: "Size for bulk put requests, mostly used on building the index",
3391 key: :bulk_wait_interval,
3393 description: "Time to wait between bulk put requests (in ms)",
3394 suggestion: [15_000]
3406 description: "Translation Settings",
3411 description: "Is translation enabled?",
3412 suggestion: [true, false]
3417 description: "Translation module.",
3418 suggestions: {:list_behaviour_implementations, Pleroma.Akkoma.Translator}
3427 description: "DeepL Settings.",
3431 type: {:dropdown, :atom},
3432 description: "API Tier",
3433 suggestions: [:free, :pro]
3438 description: "API key for DeepL",
3445 key: :libre_translate,
3447 description: "LibreTranslate Settings.",
3452 description: "URL for libretranslate",
3458 description: "API key for libretranslate",
3465 key: :argos_translate,
3467 description: "ArgosTranslate Settings.",
3470 key: :command_argos_translate,
3473 "command for `argos-translate`. Can be the command if it's in your PATH, or the full path to the file.",
3474 suggestion: ["argos-translate"]
3477 key: :command_argospm,
3480 "command for `argospm`. Can be the command if it's in your PATH, or the full path to the file.",
3481 suggestion: ["argospm"]
3486 description: "Strip html from the post before translating it."