6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
105 "https://cdn-host.com"
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
117 key: :filename_display_max_length,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
125 key: Pleroma.Uploaders.Local,
127 description: "Local uploader-related settings",
132 description: "Path where user's uploads will be saved",
141 key: Pleroma.Uploaders.S3,
143 description: "S3 uploader-related settings",
148 description: "S3 bucket",
154 key: :bucket_namespace,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
160 key: :truncated_namespace,
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
167 key: :streaming_enabled,
170 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
176 key: Pleroma.Upload.Filter.Mogrify,
178 description: "Uploads mogrify filter settings",
182 type: [:string, {:list, :string}, {:list, :tuple}],
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
198 description: "Filter replaces the filename of the upload",
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
207 "custom-file-name.{extension}"
214 key: Pleroma.Emails.Mailer,
216 description: "Mailer-related settings",
220 label: "Mailer Enabled",
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
229 Swoosh.Adapters.AmazonSES,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
244 group: {:subgroup, Swoosh.Adapters.SMTP},
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "SMTP port",
255 suggestions: ["1025"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "Use Implicit SSL/TLS. e.g. port 465"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "SMTP temporary (4xx) error retries",
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 label: "SendGrid API Key",
306 suggestions: ["YOUR_API_KEY"]
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
323 label: "Qmail compat mode",
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
329 label: "Mandrill API Key",
331 suggestions: ["YOUR_API_KEY"]
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
336 label: "Mailgun API Key",
338 suggestions: ["YOUR_API_KEY"]
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
344 suggestions: ["YOUR_DOMAIN_NAME"]
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
349 label: "MailJet Public API Key",
351 suggestions: ["MJ_APIKEY_PUBLIC"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
356 label: "MailJet Private API Key",
358 suggestions: ["MJ_APIKEY_PRIVATE"]
361 group: {:subgroup, Swoosh.Adapters.Postmark},
363 label: "Postmark API Key",
365 suggestions: ["X-Postmark-Server-Token"]
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
370 label: "SparkPost API key",
372 suggestions: ["YOUR_API_KEY"]
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 suggestions: ["https://api.sparkpost.com/api/v1"]
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
383 label: "AWS Access Key",
385 suggestions: ["AWS_ACCESS_KEY"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
390 label: "AWS Secret Key",
392 suggestions: ["AWS_SECRET_KEY"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.Dyn},
404 label: "Dyn API Key",
406 suggestions: ["apikey"]
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
411 label: "SocketLabs API Key",
413 suggestions: ["INJECTION_API_KEY"]
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 suggestions: ["SERVER_ID"]
423 group: {:subgroup, Swoosh.Adapters.Gmail},
425 label: "GMail API Access Token",
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
434 label: "URI Schemes",
436 description: "URI schemes related settings",
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
466 description: "Customizable features",
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
479 key: :populate_hashtags_table,
481 description: "`populate_hashtags_table` background migration settings",
484 key: :fault_rate_allowance,
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
491 key: :sleep_interval_ms,
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 type: {:list, :string},
515 description: "Languages the instance uses",
524 label: "Admin Email Address",
526 description: "Email used to reach an Administrator/Moderator of the instance",
533 label: "Sender Email Address",
535 description: "Envelope FROM address for mail sent via Pleroma",
544 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
552 description: "Posts character limit (CW/Subject included in the counter)",
560 description: "Hard character limit beyond which remote posts will be dropped",
568 description: "File size limit of uploads (except for avatar, background, banner)",
574 key: :avatar_upload_limit,
576 description: "File size limit of user's profile avatars",
582 key: :background_upload_limit,
584 description: "File size limit of user's profile backgrounds",
590 key: :banner_upload_limit,
592 description: "File size limit of user's profile banners",
600 description: "A map with poll limits for local polls",
604 max_option_chars: 200,
606 max_expiration: 31_536_000
613 description: "Maximum number of options",
617 key: :max_option_chars,
619 description: "Maximum number of characters per option",
623 key: :min_expiration,
625 description: "Minimum expiration time (in seconds)",
629 key: :max_expiration,
631 description: "Maximum expiration time (in seconds)",
637 key: :registrations_open,
640 "Enable registrations for anyone. Invitations require this setting to be disabled."
643 key: :invites_enabled,
646 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
649 key: :account_activation_required,
651 description: "Require users to confirm their emails before signing in"
654 key: :account_approval_required,
656 description: "Require users to be manually approved by an admin before signing in"
661 description: "Enable federation with other instances"
664 key: :federation_incoming_replies_max_depth,
665 label: "Fed. incoming replies max depth",
668 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
669 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
675 key: :federation_reachability_timeout_days,
676 label: "Fed. reachability timeout days",
679 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
688 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
694 "Switching this on will allow unauthenticated users access to all public resources on your instance" <>
695 " Switching it off is useful for disabling the Local Timeline and The Whole Known Network. " <>
696 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
699 key: :quarantined_instances,
700 type: {:list, :tuple},
701 key_placeholder: "instance",
702 value_placeholder: "reason",
704 "(Deprecated, will be removed in next release) List of ActivityPub instances where activities will not be sent, and the reason for doing so",
706 {"quarantined.com", "Reason"},
707 {"*.quarantined.com", "Reason"}
713 description: "Instance static directory",
719 key: :allowed_post_formats,
720 type: {:list, :string},
721 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
727 "text/x.misskeymarkdown"
731 key: :extended_nickname_format,
734 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
735 " This will break federation with older software for theses nicknames."
738 key: :cleanup_attachments,
741 Enable to remove associated attachments when status is removed.
742 This will not affect duplicates and attachments without status.
743 Enabling this will increase load to database when deleting statuses on larger instances.
747 key: :max_pinned_statuses,
749 description: "The maximum number of pinned statuses. 0 will disable the feature.",
757 key: :autofollowed_nicknames,
758 type: {:list, :string},
760 "Set to nicknames of (local) users that every new user should automatically follow"
763 key: :autofollowing_nicknames,
764 type: {:list, :string},
766 "Set to nicknames of (local) users that automatically follows every newly registered user"
769 key: :attachment_links,
771 description: "Enable to automatically add attachment link text to statuses"
774 key: :max_report_comment_size,
776 description: "The maximum size of the report comment. Default: 1000.",
782 key: :safe_dm_mentions,
783 label: "Safe DM mentions",
786 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
787 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
793 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
796 key: :remote_post_retention_days,
799 "The default amount of days to retain remote posts when pruning the database",
805 key: :user_bio_length,
807 description: "A user bio maximum length. Default: 5000.",
813 key: :user_name_length,
815 description: "A user name maximum length. Default: 100.",
821 key: :skip_thread_containment,
823 description: "Skip filtering out broken threads. Default: enabled."
826 key: :limit_to_local_content,
827 type: {:dropdown, :atom},
829 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
837 key: :max_account_fields,
839 description: "The maximum number of custom fields in the user profile. Default: 10.",
845 key: :max_remote_account_fields,
848 "The maximum number of custom fields in the remote user profile. Default: 20.",
854 key: :account_field_name_length,
856 description: "An account field name maximum length. Default: 512.",
862 key: :account_field_value_length,
864 description: "An account field value maximum length. Default: 2048.",
870 key: :registration_reason_length,
872 description: "Maximum registration reason length. Default: 500.",
878 key: :external_user_synchronization,
880 description: "Enabling following/followers counters synchronization for external users"
883 key: :multi_factor_authentication,
885 description: "Multi-factor authentication settings",
888 totp: [digits: 6, period: 30],
889 backup_codes: [number: 5, length: 16]
895 label: "TOTP settings",
897 description: "TOTP settings",
898 suggestions: [digits: 6, period: 30],
905 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
912 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
919 description: "MFA backup codes settings",
920 suggestions: [number: 5, length: 16],
926 description: "Number of backup codes to generate."
933 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
940 key: :instance_thumbnail,
941 type: {:string, :image},
943 "The instance thumbnail can be any image that represents your instance and is used by some apps or services when they display information about your instance.",
944 suggestions: ["/instance/thumbnail.jpeg"]
947 key: :show_reactions,
949 description: "Let favourites and emoji reactions be viewed through the API."
952 key: :profile_directory,
954 description: "Enable profile directory."
957 key: :privileged_staff,
960 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses)"
964 type: {:list, :string},
966 "List of instances that make up your local bubble (closely-related instances). Used to populate the 'bubble' timeline (domain only)."
974 description: "Welcome messages settings",
977 key: :direct_message,
979 descpiption: "Direct message settings",
984 description: "Enables sending a direct message to newly registered users"
989 description: "A message that will be sent to newly registered users",
991 "Hi, @username! Welcome on board!"
995 key: :sender_nickname,
997 description: "The nickname of the local user that sends a welcome message",
1007 descpiption: "Email message settings",
1012 description: "Enables sending an email to newly registered users"
1016 type: [:string, :tuple],
1018 "Email address and/or nickname that will be used to send the welcome email.",
1020 {"Pleroma App", "welcome@pleroma.app"}
1027 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1028 suggestions: ["Welcome to <%= instance_name%>"]
1034 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1035 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1041 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1042 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1051 description: "Logger-related settings",
1055 type: [:atom, :tuple, :module],
1057 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1058 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1066 label: "ExSyslogger",
1067 description: "ExSyslogger-related settings",
1071 type: {:dropdown, :atom},
1072 description: "Log level",
1073 suggestions: [:debug, :info, :warn, :error]
1079 "A string that's prepended to every message, and is typically set to the app name",
1080 suggestions: ["pleroma"]
1085 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1086 suggestions: ["$metadata[$level] $message"]
1090 type: {:list, :atom},
1091 suggestions: [:request_id]
1099 label: "Console Logger",
1100 description: "Console logger settings",
1104 type: {:dropdown, :atom},
1105 description: "Log level",
1106 suggestions: [:debug, :info, :warn, :error]
1111 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1112 suggestions: ["$metadata[$level] $message"]
1116 type: {:list, :atom},
1117 suggestions: [:request_id]
1123 key: :frontend_configurations,
1126 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1127 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1128 "add your own configuration your settings all fields must be complete.",
1132 label: "Pleroma FE",
1134 description: "Settings for Pleroma FE",
1137 alwaysShowSubjectInput: true,
1138 background: "/static/aurora_borealis.jpg",
1139 collapseMessageWithSubject: false,
1141 hideFilteredStatuses: false,
1142 hideMutedPosts: false,
1143 hidePostStats: false,
1144 hideUserStats: false,
1145 loginMethod: "password",
1146 logo: "/static/logo.svg",
1149 minimalScopesMode: false,
1150 noAttachmentLinks: false,
1151 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1152 postContentType: "text/plain",
1153 redirectRootLogin: "/main/friends",
1154 redirectRootNoLogin: "/main/all",
1156 sidebarRight: false,
1157 showFeaturesPanel: true,
1158 showInstanceSpecificPanel: false,
1159 subjectLineBehavior: "email",
1160 theme: "pleroma-dark",
1161 webPushNotifications: false
1166 key: :alwaysShowSubjectInput,
1167 label: "Always show subject input",
1169 description: "When disabled, auto-hide the subject field if it's empty"
1173 type: {:string, :image},
1175 "URL of the background, unless viewing a user profile with a background that is set",
1176 suggestions: ["/images/city.jpg"]
1179 key: :collapseMessageWithSubject,
1180 label: "Collapse message with subject",
1183 "When a message has a subject (aka Content Warning), collapse it by default"
1189 description: "Enables green text on lines prefixed with the > character"
1192 key: :conversationDisplay,
1193 label: "Conversation display style",
1195 description: "How to display conversations (linear or tree)",
1196 suggestions: ["linear", "tree"]
1199 key: :hideFilteredStatuses,
1200 label: "Hide Filtered Statuses",
1202 description: "Hides filtered statuses from timelines"
1205 key: :hideMutedPosts,
1206 label: "Hide Muted Posts",
1208 description: "Hides muted statuses from timelines"
1211 key: :hidePostStats,
1212 label: "Hide post stats",
1214 description: "Hide notices statistics (repeats, favorites, ...)"
1217 key: :hideUserStats,
1218 label: "Hide user stats",
1221 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1225 type: {:string, :image},
1226 description: "URL of the logo, defaults to Pleroma's logo",
1227 suggestions: ["/static/logo.svg"]
1231 label: "Logo margin",
1234 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1235 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1236 suggestions: [".1em"]
1243 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1244 "If you want a colorful logo you must disable logoMask."
1247 key: :nsfwCensorImage,
1248 label: "NSFW Censor Image",
1249 type: {:string, :image},
1251 "URL of the image to use for hiding NSFW media attachments in the timeline",
1252 suggestions: ["/static/img/nsfw.74818f9.png"]
1255 key: :postContentType,
1256 label: "Post Content Type",
1257 type: {:dropdown, :atom},
1258 description: "Default post formatting option",
1264 "text/x.misskeymarkdown"
1268 key: :redirectRootNoLogin,
1269 label: "Redirect root no login",
1272 "Relative URL which indicates where to redirect when a user isn't logged in",
1273 suggestions: ["/main/all"]
1276 key: :redirectRootLogin,
1277 label: "Redirect root login",
1280 "Relative URL which indicates where to redirect when a user is logged in",
1281 suggestions: ["/main/friends"]
1285 label: "Scope copy",
1287 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1291 label: "Sidebar on Right",
1293 description: "Change alignment of sidebar and panels to the right"
1296 key: :showFeaturesPanel,
1297 label: "Show instance features panel",
1300 "Enables panel displaying functionality of the instance on the About page"
1303 key: :showInstanceSpecificPanel,
1304 label: "Show instance specific panel",
1306 description: "Whether to show the instance's custom panel"
1309 key: :subjectLineBehavior,
1310 label: "Subject line behavior",
1312 description: "Allows changing the default behaviour of subject lines in replies.
1313 `email`: copy and preprend re:, as in email,
1314 `masto`: copy verbatim, as in Mastodon,
1315 `noop`: don't copy the subject.",
1316 suggestions: ["email", "masto", "noop"]
1321 description: "Which theme to use. Available themes are defined in styles.json",
1322 suggestions: ["pleroma-dark"]
1325 key: :showPanelNavShortcuts,
1326 label: "Show timeline panel nav shortcuts",
1328 description: "Whether to put timeline nav tabs on the top of the panel"
1331 key: :showNavShortcuts,
1332 label: "Show navbar shortcuts",
1334 description: "Whether to put extra navigation options on the navbar"
1337 key: :showWiderShortcuts,
1338 label: "Increase navbar shortcut spacing",
1340 description: "Whether to add extra space between navbar icons"
1343 key: :hideSiteFavicon,
1344 label: "Hide site favicon",
1346 description: "Whether to hide the instance favicon from the navbar"
1350 label: "Hide site name",
1352 description: "Whether to hide the site name from the navbar"
1355 key: :renderMisskeyMarkdown,
1356 label: "Render misskey markdown",
1358 description: "Whether to render Misskey-flavoured markdown"
1364 description: "Whether to pause animated images until they're hovered on"
1372 description: "Settings for Masto FE",
1375 showInstanceSpecificPanel: true
1380 key: :showInstanceSpecificPanel,
1381 label: "Show instance specific panel",
1383 description: "Whenether to show the instance's specific panel"
1394 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1398 type: {:keyword, :map},
1400 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1403 url: "/images/pleroma-fox-tan-smol.png",
1404 mime_type: "image/png"
1406 pleroma_fox_tan_shy: %{
1407 url: "/images/pleroma-fox-tan-shy.png",
1408 mime_type: "image/png"
1413 key: :default_mascot,
1416 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1422 key: :default_user_avatar,
1423 type: {:string, :image},
1424 description: "URL of the default user avatar",
1425 suggestions: ["/images/avi.png"]
1434 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1438 type: {:list, :map},
1439 description: "Describe the icons of the app",
1442 src: "/static/logo.png"
1445 src: "/static/icon.png",
1449 src: "/static/icon.ico",
1450 sizes: "72x72 96x96 128x128 256x256"
1457 description: "Describe the theme color of the app - this is only used for mastodon-fe",
1458 suggestions: ["#282c37", "mediumpurple"]
1461 key: :background_color,
1464 "Describe the background color of the app - this is only used for mastodon-fe",
1465 suggestions: ["#191b22", "aliceblue"]
1473 description: "Media proxy",
1478 description: "Enables proxying of remote media via the instance's proxy"
1485 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1486 suggestions: ["https://example.com"]
1494 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1500 description: "Enables media cache object invalidation."
1505 description: "Module which will be used to purge objects from the cache.",
1507 Pleroma.Web.MediaProxy.Invalidation.Script,
1508 Pleroma.Web.MediaProxy.Invalidation.Http
1515 label: "Advanced MediaProxy Options",
1517 description: "Internal Pleroma.ReverseProxy settings",
1519 redirect_on_failure: false,
1520 max_body_length: 25 * 1_048_576,
1521 max_read_duration: 30_000
1525 key: :redirect_on_failure,
1528 Redirects the client to the origin server upon encountering HTTP errors.\n
1529 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1530 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1531 IP addresses of your users to the other servers, bypassing the MediaProxy.
1535 key: :max_body_length,
1538 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1541 key: :max_read_duration,
1543 description: "Timeout (in milliseconds) of GET request to the remote URI."
1549 type: {:list, :string},
1550 description: "List of hosts with scheme to bypass the MediaProxy",
1551 suggestions: ["http://example.com"]
1557 key: :media_preview_proxy,
1559 description: "Media preview proxy",
1565 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1568 key: :thumbnail_max_width,
1571 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1574 key: :thumbnail_max_height,
1577 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1580 key: :image_quality,
1582 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1585 key: :min_content_length,
1588 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1594 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1596 description: "HTTP invalidate settings",
1601 description: "HTTP method of request. Default: :purge"
1605 type: {:keyword, :string},
1606 description: "HTTP headers of request",
1607 suggestions: [{"x-refresh", 1}]
1612 description: "Request options",
1616 type: {:map, :string}
1624 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1626 description: "Invalidation script settings",
1631 description: "Path to executable script which will purge cached items.",
1632 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1636 label: "URL Format",
1639 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1640 suggestions: [":htcacheclean"]
1647 label: "ActivityPub",
1649 description: "ActivityPub-related settings",
1652 key: :unfollow_blocked,
1654 description: "Whether blocks result in people getting unfollowed"
1657 key: :outgoing_blocks,
1659 description: "Whether to federate blocks to other instances"
1662 key: :blockers_visible,
1664 description: "Whether a user can see someone who has blocked them"
1667 key: :sign_object_fetches,
1669 description: "Sign object fetches with HTTP signatures"
1672 key: :authorized_fetch_mode,
1674 description: "Require HTTP signatures on AP fetches"
1677 key: :note_replies_output_limit,
1680 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1683 key: :follow_handshake_timeout,
1685 description: "Following handshake timeout",
1689 key: :max_collection_objects,
1692 "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.",
1699 key: :http_security,
1700 label: "HTTP security",
1702 description: "HTTP security settings",
1707 description: "Whether the managed content security policy is enabled"
1713 description: "Whether to additionally send a Strict-Transport-Security header"
1717 label: "STS max age",
1719 description: "The maximum age for the Strict-Transport-Security header if sent",
1720 suggestions: [63_072_000]
1723 key: :referrer_policy,
1725 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1726 suggestions: ["same-origin", "no-referrer"]
1730 label: "Report URI",
1732 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1733 suggestions: ["https://example.com/report-uri"]
1738 group: :web_push_encryption,
1739 key: :vapid_details,
1740 label: "Vapid Details",
1743 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1749 "A mailto link for the administrative contact." <>
1750 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1751 suggestions: ["mailto:moderators@pleroma.com"]
1756 description: "VAPID public key",
1757 suggestions: ["Public key"]
1762 description: "VAPID private key",
1763 suggestions: ["Private key"]
1769 key: Pleroma.Captcha,
1771 description: "Captcha-related settings",
1776 description: "Whether the captcha should be shown on registration"
1781 description: "The method/service to use for captcha",
1782 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1785 key: :seconds_valid,
1787 description: "The time in seconds for which the captcha is valid",
1794 key: Pleroma.Captcha.Kocaptcha,
1797 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1798 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1803 description: "The kocaptcha endpoint to use",
1804 suggestions: ["https://captcha.kotobank.ch"]
1810 label: "Pleroma Admin Token",
1813 "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)",
1818 description: "Admin token",
1820 "Please use a high entropy string or UUID"
1830 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1834 type: {:dropdown, :atom},
1835 description: "Logs verbose mode",
1836 suggestions: [false, :error, :warn, :info, :debug]
1840 type: {:keyword, :integer},
1842 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1844 activity_expiration: 10,
1845 attachments_cleanup: 5,
1847 federator_incoming: 50,
1848 federator_outgoing: 50,
1850 scheduled_activities: 10,
1856 key: :activity_expiration,
1858 description: "Activity expiration queue",
1864 description: "Backup queue",
1868 key: :attachments_cleanup,
1870 description: "Attachment deletion queue",
1876 description: "Background queue",
1880 key: :federator_incoming,
1882 description: "Incoming federation queue",
1886 key: :federator_outgoing,
1888 description: "Outgoing federation queue",
1894 description: "Email sender queue, see Pleroma.Emails.Mailer",
1898 key: :scheduled_activities,
1900 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1904 key: :transmogrifier,
1906 description: "Transmogrifier queue",
1912 description: "Web push notifications queue",
1919 type: {:list, :tuple},
1920 description: "Settings for cron background jobs",
1922 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1923 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1932 description: "Includes custom worker options not interpretable directly by `Oban`",
1936 type: {:keyword, :integer},
1937 description: "Max retry attempts for failed jobs, per `Oban` queue",
1939 federator_incoming: 5,
1940 federator_outgoing: 5
1945 type: {:keyword, :integer},
1946 description: "Timeout for jobs, per `Oban` queue, in ms",
1948 activity_expiration: :timer.seconds(5),
1949 token_expiration: :timer.seconds(5),
1950 filter_expiration: :timer.seconds(5),
1951 backup: :timer.seconds(900),
1952 federator_incoming: :timer.seconds(10),
1953 federator_outgoing: :timer.seconds(10),
1954 ingestion_queue: :timer.seconds(5),
1955 web_push: :timer.seconds(5),
1956 mailer: :timer.seconds(5),
1957 transmogrifier: :timer.seconds(5),
1958 scheduled_activities: :timer.seconds(5),
1959 poll_notifications: :timer.seconds(5),
1960 background: :timer.seconds(5),
1961 remote_fetcher: :timer.seconds(10),
1962 attachments_cleanup: :timer.seconds(900),
1963 new_users_digest: :timer.seconds(10),
1964 mute_expire: :timer.seconds(5),
1965 search_indexing: :timer.seconds(5),
1966 nodeinfo_fetcher: :timer.seconds(10)
1973 key: Pleroma.Web.Metadata,
1975 description: "Metadata-related settings",
1979 type: {:list, :module},
1980 description: "List of metadata providers to enable",
1982 Pleroma.Web.Metadata.Providers.OpenGraph,
1983 Pleroma.Web.Metadata.Providers.TwitterCard,
1984 Pleroma.Web.Metadata.Providers.RelMe,
1985 Pleroma.Web.Metadata.Providers.Feed
1990 label: "Unfurl NSFW",
1992 description: "When enabled NSFW attachments will be shown in previews"
1998 key: Pleroma.Web.Metadata.Providers.Theme,
2000 description: "Specific provider to hand out themes to instances that scrape index.html",
2006 "The 'accent color' of the instance, used in places like misskey's instance ticker",
2007 suggestions: ["#593196"]
2016 "If enabled the instance will parse metadata from attached links to generate link previews",
2021 description: "Enables RichMedia parsing of URLs"
2025 type: {:list, :string},
2026 description: "List of hosts which will be ignored by the metadata parser",
2027 suggestions: ["accounts.google.com", "xss.website"]
2031 label: "Ignore TLD",
2032 type: {:list, :string},
2033 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2034 suggestions: ["local", "localdomain", "lan"]
2038 type: {:list, :module},
2040 "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.",
2042 Pleroma.Web.RichMedia.Parsers.OEmbed,
2043 Pleroma.Web.RichMedia.Parsers.TwitterCard
2048 label: "TTL setters",
2049 type: {:list, :module},
2051 "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.",
2053 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2057 key: :failure_backoff,
2060 "Amount of milliseconds after request failure, during which the request will not be retried.",
2061 suggestions: [60_000]
2067 key: Pleroma.Formatter,
2071 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2075 type: [:string, :boolean],
2076 description: "Specify the class to be added to the generated link. Disable to clear.",
2077 suggestions: ["auto-linker", false]
2081 type: [:string, :boolean],
2082 description: "Override the rel attribute. Disable to clear.",
2083 suggestions: ["ugc", "noopener noreferrer", false]
2088 description: "Link URLs will open in a new window/tab."
2092 type: [:integer, :boolean],
2094 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2095 suggestions: [15, false]
2100 description: "Strip the scheme prefix."
2105 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2109 type: [:atom, :boolean],
2111 "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)",
2112 suggestions: [:no_scheme, true]
2118 key: Pleroma.ScheduledActivity,
2120 description: "Scheduled activities settings",
2123 key: :daily_user_limit,
2126 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2130 key: :total_user_limit,
2133 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2139 description: "Whether scheduled activities are sent to the job queue to be executed"
2145 key: Pleroma.Workers.PurgeExpiredActivity,
2147 description: "Expired activities settings",
2152 description: "Enables expired activities addition & deletion"
2157 description: "Minimum lifetime for ephemeral activity (in seconds)",
2164 label: "Pleroma Authenticator",
2166 description: "Authenticator",
2169 key: Pleroma.Web.Auth.Authenticator,
2171 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2181 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2182 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2183 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2184 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2189 description: "Enables LDAP authentication"
2194 description: "LDAP server hostname",
2195 suggestions: ["localhosts"]
2200 description: "LDAP port, e.g. 389 or 636",
2201 suggestions: [389, 636]
2207 description: "Enable to use SSL, usually implies the port 636"
2211 label: "SSL options",
2213 description: "Additional SSL options",
2214 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2219 description: "Path to file with PEM encoded cacerts",
2220 suggestions: ["path/to/file/with/PEM/cacerts"]
2225 description: "Type of cert verification",
2226 suggestions: [:verify_peer]
2234 description: "Enable to use STARTTLS, usually implies the port 389"
2238 label: "TLS options",
2240 description: "Additional TLS options",
2241 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2246 description: "Path to file with PEM encoded cacerts",
2247 suggestions: ["path/to/file/with/PEM/cacerts"]
2252 description: "Type of cert verification",
2253 suggestions: [:verify_peer]
2260 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2261 suggestions: ["dc=example,dc=com"]
2268 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2277 description: "Authentication / authorization settings",
2280 key: :enforce_oauth_admin_scope_usage,
2281 label: "Enforce OAuth admin scope usage",
2284 "OAuth admin scope requirement toggle. " <>
2285 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2286 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2287 "`is_admin` user flag grants access to admin-specific actions."
2290 key: :auth_template,
2293 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2294 suggestions: ["show.html"]
2297 key: :oauth_consumer_template,
2298 label: "OAuth consumer template",
2301 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2302 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2303 suggestions: ["consumer.html"]
2306 key: :oauth_consumer_strategies,
2307 label: "OAuth consumer strategies",
2308 type: {:list, :string},
2310 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2311 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2312 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2313 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2319 key: :email_notifications,
2321 description: "Email notifications settings",
2327 "emails of \"what you've missed\" for users who have been inactive for a while",
2331 schedule: "0 0 * * 0",
2333 inactivity_threshold: 7
2341 description: "Globally enable or disable digest emails"
2347 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2348 suggestions: ["0 0 * * 0"]
2353 description: "Minimum interval between digest emails to one user",
2357 key: :inactivity_threshold,
2359 description: "Minimum user inactivity threshold",
2368 key: Pleroma.Emails.UserEmail,
2370 description: "Email template settings",
2374 type: {:string, :image},
2375 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2376 suggestions: ["some/path/logo.png"]
2381 description: "A map with color settings for email templates.",
2384 link_color: "#d8a070",
2385 background_color: "#2C3645",
2386 content_background_color: "#1B2635",
2387 header_color: "#d8a070",
2388 text_color: "#b9b9ba",
2389 text_muted_color: "#b9b9ba"
2396 suggestions: ["#d8a070"]
2399 key: :background_color,
2401 suggestions: ["#2C3645"]
2404 key: :content_background_color,
2406 suggestions: ["#1B2635"]
2411 suggestions: ["#d8a070"]
2416 suggestions: ["#b9b9ba"]
2419 key: :text_muted_color,
2421 suggestions: ["#b9b9ba"]
2429 key: Pleroma.Emails.NewUsersDigestEmail,
2431 description: "New users admin email digest",
2436 description: "Enables new users admin digest email when `true`"
2445 description: "Configure OAuth 2 provider capabilities",
2448 key: :token_expires_in,
2450 description: "The lifetime in seconds of the access token",
2451 suggestions: [2_592_000]
2454 key: :issue_new_refresh_token,
2457 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2460 key: :clean_expired_tokens,
2462 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2472 key: :shortcode_globs,
2473 type: {:list, :string},
2474 description: "Location of custom emoji files. * can be used as a wildcard.",
2475 suggestions: ["/emoji/custom/**/*.png"]
2478 key: :pack_extensions,
2479 type: {:list, :string},
2481 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2482 suggestions: [".png", ".gif"]
2486 type: {:keyword, {:list, :string}},
2488 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2489 " and the value is the location or array of locations. * can be used as a wildcard.",
2491 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2495 key: :default_manifest,
2498 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2499 " Currently only one manifest can be added (no arrays).",
2500 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2503 key: :shared_pack_cache_seconds_per_file,
2504 label: "Shared pack cache s/file",
2507 "When an emoji pack is shared, the archive is created and cached in memory" <>
2508 " for this amount of seconds multiplied by the number of files.",
2518 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2522 type: [:tuple, {:list, :tuple}],
2523 description: "For the search requests (account & status search etc.)",
2524 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2528 type: [:tuple, {:list, :tuple}],
2529 description: "For requests to timelines (each timeline has it's own limiter)",
2530 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2533 key: :app_account_creation,
2534 type: [:tuple, {:list, :tuple}],
2535 description: "For registering user accounts from the same IP address",
2536 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2539 key: :relations_actions,
2540 type: [:tuple, {:list, :tuple}],
2541 description: "For actions on relationships with all users (follow, unfollow)",
2542 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2545 key: :relation_id_action,
2546 label: "Relation ID action",
2547 type: [:tuple, {:list, :tuple}],
2548 description: "For actions on relation with a specific user (follow, unfollow)",
2549 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2552 key: :statuses_actions,
2553 type: [:tuple, {:list, :tuple}],
2555 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2556 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2559 key: :status_id_action,
2560 label: "Status ID action",
2561 type: [:tuple, {:list, :tuple}],
2563 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2564 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2567 key: :authentication,
2568 type: [:tuple, {:list, :tuple}],
2569 description: "For authentication create / password check / user existence check requests",
2570 suggestions: [{60_000, 15}]
2576 label: "Mime Types",
2578 description: "Mime Types settings",
2585 "application/xml" => ["xml"],
2586 "application/xrd+xml" => ["xrd+xml"],
2587 "application/jrd+json" => ["jrd+json"],
2588 "application/activity+json" => ["activity+json"],
2589 "application/ld+json" => ["activity+json"]
2594 key: "application/xml",
2595 type: {:list, :string},
2596 suggestions: ["xml"]
2599 key: "application/xrd+xml",
2600 type: {:list, :string},
2601 suggestions: ["xrd+xml"]
2604 key: "application/jrd+json",
2605 type: {:list, :string},
2606 suggestions: ["jrd+json"]
2609 key: "application/activity+json",
2610 type: {:list, :string},
2611 suggestions: ["activity+json"]
2614 key: "application/ld+json",
2615 type: {:list, :string},
2616 suggestions: ["activity+json"]
2627 description: "HTTP settings",
2631 label: "HTTP Pool Request Timeout",
2633 description: "Timeout for initiating HTTP requests (in ms, default 5000)",
2637 key: :receive_timeout,
2638 label: "HTTP Receive Timeout",
2641 "Timeout for waiting on remote servers to respond to HTTP requests (in ms, default 15000)",
2642 suggestions: [15000]
2649 "Proxy URL - of the format http://host:port. Advise setting in .exs instead of admin-fe due to this being set at boot-time.",
2650 suggestions: ["http://localhost:3128"]
2654 type: [:string, :atom],
2656 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2657 suggestions: ["Pleroma", :default]
2662 description: "Adapter specific options",
2668 label: "SSL Options",
2669 description: "SSL options for HTTP adapter",
2673 type: {:list, :atom},
2674 description: "List of TLS version to use",
2675 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2686 label: "Markup Settings",
2690 key: :allow_inline_images,
2694 key: :allow_headings,
2707 type: {:list, :module},
2709 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2710 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2720 key: :deny_follow_blocked,
2731 key: :restricted_nicknames,
2732 type: {:list, :string},
2733 description: "List of nicknames users may not register with.",
2752 "ostatus_subscribe",
2768 key: :email_blacklist,
2769 type: {:list, :string},
2770 description: "List of email domains users may not register with.",
2771 suggestions: ["mailinator.com", "maildrop.cc"]
2777 label: "CORS plug config",
2783 suggestions: [86_400]
2787 type: {:list, :string},
2788 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2792 type: {:list, :string},
2795 "X-RateLimit-Reset",
2796 "X-RateLimit-Limit",
2797 "X-RateLimit-Remaining",
2808 type: {:list, :string},
2809 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2815 key: Pleroma.Web.Plugs.RemoteIp,
2818 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2819 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2825 description: "Enable/disable the plug. Default: disabled."
2829 type: {:list, :string},
2831 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2836 type: {:list, :string},
2838 "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."
2842 type: {:list, :string},
2844 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"]`
2851 key: :web_cache_ttl,
2852 label: "Web cache TTL",
2855 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2861 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2865 key: :activity_pub_question,
2867 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2868 suggestions: [30_000]
2878 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2883 description: "Enables the rendering of static HTML. Default: disabled."
2891 description: "Configure feed rendering",
2896 description: "Configure title rendering",
2901 description: "Maximum number of characters before truncating title",
2907 description: "Replacement which will be used after truncating string",
2908 suggestions: ["..."]
2916 key: :mrf_follow_bot,
2918 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2919 label: "MRF FollowBot Policy",
2921 description: "Automatically follows newly discovered accounts.",
2924 key: :follower_nickname,
2926 description: "The name of the bot account to use for following newly discovered users.",
2927 suggestions: ["followbot"]
2935 description: "Custom Runtime Modules",
2940 description: "A path to custom Elixir modules (such as MRF policies)."
2948 description: "Settings for notifications streamer",
2953 description: "Number of workers to send notifications",
2957 key: :overflow_workers,
2959 description: "Maximum number of workers created if pool is empty",
2966 key: :restrict_unauthenticated,
2967 label: "Restrict Unauthenticated",
2969 description: "Disallow unauthenticated viewing of timelines, user profiles and statuses.",
2974 description: "Settings for public and federated timelines.",
2979 description: "Disallow viewing the public timeline."
2984 description: "Disallow viewing the whole known network timeline."
2991 description: "Settings for user profiles.",
2996 description: "Disallow viewing local user profiles."
3001 description: "Disallow viewing remote user profiles."
3008 description: "Settings for posts.",
3013 description: "Disallow viewing local posts."
3018 description: "Disallow viewing remote posts."
3026 key: Pleroma.Web.ApiSpec.CastAndValidate,
3033 "Enables strict input validation (useful in development, not recommended in production)"
3039 key: :instances_favicons,
3041 description: "Control favicons for instances",
3046 description: "Allow/disallow displaying and getting instances favicons"
3052 key: :instances_nodeinfo,
3054 description: "Control favicons for instances",
3059 description: "Allow/disallow getting instance nodeinfo"
3067 descriptions: "S3 service related settings",
3070 key: :access_key_id,
3072 description: "S3 access key ID",
3073 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3076 key: :secret_access_key,
3078 description: "Secret access key",
3079 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3084 description: "S3 host",
3085 suggestions: ["s3.eu-central-1.amazonaws.com"]
3090 description: "S3 region (for AWS)",
3091 suggestions: ["us-east-1"]
3099 description: "Installed frontends management",
3104 description: "Primary frontend, the one that is served for all pages by default",
3105 children: installed_frontend_options
3110 description: "Admin frontend",
3111 children: installed_frontend_options
3116 description: "Mastodon frontend",
3117 children: installed_frontend_options
3122 description: "Swagger API reference frontend",
3124 installed_frontend_options ++
3130 description: "Whether to have this enabled at all"
3138 "A map containing available frontends and parameters for their installation.",
3139 children: frontend_options
3145 key: Pleroma.Web.Preload,
3147 description: "Preload-related settings",
3151 type: {:list, :module},
3152 description: "List of preload providers to enable",
3154 Pleroma.Web.Preload.Providers.Instance,
3155 Pleroma.Web.Preload.Providers.User,
3156 Pleroma.Web.Preload.Providers.Timelines,
3157 Pleroma.Web.Preload.Providers.StatusNet
3166 description: "Majic/libmagic configuration",
3171 description: "Number of majic workers to start.",
3178 key: Pleroma.User.Backup,
3180 description: "Account Backup",
3183 key: :purge_after_days,
3185 description: "Remove backup achives after N days",
3191 description: "Limit user to export not more often than once per N days",
3198 key: ConcurrentLimiter,
3200 description: "Limits configuration for background tasks.",
3203 key: Pleroma.Web.RichMedia.Helpers,
3205 description: "Concurrent limits configuration for getting RichMedia for activities.",
3206 suggestions: [max_running: 5, max_waiting: 5],
3211 description: "Max running concurrently jobs.",
3217 description: "Max waiting jobs.",
3223 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3225 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3226 suggestions: [max_running: 5, max_waiting: 5],
3231 description: "Max running concurrently jobs.",
3237 description: "Max waiting jobs.",
3246 key: Pleroma.Search,
3249 description: "General search settings.",
3254 description: "Selected search module.",
3255 suggestions: {:list_behaviour_implementations, Pleroma.Search.SearchBackend}
3261 key: Pleroma.Search.Meilisearch,
3263 description: "Meilisearch settings.",
3268 description: "Meilisearch URL.",
3269 suggestion: ["http://127.0.0.1:7700/"]
3275 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3279 key: :initial_indexing_chunk_size,
3282 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3283 " since there's a limit on maximum insert size",
3284 suggestion: [100_000]
3290 key: Pleroma.Search.Elasticsearch.Cluster,
3291 label: "Elasticsearch",
3293 description: "Elasticsearch settings.",
3298 description: "Elasticsearch URL.",
3299 suggestion: ["http://127.0.0.1:9200/"]
3304 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3305 suggestion: ["elastic"]
3310 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3311 suggestion: ["changeme"]
3317 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3318 suggestion: [Elasticsearch.API.HTTP]
3324 "The JSON module used to encode/decode when communicating with Elasticsearch",
3330 description: "The indices to set up in Elasticsearch",
3335 description: "Config for the index to use for activities",
3341 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3342 suggestion: ["priv/es-mappings/activity.json"]
3347 description: "The internal store module",
3348 suggestion: [Pleroma.Search.Elasticsearch.Store]
3352 type: {:list, :module},
3353 description: "The internal types to use for this index",
3354 suggestion: [[Pleroma.Activity]]
3357 key: :bulk_page_size,
3359 description: "Size for bulk put requests, mostly used on building the index",
3363 key: :bulk_wait_interval,
3365 description: "Time to wait between bulk put requests (in ms)",
3366 suggestion: [15_000]
3378 description: "Translation Settings",
3383 description: "Is translation enabled?",
3384 suggestion: [true, false]
3389 description: "Translation module.",
3390 suggestions: {:list_behaviour_implementations, Pleroma.Akkoma.Translator}
3399 description: "DeepL Settings.",
3403 type: {:dropdown, :atom},
3404 description: "API Tier",
3405 suggestions: [:free, :pro]
3410 description: "API key for DeepL",
3417 key: :libre_translate,
3419 description: "LibreTranslate Settings.",
3424 description: "URL for libretranslate",
3430 description: "API key for libretranslate",