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 "List of ActivityPub instances where private (DMs, followers-only) 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 and chats)"
957 description: "Welcome messages settings",
960 key: :direct_message,
962 descpiption: "Direct message settings",
967 description: "Enables sending a direct message to newly registered users"
972 description: "A message that will be sent to newly registered users",
974 "Hi, @username! Welcome on board!"
978 key: :sender_nickname,
980 description: "The nickname of the local user that sends a welcome message",
990 descpiption: "Chat message settings",
995 description: "Enables sending a chat message to newly registered users"
1001 "A message that will be sent to newly registered users as a chat message",
1003 "Hello, welcome on board!"
1007 key: :sender_nickname,
1009 description: "The nickname of the local user that sends a welcome chat message",
1019 descpiption: "Email message settings",
1024 description: "Enables sending an email to newly registered users"
1028 type: [:string, :tuple],
1030 "Email address and/or nickname that will be used to send the welcome email.",
1032 {"Pleroma App", "welcome@pleroma.app"}
1039 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1040 suggestions: ["Welcome to <%= instance_name%>"]
1046 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1047 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1053 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1054 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1063 description: "Logger-related settings",
1067 type: [:atom, :tuple, :module],
1069 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1070 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1078 label: "ExSyslogger",
1079 description: "ExSyslogger-related settings",
1083 type: {:dropdown, :atom},
1084 description: "Log level",
1085 suggestions: [:debug, :info, :warn, :error]
1091 "A string that's prepended to every message, and is typically set to the app name",
1092 suggestions: ["pleroma"]
1097 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1098 suggestions: ["$metadata[$level] $message"]
1102 type: {:list, :atom},
1103 suggestions: [:request_id]
1111 label: "Console Logger",
1112 description: "Console logger settings",
1116 type: {:dropdown, :atom},
1117 description: "Log level",
1118 suggestions: [:debug, :info, :warn, :error]
1123 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1124 suggestions: ["$metadata[$level] $message"]
1128 type: {:list, :atom},
1129 suggestions: [:request_id]
1136 label: "Quack Logger",
1137 description: "Quack-related settings",
1141 type: {:dropdown, :atom},
1142 description: "Log level",
1143 suggestions: [:debug, :info, :warn, :error]
1147 type: {:list, :atom},
1148 description: "Configure which metadata you want to report on",
1165 label: "Webhook URL",
1167 description: "Configure the Slack incoming webhook",
1168 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1174 key: :frontend_configurations,
1177 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1178 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1179 "add your own configuration your settings all fields must be complete.",
1183 label: "Pleroma FE",
1185 description: "Settings for Pleroma FE",
1188 alwaysShowSubjectInput: true,
1189 background: "/static/aurora_borealis.jpg",
1190 collapseMessageWithSubject: false,
1192 hideFilteredStatuses: false,
1193 hideMutedPosts: false,
1194 hidePostStats: false,
1195 hideSitename: false,
1196 hideUserStats: false,
1197 loginMethod: "password",
1198 logo: "/static/logo.svg",
1201 minimalScopesMode: false,
1202 noAttachmentLinks: false,
1203 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1204 postContentType: "text/plain",
1205 redirectRootLogin: "/main/friends",
1206 redirectRootNoLogin: "/main/all",
1208 sidebarRight: false,
1209 showFeaturesPanel: true,
1210 showInstanceSpecificPanel: false,
1211 subjectLineBehavior: "email",
1212 theme: "pleroma-dark",
1213 webPushNotifications: false
1218 key: :alwaysShowSubjectInput,
1219 label: "Always show subject input",
1221 description: "When disabled, auto-hide the subject field if it's empty"
1225 type: {:string, :image},
1227 "URL of the background, unless viewing a user profile with a background that is set",
1228 suggestions: ["/images/city.jpg"]
1231 key: :collapseMessageWithSubject,
1232 label: "Collapse message with subject",
1235 "When a message has a subject (aka Content Warning), collapse it by default"
1241 description: "Enables green text on lines prefixed with the > character"
1244 key: :hideFilteredStatuses,
1245 label: "Hide Filtered Statuses",
1247 description: "Hides filtered statuses from timelines"
1250 key: :hideMutedPosts,
1251 label: "Hide Muted Posts",
1253 description: "Hides muted statuses from timelines"
1256 key: :hidePostStats,
1257 label: "Hide post stats",
1259 description: "Hide notices statistics (repeats, favorites, ...)"
1263 label: "Hide Sitename",
1265 description: "Hides instance name from PleromaFE banner"
1268 key: :hideUserStats,
1269 label: "Hide user stats",
1272 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1276 type: {:string, :image},
1277 description: "URL of the logo, defaults to Pleroma's logo",
1278 suggestions: ["/static/logo.svg"]
1282 label: "Logo margin",
1285 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1286 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1287 suggestions: [".1em"]
1294 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1295 "If you want a colorful logo you must disable logoMask."
1298 key: :minimalScopesMode,
1299 label: "Minimal scopes mode",
1302 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1303 "Also prevents replying to a DM with a public post from PleromaFE."
1306 key: :nsfwCensorImage,
1307 label: "NSFW Censor Image",
1308 type: {:string, :image},
1310 "URL of the image to use for hiding NSFW media attachments in the timeline",
1311 suggestions: ["/static/img/nsfw.74818f9.png"]
1314 key: :postContentType,
1315 label: "Post Content Type",
1316 type: {:dropdown, :atom},
1317 description: "Default post formatting option",
1318 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1321 key: :redirectRootNoLogin,
1322 label: "Redirect root no login",
1325 "Relative URL which indicates where to redirect when a user isn't logged in",
1326 suggestions: ["/main/all"]
1329 key: :redirectRootLogin,
1330 label: "Redirect root login",
1333 "Relative URL which indicates where to redirect when a user is logged in",
1334 suggestions: ["/main/friends"]
1338 label: "Scope copy",
1340 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1344 label: "Sidebar on Right",
1346 description: "Change alignment of sidebar and panels to the right"
1349 key: :showFeaturesPanel,
1350 label: "Show instance features panel",
1353 "Enables panel displaying functionality of the instance on the About page"
1356 key: :showInstanceSpecificPanel,
1357 label: "Show instance specific panel",
1359 description: "Whether to show the instance's custom panel"
1362 key: :subjectLineBehavior,
1363 label: "Subject line behavior",
1365 description: "Allows changing the default behaviour of subject lines in replies.
1366 `email`: copy and preprend re:, as in email,
1367 `masto`: copy verbatim, as in Mastodon,
1368 `noop`: don't copy the subject.",
1369 suggestions: ["email", "masto", "noop"]
1374 description: "Which theme to use. Available themes are defined in styles.json",
1375 suggestions: ["pleroma-dark"]
1383 description: "Settings for Masto FE",
1386 showInstanceSpecificPanel: true
1391 key: :showInstanceSpecificPanel,
1392 label: "Show instance specific panel",
1394 description: "Whenether to show the instance's specific panel"
1405 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1409 type: {:keyword, :map},
1411 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1414 url: "/images/pleroma-fox-tan-smol.png",
1415 mime_type: "image/png"
1417 pleroma_fox_tan_shy: %{
1418 url: "/images/pleroma-fox-tan-shy.png",
1419 mime_type: "image/png"
1424 key: :default_mascot,
1427 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1433 key: :default_user_avatar,
1434 type: {:string, :image},
1435 description: "URL of the default user avatar",
1436 suggestions: ["/images/avi.png"]
1445 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1449 type: {:list, :map},
1450 description: "Describe the icons of the app",
1453 src: "/static/logo.png"
1456 src: "/static/icon.png",
1460 src: "/static/icon.ico",
1461 sizes: "72x72 96x96 128x128 256x256"
1468 description: "Describe the theme color of the app",
1469 suggestions: ["#282c37", "mediumpurple"]
1472 key: :background_color,
1474 description: "Describe the background color of the app",
1475 suggestions: ["#191b22", "aliceblue"]
1483 description: "Media proxy",
1488 description: "Enables proxying of remote media via the instance's proxy"
1495 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1496 suggestions: ["https://example.com"]
1504 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1510 description: "Enables media cache object invalidation."
1515 description: "Module which will be used to purge objects from the cache.",
1517 Pleroma.Web.MediaProxy.Invalidation.Script,
1518 Pleroma.Web.MediaProxy.Invalidation.Http
1525 label: "Advanced MediaProxy Options",
1527 description: "Internal Pleroma.ReverseProxy settings",
1529 redirect_on_failure: false,
1530 max_body_length: 25 * 1_048_576,
1531 max_read_duration: 30_000
1535 key: :redirect_on_failure,
1538 Redirects the client to the origin server upon encountering HTTP errors.\n
1539 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1540 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1541 IP addresses of your users to the other servers, bypassing the MediaProxy.
1545 key: :max_body_length,
1548 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1551 key: :max_read_duration,
1553 description: "Timeout (in milliseconds) of GET request to the remote URI."
1559 type: {:list, :string},
1560 description: "List of hosts with scheme to bypass the MediaProxy",
1561 suggestions: ["http://example.com"]
1567 key: :media_preview_proxy,
1569 description: "Media preview proxy",
1575 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1578 key: :thumbnail_max_width,
1581 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1584 key: :thumbnail_max_height,
1587 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1590 key: :image_quality,
1592 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1595 key: :min_content_length,
1598 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1604 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1606 description: "HTTP invalidate settings",
1611 description: "HTTP method of request. Default: :purge"
1615 type: {:keyword, :string},
1616 description: "HTTP headers of request",
1617 suggestions: [{"x-refresh", 1}]
1622 description: "Request options",
1626 type: {:map, :string}
1634 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1636 description: "Invalidation script settings",
1641 description: "Path to executable script which will purge cached items.",
1642 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1646 label: "URL Format",
1649 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1650 suggestions: [":htcacheclean"]
1658 description: "Gopher settings",
1663 description: "Enables the gopher interface"
1669 description: "IP address to bind to",
1670 suggestions: [{0, 0, 0, 0}]
1675 description: "Port to bind to",
1681 description: "Port advertised in URLs (optional, defaults to port)",
1689 label: "ActivityPub",
1691 description: "ActivityPub-related settings",
1694 key: :unfollow_blocked,
1696 description: "Whether blocks result in people getting unfollowed"
1699 key: :outgoing_blocks,
1701 description: "Whether to federate blocks to other instances"
1704 key: :blockers_visible,
1706 description: "Whether a user can see someone who has blocked them"
1709 key: :sign_object_fetches,
1711 description: "Sign object fetches with HTTP signatures"
1714 key: :note_replies_output_limit,
1717 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1720 key: :follow_handshake_timeout,
1722 description: "Following handshake timeout",
1729 key: :http_security,
1730 label: "HTTP security",
1732 description: "HTTP security settings",
1737 description: "Whether the managed content security policy is enabled"
1743 description: "Whether to additionally send a Strict-Transport-Security header"
1747 label: "STS max age",
1749 description: "The maximum age for the Strict-Transport-Security header if sent",
1750 suggestions: [31_536_000]
1754 label: "CT max age",
1756 description: "The maximum age for the Expect-CT header if sent",
1757 suggestions: [2_592_000]
1760 key: :referrer_policy,
1762 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1763 suggestions: ["same-origin", "no-referrer"]
1767 label: "Report URI",
1769 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1770 suggestions: ["https://example.com/report-uri"]
1775 group: :web_push_encryption,
1776 key: :vapid_details,
1777 label: "Vapid Details",
1780 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1786 "A mailto link for the administrative contact." <>
1787 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1788 suggestions: ["mailto:moderators@pleroma.com"]
1793 description: "VAPID public key",
1794 suggestions: ["Public key"]
1799 description: "VAPID private key",
1800 suggestions: ["Private key"]
1806 key: Pleroma.Captcha,
1808 description: "Captcha-related settings",
1813 description: "Whether the captcha should be shown on registration"
1818 description: "The method/service to use for captcha",
1819 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1822 key: :seconds_valid,
1824 description: "The time in seconds for which the captcha is valid",
1831 key: Pleroma.Captcha.Kocaptcha,
1834 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1835 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1840 description: "The kocaptcha endpoint to use",
1841 suggestions: ["https://captcha.kotobank.ch"]
1847 label: "Pleroma Admin Token",
1850 "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)",
1855 description: "Admin token",
1857 "Please use a high entropy string or UUID"
1867 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1871 type: {:dropdown, :atom},
1872 description: "Logs verbose mode",
1873 suggestions: [false, :error, :warn, :info, :debug]
1877 type: {:keyword, :integer},
1879 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1881 activity_expiration: 10,
1882 attachments_cleanup: 5,
1884 federator_incoming: 50,
1885 federator_outgoing: 50,
1887 scheduled_activities: 10,
1893 key: :activity_expiration,
1895 description: "Activity expiration queue",
1901 description: "Backup queue",
1905 key: :attachments_cleanup,
1907 description: "Attachment deletion queue",
1913 description: "Background queue",
1917 key: :federator_incoming,
1919 description: "Incoming federation queue",
1923 key: :federator_outgoing,
1925 description: "Outgoing federation queue",
1931 description: "Email sender queue, see Pleroma.Emails.Mailer",
1935 key: :scheduled_activities,
1937 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1941 key: :transmogrifier,
1943 description: "Transmogrifier queue",
1949 description: "Web push notifications queue",
1956 type: {:list, :tuple},
1957 description: "Settings for cron background jobs",
1959 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1960 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1969 description: "Includes custom worker options not interpretable directly by `Oban`",
1973 type: {:keyword, :integer},
1974 description: "Max retry attempts for failed jobs, per `Oban` queue",
1976 federator_incoming: 5,
1977 federator_outgoing: 5
1984 key: Pleroma.Web.Metadata,
1986 description: "Metadata-related settings",
1990 type: {:list, :module},
1991 description: "List of metadata providers to enable",
1993 Pleroma.Web.Metadata.Providers.OpenGraph,
1994 Pleroma.Web.Metadata.Providers.TwitterCard,
1995 Pleroma.Web.Metadata.Providers.RelMe,
1996 Pleroma.Web.Metadata.Providers.Feed
2001 label: "Unfurl NSFW",
2003 description: "When enabled NSFW attachments will be shown in previews"
2012 "If enabled the instance will parse metadata from attached links to generate link previews",
2017 description: "Enables RichMedia parsing of URLs"
2021 type: {:list, :string},
2022 description: "List of hosts which will be ignored by the metadata parser",
2023 suggestions: ["accounts.google.com", "xss.website"]
2027 label: "Ignore TLD",
2028 type: {:list, :string},
2029 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2030 suggestions: ["local", "localdomain", "lan"]
2034 type: {:list, :module},
2036 "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.",
2038 Pleroma.Web.RichMedia.Parsers.OEmbed,
2039 Pleroma.Web.RichMedia.Parsers.TwitterCard
2044 label: "TTL setters",
2045 type: {:list, :module},
2047 "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.",
2049 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2053 key: :failure_backoff,
2056 "Amount of milliseconds after request failure, during which the request will not be retried.",
2057 suggestions: [60_000]
2063 key: Pleroma.Formatter,
2067 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2071 type: [:string, :boolean],
2072 description: "Specify the class to be added to the generated link. Disable to clear.",
2073 suggestions: ["auto-linker", false]
2077 type: [:string, :boolean],
2078 description: "Override the rel attribute. Disable to clear.",
2079 suggestions: ["ugc", "noopener noreferrer", false]
2084 description: "Link URLs will open in a new window/tab."
2088 type: [:integer, :boolean],
2090 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2091 suggestions: [15, false]
2096 description: "Strip the scheme prefix."
2101 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2105 type: [:atom, :boolean],
2107 "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)",
2108 suggestions: [:no_scheme, true]
2114 key: Pleroma.ScheduledActivity,
2116 description: "Scheduled activities settings",
2119 key: :daily_user_limit,
2122 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2126 key: :total_user_limit,
2129 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2135 description: "Whether scheduled activities are sent to the job queue to be executed"
2141 key: Pleroma.Workers.PurgeExpiredActivity,
2143 description: "Expired activities settings",
2148 description: "Enables expired activities addition & deletion"
2153 description: "Minimum lifetime for ephemeral activity (in seconds)",
2160 label: "Pleroma Authenticator",
2162 description: "Authenticator",
2165 key: Pleroma.Web.Auth.Authenticator,
2167 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2177 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2178 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2179 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2180 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2185 description: "Enables LDAP authentication"
2190 description: "LDAP server hostname",
2191 suggestions: ["localhosts"]
2196 description: "LDAP port, e.g. 389 or 636",
2197 suggestions: [389, 636]
2203 description: "Enable to use SSL, usually implies the port 636"
2207 label: "SSL options",
2209 description: "Additional SSL 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]
2230 description: "Enable to use STARTTLS, usually implies the port 389"
2234 label: "TLS options",
2236 description: "Additional TLS options",
2237 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2242 description: "Path to file with PEM encoded cacerts",
2243 suggestions: ["path/to/file/with/PEM/cacerts"]
2248 description: "Type of cert verification",
2249 suggestions: [:verify_peer]
2256 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2257 suggestions: ["dc=example,dc=com"]
2264 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2273 description: "Authentication / authorization settings",
2276 key: :enforce_oauth_admin_scope_usage,
2277 label: "Enforce OAuth admin scope usage",
2280 "OAuth admin scope requirement toggle. " <>
2281 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2282 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2283 "`is_admin` user flag grants access to admin-specific actions."
2286 key: :auth_template,
2289 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2290 suggestions: ["show.html"]
2293 key: :oauth_consumer_template,
2294 label: "OAuth consumer template",
2297 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2298 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2299 suggestions: ["consumer.html"]
2302 key: :oauth_consumer_strategies,
2303 label: "OAuth consumer strategies",
2304 type: {:list, :string},
2306 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2307 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2308 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2309 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2315 key: :email_notifications,
2317 description: "Email notifications settings",
2323 "emails of \"what you've missed\" for users who have been inactive for a while",
2327 schedule: "0 0 * * 0",
2329 inactivity_threshold: 7
2337 description: "Globally enable or disable digest emails"
2343 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2344 suggestions: ["0 0 * * 0"]
2349 description: "Minimum interval between digest emails to one user",
2353 key: :inactivity_threshold,
2355 description: "Minimum user inactivity threshold",
2364 key: Pleroma.Emails.UserEmail,
2366 description: "Email template settings",
2370 type: {:string, :image},
2371 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2372 suggestions: ["some/path/logo.png"]
2377 description: "A map with color settings for email templates.",
2380 link_color: "#d8a070",
2381 background_color: "#2C3645",
2382 content_background_color: "#1B2635",
2383 header_color: "#d8a070",
2384 text_color: "#b9b9ba",
2385 text_muted_color: "#b9b9ba"
2392 suggestions: ["#d8a070"]
2395 key: :background_color,
2397 suggestions: ["#2C3645"]
2400 key: :content_background_color,
2402 suggestions: ["#1B2635"]
2407 suggestions: ["#d8a070"]
2412 suggestions: ["#b9b9ba"]
2415 key: :text_muted_color,
2417 suggestions: ["#b9b9ba"]
2425 key: Pleroma.Emails.NewUsersDigestEmail,
2427 description: "New users admin email digest",
2432 description: "Enables new users admin digest email when `true`"
2441 description: "Configure OAuth 2 provider capabilities",
2444 key: :token_expires_in,
2446 description: "The lifetime in seconds of the access token",
2447 suggestions: [2_592_000]
2450 key: :issue_new_refresh_token,
2453 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2456 key: :clean_expired_tokens,
2458 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2468 key: :shortcode_globs,
2469 type: {:list, :string},
2470 description: "Location of custom emoji files. * can be used as a wildcard.",
2471 suggestions: ["/emoji/custom/**/*.png"]
2474 key: :pack_extensions,
2475 type: {:list, :string},
2477 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2478 suggestions: [".png", ".gif"]
2482 type: {:keyword, {:list, :string}},
2484 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2485 " and the value is the location or array of locations. * can be used as a wildcard.",
2487 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2491 key: :default_manifest,
2494 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2495 " Currently only one manifest can be added (no arrays).",
2496 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2499 key: :shared_pack_cache_seconds_per_file,
2500 label: "Shared pack cache s/file",
2503 "When an emoji pack is shared, the archive is created and cached in memory" <>
2504 " for this amount of seconds multiplied by the number of files.",
2514 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2518 type: [:tuple, {:list, :tuple}],
2519 description: "For the search requests (account & status search etc.)",
2520 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2524 type: [:tuple, {:list, :tuple}],
2525 description: "For requests to timelines (each timeline has it's own limiter)",
2526 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2529 key: :app_account_creation,
2530 type: [:tuple, {:list, :tuple}],
2531 description: "For registering user accounts from the same IP address",
2532 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2535 key: :relations_actions,
2536 type: [:tuple, {:list, :tuple}],
2537 description: "For actions on relationships with all users (follow, unfollow)",
2538 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2541 key: :relation_id_action,
2542 label: "Relation ID action",
2543 type: [:tuple, {:list, :tuple}],
2544 description: "For actions on relation with a specific user (follow, unfollow)",
2545 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2548 key: :statuses_actions,
2549 type: [:tuple, {:list, :tuple}],
2551 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2552 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2555 key: :status_id_action,
2556 label: "Status ID action",
2557 type: [:tuple, {:list, :tuple}],
2559 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2560 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2563 key: :authentication,
2564 type: [:tuple, {:list, :tuple}],
2565 description: "For authentication create / password check / user existence check requests",
2566 suggestions: [{60_000, 15}]
2575 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2576 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2581 description: "Enables SSH"
2586 description: "Dir with SSH keys",
2587 suggestions: ["/some/path/ssh_keys"]
2592 description: "Handler module",
2593 suggestions: ["Pleroma.BBS.Handler"]
2598 description: "Port to connect",
2599 suggestions: [10_022]
2602 key: :password_authenticator,
2604 description: "Authenticator module",
2605 suggestions: ["Pleroma.BBS.Authenticator"]
2611 label: "Mime Types",
2613 description: "Mime Types settings",
2620 "application/xml" => ["xml"],
2621 "application/xrd+xml" => ["xrd+xml"],
2622 "application/jrd+json" => ["jrd+json"],
2623 "application/activity+json" => ["activity+json"],
2624 "application/ld+json" => ["activity+json"]
2629 key: "application/xml",
2630 type: {:list, :string},
2631 suggestions: ["xml"]
2634 key: "application/xrd+xml",
2635 type: {:list, :string},
2636 suggestions: ["xrd+xml"]
2639 key: "application/jrd+json",
2640 type: {:list, :string},
2641 suggestions: ["jrd+json"]
2644 key: "application/activity+json",
2645 type: {:list, :string},
2646 suggestions: ["activity+json"]
2649 key: "application/ld+json",
2650 type: {:list, :string},
2651 suggestions: ["activity+json"]
2661 description: "Pleroma shout settings",
2666 description: "Enables the backend Shoutbox chat feature."
2671 description: "Shout message character limit.",
2683 description: "HTTP settings",
2688 type: [:string, :tuple],
2689 description: "Proxy URL",
2690 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2693 key: :send_user_agent,
2698 type: [:string, :atom],
2700 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2701 suggestions: ["Pleroma", :default]
2706 description: "Adapter specific options",
2712 label: "SSL Options",
2713 description: "SSL options for HTTP adapter",
2717 type: {:list, :atom},
2718 description: "List of TLS version to use",
2719 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2730 label: "Markup Settings",
2734 key: :allow_inline_images,
2738 key: :allow_headings,
2751 type: {:list, :module},
2753 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2754 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2764 key: :deny_follow_blocked,
2775 key: :restricted_nicknames,
2776 type: {:list, :string},
2777 description: "List of nicknames users may not register with.",
2796 "ostatus_subscribe",
2812 key: :email_blacklist,
2813 type: {:list, :string},
2814 description: "List of email domains users may not register with.",
2815 suggestions: ["mailinator.com", "maildrop.cc"]
2821 label: "CORS plug config",
2827 suggestions: [86_400]
2831 type: {:list, :string},
2832 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2836 type: {:list, :string},
2839 "X-RateLimit-Reset",
2840 "X-RateLimit-Limit",
2841 "X-RateLimit-Remaining",
2852 type: {:list, :string},
2853 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2859 key: Pleroma.Web.Plugs.RemoteIp,
2862 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2863 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2869 description: "Enable/disable the plug. Default: disabled."
2873 type: {:list, :string},
2875 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2880 type: {:list, :string},
2882 "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."
2886 type: {:list, :string},
2888 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"]`
2895 key: :web_cache_ttl,
2896 label: "Web cache TTL",
2899 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2905 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2909 key: :activity_pub_question,
2911 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2912 suggestions: [30_000]
2922 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2927 description: "Enables the rendering of static HTML. Default: disabled."
2935 description: "Configure feed rendering",
2940 description: "Configure title rendering",
2945 description: "Maximum number of characters before truncating title",
2951 description: "Replacement which will be used after truncating string",
2952 suggestions: ["..."]
2960 key: :mrf_follow_bot,
2962 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2963 label: "MRF FollowBot Policy",
2965 description: "Automatically follows newly discovered accounts.",
2968 key: :follower_nickname,
2970 description: "The name of the bot account to use for following newly discovered users.",
2971 suggestions: ["followbot"]
2979 description: "Custom Runtime Modules",
2984 description: "A path to custom Elixir modules (such as MRF policies)."
2992 description: "Settings for notifications streamer",
2997 description: "Number of workers to send notifications",
3001 key: :overflow_workers,
3003 description: "Maximum number of workers created if pool is empty",
3010 key: :connections_pool,
3012 description: "Advanced settings for `Gun` connections pool",
3015 key: :connection_acquisition_wait,
3018 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3022 key: :connection_acquisition_retries,
3025 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3029 key: :max_connections,
3031 description: "Maximum number of connections in the pool. Default: 250 connections.",
3035 key: :connect_timeout,
3037 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3041 key: :reclaim_multiplier,
3044 "Multiplier for the number of idle connection to be reclaimed if the pool is full. For example if the pool maxes out at 250 connections and this setting is set to 0.3, the pool will reclaim at most 75 idle connections if it's overloaded. Default: 0.1",
3053 description: "Advanced settings for `Gun` workers pools",
3055 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3059 description: "Settings for #{pool_name} pool.",
3064 description: "Maximum number of concurrent requests in the pool.",
3071 "Maximum number of requests waiting for other requests to finish. After this number is reached, the pool will start returning errrors when a new request is made",
3077 description: "Timeout for the pool while gun will wait for response",
3078 suggestions: [10_000]
3086 key: :hackney_pools,
3088 description: "Advanced settings for `Hackney` connections pools",
3093 description: "Settings for federation pool.",
3096 key: :max_connections,
3098 description: "Number workers in the pool.",
3104 description: "Timeout while `hackney` will wait for response.",
3105 suggestions: [150_000]
3112 description: "Settings for media pool.",
3115 key: :max_connections,
3117 description: "Number workers in the pool.",
3123 description: "Timeout while `hackney` will wait for response.",
3124 suggestions: [150_000]
3131 description: "Settings for upload pool.",
3134 key: :max_connections,
3136 description: "Number workers in the pool.",
3142 description: "Timeout while `hackney` will wait for response.",
3143 suggestions: [300_000]
3151 key: :restrict_unauthenticated,
3152 label: "Restrict Unauthenticated",
3155 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3160 description: "Settings for public and federated timelines.",
3165 description: "Disallow view public timeline."
3170 description: "Disallow view federated timeline."
3177 description: "Settings for user profiles.",
3182 description: "Disallow view local user profiles."
3187 description: "Disallow view remote user profiles."
3194 description: "Settings for statuses.",
3199 description: "Disallow view local statuses."
3204 description: "Disallow view remote statuses."
3212 key: Pleroma.Web.ApiSpec.CastAndValidate,
3219 "Enables strict input validation (useful in development, not recommended in production)"
3225 key: :instances_favicons,
3227 description: "Control favicons for instances",
3232 description: "Allow/disallow displaying and getting instances favicons"
3240 descriptions: "S3 service related settings",
3243 key: :access_key_id,
3245 description: "S3 access key ID",
3246 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3249 key: :secret_access_key,
3251 description: "Secret access key",
3252 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3257 description: "S3 host",
3258 suggestions: ["s3.eu-central-1.amazonaws.com"]
3263 description: "S3 region (for AWS)",
3264 suggestions: ["us-east-1"]
3272 description: "Installed frontends management",
3277 description: "Primary frontend, the one that is served for all pages by default",
3278 children: installed_frontend_options
3283 description: "Admin frontend",
3284 children: installed_frontend_options
3290 "A map containing available frontends and parameters for their installation.",
3291 children: frontend_options
3297 key: Pleroma.Web.Preload,
3299 description: "Preload-related settings",
3303 type: {:list, :module},
3304 description: "List of preload providers to enable",
3306 Pleroma.Web.Preload.Providers.Instance,
3307 Pleroma.Web.Preload.Providers.User,
3308 Pleroma.Web.Preload.Providers.Timelines,
3309 Pleroma.Web.Preload.Providers.StatusNet
3318 description: "Majic/libmagic configuration",
3323 description: "Number of majic workers to start.",
3330 key: Pleroma.User.Backup,
3332 description: "Account Backup",
3335 key: :purge_after_days,
3337 description: "Remove backup achives after N days",
3343 description: "Limit user to export not more often than once per N days",
3350 key: Pleroma.Web.Endpoint.MetricsExporter,
3352 description: "Prometheus app metrics endpoint configuration",
3357 description: "[Pleroma extension] Enables app metrics endpoint."
3361 label: "IP Whitelist",
3362 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3363 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3367 type: [:boolean, :tuple],
3368 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3369 suggestion: [false, {:basic, "myusername", "mypassword"}]
3374 description: "App metrics endpoint URI path.",
3375 suggestions: ["/api/pleroma/app_metrics"]
3380 description: "App metrics endpoint output format.",
3381 suggestions: [:text, :protobuf]
3387 key: ConcurrentLimiter,
3389 description: "Limits configuration for background tasks.",
3392 key: Pleroma.Web.RichMedia.Helpers,
3394 description: "Concurrent limits configuration for getting RichMedia for activities.",
3395 suggestions: [max_running: 5, max_waiting: 5],
3400 description: "Max running concurrently jobs.",
3406 description: "Max waiting jobs.",
3412 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3414 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3415 suggestions: [max_running: 5, max_waiting: 5],
3420 description: "Max running concurrently jobs.",
3426 description: "Max waiting jobs.",
3435 key: Pleroma.Search,
3437 description: "General search settings.",
3442 description: "Selected search module.",
3443 suggestion: [Pleroma.Search.DatabaseSearch, Pleroma.Search.Meilisearch]
3449 key: Pleroma.Search.Meilisearch,
3451 description: "Meilisearch settings.",
3456 description: "Meilisearch URL.",
3457 suggestion: ["http://127.0.0.1:7700/"]
3463 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3467 key: :initial_indexing_chunk_size,
3470 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3471 " since there's a limit on maximum insert size",
3472 suggestion: [100_000]