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 label: "Admin Email Address",
516 description: "Email used to reach an Administrator/Moderator of the instance",
523 label: "Sender Email Address",
525 description: "Envelope FROM address for mail sent via Pleroma",
534 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
542 description: "Posts character limit (CW/Subject included in the counter)",
550 description: "Hard character limit beyond which remote posts will be dropped",
558 description: "File size limit of uploads (except for avatar, background, banner)",
564 key: :avatar_upload_limit,
566 description: "File size limit of user's profile avatars",
572 key: :background_upload_limit,
574 description: "File size limit of user's profile backgrounds",
580 key: :banner_upload_limit,
582 description: "File size limit of user's profile banners",
590 description: "A map with poll limits for local polls",
594 max_option_chars: 200,
596 max_expiration: 31_536_000
603 description: "Maximum number of options",
607 key: :max_option_chars,
609 description: "Maximum number of characters per option",
613 key: :min_expiration,
615 description: "Minimum expiration time (in seconds)",
619 key: :max_expiration,
621 description: "Maximum expiration time (in seconds)",
627 key: :registrations_open,
630 "Enable registrations for anyone. Invitations require this setting to be disabled."
633 key: :invites_enabled,
636 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
639 key: :account_activation_required,
641 description: "Require users to confirm their emails before signing in"
644 key: :account_approval_required,
646 description: "Require users to be manually approved by an admin before signing in"
651 description: "Enable federation with other instances"
654 key: :federation_incoming_replies_max_depth,
655 label: "Fed. incoming replies max depth",
658 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
659 " 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.",
665 key: :federation_reachability_timeout_days,
666 label: "Fed. reachability timeout days",
669 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
678 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
684 "Makes the client API in authenticated mode-only except for user-profiles." <>
685 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
686 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
689 key: :quarantined_instances,
690 type: {:list, :tuple},
691 key_placeholder: "instance",
692 value_placeholder: "reason",
694 "(Deprecated, will be removed in next release) List of ActivityPub instances where activities will not be sent, and the reason for doing so",
696 {"quarantined.com", "Reason"},
697 {"*.quarantined.com", "Reason"}
703 description: "Instance static directory",
709 key: :allowed_post_formats,
710 type: {:list, :string},
711 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
720 key: :extended_nickname_format,
723 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
724 " This will break federation with older software for theses nicknames."
727 key: :cleanup_attachments,
730 Enable to remove associated attachments when status is removed.
731 This will not affect duplicates and attachments without status.
732 Enabling this will increase load to database when deleting statuses on larger instances.
736 key: :max_pinned_statuses,
738 description: "The maximum number of pinned statuses. 0 will disable the feature.",
746 key: :autofollowed_nicknames,
747 type: {:list, :string},
749 "Set to nicknames of (local) users that every new user should automatically follow"
752 key: :autofollowing_nicknames,
753 type: {:list, :string},
755 "Set to nicknames of (local) users that automatically follows every newly registered user"
758 key: :attachment_links,
760 description: "Enable to automatically add attachment link text to statuses"
763 key: :max_report_comment_size,
765 description: "The maximum size of the report comment. Default: 1000.",
771 key: :safe_dm_mentions,
772 label: "Safe DM mentions",
775 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
776 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
782 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
785 key: :remote_post_retention_days,
788 "The default amount of days to retain remote posts when pruning the database",
794 key: :user_bio_length,
796 description: "A user bio maximum length. Default: 5000.",
802 key: :user_name_length,
804 description: "A user name maximum length. Default: 100.",
810 key: :skip_thread_containment,
812 description: "Skip filtering out broken threads. Default: enabled."
815 key: :limit_to_local_content,
816 type: {:dropdown, :atom},
818 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
826 key: :max_account_fields,
828 description: "The maximum number of custom fields in the user profile. Default: 10.",
834 key: :max_remote_account_fields,
837 "The maximum number of custom fields in the remote user profile. Default: 20.",
843 key: :account_field_name_length,
845 description: "An account field name maximum length. Default: 512.",
851 key: :account_field_value_length,
853 description: "An account field value maximum length. Default: 2048.",
859 key: :registration_reason_length,
861 description: "Maximum registration reason length. Default: 500.",
867 key: :external_user_synchronization,
869 description: "Enabling following/followers counters synchronization for external users"
872 key: :multi_factor_authentication,
874 description: "Multi-factor authentication settings",
877 totp: [digits: 6, period: 30],
878 backup_codes: [number: 5, length: 16]
884 label: "TOTP settings",
886 description: "TOTP settings",
887 suggestions: [digits: 6, period: 30],
894 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
901 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
908 description: "MFA backup codes settings",
909 suggestions: [number: 5, length: 16],
915 description: "Number of backup codes to generate."
922 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
929 key: :instance_thumbnail,
930 type: {:string, :image},
932 "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.",
933 suggestions: ["/instance/thumbnail.jpeg"]
936 key: :show_reactions,
938 description: "Let favourites and emoji reactions be viewed through the API."
941 key: :profile_directory,
943 description: "Enable profile directory."
946 key: :privileged_staff,
949 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses)"
953 type: {:list, :string},
955 "List of instances that make up your local bubble (closely-related instances). Used to populate the 'bubble' timeline (domain only)."
963 description: "Welcome messages settings",
966 key: :direct_message,
968 descpiption: "Direct message settings",
973 description: "Enables sending a direct message to newly registered users"
978 description: "A message that will be sent to newly registered users",
980 "Hi, @username! Welcome on board!"
984 key: :sender_nickname,
986 description: "The nickname of the local user that sends a welcome message",
996 descpiption: "Email message settings",
1001 description: "Enables sending an email to newly registered users"
1005 type: [:string, :tuple],
1007 "Email address and/or nickname that will be used to send the welcome email.",
1009 {"Pleroma App", "welcome@pleroma.app"}
1016 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1017 suggestions: ["Welcome to <%= instance_name%>"]
1023 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1024 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1030 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1031 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1040 description: "Logger-related settings",
1044 type: [:atom, :tuple, :module],
1046 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1047 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1055 label: "ExSyslogger",
1056 description: "ExSyslogger-related settings",
1060 type: {:dropdown, :atom},
1061 description: "Log level",
1062 suggestions: [:debug, :info, :warn, :error]
1068 "A string that's prepended to every message, and is typically set to the app name",
1069 suggestions: ["pleroma"]
1074 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1075 suggestions: ["$metadata[$level] $message"]
1079 type: {:list, :atom},
1080 suggestions: [:request_id]
1088 label: "Console Logger",
1089 description: "Console logger settings",
1093 type: {:dropdown, :atom},
1094 description: "Log level",
1095 suggestions: [:debug, :info, :warn, :error]
1100 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1101 suggestions: ["$metadata[$level] $message"]
1105 type: {:list, :atom},
1106 suggestions: [:request_id]
1113 label: "Quack Logger",
1114 description: "Quack-related settings",
1118 type: {:dropdown, :atom},
1119 description: "Log level",
1120 suggestions: [:debug, :info, :warn, :error]
1124 type: {:list, :atom},
1125 description: "Configure which metadata you want to report on",
1142 label: "Webhook URL",
1144 description: "Configure the Slack incoming webhook",
1145 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1151 key: :frontend_configurations,
1154 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1155 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1156 "add your own configuration your settings all fields must be complete.",
1160 label: "Pleroma FE",
1162 description: "Settings for Pleroma FE",
1165 alwaysShowSubjectInput: true,
1166 background: "/static/aurora_borealis.jpg",
1167 collapseMessageWithSubject: false,
1169 hideFilteredStatuses: false,
1170 hideMutedPosts: false,
1171 hidePostStats: false,
1172 hideSitename: false,
1173 hideUserStats: false,
1174 loginMethod: "password",
1175 logo: "/static/logo.svg",
1178 minimalScopesMode: false,
1179 noAttachmentLinks: false,
1180 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1181 postContentType: "text/plain",
1182 redirectRootLogin: "/main/friends",
1183 redirectRootNoLogin: "/main/all",
1185 sidebarRight: false,
1186 showFeaturesPanel: true,
1187 showInstanceSpecificPanel: false,
1188 subjectLineBehavior: "email",
1189 theme: "pleroma-dark",
1190 webPushNotifications: false
1195 key: :alwaysShowSubjectInput,
1196 label: "Always show subject input",
1198 description: "When disabled, auto-hide the subject field if it's empty"
1202 type: {:string, :image},
1204 "URL of the background, unless viewing a user profile with a background that is set",
1205 suggestions: ["/images/city.jpg"]
1208 key: :collapseMessageWithSubject,
1209 label: "Collapse message with subject",
1212 "When a message has a subject (aka Content Warning), collapse it by default"
1218 description: "Enables green text on lines prefixed with the > character"
1221 key: :hideFilteredStatuses,
1222 label: "Hide Filtered Statuses",
1224 description: "Hides filtered statuses from timelines"
1227 key: :hideMutedPosts,
1228 label: "Hide Muted Posts",
1230 description: "Hides muted statuses from timelines"
1233 key: :hidePostStats,
1234 label: "Hide post stats",
1236 description: "Hide notices statistics (repeats, favorites, ...)"
1240 label: "Hide Sitename",
1242 description: "Hides instance name from PleromaFE banner"
1245 key: :hideUserStats,
1246 label: "Hide user stats",
1249 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1253 type: {:string, :image},
1254 description: "URL of the logo, defaults to Pleroma's logo",
1255 suggestions: ["/static/logo.svg"]
1259 label: "Logo margin",
1262 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1263 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1264 suggestions: [".1em"]
1271 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1272 "If you want a colorful logo you must disable logoMask."
1275 key: :minimalScopesMode,
1276 label: "Minimal scopes mode",
1279 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1280 "Also prevents replying to a DM with a public post from PleromaFE."
1283 key: :nsfwCensorImage,
1284 label: "NSFW Censor Image",
1285 type: {:string, :image},
1287 "URL of the image to use for hiding NSFW media attachments in the timeline",
1288 suggestions: ["/static/img/nsfw.74818f9.png"]
1291 key: :postContentType,
1292 label: "Post Content Type",
1293 type: {:dropdown, :atom},
1294 description: "Default post formatting option",
1295 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1298 key: :redirectRootNoLogin,
1299 label: "Redirect root no login",
1302 "Relative URL which indicates where to redirect when a user isn't logged in",
1303 suggestions: ["/main/all"]
1306 key: :redirectRootLogin,
1307 label: "Redirect root login",
1310 "Relative URL which indicates where to redirect when a user is logged in",
1311 suggestions: ["/main/friends"]
1315 label: "Scope copy",
1317 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1321 label: "Sidebar on Right",
1323 description: "Change alignment of sidebar and panels to the right"
1326 key: :showFeaturesPanel,
1327 label: "Show instance features panel",
1330 "Enables panel displaying functionality of the instance on the About page"
1333 key: :showInstanceSpecificPanel,
1334 label: "Show instance specific panel",
1336 description: "Whether to show the instance's custom panel"
1339 key: :subjectLineBehavior,
1340 label: "Subject line behavior",
1342 description: "Allows changing the default behaviour of subject lines in replies.
1343 `email`: copy and preprend re:, as in email,
1344 `masto`: copy verbatim, as in Mastodon,
1345 `noop`: don't copy the subject.",
1346 suggestions: ["email", "masto", "noop"]
1351 description: "Which theme to use. Available themes are defined in styles.json",
1352 suggestions: ["pleroma-dark"]
1360 description: "Settings for Masto FE",
1363 showInstanceSpecificPanel: true
1368 key: :showInstanceSpecificPanel,
1369 label: "Show instance specific panel",
1371 description: "Whenether to show the instance's specific panel"
1382 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1386 type: {:keyword, :map},
1388 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1391 url: "/images/pleroma-fox-tan-smol.png",
1392 mime_type: "image/png"
1394 pleroma_fox_tan_shy: %{
1395 url: "/images/pleroma-fox-tan-shy.png",
1396 mime_type: "image/png"
1401 key: :default_mascot,
1404 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1410 key: :default_user_avatar,
1411 type: {:string, :image},
1412 description: "URL of the default user avatar",
1413 suggestions: ["/images/avi.png"]
1422 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1426 type: {:list, :map},
1427 description: "Describe the icons of the app",
1430 src: "/static/logo.png"
1433 src: "/static/icon.png",
1437 src: "/static/icon.ico",
1438 sizes: "72x72 96x96 128x128 256x256"
1445 description: "Describe the theme color of the app",
1446 suggestions: ["#282c37", "mediumpurple"]
1449 key: :background_color,
1451 description: "Describe the background color of the app",
1452 suggestions: ["#191b22", "aliceblue"]
1460 description: "Media proxy",
1465 description: "Enables proxying of remote media via the instance's proxy"
1472 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1473 suggestions: ["https://example.com"]
1481 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1487 description: "Enables media cache object invalidation."
1492 description: "Module which will be used to purge objects from the cache.",
1494 Pleroma.Web.MediaProxy.Invalidation.Script,
1495 Pleroma.Web.MediaProxy.Invalidation.Http
1502 label: "Advanced MediaProxy Options",
1504 description: "Internal Pleroma.ReverseProxy settings",
1506 redirect_on_failure: false,
1507 max_body_length: 25 * 1_048_576,
1508 max_read_duration: 30_000
1512 key: :redirect_on_failure,
1515 Redirects the client to the origin server upon encountering HTTP errors.\n
1516 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1517 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1518 IP addresses of your users to the other servers, bypassing the MediaProxy.
1522 key: :max_body_length,
1525 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1528 key: :max_read_duration,
1530 description: "Timeout (in milliseconds) of GET request to the remote URI."
1536 type: {:list, :string},
1537 description: "List of hosts with scheme to bypass the MediaProxy",
1538 suggestions: ["http://example.com"]
1544 key: :media_preview_proxy,
1546 description: "Media preview proxy",
1552 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1555 key: :thumbnail_max_width,
1558 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1561 key: :thumbnail_max_height,
1564 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1567 key: :image_quality,
1569 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1572 key: :min_content_length,
1575 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1581 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1583 description: "HTTP invalidate settings",
1588 description: "HTTP method of request. Default: :purge"
1592 type: {:keyword, :string},
1593 description: "HTTP headers of request",
1594 suggestions: [{"x-refresh", 1}]
1599 description: "Request options",
1603 type: {:map, :string}
1611 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1613 description: "Invalidation script settings",
1618 description: "Path to executable script which will purge cached items.",
1619 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1623 label: "URL Format",
1626 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1627 suggestions: [":htcacheclean"]
1634 label: "ActivityPub",
1636 description: "ActivityPub-related settings",
1639 key: :unfollow_blocked,
1641 description: "Whether blocks result in people getting unfollowed"
1644 key: :outgoing_blocks,
1646 description: "Whether to federate blocks to other instances"
1649 key: :blockers_visible,
1651 description: "Whether a user can see someone who has blocked them"
1654 key: :sign_object_fetches,
1656 description: "Sign object fetches with HTTP signatures"
1659 key: :authorized_fetch_mode,
1661 description: "Require HTTP signatures on AP fetches"
1664 key: :note_replies_output_limit,
1667 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1670 key: :follow_handshake_timeout,
1672 description: "Following handshake timeout",
1676 key: :max_collection_objects,
1679 "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.",
1686 key: :http_security,
1687 label: "HTTP security",
1689 description: "HTTP security settings",
1694 description: "Whether the managed content security policy is enabled"
1700 description: "Whether to additionally send a Strict-Transport-Security header"
1704 label: "STS max age",
1706 description: "The maximum age for the Strict-Transport-Security header if sent",
1707 suggestions: [31_536_000]
1711 label: "CT max age",
1713 description: "The maximum age for the Expect-CT header if sent",
1714 suggestions: [2_592_000]
1717 key: :referrer_policy,
1719 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1720 suggestions: ["same-origin", "no-referrer"]
1724 label: "Report URI",
1726 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1727 suggestions: ["https://example.com/report-uri"]
1732 group: :web_push_encryption,
1733 key: :vapid_details,
1734 label: "Vapid Details",
1737 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1743 "A mailto link for the administrative contact." <>
1744 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1745 suggestions: ["mailto:moderators@pleroma.com"]
1750 description: "VAPID public key",
1751 suggestions: ["Public key"]
1756 description: "VAPID private key",
1757 suggestions: ["Private key"]
1763 key: Pleroma.Captcha,
1765 description: "Captcha-related settings",
1770 description: "Whether the captcha should be shown on registration"
1775 description: "The method/service to use for captcha",
1776 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1779 key: :seconds_valid,
1781 description: "The time in seconds for which the captcha is valid",
1788 key: Pleroma.Captcha.Kocaptcha,
1791 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1792 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1797 description: "The kocaptcha endpoint to use",
1798 suggestions: ["https://captcha.kotobank.ch"]
1804 label: "Pleroma Admin Token",
1807 "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)",
1812 description: "Admin token",
1814 "Please use a high entropy string or UUID"
1824 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1828 type: {:dropdown, :atom},
1829 description: "Logs verbose mode",
1830 suggestions: [false, :error, :warn, :info, :debug]
1834 type: {:keyword, :integer},
1836 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1838 activity_expiration: 10,
1839 attachments_cleanup: 5,
1841 federator_incoming: 50,
1842 federator_outgoing: 50,
1844 scheduled_activities: 10,
1850 key: :activity_expiration,
1852 description: "Activity expiration queue",
1858 description: "Backup queue",
1862 key: :attachments_cleanup,
1864 description: "Attachment deletion queue",
1870 description: "Background queue",
1874 key: :federator_incoming,
1876 description: "Incoming federation queue",
1880 key: :federator_outgoing,
1882 description: "Outgoing federation queue",
1888 description: "Email sender queue, see Pleroma.Emails.Mailer",
1892 key: :scheduled_activities,
1894 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1898 key: :transmogrifier,
1900 description: "Transmogrifier queue",
1906 description: "Web push notifications queue",
1913 type: {:list, :tuple},
1914 description: "Settings for cron background jobs",
1916 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1917 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1926 description: "Includes custom worker options not interpretable directly by `Oban`",
1930 type: {:keyword, :integer},
1931 description: "Max retry attempts for failed jobs, per `Oban` queue",
1933 federator_incoming: 5,
1934 federator_outgoing: 5
1941 key: Pleroma.Web.Metadata,
1943 description: "Metadata-related settings",
1947 type: {:list, :module},
1948 description: "List of metadata providers to enable",
1950 Pleroma.Web.Metadata.Providers.OpenGraph,
1951 Pleroma.Web.Metadata.Providers.TwitterCard,
1952 Pleroma.Web.Metadata.Providers.RelMe,
1953 Pleroma.Web.Metadata.Providers.Feed
1958 label: "Unfurl NSFW",
1960 description: "When enabled NSFW attachments will be shown in previews"
1966 key: Pleroma.Web.Metadata.Providers.Theme,
1968 description: "Specific provider to hand out themes to instances that scrape index.html",
1974 "The 'accent color' of the instance, used in places like misskey's instance ticker",
1975 suggestions: ["#593196"]
1984 "If enabled the instance will parse metadata from attached links to generate link previews",
1989 description: "Enables RichMedia parsing of URLs"
1993 type: {:list, :string},
1994 description: "List of hosts which will be ignored by the metadata parser",
1995 suggestions: ["accounts.google.com", "xss.website"]
1999 label: "Ignore TLD",
2000 type: {:list, :string},
2001 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2002 suggestions: ["local", "localdomain", "lan"]
2006 type: {:list, :module},
2008 "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.",
2010 Pleroma.Web.RichMedia.Parsers.OEmbed,
2011 Pleroma.Web.RichMedia.Parsers.TwitterCard
2016 label: "TTL setters",
2017 type: {:list, :module},
2019 "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.",
2021 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2025 key: :failure_backoff,
2028 "Amount of milliseconds after request failure, during which the request will not be retried.",
2029 suggestions: [60_000]
2035 key: Pleroma.Formatter,
2039 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2043 type: [:string, :boolean],
2044 description: "Specify the class to be added to the generated link. Disable to clear.",
2045 suggestions: ["auto-linker", false]
2049 type: [:string, :boolean],
2050 description: "Override the rel attribute. Disable to clear.",
2051 suggestions: ["ugc", "noopener noreferrer", false]
2056 description: "Link URLs will open in a new window/tab."
2060 type: [:integer, :boolean],
2062 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2063 suggestions: [15, false]
2068 description: "Strip the scheme prefix."
2073 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2077 type: [:atom, :boolean],
2079 "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)",
2080 suggestions: [:no_scheme, true]
2086 key: Pleroma.ScheduledActivity,
2088 description: "Scheduled activities settings",
2091 key: :daily_user_limit,
2094 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2098 key: :total_user_limit,
2101 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2107 description: "Whether scheduled activities are sent to the job queue to be executed"
2113 key: Pleroma.Workers.PurgeExpiredActivity,
2115 description: "Expired activities settings",
2120 description: "Enables expired activities addition & deletion"
2125 description: "Minimum lifetime for ephemeral activity (in seconds)",
2132 label: "Pleroma Authenticator",
2134 description: "Authenticator",
2137 key: Pleroma.Web.Auth.Authenticator,
2139 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2149 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2150 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2151 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2152 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2157 description: "Enables LDAP authentication"
2162 description: "LDAP server hostname",
2163 suggestions: ["localhosts"]
2168 description: "LDAP port, e.g. 389 or 636",
2169 suggestions: [389, 636]
2175 description: "Enable to use SSL, usually implies the port 636"
2179 label: "SSL options",
2181 description: "Additional SSL options",
2182 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2187 description: "Path to file with PEM encoded cacerts",
2188 suggestions: ["path/to/file/with/PEM/cacerts"]
2193 description: "Type of cert verification",
2194 suggestions: [:verify_peer]
2202 description: "Enable to use STARTTLS, usually implies the port 389"
2206 label: "TLS options",
2208 description: "Additional TLS options",
2209 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2214 description: "Path to file with PEM encoded cacerts",
2215 suggestions: ["path/to/file/with/PEM/cacerts"]
2220 description: "Type of cert verification",
2221 suggestions: [:verify_peer]
2228 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2229 suggestions: ["dc=example,dc=com"]
2236 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2245 description: "Authentication / authorization settings",
2248 key: :enforce_oauth_admin_scope_usage,
2249 label: "Enforce OAuth admin scope usage",
2252 "OAuth admin scope requirement toggle. " <>
2253 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2254 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2255 "`is_admin` user flag grants access to admin-specific actions."
2258 key: :auth_template,
2261 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2262 suggestions: ["show.html"]
2265 key: :oauth_consumer_template,
2266 label: "OAuth consumer template",
2269 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2270 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2271 suggestions: ["consumer.html"]
2274 key: :oauth_consumer_strategies,
2275 label: "OAuth consumer strategies",
2276 type: {:list, :string},
2278 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2279 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2280 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2281 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2287 key: :email_notifications,
2289 description: "Email notifications settings",
2295 "emails of \"what you've missed\" for users who have been inactive for a while",
2299 schedule: "0 0 * * 0",
2301 inactivity_threshold: 7
2309 description: "Globally enable or disable digest emails"
2315 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2316 suggestions: ["0 0 * * 0"]
2321 description: "Minimum interval between digest emails to one user",
2325 key: :inactivity_threshold,
2327 description: "Minimum user inactivity threshold",
2336 key: Pleroma.Emails.UserEmail,
2338 description: "Email template settings",
2342 type: {:string, :image},
2343 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2344 suggestions: ["some/path/logo.png"]
2349 description: "A map with color settings for email templates.",
2352 link_color: "#d8a070",
2353 background_color: "#2C3645",
2354 content_background_color: "#1B2635",
2355 header_color: "#d8a070",
2356 text_color: "#b9b9ba",
2357 text_muted_color: "#b9b9ba"
2364 suggestions: ["#d8a070"]
2367 key: :background_color,
2369 suggestions: ["#2C3645"]
2372 key: :content_background_color,
2374 suggestions: ["#1B2635"]
2379 suggestions: ["#d8a070"]
2384 suggestions: ["#b9b9ba"]
2387 key: :text_muted_color,
2389 suggestions: ["#b9b9ba"]
2397 key: Pleroma.Emails.NewUsersDigestEmail,
2399 description: "New users admin email digest",
2404 description: "Enables new users admin digest email when `true`"
2413 description: "Configure OAuth 2 provider capabilities",
2416 key: :token_expires_in,
2418 description: "The lifetime in seconds of the access token",
2419 suggestions: [2_592_000]
2422 key: :issue_new_refresh_token,
2425 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2428 key: :clean_expired_tokens,
2430 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2440 key: :shortcode_globs,
2441 type: {:list, :string},
2442 description: "Location of custom emoji files. * can be used as a wildcard.",
2443 suggestions: ["/emoji/custom/**/*.png"]
2446 key: :pack_extensions,
2447 type: {:list, :string},
2449 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2450 suggestions: [".png", ".gif"]
2454 type: {:keyword, {:list, :string}},
2456 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2457 " and the value is the location or array of locations. * can be used as a wildcard.",
2459 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2463 key: :default_manifest,
2466 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2467 " Currently only one manifest can be added (no arrays).",
2468 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2471 key: :shared_pack_cache_seconds_per_file,
2472 label: "Shared pack cache s/file",
2475 "When an emoji pack is shared, the archive is created and cached in memory" <>
2476 " for this amount of seconds multiplied by the number of files.",
2486 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2490 type: [:tuple, {:list, :tuple}],
2491 description: "For the search requests (account & status search etc.)",
2492 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2496 type: [:tuple, {:list, :tuple}],
2497 description: "For requests to timelines (each timeline has it's own limiter)",
2498 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2501 key: :app_account_creation,
2502 type: [:tuple, {:list, :tuple}],
2503 description: "For registering user accounts from the same IP address",
2504 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2507 key: :relations_actions,
2508 type: [:tuple, {:list, :tuple}],
2509 description: "For actions on relationships with all users (follow, unfollow)",
2510 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2513 key: :relation_id_action,
2514 label: "Relation ID action",
2515 type: [:tuple, {:list, :tuple}],
2516 description: "For actions on relation with a specific user (follow, unfollow)",
2517 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2520 key: :statuses_actions,
2521 type: [:tuple, {:list, :tuple}],
2523 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2524 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2527 key: :status_id_action,
2528 label: "Status ID action",
2529 type: [:tuple, {:list, :tuple}],
2531 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2532 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2535 key: :authentication,
2536 type: [:tuple, {:list, :tuple}],
2537 description: "For authentication create / password check / user existence check requests",
2538 suggestions: [{60_000, 15}]
2544 label: "Mime Types",
2546 description: "Mime Types settings",
2553 "application/xml" => ["xml"],
2554 "application/xrd+xml" => ["xrd+xml"],
2555 "application/jrd+json" => ["jrd+json"],
2556 "application/activity+json" => ["activity+json"],
2557 "application/ld+json" => ["activity+json"]
2562 key: "application/xml",
2563 type: {:list, :string},
2564 suggestions: ["xml"]
2567 key: "application/xrd+xml",
2568 type: {:list, :string},
2569 suggestions: ["xrd+xml"]
2572 key: "application/jrd+json",
2573 type: {:list, :string},
2574 suggestions: ["jrd+json"]
2577 key: "application/activity+json",
2578 type: {:list, :string},
2579 suggestions: ["activity+json"]
2582 key: "application/ld+json",
2583 type: {:list, :string},
2584 suggestions: ["activity+json"]
2595 description: "HTTP settings",
2600 type: [:string, :tuple],
2601 description: "Proxy URL",
2602 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2606 type: [:string, :atom],
2608 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2609 suggestions: ["Pleroma", :default]
2614 description: "Adapter specific options",
2620 label: "SSL Options",
2621 description: "SSL options for HTTP adapter",
2625 type: {:list, :atom},
2626 description: "List of TLS version to use",
2627 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2638 label: "Markup Settings",
2642 key: :allow_inline_images,
2646 key: :allow_headings,
2659 type: {:list, :module},
2661 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2662 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2672 key: :deny_follow_blocked,
2683 key: :restricted_nicknames,
2684 type: {:list, :string},
2685 description: "List of nicknames users may not register with.",
2704 "ostatus_subscribe",
2720 key: :email_blacklist,
2721 type: {:list, :string},
2722 description: "List of email domains users may not register with.",
2723 suggestions: ["mailinator.com", "maildrop.cc"]
2729 label: "CORS plug config",
2735 suggestions: [86_400]
2739 type: {:list, :string},
2740 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2744 type: {:list, :string},
2747 "X-RateLimit-Reset",
2748 "X-RateLimit-Limit",
2749 "X-RateLimit-Remaining",
2760 type: {:list, :string},
2761 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2767 key: Pleroma.Web.Plugs.RemoteIp,
2770 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2771 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2777 description: "Enable/disable the plug. Default: disabled."
2781 type: {:list, :string},
2783 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2788 type: {:list, :string},
2790 "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."
2794 type: {:list, :string},
2796 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"]`
2803 key: :web_cache_ttl,
2804 label: "Web cache TTL",
2807 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2813 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2817 key: :activity_pub_question,
2819 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2820 suggestions: [30_000]
2830 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2835 description: "Enables the rendering of static HTML. Default: disabled."
2843 description: "Configure feed rendering",
2848 description: "Configure title rendering",
2853 description: "Maximum number of characters before truncating title",
2859 description: "Replacement which will be used after truncating string",
2860 suggestions: ["..."]
2868 key: :mrf_follow_bot,
2870 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2871 label: "MRF FollowBot Policy",
2873 description: "Automatically follows newly discovered accounts.",
2876 key: :follower_nickname,
2878 description: "The name of the bot account to use for following newly discovered users.",
2879 suggestions: ["followbot"]
2887 description: "Custom Runtime Modules",
2892 description: "A path to custom Elixir modules (such as MRF policies)."
2900 description: "Settings for notifications streamer",
2905 description: "Number of workers to send notifications",
2909 key: :overflow_workers,
2911 description: "Maximum number of workers created if pool is empty",
2918 key: :restrict_unauthenticated,
2919 label: "Restrict Unauthenticated",
2922 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
2927 description: "Settings for public and federated timelines.",
2932 description: "Disallow view public timeline."
2937 description: "Disallow view federated timeline."
2944 description: "Settings for user profiles.",
2949 description: "Disallow view local user profiles."
2954 description: "Disallow view remote user profiles."
2961 description: "Settings for statuses.",
2966 description: "Disallow view local statuses."
2971 description: "Disallow view remote statuses."
2979 key: Pleroma.Web.ApiSpec.CastAndValidate,
2986 "Enables strict input validation (useful in development, not recommended in production)"
2992 key: :instances_favicons,
2994 description: "Control favicons for instances",
2999 description: "Allow/disallow displaying and getting instances favicons"
3007 descriptions: "S3 service related settings",
3010 key: :access_key_id,
3012 description: "S3 access key ID",
3013 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3016 key: :secret_access_key,
3018 description: "Secret access key",
3019 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3024 description: "S3 host",
3025 suggestions: ["s3.eu-central-1.amazonaws.com"]
3030 description: "S3 region (for AWS)",
3031 suggestions: ["us-east-1"]
3039 description: "Installed frontends management",
3044 description: "Primary frontend, the one that is served for all pages by default",
3045 children: installed_frontend_options
3050 description: "Admin frontend",
3051 children: installed_frontend_options
3056 description: "Mastodon frontend",
3057 children: installed_frontend_options
3062 description: "Swagger API reference frontend",
3064 installed_frontend_options ++
3070 description: "Whether to have this enabled at all"
3078 "A map containing available frontends and parameters for their installation.",
3079 children: frontend_options
3085 key: Pleroma.Web.Preload,
3087 description: "Preload-related settings",
3091 type: {:list, :module},
3092 description: "List of preload providers to enable",
3094 Pleroma.Web.Preload.Providers.Instance,
3095 Pleroma.Web.Preload.Providers.User,
3096 Pleroma.Web.Preload.Providers.Timelines,
3097 Pleroma.Web.Preload.Providers.StatusNet
3106 description: "Majic/libmagic configuration",
3111 description: "Number of majic workers to start.",
3118 key: Pleroma.User.Backup,
3120 description: "Account Backup",
3123 key: :purge_after_days,
3125 description: "Remove backup achives after N days",
3131 description: "Limit user to export not more often than once per N days",
3138 key: ConcurrentLimiter,
3140 description: "Limits configuration for background tasks.",
3143 key: Pleroma.Web.RichMedia.Helpers,
3145 description: "Concurrent limits configuration for getting RichMedia for activities.",
3146 suggestions: [max_running: 5, max_waiting: 5],
3151 description: "Max running concurrently jobs.",
3157 description: "Max waiting jobs.",
3163 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3165 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3166 suggestions: [max_running: 5, max_waiting: 5],
3171 description: "Max running concurrently jobs.",
3177 description: "Max waiting jobs.",
3186 key: Pleroma.Search,
3188 description: "General search settings.",
3193 description: "Selected search module.",
3194 suggestion: [Pleroma.Search.DatabaseSearch, Pleroma.Search.Meilisearch]
3200 key: Pleroma.Search.Meilisearch,
3202 description: "Meilisearch settings.",
3207 description: "Meilisearch URL.",
3208 suggestion: ["http://127.0.0.1:7700/"]
3214 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3218 key: :initial_indexing_chunk_size,
3221 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3222 " since there's a limit on maximum insert size",
3223 suggestion: [100_000]
3229 key: Pleroma.Search.Elasticsearch.Cluster,
3231 description: "Elasticsearch settings.",
3236 description: "Elasticsearch URL.",
3237 suggestion: ["http://127.0.0.1:9200/"]
3242 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3243 suggestion: ["elastic"]
3248 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3249 suggestion: ["changeme"]
3255 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3256 suggestion: [Elasticsearch.API.HTTP]
3262 "The JSON module used to encode/decode when communicating with Elasticsearch",
3268 description: "The indices to set up in Elasticsearch",
3273 description: "Config for the index to use for activities",
3279 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3280 suggestion: ["priv/es-mappings/activity.json"]
3285 description: "The internal store module",
3286 suggestion: [Pleroma.Search.Elasticsearch.Store]
3290 type: {:list, :module},
3291 description: "The internal types to use for this index",
3292 suggestion: [[Pleroma.Activity]]
3295 key: :bulk_page_size,
3297 description: "Size for bulk put requests, mostly used on building the index",
3301 key: :bulk_wait_interval,
3303 description: "Time to wait between bulk put requests (in ms)",
3304 suggestion: [15_000]