6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
105 "https://cdn-host.com"
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
117 key: :filename_display_max_length,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
125 key: Pleroma.Uploaders.Local,
127 description: "Local uploader-related settings",
132 description: "Path where user's uploads will be saved",
141 key: Pleroma.Uploaders.S3,
143 description: "S3 uploader-related settings",
148 description: "S3 bucket",
154 key: :bucket_namespace,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
160 key: :truncated_namespace,
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
167 key: :streaming_enabled,
170 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
176 key: Pleroma.Upload.Filter.Mogrify,
178 description: "Uploads mogrify filter settings",
182 type: [:string, {:list, :string}, {:list, :tuple}],
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
198 description: "Filter replaces the filename of the upload",
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
207 "custom-file-name.{extension}"
214 key: Pleroma.Emails.Mailer,
216 description: "Mailer-related settings",
220 label: "Mailer Enabled",
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
229 Swoosh.Adapters.AmazonSES,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
244 group: {:subgroup, Swoosh.Adapters.SMTP},
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
251 group: {:subgroup, Swoosh.Adapters.SMTP},
254 description: "SMTP port",
255 suggestions: ["1025"]
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "Use Implicit SSL/TLS. e.g. port 465"
279 group: {:subgroup, Swoosh.Adapters.SMTP},
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
287 group: {:subgroup, Swoosh.Adapters.SMTP},
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "SMTP temporary (4xx) error retries",
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 label: "SendGrid API Key",
306 suggestions: ["YOUR_API_KEY"]
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
323 label: "Qmail compat mode",
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
329 label: "Mandrill API Key",
331 suggestions: ["YOUR_API_KEY"]
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
336 label: "Mailgun API Key",
338 suggestions: ["YOUR_API_KEY"]
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
344 suggestions: ["YOUR_DOMAIN_NAME"]
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
349 label: "MailJet Public API Key",
351 suggestions: ["MJ_APIKEY_PUBLIC"]
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
356 label: "MailJet Private API Key",
358 suggestions: ["MJ_APIKEY_PRIVATE"]
361 group: {:subgroup, Swoosh.Adapters.Postmark},
363 label: "Postmark API Key",
365 suggestions: ["X-Postmark-Server-Token"]
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
370 label: "SparkPost API key",
372 suggestions: ["YOUR_API_KEY"]
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 suggestions: ["https://api.sparkpost.com/api/v1"]
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
383 label: "AWS Access Key",
385 suggestions: ["AWS_ACCESS_KEY"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
390 label: "AWS Secret Key",
392 suggestions: ["AWS_SECRET_KEY"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 suggestions: ["us-east-1", "us-east-2"]
402 group: {:subgroup, Swoosh.Adapters.Dyn},
404 label: "Dyn API Key",
406 suggestions: ["apikey"]
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
411 label: "SocketLabs API Key",
413 suggestions: ["INJECTION_API_KEY"]
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 suggestions: ["SERVER_ID"]
423 group: {:subgroup, Swoosh.Adapters.Gmail},
425 label: "GMail API Access Token",
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
434 label: "URI Schemes",
436 description: "URI schemes related settings",
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
466 description: "Customizable features",
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
479 key: :populate_hashtags_table,
481 description: "`populate_hashtags_table` background migration settings",
484 key: :fault_rate_allowance,
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
491 key: :sleep_interval_ms,
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
502 description: "Instance-related settings",
507 description: "Name of the instance",
514 type: {:list, :string},
515 description: "Languages the instance uses",
524 label: "Admin Email Address",
526 description: "Email used to reach an Administrator/Moderator of the instance",
533 label: "Sender Email Address",
535 description: "Envelope FROM address for mail sent via Pleroma",
544 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
552 description: "Posts character limit (CW/Subject included in the counter)",
560 description: "Hard character limit beyond which remote posts will be dropped",
568 description: "File size limit of uploads (except for avatar, background, banner)",
574 key: :avatar_upload_limit,
576 description: "File size limit of user's profile avatars",
582 key: :background_upload_limit,
584 description: "File size limit of user's profile backgrounds",
590 key: :banner_upload_limit,
592 description: "File size limit of user's profile banners",
600 description: "A map with poll limits for local polls",
604 max_option_chars: 200,
606 max_expiration: 31_536_000
613 description: "Maximum number of options",
617 key: :max_option_chars,
619 description: "Maximum number of characters per option",
623 key: :min_expiration,
625 description: "Minimum expiration time (in seconds)",
629 key: :max_expiration,
631 description: "Maximum expiration time (in seconds)",
637 key: :registrations_open,
640 "Enable registrations for anyone. Invitations require this setting to be disabled."
643 key: :invites_enabled,
646 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
649 key: :account_activation_required,
651 description: "Require users to confirm their emails before signing in"
654 key: :account_approval_required,
656 description: "Require users to be manually approved by an admin before signing in"
661 description: "Enable federation with other instances"
664 key: :federation_incoming_replies_max_depth,
665 label: "Fed. incoming replies max depth",
668 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
669 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
675 key: :federation_reachability_timeout_days,
676 label: "Fed. reachability timeout days",
679 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
688 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
694 "Makes the client API in authenticated mode-only except for user-profiles." <>
695 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
696 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
699 key: :quarantined_instances,
700 type: {:list, :tuple},
701 key_placeholder: "instance",
702 value_placeholder: "reason",
704 "(Deprecated, will be removed in next release) List of ActivityPub instances where activities will not be sent, and the reason for doing so",
706 {"quarantined.com", "Reason"},
707 {"*.quarantined.com", "Reason"}
713 description: "Instance static directory",
719 key: :allowed_post_formats,
720 type: {:list, :string},
721 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
730 key: :extended_nickname_format,
733 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
734 " This will break federation with older software for theses nicknames."
737 key: :cleanup_attachments,
740 Enable to remove associated attachments when status is removed.
741 This will not affect duplicates and attachments without status.
742 Enabling this will increase load to database when deleting statuses on larger instances.
746 key: :max_pinned_statuses,
748 description: "The maximum number of pinned statuses. 0 will disable the feature.",
756 key: :autofollowed_nicknames,
757 type: {:list, :string},
759 "Set to nicknames of (local) users that every new user should automatically follow"
762 key: :autofollowing_nicknames,
763 type: {:list, :string},
765 "Set to nicknames of (local) users that automatically follows every newly registered user"
768 key: :attachment_links,
770 description: "Enable to automatically add attachment link text to statuses"
773 key: :max_report_comment_size,
775 description: "The maximum size of the report comment. Default: 1000.",
781 key: :safe_dm_mentions,
782 label: "Safe DM mentions",
785 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
786 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
792 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
795 key: :remote_post_retention_days,
798 "The default amount of days to retain remote posts when pruning the database",
804 key: :user_bio_length,
806 description: "A user bio maximum length. Default: 5000.",
812 key: :user_name_length,
814 description: "A user name maximum length. Default: 100.",
820 key: :skip_thread_containment,
822 description: "Skip filtering out broken threads. Default: enabled."
825 key: :limit_to_local_content,
826 type: {:dropdown, :atom},
828 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
836 key: :max_account_fields,
838 description: "The maximum number of custom fields in the user profile. Default: 10.",
844 key: :max_remote_account_fields,
847 "The maximum number of custom fields in the remote user profile. Default: 20.",
853 key: :account_field_name_length,
855 description: "An account field name maximum length. Default: 512.",
861 key: :account_field_value_length,
863 description: "An account field value maximum length. Default: 2048.",
869 key: :registration_reason_length,
871 description: "Maximum registration reason length. Default: 500.",
877 key: :external_user_synchronization,
879 description: "Enabling following/followers counters synchronization for external users"
882 key: :multi_factor_authentication,
884 description: "Multi-factor authentication settings",
887 totp: [digits: 6, period: 30],
888 backup_codes: [number: 5, length: 16]
894 label: "TOTP settings",
896 description: "TOTP settings",
897 suggestions: [digits: 6, period: 30],
904 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
911 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
918 description: "MFA backup codes settings",
919 suggestions: [number: 5, length: 16],
925 description: "Number of backup codes to generate."
932 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
939 key: :instance_thumbnail,
940 type: {:string, :image},
942 "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.",
943 suggestions: ["/instance/thumbnail.jpeg"]
946 key: :show_reactions,
948 description: "Let favourites and emoji reactions be viewed through the API."
951 key: :profile_directory,
953 description: "Enable profile directory."
956 key: :privileged_staff,
959 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses)"
963 type: {:list, :string},
965 "List of instances that make up your local bubble (closely-related instances). Used to populate the 'bubble' timeline (domain only)."
973 description: "Welcome messages settings",
976 key: :direct_message,
978 descpiption: "Direct message settings",
983 description: "Enables sending a direct message to newly registered users"
988 description: "A message that will be sent to newly registered users",
990 "Hi, @username! Welcome on board!"
994 key: :sender_nickname,
996 description: "The nickname of the local user that sends a welcome message",
1006 descpiption: "Email message settings",
1011 description: "Enables sending an email to newly registered users"
1015 type: [:string, :tuple],
1017 "Email address and/or nickname that will be used to send the welcome email.",
1019 {"Pleroma App", "welcome@pleroma.app"}
1026 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1027 suggestions: ["Welcome to <%= instance_name%>"]
1033 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1034 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1040 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1041 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1050 description: "Logger-related settings",
1054 type: [:atom, :tuple, :module],
1056 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1057 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1065 label: "ExSyslogger",
1066 description: "ExSyslogger-related settings",
1070 type: {:dropdown, :atom},
1071 description: "Log level",
1072 suggestions: [:debug, :info, :warn, :error]
1078 "A string that's prepended to every message, and is typically set to the app name",
1079 suggestions: ["pleroma"]
1084 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1085 suggestions: ["$metadata[$level] $message"]
1089 type: {:list, :atom},
1090 suggestions: [:request_id]
1098 label: "Console Logger",
1099 description: "Console logger settings",
1103 type: {:dropdown, :atom},
1104 description: "Log level",
1105 suggestions: [:debug, :info, :warn, :error]
1110 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1111 suggestions: ["$metadata[$level] $message"]
1115 type: {:list, :atom},
1116 suggestions: [:request_id]
1123 label: "Quack Logger",
1124 description: "Quack-related settings",
1128 type: {:dropdown, :atom},
1129 description: "Log level",
1130 suggestions: [:debug, :info, :warn, :error]
1134 type: {:list, :atom},
1135 description: "Configure which metadata you want to report on",
1152 label: "Webhook URL",
1154 description: "Configure the Slack incoming webhook",
1155 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1161 key: :frontend_configurations,
1164 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1165 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1166 "add your own configuration your settings all fields must be complete.",
1170 label: "Pleroma FE",
1172 description: "Settings for Pleroma FE",
1175 alwaysShowSubjectInput: true,
1176 background: "/static/aurora_borealis.jpg",
1177 collapseMessageWithSubject: false,
1179 hideFilteredStatuses: false,
1180 hideMutedPosts: false,
1181 hidePostStats: false,
1182 hideUserStats: false,
1183 loginMethod: "password",
1184 logo: "/static/logo.svg",
1187 minimalScopesMode: false,
1188 noAttachmentLinks: false,
1189 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1190 postContentType: "text/plain",
1191 redirectRootLogin: "/main/friends",
1192 redirectRootNoLogin: "/main/all",
1194 sidebarRight: false,
1195 showFeaturesPanel: true,
1196 showInstanceSpecificPanel: false,
1197 subjectLineBehavior: "email",
1198 theme: "pleroma-dark",
1199 webPushNotifications: false
1204 key: :alwaysShowSubjectInput,
1205 label: "Always show subject input",
1207 description: "When disabled, auto-hide the subject field if it's empty"
1211 type: {:string, :image},
1213 "URL of the background, unless viewing a user profile with a background that is set",
1214 suggestions: ["/images/city.jpg"]
1217 key: :collapseMessageWithSubject,
1218 label: "Collapse message with subject",
1221 "When a message has a subject (aka Content Warning), collapse it by default"
1227 description: "Enables green text on lines prefixed with the > character"
1230 key: :hideFilteredStatuses,
1231 label: "Hide Filtered Statuses",
1233 description: "Hides filtered statuses from timelines"
1236 key: :hideMutedPosts,
1237 label: "Hide Muted Posts",
1239 description: "Hides muted statuses from timelines"
1242 key: :hidePostStats,
1243 label: "Hide post stats",
1245 description: "Hide notices statistics (repeats, favorites, ...)"
1248 key: :hideUserStats,
1249 label: "Hide user stats",
1252 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1256 type: {:string, :image},
1257 description: "URL of the logo, defaults to Pleroma's logo",
1258 suggestions: ["/static/logo.svg"]
1262 label: "Logo margin",
1265 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1266 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1267 suggestions: [".1em"]
1274 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1275 "If you want a colorful logo you must disable logoMask."
1278 key: :minimalScopesMode,
1279 label: "Minimal scopes mode",
1282 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1283 "Also prevents replying to a DM with a public post from PleromaFE."
1286 key: :nsfwCensorImage,
1287 label: "NSFW Censor Image",
1288 type: {:string, :image},
1290 "URL of the image to use for hiding NSFW media attachments in the timeline",
1291 suggestions: ["/static/img/nsfw.74818f9.png"]
1294 key: :postContentType,
1295 label: "Post Content Type",
1296 type: {:dropdown, :atom},
1297 description: "Default post formatting option",
1298 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1301 key: :redirectRootNoLogin,
1302 label: "Redirect root no login",
1305 "Relative URL which indicates where to redirect when a user isn't logged in",
1306 suggestions: ["/main/all"]
1309 key: :redirectRootLogin,
1310 label: "Redirect root login",
1313 "Relative URL which indicates where to redirect when a user is logged in",
1314 suggestions: ["/main/friends"]
1318 label: "Scope copy",
1320 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1324 label: "Sidebar on Right",
1326 description: "Change alignment of sidebar and panels to the right"
1329 key: :showFeaturesPanel,
1330 label: "Show instance features panel",
1333 "Enables panel displaying functionality of the instance on the About page"
1336 key: :showInstanceSpecificPanel,
1337 label: "Show instance specific panel",
1339 description: "Whether to show the instance's custom panel"
1342 key: :subjectLineBehavior,
1343 label: "Subject line behavior",
1345 description: "Allows changing the default behaviour of subject lines in replies.
1346 `email`: copy and preprend re:, as in email,
1347 `masto`: copy verbatim, as in Mastodon,
1348 `noop`: don't copy the subject.",
1349 suggestions: ["email", "masto", "noop"]
1354 description: "Which theme to use. Available themes are defined in styles.json",
1355 suggestions: ["pleroma-dark"]
1358 key: :showPanelNavShortcuts,
1359 label: "Show timeline panel nav shortcuts",
1361 description: "Whether to put timeline nav tabs on the top of the panel"
1364 key: :showNavShortcuts,
1365 label: "Show navbar shortcuts",
1367 description: "Whether to put extra navigation options on the navbar"
1370 key: :showWiderShortcuts,
1371 label: "Increase navbar shortcut spacing",
1373 description: "Whether to add extra space between navbar icons"
1376 key: :hideSiteFavicon,
1377 label: "Hide site favicon",
1379 description: "Whether to hide the instance favicon from the navbar"
1383 label: "Hide site name",
1385 description: "Whether to hide the site name from the navbar"
1388 key: :renderMisskeyMarkdown,
1389 label: "Render misskey markdown",
1391 description: "Whether to render Misskey-flavoured markdown"
1399 description: "Settings for Masto FE",
1402 showInstanceSpecificPanel: true
1407 key: :showInstanceSpecificPanel,
1408 label: "Show instance specific panel",
1410 description: "Whenether to show the instance's specific panel"
1421 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1425 type: {:keyword, :map},
1427 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1430 url: "/images/pleroma-fox-tan-smol.png",
1431 mime_type: "image/png"
1433 pleroma_fox_tan_shy: %{
1434 url: "/images/pleroma-fox-tan-shy.png",
1435 mime_type: "image/png"
1440 key: :default_mascot,
1443 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1449 key: :default_user_avatar,
1450 type: {:string, :image},
1451 description: "URL of the default user avatar",
1452 suggestions: ["/images/avi.png"]
1461 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1465 type: {:list, :map},
1466 description: "Describe the icons of the app",
1469 src: "/static/logo.png"
1472 src: "/static/icon.png",
1476 src: "/static/icon.ico",
1477 sizes: "72x72 96x96 128x128 256x256"
1484 description: "Describe the theme color of the app - this is only used for mastodon-fe",
1485 suggestions: ["#282c37", "mediumpurple"]
1488 key: :background_color,
1491 "Describe the background color of the app - this is only used for mastodon-fe",
1492 suggestions: ["#191b22", "aliceblue"]
1500 description: "Media proxy",
1505 description: "Enables proxying of remote media via the instance's proxy"
1512 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1513 suggestions: ["https://example.com"]
1521 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1527 description: "Enables media cache object invalidation."
1532 description: "Module which will be used to purge objects from the cache.",
1534 Pleroma.Web.MediaProxy.Invalidation.Script,
1535 Pleroma.Web.MediaProxy.Invalidation.Http
1542 label: "Advanced MediaProxy Options",
1544 description: "Internal Pleroma.ReverseProxy settings",
1546 redirect_on_failure: false,
1547 max_body_length: 25 * 1_048_576,
1548 max_read_duration: 30_000
1552 key: :redirect_on_failure,
1555 Redirects the client to the origin server upon encountering HTTP errors.\n
1556 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1557 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1558 IP addresses of your users to the other servers, bypassing the MediaProxy.
1562 key: :max_body_length,
1565 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1568 key: :max_read_duration,
1570 description: "Timeout (in milliseconds) of GET request to the remote URI."
1576 type: {:list, :string},
1577 description: "List of hosts with scheme to bypass the MediaProxy",
1578 suggestions: ["http://example.com"]
1584 key: :media_preview_proxy,
1586 description: "Media preview proxy",
1592 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1595 key: :thumbnail_max_width,
1598 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1601 key: :thumbnail_max_height,
1604 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1607 key: :image_quality,
1609 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1612 key: :min_content_length,
1615 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1621 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1623 description: "HTTP invalidate settings",
1628 description: "HTTP method of request. Default: :purge"
1632 type: {:keyword, :string},
1633 description: "HTTP headers of request",
1634 suggestions: [{"x-refresh", 1}]
1639 description: "Request options",
1643 type: {:map, :string}
1651 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1653 description: "Invalidation script settings",
1658 description: "Path to executable script which will purge cached items.",
1659 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1663 label: "URL Format",
1666 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1667 suggestions: [":htcacheclean"]
1674 label: "ActivityPub",
1676 description: "ActivityPub-related settings",
1679 key: :unfollow_blocked,
1681 description: "Whether blocks result in people getting unfollowed"
1684 key: :outgoing_blocks,
1686 description: "Whether to federate blocks to other instances"
1689 key: :blockers_visible,
1691 description: "Whether a user can see someone who has blocked them"
1694 key: :sign_object_fetches,
1696 description: "Sign object fetches with HTTP signatures"
1699 key: :authorized_fetch_mode,
1701 description: "Require HTTP signatures on AP fetches"
1704 key: :note_replies_output_limit,
1707 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1710 key: :follow_handshake_timeout,
1712 description: "Following handshake timeout",
1716 key: :max_collection_objects,
1719 "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.",
1726 key: :http_security,
1727 label: "HTTP security",
1729 description: "HTTP security settings",
1734 description: "Whether the managed content security policy is enabled"
1740 description: "Whether to additionally send a Strict-Transport-Security header"
1744 label: "STS max age",
1746 description: "The maximum age for the Strict-Transport-Security header if sent",
1747 suggestions: [31_536_000]
1751 label: "CT max age",
1753 description: "The maximum age for the Expect-CT header if sent",
1754 suggestions: [2_592_000]
1757 key: :referrer_policy,
1759 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1760 suggestions: ["same-origin", "no-referrer"]
1764 label: "Report URI",
1766 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1767 suggestions: ["https://example.com/report-uri"]
1772 group: :web_push_encryption,
1773 key: :vapid_details,
1774 label: "Vapid Details",
1777 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1783 "A mailto link for the administrative contact." <>
1784 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1785 suggestions: ["mailto:moderators@pleroma.com"]
1790 description: "VAPID public key",
1791 suggestions: ["Public key"]
1796 description: "VAPID private key",
1797 suggestions: ["Private key"]
1803 key: Pleroma.Captcha,
1805 description: "Captcha-related settings",
1810 description: "Whether the captcha should be shown on registration"
1815 description: "The method/service to use for captcha",
1816 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1819 key: :seconds_valid,
1821 description: "The time in seconds for which the captcha is valid",
1828 key: Pleroma.Captcha.Kocaptcha,
1831 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1832 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1837 description: "The kocaptcha endpoint to use",
1838 suggestions: ["https://captcha.kotobank.ch"]
1844 label: "Pleroma Admin Token",
1847 "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)",
1852 description: "Admin token",
1854 "Please use a high entropy string or UUID"
1864 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1868 type: {:dropdown, :atom},
1869 description: "Logs verbose mode",
1870 suggestions: [false, :error, :warn, :info, :debug]
1874 type: {:keyword, :integer},
1876 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1878 activity_expiration: 10,
1879 attachments_cleanup: 5,
1881 federator_incoming: 50,
1882 federator_outgoing: 50,
1884 scheduled_activities: 10,
1890 key: :activity_expiration,
1892 description: "Activity expiration queue",
1898 description: "Backup queue",
1902 key: :attachments_cleanup,
1904 description: "Attachment deletion queue",
1910 description: "Background queue",
1914 key: :federator_incoming,
1916 description: "Incoming federation queue",
1920 key: :federator_outgoing,
1922 description: "Outgoing federation queue",
1928 description: "Email sender queue, see Pleroma.Emails.Mailer",
1932 key: :scheduled_activities,
1934 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1938 key: :transmogrifier,
1940 description: "Transmogrifier queue",
1946 description: "Web push notifications queue",
1953 type: {:list, :tuple},
1954 description: "Settings for cron background jobs",
1956 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1957 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1966 description: "Includes custom worker options not interpretable directly by `Oban`",
1970 type: {:keyword, :integer},
1971 description: "Max retry attempts for failed jobs, per `Oban` queue",
1973 federator_incoming: 5,
1974 federator_outgoing: 5
1981 key: Pleroma.Web.Metadata,
1983 description: "Metadata-related settings",
1987 type: {:list, :module},
1988 description: "List of metadata providers to enable",
1990 Pleroma.Web.Metadata.Providers.OpenGraph,
1991 Pleroma.Web.Metadata.Providers.TwitterCard,
1992 Pleroma.Web.Metadata.Providers.RelMe,
1993 Pleroma.Web.Metadata.Providers.Feed
1998 label: "Unfurl NSFW",
2000 description: "When enabled NSFW attachments will be shown in previews"
2006 key: Pleroma.Web.Metadata.Providers.Theme,
2008 description: "Specific provider to hand out themes to instances that scrape index.html",
2014 "The 'accent color' of the instance, used in places like misskey's instance ticker",
2015 suggestions: ["#593196"]
2024 "If enabled the instance will parse metadata from attached links to generate link previews",
2029 description: "Enables RichMedia parsing of URLs"
2033 type: {:list, :string},
2034 description: "List of hosts which will be ignored by the metadata parser",
2035 suggestions: ["accounts.google.com", "xss.website"]
2039 label: "Ignore TLD",
2040 type: {:list, :string},
2041 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2042 suggestions: ["local", "localdomain", "lan"]
2046 type: {:list, :module},
2048 "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.",
2050 Pleroma.Web.RichMedia.Parsers.OEmbed,
2051 Pleroma.Web.RichMedia.Parsers.TwitterCard
2056 label: "TTL setters",
2057 type: {:list, :module},
2059 "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.",
2061 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2065 key: :failure_backoff,
2068 "Amount of milliseconds after request failure, during which the request will not be retried.",
2069 suggestions: [60_000]
2075 key: Pleroma.Formatter,
2079 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2083 type: [:string, :boolean],
2084 description: "Specify the class to be added to the generated link. Disable to clear.",
2085 suggestions: ["auto-linker", false]
2089 type: [:string, :boolean],
2090 description: "Override the rel attribute. Disable to clear.",
2091 suggestions: ["ugc", "noopener noreferrer", false]
2096 description: "Link URLs will open in a new window/tab."
2100 type: [:integer, :boolean],
2102 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2103 suggestions: [15, false]
2108 description: "Strip the scheme prefix."
2113 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2117 type: [:atom, :boolean],
2119 "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)",
2120 suggestions: [:no_scheme, true]
2126 key: Pleroma.ScheduledActivity,
2128 description: "Scheduled activities settings",
2131 key: :daily_user_limit,
2134 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2138 key: :total_user_limit,
2141 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2147 description: "Whether scheduled activities are sent to the job queue to be executed"
2153 key: Pleroma.Workers.PurgeExpiredActivity,
2155 description: "Expired activities settings",
2160 description: "Enables expired activities addition & deletion"
2165 description: "Minimum lifetime for ephemeral activity (in seconds)",
2172 label: "Pleroma Authenticator",
2174 description: "Authenticator",
2177 key: Pleroma.Web.Auth.Authenticator,
2179 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2189 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2190 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2191 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2192 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2197 description: "Enables LDAP authentication"
2202 description: "LDAP server hostname",
2203 suggestions: ["localhosts"]
2208 description: "LDAP port, e.g. 389 or 636",
2209 suggestions: [389, 636]
2215 description: "Enable to use SSL, usually implies the port 636"
2219 label: "SSL options",
2221 description: "Additional SSL options",
2222 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2227 description: "Path to file with PEM encoded cacerts",
2228 suggestions: ["path/to/file/with/PEM/cacerts"]
2233 description: "Type of cert verification",
2234 suggestions: [:verify_peer]
2242 description: "Enable to use STARTTLS, usually implies the port 389"
2246 label: "TLS options",
2248 description: "Additional TLS options",
2249 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2254 description: "Path to file with PEM encoded cacerts",
2255 suggestions: ["path/to/file/with/PEM/cacerts"]
2260 description: "Type of cert verification",
2261 suggestions: [:verify_peer]
2268 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2269 suggestions: ["dc=example,dc=com"]
2276 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2285 description: "Authentication / authorization settings",
2288 key: :enforce_oauth_admin_scope_usage,
2289 label: "Enforce OAuth admin scope usage",
2292 "OAuth admin scope requirement toggle. " <>
2293 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2294 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2295 "`is_admin` user flag grants access to admin-specific actions."
2298 key: :auth_template,
2301 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2302 suggestions: ["show.html"]
2305 key: :oauth_consumer_template,
2306 label: "OAuth consumer template",
2309 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2310 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2311 suggestions: ["consumer.html"]
2314 key: :oauth_consumer_strategies,
2315 label: "OAuth consumer strategies",
2316 type: {:list, :string},
2318 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2319 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2320 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2321 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2327 key: :email_notifications,
2329 description: "Email notifications settings",
2335 "emails of \"what you've missed\" for users who have been inactive for a while",
2339 schedule: "0 0 * * 0",
2341 inactivity_threshold: 7
2349 description: "Globally enable or disable digest emails"
2355 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2356 suggestions: ["0 0 * * 0"]
2361 description: "Minimum interval between digest emails to one user",
2365 key: :inactivity_threshold,
2367 description: "Minimum user inactivity threshold",
2376 key: Pleroma.Emails.UserEmail,
2378 description: "Email template settings",
2382 type: {:string, :image},
2383 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2384 suggestions: ["some/path/logo.png"]
2389 description: "A map with color settings for email templates.",
2392 link_color: "#d8a070",
2393 background_color: "#2C3645",
2394 content_background_color: "#1B2635",
2395 header_color: "#d8a070",
2396 text_color: "#b9b9ba",
2397 text_muted_color: "#b9b9ba"
2404 suggestions: ["#d8a070"]
2407 key: :background_color,
2409 suggestions: ["#2C3645"]
2412 key: :content_background_color,
2414 suggestions: ["#1B2635"]
2419 suggestions: ["#d8a070"]
2424 suggestions: ["#b9b9ba"]
2427 key: :text_muted_color,
2429 suggestions: ["#b9b9ba"]
2437 key: Pleroma.Emails.NewUsersDigestEmail,
2439 description: "New users admin email digest",
2444 description: "Enables new users admin digest email when `true`"
2453 description: "Configure OAuth 2 provider capabilities",
2456 key: :token_expires_in,
2458 description: "The lifetime in seconds of the access token",
2459 suggestions: [2_592_000]
2462 key: :issue_new_refresh_token,
2465 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2468 key: :clean_expired_tokens,
2470 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2480 key: :shortcode_globs,
2481 type: {:list, :string},
2482 description: "Location of custom emoji files. * can be used as a wildcard.",
2483 suggestions: ["/emoji/custom/**/*.png"]
2486 key: :pack_extensions,
2487 type: {:list, :string},
2489 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2490 suggestions: [".png", ".gif"]
2494 type: {:keyword, {:list, :string}},
2496 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2497 " and the value is the location or array of locations. * can be used as a wildcard.",
2499 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2503 key: :default_manifest,
2506 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2507 " Currently only one manifest can be added (no arrays).",
2508 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2511 key: :shared_pack_cache_seconds_per_file,
2512 label: "Shared pack cache s/file",
2515 "When an emoji pack is shared, the archive is created and cached in memory" <>
2516 " for this amount of seconds multiplied by the number of files.",
2526 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2530 type: [:tuple, {:list, :tuple}],
2531 description: "For the search requests (account & status search etc.)",
2532 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2536 type: [:tuple, {:list, :tuple}],
2537 description: "For requests to timelines (each timeline has it's own limiter)",
2538 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2541 key: :app_account_creation,
2542 type: [:tuple, {:list, :tuple}],
2543 description: "For registering user accounts from the same IP address",
2544 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2547 key: :relations_actions,
2548 type: [:tuple, {:list, :tuple}],
2549 description: "For actions on relationships with all users (follow, unfollow)",
2550 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2553 key: :relation_id_action,
2554 label: "Relation ID action",
2555 type: [:tuple, {:list, :tuple}],
2556 description: "For actions on relation with a specific user (follow, unfollow)",
2557 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2560 key: :statuses_actions,
2561 type: [:tuple, {:list, :tuple}],
2563 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2564 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2567 key: :status_id_action,
2568 label: "Status ID action",
2569 type: [:tuple, {:list, :tuple}],
2571 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2572 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2575 key: :authentication,
2576 type: [:tuple, {:list, :tuple}],
2577 description: "For authentication create / password check / user existence check requests",
2578 suggestions: [{60_000, 15}]
2584 label: "Mime Types",
2586 description: "Mime Types settings",
2593 "application/xml" => ["xml"],
2594 "application/xrd+xml" => ["xrd+xml"],
2595 "application/jrd+json" => ["jrd+json"],
2596 "application/activity+json" => ["activity+json"],
2597 "application/ld+json" => ["activity+json"]
2602 key: "application/xml",
2603 type: {:list, :string},
2604 suggestions: ["xml"]
2607 key: "application/xrd+xml",
2608 type: {:list, :string},
2609 suggestions: ["xrd+xml"]
2612 key: "application/jrd+json",
2613 type: {:list, :string},
2614 suggestions: ["jrd+json"]
2617 key: "application/activity+json",
2618 type: {:list, :string},
2619 suggestions: ["activity+json"]
2622 key: "application/ld+json",
2623 type: {:list, :string},
2624 suggestions: ["activity+json"]
2635 description: "HTTP settings",
2642 "Proxy URL - of the format http://host:port. Advise setting in .exs instead of admin-fe due to this being set at boot-time.",
2643 suggestions: ["http://localhost:3128"]
2647 type: [:string, :atom],
2649 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2650 suggestions: ["Pleroma", :default]
2655 description: "Adapter specific options",
2661 label: "SSL Options",
2662 description: "SSL options for HTTP adapter",
2666 type: {:list, :atom},
2667 description: "List of TLS version to use",
2668 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2679 label: "Markup Settings",
2683 key: :allow_inline_images,
2687 key: :allow_headings,
2700 type: {:list, :module},
2702 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2703 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2713 key: :deny_follow_blocked,
2724 key: :restricted_nicknames,
2725 type: {:list, :string},
2726 description: "List of nicknames users may not register with.",
2745 "ostatus_subscribe",
2761 key: :email_blacklist,
2762 type: {:list, :string},
2763 description: "List of email domains users may not register with.",
2764 suggestions: ["mailinator.com", "maildrop.cc"]
2770 label: "CORS plug config",
2776 suggestions: [86_400]
2780 type: {:list, :string},
2781 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2785 type: {:list, :string},
2788 "X-RateLimit-Reset",
2789 "X-RateLimit-Limit",
2790 "X-RateLimit-Remaining",
2801 type: {:list, :string},
2802 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2808 key: Pleroma.Web.Plugs.RemoteIp,
2811 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2812 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2818 description: "Enable/disable the plug. Default: disabled."
2822 type: {:list, :string},
2824 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2829 type: {:list, :string},
2831 "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."
2835 type: {:list, :string},
2837 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"]`
2844 key: :web_cache_ttl,
2845 label: "Web cache TTL",
2848 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2854 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2858 key: :activity_pub_question,
2860 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2861 suggestions: [30_000]
2871 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2876 description: "Enables the rendering of static HTML. Default: disabled."
2884 description: "Configure feed rendering",
2889 description: "Configure title rendering",
2894 description: "Maximum number of characters before truncating title",
2900 description: "Replacement which will be used after truncating string",
2901 suggestions: ["..."]
2909 key: :mrf_follow_bot,
2911 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2912 label: "MRF FollowBot Policy",
2914 description: "Automatically follows newly discovered accounts.",
2917 key: :follower_nickname,
2919 description: "The name of the bot account to use for following newly discovered users.",
2920 suggestions: ["followbot"]
2928 description: "Custom Runtime Modules",
2933 description: "A path to custom Elixir modules (such as MRF policies)."
2941 description: "Settings for notifications streamer",
2946 description: "Number of workers to send notifications",
2950 key: :overflow_workers,
2952 description: "Maximum number of workers created if pool is empty",
2959 key: :restrict_unauthenticated,
2960 label: "Restrict Unauthenticated",
2963 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
2968 description: "Settings for public and federated timelines.",
2973 description: "Disallow view public timeline."
2978 description: "Disallow view federated timeline."
2985 description: "Settings for user profiles.",
2990 description: "Disallow view local user profiles."
2995 description: "Disallow view remote user profiles."
3002 description: "Settings for statuses.",
3007 description: "Disallow view local statuses."
3012 description: "Disallow view remote statuses."
3020 key: Pleroma.Web.ApiSpec.CastAndValidate,
3027 "Enables strict input validation (useful in development, not recommended in production)"
3033 key: :instances_favicons,
3035 description: "Control favicons for instances",
3040 description: "Allow/disallow displaying and getting instances favicons"
3048 descriptions: "S3 service related settings",
3051 key: :access_key_id,
3053 description: "S3 access key ID",
3054 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3057 key: :secret_access_key,
3059 description: "Secret access key",
3060 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3065 description: "S3 host",
3066 suggestions: ["s3.eu-central-1.amazonaws.com"]
3071 description: "S3 region (for AWS)",
3072 suggestions: ["us-east-1"]
3080 description: "Installed frontends management",
3085 description: "Primary frontend, the one that is served for all pages by default",
3086 children: installed_frontend_options
3091 description: "Admin frontend",
3092 children: installed_frontend_options
3097 description: "Mastodon frontend",
3098 children: installed_frontend_options
3103 description: "Swagger API reference frontend",
3105 installed_frontend_options ++
3111 description: "Whether to have this enabled at all"
3119 "A map containing available frontends and parameters for their installation.",
3120 children: frontend_options
3126 key: Pleroma.Web.Preload,
3128 description: "Preload-related settings",
3132 type: {:list, :module},
3133 description: "List of preload providers to enable",
3135 Pleroma.Web.Preload.Providers.Instance,
3136 Pleroma.Web.Preload.Providers.User,
3137 Pleroma.Web.Preload.Providers.Timelines,
3138 Pleroma.Web.Preload.Providers.StatusNet
3147 description: "Majic/libmagic configuration",
3152 description: "Number of majic workers to start.",
3159 key: Pleroma.User.Backup,
3161 description: "Account Backup",
3164 key: :purge_after_days,
3166 description: "Remove backup achives after N days",
3172 description: "Limit user to export not more often than once per N days",
3179 key: ConcurrentLimiter,
3181 description: "Limits configuration for background tasks.",
3184 key: Pleroma.Web.RichMedia.Helpers,
3186 description: "Concurrent limits configuration for getting RichMedia for activities.",
3187 suggestions: [max_running: 5, max_waiting: 5],
3192 description: "Max running concurrently jobs.",
3198 description: "Max waiting jobs.",
3204 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3206 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3207 suggestions: [max_running: 5, max_waiting: 5],
3212 description: "Max running concurrently jobs.",
3218 description: "Max waiting jobs.",
3227 key: Pleroma.Search,
3230 description: "General search settings.",
3235 description: "Selected search module.",
3236 suggestions: {:list_behaviour_implementations, Pleroma.Search.SearchBackend}
3242 key: Pleroma.Search.Meilisearch,
3244 description: "Meilisearch settings.",
3249 description: "Meilisearch URL.",
3250 suggestion: ["http://127.0.0.1:7700/"]
3256 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3260 key: :initial_indexing_chunk_size,
3263 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3264 " since there's a limit on maximum insert size",
3265 suggestion: [100_000]
3271 key: Pleroma.Search.Elasticsearch.Cluster,
3272 label: "Elasticsearch",
3274 description: "Elasticsearch settings.",
3279 description: "Elasticsearch URL.",
3280 suggestion: ["http://127.0.0.1:9200/"]
3285 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3286 suggestion: ["elastic"]
3291 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3292 suggestion: ["changeme"]
3298 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3299 suggestion: [Elasticsearch.API.HTTP]
3305 "The JSON module used to encode/decode when communicating with Elasticsearch",
3311 description: "The indices to set up in Elasticsearch",
3316 description: "Config for the index to use for activities",
3322 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3323 suggestion: ["priv/es-mappings/activity.json"]
3328 description: "The internal store module",
3329 suggestion: [Pleroma.Search.Elasticsearch.Store]
3333 type: {:list, :module},
3334 description: "The internal types to use for this index",
3335 suggestion: [[Pleroma.Activity]]
3338 key: :bulk_page_size,
3340 description: "Size for bulk put requests, mostly used on building the index",
3344 key: :bulk_wait_interval,
3346 description: "Time to wait between bulk put requests (in ms)",
3347 suggestion: [15_000]
3359 description: "Translation Settings",
3364 description: "Is translation enabled?",
3365 suggestion: [true, false]
3370 description: "Translation module.",
3371 suggestions: {:list_behaviour_implementations, Pleroma.Akkoma.Translator}
3380 description: "DeepL Settings.",
3384 type: {:dropdown, :atom},
3385 description: "API Tier",
3386 suggestions: [:free, :pro]
3391 description: "API key for DeepL",
3398 key: :libre_translate,
3400 description: "LibreTranslate Settings.",
3405 description: "URL for libretranslate",
3411 description: "API key for libretranslate",