2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 installed_frontend_options = [
21 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
28 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
37 description: "Name of the frontend."
43 description: "Reference of the frontend to be used."
47 label: "Git Repository URL",
49 description: "URL of the git repository of the frontend"
56 "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`.",
57 example: "https://some.url/builds/${ref}.zip"
61 label: "Build directory",
63 description: "The directory inside the zip file "
67 config :pleroma, :config_description, [
72 description: "Upload general settings",
77 description: "Module which will be used for uploads",
78 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
82 type: {:list, :module},
84 "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.",
85 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
91 "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`."
97 description: "Base URL for the uploads, needed if you use CDN",
99 "https://cdn-host.com"
106 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
110 label: "Proxy Options",
112 description: "Options for Pleroma.ReverseProxy",
114 redirect_on_failure: false,
115 max_body_length: 25 * 1_048_576,
117 follow_redirect: true,
123 key: :redirect_on_failure,
126 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
127 "Any error during body processing will not be redirected as the response is chunked."
130 key: :max_body_length,
133 "Limits the content length to be approximately the " <>
134 "specified length. It is validated with the `content-length` header and also verified when proxying."
140 description: "HTTP options",
145 description: "Adapter specific options",
150 label: "SSL Options",
151 description: "SSL options for HTTP adapter",
155 type: {:list, :atom},
156 description: "List of TLS versions to use",
157 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
166 type: [:string, :tuple],
167 description: "Proxy URL",
168 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
175 key: :filename_display_max_length,
177 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
183 key: Pleroma.Uploaders.Local,
185 description: "Local uploader-related settings",
190 description: "Path where user's uploads will be saved",
199 key: Pleroma.Uploaders.S3,
201 description: "S3 uploader-related settings",
206 description: "S3 bucket",
212 key: :bucket_namespace,
214 description: "S3 bucket namespace",
215 suggestions: ["pleroma"]
218 key: :public_endpoint,
220 description: "S3 endpoint",
221 suggestions: ["https://s3.amazonaws.com"]
224 key: :truncated_namespace,
227 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
228 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
231 key: :streaming_enabled,
234 "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."
240 key: Pleroma.Upload.Filter.Mogrify,
242 description: "Uploads mogrify filter settings",
246 type: [:string, {:list, :string}, {:list, :tuple}],
248 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
249 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
260 key: Pleroma.Upload.Filter.AnonymizeFilename,
262 description: "Filter replaces the filename of the upload",
268 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
269 " filename extension by using {extension}, for example custom-file-name.{extension}.",
271 "custom-file-name.{extension}"
280 description: "Websocket based federation",
285 description: "Enable FedSockets"
291 key: Pleroma.Emails.Mailer,
293 description: "Mailer-related settings",
299 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
300 " or Swoosh.Adapters.Local for in-memory mailbox",
302 Swoosh.Adapters.SMTP,
303 Swoosh.Adapters.Sendgrid,
304 Swoosh.Adapters.Sendmail,
305 Swoosh.Adapters.Mandrill,
306 Swoosh.Adapters.Mailgun,
307 Swoosh.Adapters.Mailjet,
308 Swoosh.Adapters.Postmark,
309 Swoosh.Adapters.SparkPost,
310 Swoosh.Adapters.AmazonSES,
312 Swoosh.Adapters.SocketLabs,
313 Swoosh.Adapters.Gmail,
314 Swoosh.Adapters.Local
320 description: "Allow/disallow send emails"
323 group: {:subgroup, Swoosh.Adapters.SMTP},
326 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
327 suggestions: ["smtp.gmail.com"]
330 group: {:subgroup, Swoosh.Adapters.SMTP},
333 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
334 suggestions: ["pleroma"]
337 group: {:subgroup, Swoosh.Adapters.SMTP},
340 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
341 suggestions: ["password"]
344 group: {:subgroup, Swoosh.Adapters.SMTP},
348 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
351 group: {:subgroup, Swoosh.Adapters.SMTP},
355 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
356 suggestions: [:always, :never, :if_available]
359 group: {:subgroup, Swoosh.Adapters.SMTP},
362 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
363 suggestions: [:always, :never, :if_available]
366 group: {:subgroup, Swoosh.Adapters.SMTP},
369 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
373 group: {:subgroup, Swoosh.Adapters.SMTP},
376 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
380 group: {:subgroup, Swoosh.Adapters.SMTP},
382 label: "No MX lookups",
384 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
387 group: {:subgroup, Swoosh.Adapters.Sendgrid},
391 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
392 suggestions: ["my-api-key"]
395 group: {:subgroup, Swoosh.Adapters.Sendmail},
398 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
399 suggestions: ["/usr/bin/sendmail"]
402 group: {:subgroup, Swoosh.Adapters.Sendmail},
405 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
406 suggestions: ["-N delay,failure,success"]
409 group: {:subgroup, Swoosh.Adapters.Sendmail},
412 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
415 group: {:subgroup, Swoosh.Adapters.Mandrill},
419 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
420 suggestions: ["my-api-key"]
423 group: {:subgroup, Swoosh.Adapters.Mailgun},
427 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
428 suggestions: ["my-api-key"]
431 group: {:subgroup, Swoosh.Adapters.Mailgun},
434 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
435 suggestions: ["pleroma.com"]
438 group: {:subgroup, Swoosh.Adapters.Mailjet},
442 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
443 suggestions: ["my-api-key"]
446 group: {:subgroup, Swoosh.Adapters.Mailjet},
449 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
450 suggestions: ["my-secret-key"]
453 group: {:subgroup, Swoosh.Adapters.Postmark},
457 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
458 suggestions: ["my-api-key"]
461 group: {:subgroup, Swoosh.Adapters.SparkPost},
465 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
466 suggestions: ["my-api-key"]
469 group: {:subgroup, Swoosh.Adapters.SparkPost},
472 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
473 suggestions: ["https://api.sparkpost.com/api/v1"]
476 group: {:subgroup, Swoosh.Adapters.AmazonSES},
479 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
480 suggestions: ["us-east-1", "us-east-2"]
483 group: {:subgroup, Swoosh.Adapters.AmazonSES},
486 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
487 suggestions: ["aws-access-key"]
490 group: {:subgroup, Swoosh.Adapters.AmazonSES},
493 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
494 suggestions: ["aws-secret-key"]
497 group: {:subgroup, Swoosh.Adapters.Dyn},
501 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
502 suggestions: ["my-api-key"]
505 group: {:subgroup, Swoosh.Adapters.SocketLabs},
508 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
511 group: {:subgroup, Swoosh.Adapters.SocketLabs},
515 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
518 group: {:subgroup, Swoosh.Adapters.Gmail},
521 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
528 description: "`Swoosh.Adapters.Local` adapter specific settings",
531 group: {:subgroup, Swoosh.Adapters.Local},
534 description: "Run the preview server together as part of your app"
537 group: {:subgroup, Swoosh.Adapters.Local},
540 description: "The preview server port",
548 label: "URI Schemes",
550 description: "URI schemes related settings",
554 type: {:list, :string},
555 description: "List of the scheme part that is considered valid to be an URL",
580 description: "Instance-related settings",
585 description: "Name of the instance",
592 label: "Admin Email Address",
594 description: "Email used to reach an Administrator/Moderator of the instance",
601 label: "Sender Email Address",
603 description: "Envelope FROM address for mail sent via Pleroma",
612 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
620 description: "Posts character limit (CW/Subject included in the counter)",
628 description: "Character limit of the instance chat messages",
636 description: "Hard character limit beyond which remote posts will be dropped",
644 description: "File size limit of uploads (except for avatar, background, banner)",
650 key: :avatar_upload_limit,
652 description: "File size limit of user's profile avatars",
658 key: :background_upload_limit,
660 description: "File size limit of user's profile backgrounds",
666 key: :banner_upload_limit,
668 description: "File size limit of user's profile banners",
676 description: "A map with poll limits for local polls",
680 max_option_chars: 200,
682 max_expiration: 31_536_000
689 description: "Maximum number of options",
693 key: :max_option_chars,
695 description: "Maximum number of characters per option",
699 key: :min_expiration,
701 description: "Minimum expiration time (in seconds)",
705 key: :max_expiration,
707 description: "Maximum expiration time (in seconds)",
713 key: :registrations_open,
716 "Enable registrations for anyone. Invitations require this setting to be disabled."
719 key: :invites_enabled,
722 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
725 key: :account_activation_required,
727 description: "Require users to confirm their emails before signing in"
730 key: :account_approval_required,
732 description: "Require users to be manually approved by an admin before signing in"
737 description: "Enable federation with other instances"
740 key: :federation_incoming_replies_max_depth,
741 label: "Fed. incoming replies max depth",
744 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
745 " 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.",
751 key: :federation_reachability_timeout_days,
752 label: "Fed. reachability timeout days",
755 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
763 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
769 "Makes the client API in authenticated mode-only except for user-profiles." <>
770 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
771 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
774 key: :quarantined_instances,
775 type: {:list, :string},
777 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
786 description: "Instance static directory",
792 key: :allowed_post_formats,
793 type: {:list, :string},
794 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
803 key: :extended_nickname_format,
806 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
807 " This will break federation with older software for theses nicknames."
810 key: :cleanup_attachments,
813 Enable to remove associated attachments when status is removed.
814 This will not affect duplicates and attachments without status.
815 Enabling this will increase load to database when deleting statuses on larger instances.
819 key: :max_pinned_statuses,
821 description: "The maximum number of pinned statuses. 0 will disable the feature.",
829 key: :autofollowed_nicknames,
830 type: {:list, :string},
832 "Set to nicknames of (local) users that every new user should automatically follow"
835 key: :autofollowing_nicknames,
836 type: {:list, :string},
838 "Set to nicknames of (local) users that automatically follows every newly registered user"
841 key: :attachment_links,
843 description: "Enable to automatically add attachment link text to statuses"
846 key: :max_report_comment_size,
848 description: "The maximum size of the report comment. Default: 1000.",
854 key: :safe_dm_mentions,
855 label: "Safe DM mentions",
858 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
859 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
865 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
868 key: :remote_post_retention_days,
871 "The default amount of days to retain remote posts when pruning the database",
877 key: :user_bio_length,
879 description: "A user bio maximum length. Default: 5000.",
885 key: :user_name_length,
887 description: "A user name maximum length. Default: 100.",
893 key: :skip_thread_containment,
895 description: "Skip filtering out broken threads. Default: enabled."
898 key: :limit_to_local_content,
899 type: {:dropdown, :atom},
901 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
909 key: :max_account_fields,
911 description: "The maximum number of custom fields in the user profile. Default: 10.",
917 key: :max_remote_account_fields,
920 "The maximum number of custom fields in the remote user profile. Default: 20.",
926 key: :account_field_name_length,
928 description: "An account field name maximum length. Default: 512.",
934 key: :account_field_value_length,
936 description: "An account field value maximum length. Default: 2048.",
942 key: :registration_reason_length,
944 description: "Maximum registration reason length. Default: 500.",
950 key: :external_user_synchronization,
952 description: "Enabling following/followers counters synchronization for external users"
955 key: :multi_factor_authentication,
957 description: "Multi-factor authentication settings",
960 totp: [digits: 6, period: 30],
961 backup_codes: [number: 5, length: 16]
967 label: "TOTP settings",
969 description: "TOTP settings",
970 suggestions: [digits: 6, period: 30],
977 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
984 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
991 description: "MFA backup codes settings",
992 suggestions: [number: 5, length: 16],
998 description: "Number of backup codes to generate."
1005 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
1012 key: :instance_thumbnail,
1013 type: {:string, :image},
1015 "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.",
1016 suggestions: ["/instance/thumbnail.jpeg"]
1019 key: :show_reactions,
1021 description: "Let favourites and emoji reactions be viewed through the API."
1029 description: "Welcome messages settings",
1032 key: :direct_message,
1034 descpiption: "Direct message settings",
1039 description: "Enables sending a direct message to newly registered users"
1044 description: "A message that will be sent to newly registered users",
1046 "Hi, @username! Welcome on board!"
1050 key: :sender_nickname,
1052 description: "The nickname of the local user that sends a welcome message",
1062 descpiption: "Chat message settings",
1067 description: "Enables sending a chat message to newly registered users"
1073 "A message that will be sent to newly registered users as a chat message",
1075 "Hello, welcome on board!"
1079 key: :sender_nickname,
1081 description: "The nickname of the local user that sends a welcome chat message",
1091 descpiption: "Email message settings",
1096 description: "Enables sending an email to newly registered users"
1100 type: [:string, :tuple],
1102 "Email address and/or nickname that will be used to send the welcome email.",
1104 {"Pleroma App", "welcome@pleroma.app"}
1111 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1112 suggestions: ["Welcome to <%= instance_name%>"]
1118 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1119 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1125 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1126 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1135 description: "Logger-related settings",
1139 type: [:atom, :tuple, :module],
1141 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1142 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1150 label: "ExSyslogger",
1151 description: "ExSyslogger-related settings",
1155 type: {:dropdown, :atom},
1156 description: "Log level",
1157 suggestions: [:debug, :info, :warn, :error]
1163 "A string that's prepended to every message, and is typically set to the app name",
1164 suggestions: ["pleroma"]
1169 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1170 suggestions: ["$metadata[$level] $message"]
1174 type: {:list, :atom},
1175 suggestions: [:request_id]
1183 label: "Console Logger",
1184 description: "Console logger settings",
1188 type: {:dropdown, :atom},
1189 description: "Log level",
1190 suggestions: [:debug, :info, :warn, :error]
1195 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1196 suggestions: ["$metadata[$level] $message"]
1200 type: {:list, :atom},
1201 suggestions: [:request_id]
1208 label: "Quack Logger",
1209 description: "Quack-related settings",
1213 type: {:dropdown, :atom},
1214 description: "Log level",
1215 suggestions: [:debug, :info, :warn, :error]
1219 type: {:list, :atom},
1220 description: "Configure which metadata you want to report on",
1237 label: "Webhook URL",
1239 description: "Configure the Slack incoming webhook",
1240 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1246 key: :frontend_configurations,
1249 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1250 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1251 "add your own configuration your settings all fields must be complete.",
1255 label: "Pleroma FE",
1257 description: "Settings for Pleroma FE",
1260 alwaysShowSubjectInput: true,
1261 background: "/static/aurora_borealis.jpg",
1262 collapseMessageWithSubject: false,
1265 hideFilteredStatuses: false,
1266 hideMutedPosts: false,
1267 hidePostStats: false,
1268 hideSitename: false,
1269 hideUserStats: false,
1270 loginMethod: "password",
1271 logo: "/static/logo.png",
1274 minimalScopesMode: false,
1275 noAttachmentLinks: false,
1276 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1277 postContentType: "text/plain",
1278 redirectRootLogin: "/main/friends",
1279 redirectRootNoLogin: "/main/all",
1281 sidebarRight: false,
1282 showFeaturesPanel: true,
1283 showInstanceSpecificPanel: false,
1284 subjectLineBehavior: "email",
1285 theme: "pleroma-dark",
1286 webPushNotifications: false
1291 key: :alwaysShowSubjectInput,
1292 label: "Always show subject input",
1294 description: "When disabled, auto-hide the subject field if it's empty"
1298 type: {:string, :image},
1300 "URL of the background, unless viewing a user profile with a background that is set",
1301 suggestions: ["/images/city.jpg"]
1304 key: :collapseMessageWithSubject,
1305 label: "Collapse message with subject",
1308 "When a message has a subject (aka Content Warning), collapse it by default"
1312 label: "PleromaFE Chat",
1314 description: "Disables PleromaFE Chat component"
1320 description: "Enables green text on lines prefixed with the > character"
1323 key: :hideFilteredStatuses,
1324 label: "Hide Filtered Statuses",
1326 description: "Hides filtered statuses from timelines"
1329 key: :hideMutedPosts,
1330 label: "Hide Muted Posts",
1332 description: "Hides muted statuses from timelines"
1335 key: :hidePostStats,
1336 label: "Hide post stats",
1338 description: "Hide notices statistics (repeats, favorites, ...)"
1342 label: "Hide Sitename",
1344 description: "Hides instance name from PleromaFE banner"
1347 key: :hideUserStats,
1348 label: "Hide user stats",
1351 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1355 type: {:string, :image},
1356 description: "URL of the logo, defaults to Pleroma's logo",
1357 suggestions: ["/static/logo.png"]
1361 label: "Logo margin",
1364 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1365 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1366 suggestions: [".1em"]
1373 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1374 "If you want a colorful logo you must disable logoMask."
1377 key: :minimalScopesMode,
1378 label: "Minimal scopes mode",
1381 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1382 "Also prevents replying to a DM with a public post from PleromaFE."
1385 key: :nsfwCensorImage,
1386 label: "NSFW Censor Image",
1387 type: {:string, :image},
1389 "URL of the image to use for hiding NSFW media attachments in the timeline",
1390 suggestions: ["/static/img/nsfw.74818f9.png"]
1393 key: :postContentType,
1394 label: "Post Content Type",
1395 type: {:dropdown, :atom},
1396 description: "Default post formatting option",
1397 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1400 key: :redirectRootNoLogin,
1401 label: "Redirect root no login",
1404 "Relative URL which indicates where to redirect when a user isn't logged in",
1405 suggestions: ["/main/all"]
1408 key: :redirectRootLogin,
1409 label: "Redirect root login",
1412 "Relative URL which indicates where to redirect when a user is logged in",
1413 suggestions: ["/main/friends"]
1417 label: "Scope copy",
1419 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1423 label: "Sidebar on Right",
1425 description: "Change alignment of sidebar and panels to the right"
1428 key: :showFeaturesPanel,
1429 label: "Show instance features panel",
1432 "Enables panel displaying functionality of the instance on the About page"
1435 key: :showInstanceSpecificPanel,
1436 label: "Show instance specific panel",
1438 description: "Whether to show the instance's custom panel"
1441 key: :subjectLineBehavior,
1442 label: "Subject line behavior",
1444 description: "Allows changing the default behaviour of subject lines in replies.
1445 `email`: copy and preprend re:, as in email,
1446 `masto`: copy verbatim, as in Mastodon,
1447 `noop`: don't copy the subject.",
1448 suggestions: ["email", "masto", "noop"]
1453 description: "Which theme to use. Available themes are defined in styles.json",
1454 suggestions: ["pleroma-dark"]
1462 description: "Settings for Masto FE",
1465 showInstanceSpecificPanel: true
1470 key: :showInstanceSpecificPanel,
1471 label: "Show instance specific panel",
1473 description: "Whenether to show the instance's specific panel"
1484 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1488 type: {:keyword, :map},
1490 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1493 url: "/images/pleroma-fox-tan-smol.png",
1494 mime_type: "image/png"
1496 pleroma_fox_tan_shy: %{
1497 url: "/images/pleroma-fox-tan-shy.png",
1498 mime_type: "image/png"
1503 key: :default_mascot,
1506 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1512 key: :default_user_avatar,
1513 type: {:string, :image},
1514 description: "URL of the default user avatar",
1515 suggestions: ["/images/avi.png"]
1524 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1528 type: {:list, :map},
1529 description: "Describe the icons of the app",
1532 src: "/static/logo.png"
1535 src: "/static/icon.png",
1539 src: "/static/icon.ico",
1540 sizes: "72x72 96x96 128x128 256x256"
1547 description: "Describe the theme color of the app",
1548 suggestions: ["#282c37", "mediumpurple"]
1551 key: :background_color,
1553 description: "Describe the background color of the app",
1554 suggestions: ["#191b22", "aliceblue"]
1564 description: "General MRF settings",
1568 type: [:module, {:list, :module}],
1570 "A list of MRF policies enabled. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
1571 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1575 label: "MRF transparency",
1578 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1581 key: :transparency_exclusions,
1582 label: "MRF transparency exclusions",
1583 type: {:list, :string},
1585 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1596 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1597 label: "MRF Simple",
1599 description: "Simple ingress policies",
1602 key: :media_removal,
1603 type: {:list, :string},
1604 description: "List of instances to strip media attachments from",
1605 suggestions: ["example.com", "*.example.com"]
1609 label: "Media NSFW",
1610 type: {:list, :string},
1611 description: "List of instances to tag all media as NSFW (sensitive) from",
1612 suggestions: ["example.com", "*.example.com"]
1615 key: :federated_timeline_removal,
1616 type: {:list, :string},
1618 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1619 suggestions: ["example.com", "*.example.com"]
1623 type: {:list, :string},
1624 description: "List of instances to reject activities from (except deletes)",
1625 suggestions: ["example.com", "*.example.com"]
1629 type: {:list, :string},
1630 description: "List of instances to only accept activities from (except deletes)",
1631 suggestions: ["example.com", "*.example.com"]
1634 key: :followers_only,
1635 type: {:list, :string},
1636 description: "Force posts from the given instances to be visible by followers only",
1637 suggestions: ["example.com", "*.example.com"]
1640 key: :report_removal,
1641 type: {:list, :string},
1642 description: "List of instances to reject reports from",
1643 suggestions: ["example.com", "*.example.com"]
1646 key: :avatar_removal,
1647 type: {:list, :string},
1648 description: "List of instances to strip avatars from",
1649 suggestions: ["example.com", "*.example.com"]
1652 key: :banner_removal,
1653 type: {:list, :string},
1654 description: "List of instances to strip banners from",
1655 suggestions: ["example.com", "*.example.com"]
1658 key: :reject_deletes,
1659 type: {:list, :string},
1660 description: "List of instances to reject deletions from",
1661 suggestions: ["example.com", "*.example.com"]
1667 key: :mrf_activity_expiration,
1669 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1670 label: "MRF Activity Expiration Policy",
1672 description: "Adds automatic expiration to all local activities",
1677 description: "Default global expiration time for all local activities (in days)",
1678 suggestions: [90, 365]
1686 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1687 label: "MRF Subchain",
1690 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1691 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1695 type: {:map, {:list, :string}},
1696 description: "Matches a series of regular expressions against the actor field",
1699 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1707 key: :mrf_rejectnonpublic,
1709 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1710 description: "RejectNonPublic drops posts with non-public visibility settings.",
1711 label: "MRF Reject Non Public",
1715 key: :allow_followersonly,
1716 label: "Allow followers-only",
1718 description: "Whether to allow followers-only posts"
1723 description: "Whether to allow direct messages"
1729 key: :mrf_hellthread,
1731 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1732 label: "MRF Hellthread",
1734 description: "Block messages with excessive user mentions",
1737 key: :delist_threshold,
1740 "Number of mentioned users after which the message gets removed from timelines and" <>
1741 "disables notifications. Set to 0 to disable.",
1745 key: :reject_threshold,
1748 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1757 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1758 label: "MRF Keyword",
1761 "Reject or Word-Replace messages matching a keyword or [Regex](https://hexdocs.pm/elixir/Regex.html).",
1765 type: {:list, :string},
1767 A list of patterns which result in message being rejected.
1769 Each pattern can be a string or [Regex](https://hexdocs.pm/elixir/Regex.html) in the format of `~r/PATTERN/`.
1771 suggestions: ["foo", ~r/foo/iu]
1774 key: :federated_timeline_removal,
1775 type: {:list, :string},
1777 A list of patterns which result in message being removed from federated timelines (a.k.a unlisted).
1779 Each pattern can be a string or [Regex](https://hexdocs.pm/elixir/Regex.html) in the format of `~r/PATTERN/`.
1781 suggestions: ["foo", ~r/foo/iu]
1785 type: {:list, :tuple},
1787 **Pattern**: a string or [Regex](https://hexdocs.pm/elixir/Regex.html) in the format of `~r/PATTERN/`.
1789 **Replacement**: a string. Leaving the field empty is permitted.
1798 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1799 label: "MRF Mention",
1801 description: "Block messages which mention a specific user",
1805 type: {:list, :string},
1806 description: "A list of actors for which any post mentioning them will be dropped",
1807 suggestions: ["actor1", "actor2"]
1813 key: :mrf_vocabulary,
1815 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1816 label: "MRF Vocabulary",
1818 description: "Filter messages which belong to certain activity vocabularies",
1822 type: {:list, :string},
1824 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1825 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1829 type: {:list, :string},
1831 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1832 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1838 # key: :mrf_user_allowlist,
1840 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1843 # "The keys in this section are the domain names that the policy should apply to." <>
1844 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1846 # %{"example.org" => ["https://example.org/users/admin"]}
1854 description: "Media proxy",
1859 description: "Enables proxying of remote media to the instance's proxy"
1866 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1867 suggestions: ["https://example.com"]
1875 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1881 description: "Enables media cache object invalidation."
1886 description: "Module which will be used to purge objects from the cache.",
1888 Pleroma.Web.MediaProxy.Invalidation.Script,
1889 Pleroma.Web.MediaProxy.Invalidation.Http
1896 label: "Proxy Options",
1898 description: "Options for Pleroma.ReverseProxy",
1900 redirect_on_failure: false,
1901 max_body_length: 25 * 1_048_576,
1902 max_read_duration: 30_000,
1904 follow_redirect: true,
1910 key: :redirect_on_failure,
1913 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1914 "Any error during body processing will not be redirected as the response is chunked."
1917 key: :max_body_length,
1920 "Limits the content length to be approximately the " <>
1921 "specified length. It is validated with the `content-length` header and also verified when proxying."
1924 key: :max_read_duration,
1926 description: "Timeout (in milliseconds) of GET request to remote URI."
1932 description: "HTTP options",
1937 description: "Adapter specific options",
1942 label: "SSL Options",
1943 description: "SSL options for HTTP adapter",
1947 type: {:list, :atom},
1948 description: "List of TLS version to use",
1949 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1958 type: [:string, :tuple],
1959 description: "Proxy URL",
1960 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1968 type: {:list, :string},
1969 description: "List of hosts with scheme to bypass the mediaproxy",
1970 suggestions: ["http://example.com"]
1976 key: :media_preview_proxy,
1978 description: "Media preview proxy",
1984 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1987 key: :thumbnail_max_width,
1990 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1993 key: :thumbnail_max_height,
1996 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1999 key: :image_quality,
2001 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
2004 key: :min_content_length,
2007 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
2013 key: Pleroma.Web.MediaProxy.Invalidation.Http,
2015 description: "HTTP invalidate settings",
2020 description: "HTTP method of request. Default: :purge"
2024 type: {:keyword, :string},
2025 description: "HTTP headers of request",
2026 suggestions: [{"x-refresh", 1}]
2031 description: "Request options",
2035 type: {:map, :string}
2043 key: Pleroma.Web.MediaProxy.Invalidation.Script,
2045 description: "Script invalidate settings",
2050 description: "Path to shell script. Which will run purge cache.",
2051 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2059 description: "Gopher settings",
2064 description: "Enables the gopher interface"
2070 description: "IP address to bind to",
2071 suggestions: [{0, 0, 0, 0}]
2076 description: "Port to bind to",
2082 description: "Port advertised in URLs (optional, defaults to port)",
2090 label: "ActivityPub",
2092 description: "ActivityPub-related settings",
2095 key: :unfollow_blocked,
2097 description: "Whether blocks result in people getting unfollowed"
2100 key: :outgoing_blocks,
2102 description: "Whether to federate blocks to other instances"
2105 key: :sign_object_fetches,
2107 description: "Sign object fetches with HTTP signatures"
2110 key: :note_replies_output_limit,
2113 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2116 key: :follow_handshake_timeout,
2118 description: "Following handshake timeout",
2125 key: :http_security,
2126 label: "HTTP security",
2128 description: "HTTP security settings",
2133 description: "Whether the managed content security policy is enabled"
2139 description: "Whether to additionally send a Strict-Transport-Security header"
2143 label: "STS max age",
2145 description: "The maximum age for the Strict-Transport-Security header if sent",
2146 suggestions: [31_536_000]
2150 label: "CT max age",
2152 description: "The maximum age for the Expect-CT header if sent",
2153 suggestions: [2_592_000]
2156 key: :referrer_policy,
2158 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2159 suggestions: ["same-origin", "no-referrer"]
2163 label: "Report URI",
2165 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2166 suggestions: ["https://example.com/report-uri"]
2171 group: :web_push_encryption,
2172 key: :vapid_details,
2173 label: "Vapid Details",
2176 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2182 "A mailto link for the administrative contact." <>
2183 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2184 suggestions: ["mailto:moderators@pleroma.com"]
2189 description: "VAPID public key",
2190 suggestions: ["Public key"]
2195 description: "VAPID private key",
2196 suggestions: ["Private key"]
2202 key: Pleroma.Captcha,
2204 description: "Captcha-related settings",
2209 description: "Whether the captcha should be shown on registration"
2214 description: "The method/service to use for captcha",
2215 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2218 key: :seconds_valid,
2220 description: "The time in seconds for which the captcha is valid",
2227 key: Pleroma.Captcha.Kocaptcha,
2230 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2231 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2236 description: "The kocaptcha endpoint to use",
2237 suggestions: ["https://captcha.kotobank.ch"]
2243 label: "Pleroma Admin Token",
2246 "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)",
2251 description: "Admin token",
2253 "Please use a high entropy string or UUID"
2263 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2265 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2266 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2267 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2268 (see https://github.com/sorentwo/oban/issues/52).
2273 type: {:dropdown, :atom},
2274 description: "Logs verbose mode",
2275 suggestions: [false, :error, :warn, :info, :debug]
2279 type: {:keyword, :integer},
2281 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2283 activity_expiration: 10,
2284 attachments_cleanup: 5,
2286 federator_incoming: 50,
2287 federator_outgoing: 50,
2289 scheduled_activities: 10,
2295 key: :activity_expiration,
2297 description: "Activity expiration queue",
2301 key: :attachments_cleanup,
2303 description: "Attachment deletion queue",
2309 description: "Background queue",
2313 key: :federator_incoming,
2315 description: "Incoming federation queue",
2319 key: :federator_outgoing,
2321 description: "Outgoing federation queue",
2327 description: "Email sender queue, see Pleroma.Emails.Mailer",
2331 key: :scheduled_activities,
2333 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2337 key: :transmogrifier,
2339 description: "Transmogrifier queue",
2345 description: "Web push notifications queue",
2352 type: {:list, :tuple},
2353 description: "Settings for cron background jobs",
2355 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2356 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2365 description: "Includes custom worker options not interpretable directly by `Oban`",
2369 type: {:keyword, :integer},
2370 description: "Max retry attempts for failed jobs, per `Oban` queue",
2372 federator_incoming: 5,
2373 federator_outgoing: 5
2380 key: Pleroma.Web.Metadata,
2382 description: "Metadata-related settings",
2386 type: {:list, :module},
2387 description: "List of metadata providers to enable",
2389 Pleroma.Web.Metadata.Providers.OpenGraph,
2390 Pleroma.Web.Metadata.Providers.TwitterCard,
2391 Pleroma.Web.Metadata.Providers.RelMe,
2392 Pleroma.Web.Metadata.Providers.Feed
2397 label: "Unfurl NSFW",
2399 description: "When enabled NSFW attachments will be shown in previews"
2408 "If enabled the instance will parse metadata from attached links to generate link previews",
2413 description: "Enables RichMedia parsing of URLs"
2417 type: {:list, :string},
2418 description: "List of hosts which will be ignored by the metadata parser",
2419 suggestions: ["accounts.google.com", "xss.website"]
2423 label: "Ignore TLD",
2424 type: {:list, :string},
2425 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2426 suggestions: ["local", "localdomain", "lan"]
2430 type: {:list, :module},
2432 "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.",
2434 Pleroma.Web.RichMedia.Parsers.OEmbed,
2435 Pleroma.Web.RichMedia.Parsers.TwitterCard
2440 label: "TTL setters",
2441 type: {:list, :module},
2443 "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.",
2445 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2449 key: :failure_backoff,
2452 "Amount of milliseconds after request failure, during which the request will not be retried.",
2453 suggestions: [60_000]
2459 key: Pleroma.Formatter,
2463 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2467 type: [:string, :boolean],
2468 description: "Specify the class to be added to the generated link. Disable to clear.",
2469 suggestions: ["auto-linker", false]
2473 type: [:string, :boolean],
2474 description: "Override the rel attribute. Disable to clear.",
2475 suggestions: ["ugc", "noopener noreferrer", false]
2480 description: "Link URLs will open in a new window/tab."
2484 type: [:integer, :boolean],
2486 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2487 suggestions: [15, false]
2492 description: "Strip the scheme prefix."
2497 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2501 type: [:atom, :boolean],
2503 "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)",
2504 suggestions: [:no_scheme, true]
2510 key: Pleroma.ScheduledActivity,
2512 description: "Scheduled activities settings",
2515 key: :daily_user_limit,
2518 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2522 key: :total_user_limit,
2525 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2531 description: "Whether scheduled activities are sent to the job queue to be executed"
2537 key: Pleroma.Workers.PurgeExpiredActivity,
2539 description: "Expired activities settings",
2544 description: "Enables expired activities addition & deletion"
2549 description: "Minimum lifetime for ephemeral activity (in seconds)",
2556 label: "Pleroma Authenticator",
2558 description: "Authenticator",
2561 key: Pleroma.Web.Auth.Authenticator,
2563 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2573 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2574 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2575 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2576 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2581 description: "Enables LDAP authentication"
2586 description: "LDAP server hostname",
2587 suggestions: ["localhosts"]
2592 description: "LDAP port, e.g. 389 or 636",
2593 suggestions: [389, 636]
2599 description: "Enable to use SSL, usually implies the port 636"
2603 label: "SSL options",
2605 description: "Additional SSL options",
2606 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2611 description: "Path to file with PEM encoded cacerts",
2612 suggestions: ["path/to/file/with/PEM/cacerts"]
2617 description: "Type of cert verification",
2618 suggestions: [:verify_peer]
2626 description: "Enable to use STARTTLS, usually implies the port 389"
2630 label: "TLS options",
2632 description: "Additional TLS options",
2633 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2638 description: "Path to file with PEM encoded cacerts",
2639 suggestions: ["path/to/file/with/PEM/cacerts"]
2644 description: "Type of cert verification",
2645 suggestions: [:verify_peer]
2652 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2653 suggestions: ["dc=example,dc=com"]
2660 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2669 description: "Authentication / authorization settings",
2672 key: :enforce_oauth_admin_scope_usage,
2673 label: "Enforce OAuth admin scope usage",
2676 "OAuth admin scope requirement toggle. " <>
2677 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2678 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2679 "`is_admin` user flag grants access to admin-specific actions."
2682 key: :auth_template,
2685 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2686 suggestions: ["show.html"]
2689 key: :oauth_consumer_template,
2690 label: "OAuth consumer template",
2693 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2694 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2695 suggestions: ["consumer.html"]
2698 key: :oauth_consumer_strategies,
2699 label: "OAuth consumer strategies",
2700 type: {:list, :string},
2702 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2703 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2704 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2705 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2711 key: :email_notifications,
2713 description: "Email notifications settings",
2719 "emails of \"what you've missed\" for users who have been inactive for a while",
2723 schedule: "0 0 * * 0",
2725 inactivity_threshold: 7
2733 description: "Globally enable or disable digest emails"
2739 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2740 suggestions: ["0 0 * * 0"]
2745 description: "Minimum interval between digest emails to one user",
2749 key: :inactivity_threshold,
2751 description: "Minimum user inactivity threshold",
2760 key: Pleroma.Emails.UserEmail,
2762 description: "Email template settings",
2766 type: {:string, :image},
2767 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2768 suggestions: ["some/path/logo.png"]
2773 description: "A map with color settings for email templates.",
2776 link_color: "#d8a070",
2777 background_color: "#2C3645",
2778 content_background_color: "#1B2635",
2779 header_color: "#d8a070",
2780 text_color: "#b9b9ba",
2781 text_muted_color: "#b9b9ba"
2788 suggestions: ["#d8a070"]
2791 key: :background_color,
2793 suggestions: ["#2C3645"]
2796 key: :content_background_color,
2798 suggestions: ["#1B2635"]
2803 suggestions: ["#d8a070"]
2808 suggestions: ["#b9b9ba"]
2811 key: :text_muted_color,
2813 suggestions: ["#b9b9ba"]
2821 key: Pleroma.Emails.NewUsersDigestEmail,
2823 description: "New users admin email digest",
2828 description: "Enables new users admin digest email when `true`"
2837 description: "Configure OAuth 2 provider capabilities",
2840 key: :token_expires_in,
2842 description: "The lifetime in seconds of the access token",
2846 key: :issue_new_refresh_token,
2849 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2852 key: :clean_expired_tokens,
2854 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2864 key: :shortcode_globs,
2865 type: {:list, :string},
2866 description: "Location of custom emoji files. * can be used as a wildcard.",
2867 suggestions: ["/emoji/custom/**/*.png"]
2870 key: :pack_extensions,
2871 type: {:list, :string},
2873 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2874 suggestions: [".png", ".gif"]
2878 type: {:keyword, {:list, :string}},
2880 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2881 " and the value is the location or array of locations. * can be used as a wildcard.",
2883 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2887 key: :default_manifest,
2890 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2891 " Currently only one manifest can be added (no arrays).",
2892 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2895 key: :shared_pack_cache_seconds_per_file,
2896 label: "Shared pack cache s/file",
2899 "When an emoji pack is shared, the archive is created and cached in memory" <>
2900 " for this amount of seconds multiplied by the number of files.",
2910 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2914 type: [:tuple, {:list, :tuple}],
2915 description: "For the search requests (account & status search etc.)",
2916 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2920 type: [:tuple, {:list, :tuple}],
2921 description: "For requests to timelines (each timeline has it's own limiter)",
2922 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2925 key: :app_account_creation,
2926 type: [:tuple, {:list, :tuple}],
2927 description: "For registering user accounts from the same IP address",
2928 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2931 key: :relations_actions,
2932 type: [:tuple, {:list, :tuple}],
2933 description: "For actions on relationships with all users (follow, unfollow)",
2934 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2937 key: :relation_id_action,
2938 label: "Relation ID action",
2939 type: [:tuple, {:list, :tuple}],
2940 description: "For actions on relation with a specific user (follow, unfollow)",
2941 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2944 key: :statuses_actions,
2945 type: [:tuple, {:list, :tuple}],
2947 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2948 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2951 key: :status_id_action,
2952 label: "Status ID action",
2953 type: [:tuple, {:list, :tuple}],
2955 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2956 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2959 key: :authentication,
2960 type: [:tuple, {:list, :tuple}],
2961 description: "For authentication create / password check / user existence check requests",
2962 suggestions: [{60_000, 15}]
2971 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2972 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2977 description: "Enables SSH"
2982 description: "Dir with SSH keys",
2983 suggestions: ["/some/path/ssh_keys"]
2988 description: "Handler module",
2989 suggestions: ["Pleroma.BBS.Handler"]
2994 description: "Port to connect",
2995 suggestions: [10_022]
2998 key: :password_authenticator,
3000 description: "Authenticator module",
3001 suggestions: ["Pleroma.BBS.Authenticator"]
3007 label: "Mime Types",
3009 description: "Mime Types settings",
3016 "application/xml" => ["xml"],
3017 "application/xrd+xml" => ["xrd+xml"],
3018 "application/jrd+json" => ["jrd+json"],
3019 "application/activity+json" => ["activity+json"],
3020 "application/ld+json" => ["activity+json"]
3025 key: "application/xml",
3026 type: {:list, :string},
3027 suggestions: ["xml"]
3030 key: "application/xrd+xml",
3031 type: {:list, :string},
3032 suggestions: ["xrd+xml"]
3035 key: "application/jrd+json",
3036 type: {:list, :string},
3037 suggestions: ["jrd+json"]
3040 key: "application/activity+json",
3041 type: {:list, :string},
3042 suggestions: ["activity+json"]
3045 key: "application/ld+json",
3046 type: {:list, :string},
3047 suggestions: ["activity+json"]
3057 description: "Pleroma chat settings",
3070 description: "HTTP settings",
3075 type: [:string, :tuple],
3076 description: "Proxy URL",
3077 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3080 key: :send_user_agent,
3085 type: [:string, :atom],
3087 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3088 suggestions: ["Pleroma", :default]
3093 description: "Adapter specific options",
3099 label: "SSL Options",
3100 description: "SSL options for HTTP adapter",
3104 type: {:list, :atom},
3105 description: "List of TLS version to use",
3106 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3117 label: "Markup Settings",
3121 key: :allow_inline_images,
3125 key: :allow_headings,
3138 type: {:list, :module},
3140 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3141 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3151 key: :deny_follow_blocked,
3158 key: :mrf_normalize_markup,
3160 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3161 label: "MRF Normalize Markup",
3162 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3168 suggestions: [Pleroma.HTML.Scrubber.Default]
3178 key: :restricted_nicknames,
3179 type: {:list, :string},
3180 description: "List of nicknames users may not register with.",
3199 "ostatus_subscribe",
3215 key: :email_blacklist,
3216 type: {:list, :string},
3217 description: "List of email domains users may not register with.",
3218 suggestions: ["mailinator.com", "maildrop.cc"]
3224 label: "CORS plug config",
3230 suggestions: [86_400]
3234 type: {:list, :string},
3235 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3239 type: {:list, :string},
3242 "X-RateLimit-Reset",
3243 "X-RateLimit-Limit",
3244 "X-RateLimit-Remaining",
3255 type: {:list, :string},
3256 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3262 key: Pleroma.Web.Plugs.RemoteIp,
3265 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3266 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3272 description: "Enable/disable the plug. Default: disabled."
3276 type: {:list, :string},
3278 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
3283 type: {:list, :string},
3285 "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."
3289 type: {:list, :string},
3291 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"]`
3298 key: :web_cache_ttl,
3299 label: "Web cache TTL",
3302 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3308 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3309 suggestions: [30_000, nil]
3312 key: :activity_pub_question,
3314 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3315 suggestions: [30_000]
3325 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3330 description: "Enables the rendering of static HTML. Default: disabled."
3338 description: "Configure feed rendering",
3343 description: "Configure title rendering",
3348 description: "Maximum number of characters before truncating title",
3354 description: "Replacement which will be used after truncating string",
3355 suggestions: ["..."]
3363 key: :mrf_object_age,
3365 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3366 label: "MRF Object Age",
3369 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3374 description: "Required age (in seconds) of a post before actions are taken.",
3375 suggestions: [172_800]
3379 type: {:list, :atom},
3381 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3382 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3383 "`:reject` rejects the message entirely",
3384 suggestions: [:delist, :strip_followers, :reject]
3392 description: "Custom Runtime Modules",
3397 description: "A path to custom Elixir modules (such as MRF policies)."
3405 description: "Settings for notifications streamer",
3410 description: "Number of workers to send notifications",
3414 key: :overflow_workers,
3416 description: "Maximum number of workers created if pool is empty",
3423 key: :connections_pool,
3425 description: "Advanced settings for `Gun` connections pool",
3428 key: :connection_acquisition_wait,
3431 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3435 key: :connection_acquisition_retries,
3438 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3442 key: :max_connections,
3444 description: "Maximum number of connections in the pool. Default: 250 connections.",
3448 key: :connect_timeout,
3450 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3454 key: :reclaim_multiplier,
3457 "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",
3466 description: "Advanced settings for `Gun` workers pools",
3468 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3472 description: "Settings for #{pool_name} pool.",
3477 description: "Maximum number of concurrent requests in the pool.",
3484 "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",
3490 description: "Timeout for the pool while gun will wait for response",
3491 suggestions: [10_000]
3499 key: :hackney_pools,
3501 description: "Advanced settings for `Hackney` connections pools",
3506 description: "Settings for federation pool.",
3509 key: :max_connections,
3511 description: "Number workers in the pool.",
3517 description: "Timeout while `hackney` will wait for response.",
3518 suggestions: [150_000]
3525 description: "Settings for media pool.",
3528 key: :max_connections,
3530 description: "Number workers in the pool.",
3536 description: "Timeout while `hackney` will wait for response.",
3537 suggestions: [150_000]
3544 description: "Settings for upload pool.",
3547 key: :max_connections,
3549 description: "Number workers in the pool.",
3555 description: "Timeout while `hackney` will wait for response.",
3556 suggestions: [300_000]
3564 key: :restrict_unauthenticated,
3565 label: "Restrict Unauthenticated",
3568 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3573 description: "Settings for public and federated timelines.",
3578 description: "Disallow view public timeline."
3583 description: "Disallow view federated timeline."
3590 description: "Settings for user profiles.",
3595 description: "Disallow view local user profiles."
3600 description: "Disallow view remote user profiles."
3607 description: "Settings for statuses.",
3612 description: "Disallow view local statuses."
3617 description: "Disallow view remote statuses."
3625 key: Pleroma.Web.ApiSpec.CastAndValidate,
3632 "Enables strict input validation (useful in development, not recommended in production)"
3638 key: :instances_favicons,
3640 description: "Control favicons for instances",
3645 description: "Allow/disallow displaying and getting instances favicons"
3653 descriptions: "S3 service related settings",
3656 key: :access_key_id,
3658 description: "S3 access key ID",
3659 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3662 key: :secret_access_key,
3664 description: "Secret access key",
3665 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3670 description: "S3 host",
3671 suggestions: ["s3.eu-central-1.amazonaws.com"]
3679 description: "Installed frontends management",
3684 description: "Primary frontend, the one that is served for all pages by default",
3685 children: installed_frontend_options
3690 description: "Admin frontend",
3691 children: installed_frontend_options
3697 "A map containing available frontends and parameters for their installation.",
3698 children: frontend_options
3704 key: Pleroma.Web.Preload,
3706 description: "Preload-related settings",
3710 type: {:list, :module},
3711 description: "List of preload providers to enable",
3713 Pleroma.Web.Preload.Providers.Instance,
3714 Pleroma.Web.Preload.Providers.User,
3715 Pleroma.Web.Preload.Providers.Timelines,
3716 Pleroma.Web.Preload.Providers.StatusNet
3725 description: "Majic/libmagic configuration",
3730 description: "Number of majic workers to start.",
3737 key: Pleroma.Web.Endpoint.MetricsExporter,
3739 description: "Prometheus app metrics endpoint configuration",
3744 description: "[Pleroma extension] Enables app metrics endpoint."
3748 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3750 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3754 type: [:boolean, :tuple],
3755 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3756 suggestion: [false, {:basic, "myusername", "mypassword"}]
3761 description: "App metrics endpoint URI path.",
3762 suggestions: ["/api/pleroma/app_metrics"]
3767 description: "App metrics endpoint output format.",
3768 suggestions: [:text, :protobuf]