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 - this is only used for mastodon-fe",
1446 suggestions: ["#282c37", "mediumpurple"]
1449 key: :background_color,
1452 "Describe the background color of the app - this is only used for mastodon-fe",
1453 suggestions: ["#191b22", "aliceblue"]
1461 description: "Media proxy",
1466 description: "Enables proxying of remote media via the instance's proxy"
1473 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1474 suggestions: ["https://example.com"]
1482 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1488 description: "Enables media cache object invalidation."
1493 description: "Module which will be used to purge objects from the cache.",
1495 Pleroma.Web.MediaProxy.Invalidation.Script,
1496 Pleroma.Web.MediaProxy.Invalidation.Http
1503 label: "Advanced MediaProxy Options",
1505 description: "Internal Pleroma.ReverseProxy settings",
1507 redirect_on_failure: false,
1508 max_body_length: 25 * 1_048_576,
1509 max_read_duration: 30_000
1513 key: :redirect_on_failure,
1516 Redirects the client to the origin server upon encountering HTTP errors.\n
1517 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1518 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1519 IP addresses of your users to the other servers, bypassing the MediaProxy.
1523 key: :max_body_length,
1526 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1529 key: :max_read_duration,
1531 description: "Timeout (in milliseconds) of GET request to the remote URI."
1537 type: {:list, :string},
1538 description: "List of hosts with scheme to bypass the MediaProxy",
1539 suggestions: ["http://example.com"]
1545 key: :media_preview_proxy,
1547 description: "Media preview proxy",
1553 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1556 key: :thumbnail_max_width,
1559 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1562 key: :thumbnail_max_height,
1565 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1568 key: :image_quality,
1570 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1573 key: :min_content_length,
1576 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1582 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1584 description: "HTTP invalidate settings",
1589 description: "HTTP method of request. Default: :purge"
1593 type: {:keyword, :string},
1594 description: "HTTP headers of request",
1595 suggestions: [{"x-refresh", 1}]
1600 description: "Request options",
1604 type: {:map, :string}
1612 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1614 description: "Invalidation script settings",
1619 description: "Path to executable script which will purge cached items.",
1620 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1624 label: "URL Format",
1627 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1628 suggestions: [":htcacheclean"]
1635 label: "ActivityPub",
1637 description: "ActivityPub-related settings",
1640 key: :unfollow_blocked,
1642 description: "Whether blocks result in people getting unfollowed"
1645 key: :outgoing_blocks,
1647 description: "Whether to federate blocks to other instances"
1650 key: :blockers_visible,
1652 description: "Whether a user can see someone who has blocked them"
1655 key: :sign_object_fetches,
1657 description: "Sign object fetches with HTTP signatures"
1660 key: :authorized_fetch_mode,
1662 description: "Require HTTP signatures on AP fetches"
1665 key: :note_replies_output_limit,
1668 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1671 key: :follow_handshake_timeout,
1673 description: "Following handshake timeout",
1677 key: :max_collection_objects,
1680 "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.",
1687 key: :http_security,
1688 label: "HTTP security",
1690 description: "HTTP security settings",
1695 description: "Whether the managed content security policy is enabled"
1701 description: "Whether to additionally send a Strict-Transport-Security header"
1705 label: "STS max age",
1707 description: "The maximum age for the Strict-Transport-Security header if sent",
1708 suggestions: [31_536_000]
1712 label: "CT max age",
1714 description: "The maximum age for the Expect-CT header if sent",
1715 suggestions: [2_592_000]
1718 key: :referrer_policy,
1720 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1721 suggestions: ["same-origin", "no-referrer"]
1725 label: "Report URI",
1727 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1728 suggestions: ["https://example.com/report-uri"]
1733 group: :web_push_encryption,
1734 key: :vapid_details,
1735 label: "Vapid Details",
1738 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1744 "A mailto link for the administrative contact." <>
1745 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1746 suggestions: ["mailto:moderators@pleroma.com"]
1751 description: "VAPID public key",
1752 suggestions: ["Public key"]
1757 description: "VAPID private key",
1758 suggestions: ["Private key"]
1764 key: Pleroma.Captcha,
1766 description: "Captcha-related settings",
1771 description: "Whether the captcha should be shown on registration"
1776 description: "The method/service to use for captcha",
1777 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1780 key: :seconds_valid,
1782 description: "The time in seconds for which the captcha is valid",
1789 key: Pleroma.Captcha.Kocaptcha,
1792 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1793 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1798 description: "The kocaptcha endpoint to use",
1799 suggestions: ["https://captcha.kotobank.ch"]
1805 label: "Pleroma Admin Token",
1808 "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)",
1813 description: "Admin token",
1815 "Please use a high entropy string or UUID"
1825 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1829 type: {:dropdown, :atom},
1830 description: "Logs verbose mode",
1831 suggestions: [false, :error, :warn, :info, :debug]
1835 type: {:keyword, :integer},
1837 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1839 activity_expiration: 10,
1840 attachments_cleanup: 5,
1842 federator_incoming: 50,
1843 federator_outgoing: 50,
1845 scheduled_activities: 10,
1851 key: :activity_expiration,
1853 description: "Activity expiration queue",
1859 description: "Backup queue",
1863 key: :attachments_cleanup,
1865 description: "Attachment deletion queue",
1871 description: "Background queue",
1875 key: :federator_incoming,
1877 description: "Incoming federation queue",
1881 key: :federator_outgoing,
1883 description: "Outgoing federation queue",
1889 description: "Email sender queue, see Pleroma.Emails.Mailer",
1893 key: :scheduled_activities,
1895 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1899 key: :transmogrifier,
1901 description: "Transmogrifier queue",
1907 description: "Web push notifications queue",
1914 type: {:list, :tuple},
1915 description: "Settings for cron background jobs",
1917 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1918 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1927 description: "Includes custom worker options not interpretable directly by `Oban`",
1931 type: {:keyword, :integer},
1932 description: "Max retry attempts for failed jobs, per `Oban` queue",
1934 federator_incoming: 5,
1935 federator_outgoing: 5
1942 key: Pleroma.Web.Metadata,
1944 description: "Metadata-related settings",
1948 type: {:list, :module},
1949 description: "List of metadata providers to enable",
1951 Pleroma.Web.Metadata.Providers.OpenGraph,
1952 Pleroma.Web.Metadata.Providers.TwitterCard,
1953 Pleroma.Web.Metadata.Providers.RelMe,
1954 Pleroma.Web.Metadata.Providers.Feed
1959 label: "Unfurl NSFW",
1961 description: "When enabled NSFW attachments will be shown in previews"
1967 key: Pleroma.Web.Metadata.Providers.Theme,
1969 description: "Specific provider to hand out themes to instances that scrape index.html",
1975 "The 'accent color' of the instance, used in places like misskey's instance ticker",
1976 suggestions: ["#593196"]
1985 "If enabled the instance will parse metadata from attached links to generate link previews",
1990 description: "Enables RichMedia parsing of URLs"
1994 type: {:list, :string},
1995 description: "List of hosts which will be ignored by the metadata parser",
1996 suggestions: ["accounts.google.com", "xss.website"]
2000 label: "Ignore TLD",
2001 type: {:list, :string},
2002 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2003 suggestions: ["local", "localdomain", "lan"]
2007 type: {:list, :module},
2009 "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.",
2011 Pleroma.Web.RichMedia.Parsers.OEmbed,
2012 Pleroma.Web.RichMedia.Parsers.TwitterCard
2017 label: "TTL setters",
2018 type: {:list, :module},
2020 "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.",
2022 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2026 key: :failure_backoff,
2029 "Amount of milliseconds after request failure, during which the request will not be retried.",
2030 suggestions: [60_000]
2036 key: Pleroma.Formatter,
2040 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2044 type: [:string, :boolean],
2045 description: "Specify the class to be added to the generated link. Disable to clear.",
2046 suggestions: ["auto-linker", false]
2050 type: [:string, :boolean],
2051 description: "Override the rel attribute. Disable to clear.",
2052 suggestions: ["ugc", "noopener noreferrer", false]
2057 description: "Link URLs will open in a new window/tab."
2061 type: [:integer, :boolean],
2063 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2064 suggestions: [15, false]
2069 description: "Strip the scheme prefix."
2074 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2078 type: [:atom, :boolean],
2080 "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)",
2081 suggestions: [:no_scheme, true]
2087 key: Pleroma.ScheduledActivity,
2089 description: "Scheduled activities settings",
2092 key: :daily_user_limit,
2095 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2099 key: :total_user_limit,
2102 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2108 description: "Whether scheduled activities are sent to the job queue to be executed"
2114 key: Pleroma.Workers.PurgeExpiredActivity,
2116 description: "Expired activities settings",
2121 description: "Enables expired activities addition & deletion"
2126 description: "Minimum lifetime for ephemeral activity (in seconds)",
2133 label: "Pleroma Authenticator",
2135 description: "Authenticator",
2138 key: Pleroma.Web.Auth.Authenticator,
2140 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2150 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2151 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2152 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2153 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2158 description: "Enables LDAP authentication"
2163 description: "LDAP server hostname",
2164 suggestions: ["localhosts"]
2169 description: "LDAP port, e.g. 389 or 636",
2170 suggestions: [389, 636]
2176 description: "Enable to use SSL, usually implies the port 636"
2180 label: "SSL options",
2182 description: "Additional SSL options",
2183 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2188 description: "Path to file with PEM encoded cacerts",
2189 suggestions: ["path/to/file/with/PEM/cacerts"]
2194 description: "Type of cert verification",
2195 suggestions: [:verify_peer]
2203 description: "Enable to use STARTTLS, usually implies the port 389"
2207 label: "TLS options",
2209 description: "Additional TLS options",
2210 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2215 description: "Path to file with PEM encoded cacerts",
2216 suggestions: ["path/to/file/with/PEM/cacerts"]
2221 description: "Type of cert verification",
2222 suggestions: [:verify_peer]
2229 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2230 suggestions: ["dc=example,dc=com"]
2237 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2246 description: "Authentication / authorization settings",
2249 key: :enforce_oauth_admin_scope_usage,
2250 label: "Enforce OAuth admin scope usage",
2253 "OAuth admin scope requirement toggle. " <>
2254 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2255 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2256 "`is_admin` user flag grants access to admin-specific actions."
2259 key: :auth_template,
2262 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2263 suggestions: ["show.html"]
2266 key: :oauth_consumer_template,
2267 label: "OAuth consumer template",
2270 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2271 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2272 suggestions: ["consumer.html"]
2275 key: :oauth_consumer_strategies,
2276 label: "OAuth consumer strategies",
2277 type: {:list, :string},
2279 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2280 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2281 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2282 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2288 key: :email_notifications,
2290 description: "Email notifications settings",
2296 "emails of \"what you've missed\" for users who have been inactive for a while",
2300 schedule: "0 0 * * 0",
2302 inactivity_threshold: 7
2310 description: "Globally enable or disable digest emails"
2316 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2317 suggestions: ["0 0 * * 0"]
2322 description: "Minimum interval between digest emails to one user",
2326 key: :inactivity_threshold,
2328 description: "Minimum user inactivity threshold",
2337 key: Pleroma.Emails.UserEmail,
2339 description: "Email template settings",
2343 type: {:string, :image},
2344 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2345 suggestions: ["some/path/logo.png"]
2350 description: "A map with color settings for email templates.",
2353 link_color: "#d8a070",
2354 background_color: "#2C3645",
2355 content_background_color: "#1B2635",
2356 header_color: "#d8a070",
2357 text_color: "#b9b9ba",
2358 text_muted_color: "#b9b9ba"
2365 suggestions: ["#d8a070"]
2368 key: :background_color,
2370 suggestions: ["#2C3645"]
2373 key: :content_background_color,
2375 suggestions: ["#1B2635"]
2380 suggestions: ["#d8a070"]
2385 suggestions: ["#b9b9ba"]
2388 key: :text_muted_color,
2390 suggestions: ["#b9b9ba"]
2398 key: Pleroma.Emails.NewUsersDigestEmail,
2400 description: "New users admin email digest",
2405 description: "Enables new users admin digest email when `true`"
2414 description: "Configure OAuth 2 provider capabilities",
2417 key: :token_expires_in,
2419 description: "The lifetime in seconds of the access token",
2420 suggestions: [2_592_000]
2423 key: :issue_new_refresh_token,
2426 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2429 key: :clean_expired_tokens,
2431 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2441 key: :shortcode_globs,
2442 type: {:list, :string},
2443 description: "Location of custom emoji files. * can be used as a wildcard.",
2444 suggestions: ["/emoji/custom/**/*.png"]
2447 key: :pack_extensions,
2448 type: {:list, :string},
2450 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2451 suggestions: [".png", ".gif"]
2455 type: {:keyword, {:list, :string}},
2457 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2458 " and the value is the location or array of locations. * can be used as a wildcard.",
2460 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2464 key: :default_manifest,
2467 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2468 " Currently only one manifest can be added (no arrays).",
2469 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2472 key: :shared_pack_cache_seconds_per_file,
2473 label: "Shared pack cache s/file",
2476 "When an emoji pack is shared, the archive is created and cached in memory" <>
2477 " for this amount of seconds multiplied by the number of files.",
2487 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2491 type: [:tuple, {:list, :tuple}],
2492 description: "For the search requests (account & status search etc.)",
2493 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2497 type: [:tuple, {:list, :tuple}],
2498 description: "For requests to timelines (each timeline has it's own limiter)",
2499 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2502 key: :app_account_creation,
2503 type: [:tuple, {:list, :tuple}],
2504 description: "For registering user accounts from the same IP address",
2505 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2508 key: :relations_actions,
2509 type: [:tuple, {:list, :tuple}],
2510 description: "For actions on relationships with all users (follow, unfollow)",
2511 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2514 key: :relation_id_action,
2515 label: "Relation ID action",
2516 type: [:tuple, {:list, :tuple}],
2517 description: "For actions on relation with a specific user (follow, unfollow)",
2518 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2521 key: :statuses_actions,
2522 type: [:tuple, {:list, :tuple}],
2524 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2525 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2528 key: :status_id_action,
2529 label: "Status ID action",
2530 type: [:tuple, {:list, :tuple}],
2532 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2533 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2536 key: :authentication,
2537 type: [:tuple, {:list, :tuple}],
2538 description: "For authentication create / password check / user existence check requests",
2539 suggestions: [{60_000, 15}]
2545 label: "Mime Types",
2547 description: "Mime Types settings",
2554 "application/xml" => ["xml"],
2555 "application/xrd+xml" => ["xrd+xml"],
2556 "application/jrd+json" => ["jrd+json"],
2557 "application/activity+json" => ["activity+json"],
2558 "application/ld+json" => ["activity+json"]
2563 key: "application/xml",
2564 type: {:list, :string},
2565 suggestions: ["xml"]
2568 key: "application/xrd+xml",
2569 type: {:list, :string},
2570 suggestions: ["xrd+xml"]
2573 key: "application/jrd+json",
2574 type: {:list, :string},
2575 suggestions: ["jrd+json"]
2578 key: "application/activity+json",
2579 type: {:list, :string},
2580 suggestions: ["activity+json"]
2583 key: "application/ld+json",
2584 type: {:list, :string},
2585 suggestions: ["activity+json"]
2596 description: "HTTP settings",
2603 "Proxy URL - of the format http://host:port. Advise setting in .exs instead of admin-fe due to this being set at boot-time.",
2604 suggestions: ["http://localhost:3128"]
2608 type: [:string, :atom],
2610 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2611 suggestions: ["Pleroma", :default]
2616 description: "Adapter specific options",
2622 label: "SSL Options",
2623 description: "SSL options for HTTP adapter",
2627 type: {:list, :atom},
2628 description: "List of TLS version to use",
2629 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2640 label: "Markup Settings",
2644 key: :allow_inline_images,
2648 key: :allow_headings,
2661 type: {:list, :module},
2663 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2664 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2674 key: :deny_follow_blocked,
2685 key: :restricted_nicknames,
2686 type: {:list, :string},
2687 description: "List of nicknames users may not register with.",
2706 "ostatus_subscribe",
2722 key: :email_blacklist,
2723 type: {:list, :string},
2724 description: "List of email domains users may not register with.",
2725 suggestions: ["mailinator.com", "maildrop.cc"]
2731 label: "CORS plug config",
2737 suggestions: [86_400]
2741 type: {:list, :string},
2742 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2746 type: {:list, :string},
2749 "X-RateLimit-Reset",
2750 "X-RateLimit-Limit",
2751 "X-RateLimit-Remaining",
2762 type: {:list, :string},
2763 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2769 key: Pleroma.Web.Plugs.RemoteIp,
2772 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2773 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2779 description: "Enable/disable the plug. Default: disabled."
2783 type: {:list, :string},
2785 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2790 type: {:list, :string},
2792 "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."
2796 type: {:list, :string},
2798 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"]`
2805 key: :web_cache_ttl,
2806 label: "Web cache TTL",
2809 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2815 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2819 key: :activity_pub_question,
2821 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2822 suggestions: [30_000]
2832 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2837 description: "Enables the rendering of static HTML. Default: disabled."
2845 description: "Configure feed rendering",
2850 description: "Configure title rendering",
2855 description: "Maximum number of characters before truncating title",
2861 description: "Replacement which will be used after truncating string",
2862 suggestions: ["..."]
2870 key: :mrf_follow_bot,
2872 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2873 label: "MRF FollowBot Policy",
2875 description: "Automatically follows newly discovered accounts.",
2878 key: :follower_nickname,
2880 description: "The name of the bot account to use for following newly discovered users.",
2881 suggestions: ["followbot"]
2889 description: "Custom Runtime Modules",
2894 description: "A path to custom Elixir modules (such as MRF policies)."
2902 description: "Settings for notifications streamer",
2907 description: "Number of workers to send notifications",
2911 key: :overflow_workers,
2913 description: "Maximum number of workers created if pool is empty",
2920 key: :restrict_unauthenticated,
2921 label: "Restrict Unauthenticated",
2924 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
2929 description: "Settings for public and federated timelines.",
2934 description: "Disallow view public timeline."
2939 description: "Disallow view federated timeline."
2946 description: "Settings for user profiles.",
2951 description: "Disallow view local user profiles."
2956 description: "Disallow view remote user profiles."
2963 description: "Settings for statuses.",
2968 description: "Disallow view local statuses."
2973 description: "Disallow view remote statuses."
2981 key: Pleroma.Web.ApiSpec.CastAndValidate,
2988 "Enables strict input validation (useful in development, not recommended in production)"
2994 key: :instances_favicons,
2996 description: "Control favicons for instances",
3001 description: "Allow/disallow displaying and getting instances favicons"
3009 descriptions: "S3 service related settings",
3012 key: :access_key_id,
3014 description: "S3 access key ID",
3015 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3018 key: :secret_access_key,
3020 description: "Secret access key",
3021 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3026 description: "S3 host",
3027 suggestions: ["s3.eu-central-1.amazonaws.com"]
3032 description: "S3 region (for AWS)",
3033 suggestions: ["us-east-1"]
3041 description: "Installed frontends management",
3046 description: "Primary frontend, the one that is served for all pages by default",
3047 children: installed_frontend_options
3052 description: "Admin frontend",
3053 children: installed_frontend_options
3058 description: "Mastodon frontend",
3059 children: installed_frontend_options
3064 description: "Swagger API reference frontend",
3066 installed_frontend_options ++
3072 description: "Whether to have this enabled at all"
3080 "A map containing available frontends and parameters for their installation.",
3081 children: frontend_options
3087 key: Pleroma.Web.Preload,
3089 description: "Preload-related settings",
3093 type: {:list, :module},
3094 description: "List of preload providers to enable",
3096 Pleroma.Web.Preload.Providers.Instance,
3097 Pleroma.Web.Preload.Providers.User,
3098 Pleroma.Web.Preload.Providers.Timelines,
3099 Pleroma.Web.Preload.Providers.StatusNet
3108 description: "Majic/libmagic configuration",
3113 description: "Number of majic workers to start.",
3120 key: Pleroma.User.Backup,
3122 description: "Account Backup",
3125 key: :purge_after_days,
3127 description: "Remove backup achives after N days",
3133 description: "Limit user to export not more often than once per N days",
3140 key: ConcurrentLimiter,
3142 description: "Limits configuration for background tasks.",
3145 key: Pleroma.Web.RichMedia.Helpers,
3147 description: "Concurrent limits configuration for getting RichMedia for activities.",
3148 suggestions: [max_running: 5, max_waiting: 5],
3153 description: "Max running concurrently jobs.",
3159 description: "Max waiting jobs.",
3165 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3167 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3168 suggestions: [max_running: 5, max_waiting: 5],
3173 description: "Max running concurrently jobs.",
3179 description: "Max waiting jobs.",
3188 key: Pleroma.Search,
3190 description: "General search settings.",
3195 description: "Selected search module.",
3196 suggestion: [Pleroma.Search.DatabaseSearch, Pleroma.Search.Meilisearch]
3202 key: Pleroma.Search.Meilisearch,
3204 description: "Meilisearch settings.",
3209 description: "Meilisearch URL.",
3210 suggestion: ["http://127.0.0.1:7700/"]
3216 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3220 key: :initial_indexing_chunk_size,
3223 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3224 " since there's a limit on maximum insert size",
3225 suggestion: [100_000]
3231 key: Pleroma.Search.Elasticsearch.Cluster,
3233 description: "Elasticsearch settings.",
3238 description: "Elasticsearch URL.",
3239 suggestion: ["http://127.0.0.1:9200/"]
3244 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3245 suggestion: ["elastic"]
3250 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3251 suggestion: ["changeme"]
3257 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3258 suggestion: [Elasticsearch.API.HTTP]
3264 "The JSON module used to encode/decode when communicating with Elasticsearch",
3270 description: "The indices to set up in Elasticsearch",
3275 description: "Config for the index to use for activities",
3281 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3282 suggestion: ["priv/es-mappings/activity.json"]
3287 description: "The internal store module",
3288 suggestion: [Pleroma.Search.Elasticsearch.Store]
3292 type: {:list, :module},
3293 description: "The internal types to use for this index",
3294 suggestion: [[Pleroma.Activity]]
3297 key: :bulk_page_size,
3299 description: "Size for bulk put requests, mostly used on building the index",
3303 key: :bulk_wait_interval,
3305 description: "Time to wait between bulk put requests (in ms)",
3306 suggestion: [15_000]