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",
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",
1760 description: "Reject or Word-Replace messages with a keyword or regex",
1764 type: {:list, :string},
1766 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1767 suggestions: ["foo", ~r/foo/iu]
1770 key: :federated_timeline_removal,
1771 type: {:list, :string},
1773 "A list of patterns which result in message being removed from federated timelines (a.k.a unlisted). Each pattern can be a string or a regular expression.",
1774 suggestions: ["foo", ~r/foo/iu]
1778 type: {:list, :tuple},
1780 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1781 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1789 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1790 label: "MRF Mention",
1792 description: "Block messages which mention a specific user",
1796 type: {:list, :string},
1797 description: "A list of actors for which any post mentioning them will be dropped",
1798 suggestions: ["actor1", "actor2"]
1804 key: :mrf_vocabulary,
1806 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1807 label: "MRF Vocabulary",
1809 description: "Filter messages which belong to certain activity vocabularies",
1813 type: {:list, :string},
1815 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1816 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1820 type: {:list, :string},
1822 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1823 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1829 # key: :mrf_user_allowlist,
1831 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1834 # "The keys in this section are the domain names that the policy should apply to." <>
1835 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1837 # %{"example.org" => ["https://example.org/users/admin"]}
1845 description: "Media proxy",
1850 description: "Enables proxying of remote media to the instance's proxy"
1857 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1858 suggestions: ["https://example.com"]
1866 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1872 description: "Enables media cache object invalidation."
1877 description: "Module which will be used to purge objects from the cache.",
1879 Pleroma.Web.MediaProxy.Invalidation.Script,
1880 Pleroma.Web.MediaProxy.Invalidation.Http
1887 label: "Proxy Options",
1889 description: "Options for Pleroma.ReverseProxy",
1891 redirect_on_failure: false,
1892 max_body_length: 25 * 1_048_576,
1893 max_read_duration: 30_000,
1895 follow_redirect: true,
1901 key: :redirect_on_failure,
1904 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1905 "Any error during body processing will not be redirected as the response is chunked."
1908 key: :max_body_length,
1911 "Limits the content length to be approximately the " <>
1912 "specified length. It is validated with the `content-length` header and also verified when proxying."
1915 key: :max_read_duration,
1917 description: "Timeout (in milliseconds) of GET request to remote URI."
1923 description: "HTTP options",
1928 description: "Adapter specific options",
1933 label: "SSL Options",
1934 description: "SSL options for HTTP adapter",
1938 type: {:list, :atom},
1939 description: "List of TLS version to use",
1940 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1949 type: [:string, :tuple],
1950 description: "Proxy URL",
1951 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1959 type: {:list, :string},
1960 description: "List of hosts with scheme to bypass the mediaproxy",
1961 suggestions: ["http://example.com"]
1967 key: :media_preview_proxy,
1969 description: "Media preview proxy",
1975 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1978 key: :thumbnail_max_width,
1981 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1984 key: :thumbnail_max_height,
1987 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1990 key: :image_quality,
1992 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1995 key: :min_content_length,
1998 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
2004 key: Pleroma.Web.MediaProxy.Invalidation.Http,
2006 description: "HTTP invalidate settings",
2011 description: "HTTP method of request. Default: :purge"
2015 type: {:keyword, :string},
2016 description: "HTTP headers of request",
2017 suggestions: [{"x-refresh", 1}]
2022 description: "Request options",
2026 type: {:map, :string}
2034 key: Pleroma.Web.MediaProxy.Invalidation.Script,
2036 description: "Script invalidate settings",
2041 description: "Path to shell script. Which will run purge cache.",
2042 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2050 description: "Gopher settings",
2055 description: "Enables the gopher interface"
2061 description: "IP address to bind to",
2062 suggestions: [{0, 0, 0, 0}]
2067 description: "Port to bind to",
2073 description: "Port advertised in URLs (optional, defaults to port)",
2081 label: "ActivityPub",
2083 description: "ActivityPub-related settings",
2086 key: :unfollow_blocked,
2088 description: "Whether blocks result in people getting unfollowed"
2091 key: :outgoing_blocks,
2093 description: "Whether to federate blocks to other instances"
2096 key: :blockers_visible,
2098 description: "Whether a user can see someone who has blocked them"
2101 key: :sign_object_fetches,
2103 description: "Sign object fetches with HTTP signatures"
2106 key: :note_replies_output_limit,
2109 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2112 key: :follow_handshake_timeout,
2114 description: "Following handshake timeout",
2121 key: :http_security,
2122 label: "HTTP security",
2124 description: "HTTP security settings",
2129 description: "Whether the managed content security policy is enabled"
2135 description: "Whether to additionally send a Strict-Transport-Security header"
2139 label: "STS max age",
2141 description: "The maximum age for the Strict-Transport-Security header if sent",
2142 suggestions: [31_536_000]
2146 label: "CT max age",
2148 description: "The maximum age for the Expect-CT header if sent",
2149 suggestions: [2_592_000]
2152 key: :referrer_policy,
2154 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2155 suggestions: ["same-origin", "no-referrer"]
2159 label: "Report URI",
2161 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2162 suggestions: ["https://example.com/report-uri"]
2167 group: :web_push_encryption,
2168 key: :vapid_details,
2169 label: "Vapid Details",
2172 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2178 "A mailto link for the administrative contact." <>
2179 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2180 suggestions: ["mailto:moderators@pleroma.com"]
2185 description: "VAPID public key",
2186 suggestions: ["Public key"]
2191 description: "VAPID private key",
2192 suggestions: ["Private key"]
2198 key: Pleroma.Captcha,
2200 description: "Captcha-related settings",
2205 description: "Whether the captcha should be shown on registration"
2210 description: "The method/service to use for captcha",
2211 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2214 key: :seconds_valid,
2216 description: "The time in seconds for which the captcha is valid",
2223 key: Pleroma.Captcha.Kocaptcha,
2226 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2227 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2232 description: "The kocaptcha endpoint to use",
2233 suggestions: ["https://captcha.kotobank.ch"]
2239 label: "Pleroma Admin Token",
2242 "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)",
2247 description: "Admin token",
2249 "Please use a high entropy string or UUID"
2259 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2261 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2262 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2263 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2264 (see https://github.com/sorentwo/oban/issues/52).
2269 type: {:dropdown, :atom},
2270 description: "Logs verbose mode",
2271 suggestions: [false, :error, :warn, :info, :debug]
2275 type: {:keyword, :integer},
2277 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2279 activity_expiration: 10,
2280 attachments_cleanup: 5,
2282 federator_incoming: 50,
2283 federator_outgoing: 50,
2285 scheduled_activities: 10,
2291 key: :activity_expiration,
2293 description: "Activity expiration queue",
2297 key: :attachments_cleanup,
2299 description: "Attachment deletion queue",
2305 description: "Background queue",
2309 key: :federator_incoming,
2311 description: "Incoming federation queue",
2315 key: :federator_outgoing,
2317 description: "Outgoing federation queue",
2323 description: "Email sender queue, see Pleroma.Emails.Mailer",
2327 key: :scheduled_activities,
2329 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2333 key: :transmogrifier,
2335 description: "Transmogrifier queue",
2341 description: "Web push notifications queue",
2348 type: {:list, :tuple},
2349 description: "Settings for cron background jobs",
2351 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2352 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2361 description: "Includes custom worker options not interpretable directly by `Oban`",
2365 type: {:keyword, :integer},
2366 description: "Max retry attempts for failed jobs, per `Oban` queue",
2368 federator_incoming: 5,
2369 federator_outgoing: 5
2376 key: Pleroma.Web.Metadata,
2378 description: "Metadata-related settings",
2382 type: {:list, :module},
2383 description: "List of metadata providers to enable",
2385 Pleroma.Web.Metadata.Providers.OpenGraph,
2386 Pleroma.Web.Metadata.Providers.TwitterCard,
2387 Pleroma.Web.Metadata.Providers.RelMe,
2388 Pleroma.Web.Metadata.Providers.Feed
2393 label: "Unfurl NSFW",
2395 description: "When enabled NSFW attachments will be shown in previews"
2404 "If enabled the instance will parse metadata from attached links to generate link previews",
2409 description: "Enables RichMedia parsing of URLs"
2413 type: {:list, :string},
2414 description: "List of hosts which will be ignored by the metadata parser",
2415 suggestions: ["accounts.google.com", "xss.website"]
2419 label: "Ignore TLD",
2420 type: {:list, :string},
2421 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2422 suggestions: ["local", "localdomain", "lan"]
2426 type: {:list, :module},
2428 "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.",
2430 Pleroma.Web.RichMedia.Parsers.OEmbed,
2431 Pleroma.Web.RichMedia.Parsers.TwitterCard
2436 label: "TTL setters",
2437 type: {:list, :module},
2439 "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.",
2441 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2445 key: :failure_backoff,
2448 "Amount of milliseconds after request failure, during which the request will not be retried.",
2449 suggestions: [60_000]
2455 key: Pleroma.Formatter,
2459 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2463 type: [:string, :boolean],
2464 description: "Specify the class to be added to the generated link. Disable to clear.",
2465 suggestions: ["auto-linker", false]
2469 type: [:string, :boolean],
2470 description: "Override the rel attribute. Disable to clear.",
2471 suggestions: ["ugc", "noopener noreferrer", false]
2476 description: "Link URLs will open in a new window/tab."
2480 type: [:integer, :boolean],
2482 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2483 suggestions: [15, false]
2488 description: "Strip the scheme prefix."
2493 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2497 type: [:atom, :boolean],
2499 "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)",
2500 suggestions: [:no_scheme, true]
2506 key: Pleroma.ScheduledActivity,
2508 description: "Scheduled activities settings",
2511 key: :daily_user_limit,
2514 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2518 key: :total_user_limit,
2521 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2527 description: "Whether scheduled activities are sent to the job queue to be executed"
2533 key: Pleroma.Workers.PurgeExpiredActivity,
2535 description: "Expired activities settings",
2540 description: "Enables expired activities addition & deletion"
2545 description: "Minimum lifetime for ephemeral activity (in seconds)",
2552 label: "Pleroma Authenticator",
2554 description: "Authenticator",
2557 key: Pleroma.Web.Auth.Authenticator,
2559 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2569 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2570 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2571 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2572 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2577 description: "Enables LDAP authentication"
2582 description: "LDAP server hostname",
2583 suggestions: ["localhosts"]
2588 description: "LDAP port, e.g. 389 or 636",
2589 suggestions: [389, 636]
2595 description: "Enable to use SSL, usually implies the port 636"
2599 label: "SSL options",
2601 description: "Additional SSL options",
2602 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2607 description: "Path to file with PEM encoded cacerts",
2608 suggestions: ["path/to/file/with/PEM/cacerts"]
2613 description: "Type of cert verification",
2614 suggestions: [:verify_peer]
2622 description: "Enable to use STARTTLS, usually implies the port 389"
2626 label: "TLS options",
2628 description: "Additional TLS options",
2629 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2634 description: "Path to file with PEM encoded cacerts",
2635 suggestions: ["path/to/file/with/PEM/cacerts"]
2640 description: "Type of cert verification",
2641 suggestions: [:verify_peer]
2648 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2649 suggestions: ["dc=example,dc=com"]
2656 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2665 description: "Authentication / authorization settings",
2668 key: :enforce_oauth_admin_scope_usage,
2669 label: "Enforce OAuth admin scope usage",
2672 "OAuth admin scope requirement toggle. " <>
2673 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2674 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2675 "`is_admin` user flag grants access to admin-specific actions."
2678 key: :auth_template,
2681 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2682 suggestions: ["show.html"]
2685 key: :oauth_consumer_template,
2686 label: "OAuth consumer template",
2689 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2690 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2691 suggestions: ["consumer.html"]
2694 key: :oauth_consumer_strategies,
2695 label: "OAuth consumer strategies",
2696 type: {:list, :string},
2698 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2699 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2700 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2701 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2707 key: :email_notifications,
2709 description: "Email notifications settings",
2715 "emails of \"what you've missed\" for users who have been inactive for a while",
2719 schedule: "0 0 * * 0",
2721 inactivity_threshold: 7
2729 description: "Globally enable or disable digest emails"
2735 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2736 suggestions: ["0 0 * * 0"]
2741 description: "Minimum interval between digest emails to one user",
2745 key: :inactivity_threshold,
2747 description: "Minimum user inactivity threshold",
2756 key: Pleroma.Emails.UserEmail,
2758 description: "Email template settings",
2762 type: {:string, :image},
2763 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2764 suggestions: ["some/path/logo.png"]
2769 description: "A map with color settings for email templates.",
2772 link_color: "#d8a070",
2773 background_color: "#2C3645",
2774 content_background_color: "#1B2635",
2775 header_color: "#d8a070",
2776 text_color: "#b9b9ba",
2777 text_muted_color: "#b9b9ba"
2784 suggestions: ["#d8a070"]
2787 key: :background_color,
2789 suggestions: ["#2C3645"]
2792 key: :content_background_color,
2794 suggestions: ["#1B2635"]
2799 suggestions: ["#d8a070"]
2804 suggestions: ["#b9b9ba"]
2807 key: :text_muted_color,
2809 suggestions: ["#b9b9ba"]
2817 key: Pleroma.Emails.NewUsersDigestEmail,
2819 description: "New users admin email digest",
2824 description: "Enables new users admin digest email when `true`"
2833 description: "Configure OAuth 2 provider capabilities",
2836 key: :token_expires_in,
2838 description: "The lifetime in seconds of the access token",
2842 key: :issue_new_refresh_token,
2845 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2848 key: :clean_expired_tokens,
2850 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2860 key: :shortcode_globs,
2861 type: {:list, :string},
2862 description: "Location of custom emoji files. * can be used as a wildcard.",
2863 suggestions: ["/emoji/custom/**/*.png"]
2866 key: :pack_extensions,
2867 type: {:list, :string},
2869 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2870 suggestions: [".png", ".gif"]
2874 type: {:keyword, {:list, :string}},
2876 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2877 " and the value is the location or array of locations. * can be used as a wildcard.",
2879 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2883 key: :default_manifest,
2886 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2887 " Currently only one manifest can be added (no arrays).",
2888 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2891 key: :shared_pack_cache_seconds_per_file,
2892 label: "Shared pack cache s/file",
2895 "When an emoji pack is shared, the archive is created and cached in memory" <>
2896 " for this amount of seconds multiplied by the number of files.",
2906 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2910 type: [:tuple, {:list, :tuple}],
2911 description: "For the search requests (account & status search etc.)",
2912 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2916 type: [:tuple, {:list, :tuple}],
2917 description: "For requests to timelines (each timeline has it's own limiter)",
2918 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2921 key: :app_account_creation,
2922 type: [:tuple, {:list, :tuple}],
2923 description: "For registering user accounts from the same IP address",
2924 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2927 key: :relations_actions,
2928 type: [:tuple, {:list, :tuple}],
2929 description: "For actions on relationships with all users (follow, unfollow)",
2930 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2933 key: :relation_id_action,
2934 label: "Relation ID action",
2935 type: [:tuple, {:list, :tuple}],
2936 description: "For actions on relation with a specific user (follow, unfollow)",
2937 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2940 key: :statuses_actions,
2941 type: [:tuple, {:list, :tuple}],
2943 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2944 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2947 key: :status_id_action,
2948 label: "Status ID action",
2949 type: [:tuple, {:list, :tuple}],
2951 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2952 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2955 key: :authentication,
2956 type: [:tuple, {:list, :tuple}],
2957 description: "For authentication create / password check / user existence check requests",
2958 suggestions: [{60_000, 15}]
2967 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2968 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2973 description: "Enables SSH"
2978 description: "Dir with SSH keys",
2979 suggestions: ["/some/path/ssh_keys"]
2984 description: "Handler module",
2985 suggestions: ["Pleroma.BBS.Handler"]
2990 description: "Port to connect",
2991 suggestions: [10_022]
2994 key: :password_authenticator,
2996 description: "Authenticator module",
2997 suggestions: ["Pleroma.BBS.Authenticator"]
3003 label: "Mime Types",
3005 description: "Mime Types settings",
3012 "application/xml" => ["xml"],
3013 "application/xrd+xml" => ["xrd+xml"],
3014 "application/jrd+json" => ["jrd+json"],
3015 "application/activity+json" => ["activity+json"],
3016 "application/ld+json" => ["activity+json"]
3021 key: "application/xml",
3022 type: {:list, :string},
3023 suggestions: ["xml"]
3026 key: "application/xrd+xml",
3027 type: {:list, :string},
3028 suggestions: ["xrd+xml"]
3031 key: "application/jrd+json",
3032 type: {:list, :string},
3033 suggestions: ["jrd+json"]
3036 key: "application/activity+json",
3037 type: {:list, :string},
3038 suggestions: ["activity+json"]
3041 key: "application/ld+json",
3042 type: {:list, :string},
3043 suggestions: ["activity+json"]
3053 description: "Pleroma chat settings",
3066 description: "HTTP settings",
3071 type: [:string, :tuple],
3072 description: "Proxy URL",
3073 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3076 key: :send_user_agent,
3081 type: [:string, :atom],
3083 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3084 suggestions: ["Pleroma", :default]
3089 description: "Adapter specific options",
3095 label: "SSL Options",
3096 description: "SSL options for HTTP adapter",
3100 type: {:list, :atom},
3101 description: "List of TLS version to use",
3102 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3113 label: "Markup Settings",
3117 key: :allow_inline_images,
3121 key: :allow_headings,
3134 type: {:list, :module},
3136 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3137 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3147 key: :deny_follow_blocked,
3154 key: :mrf_normalize_markup,
3156 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3157 label: "MRF Normalize Markup",
3158 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3164 suggestions: [Pleroma.HTML.Scrubber.Default]
3174 key: :restricted_nicknames,
3175 type: {:list, :string},
3176 description: "List of nicknames users may not register with.",
3195 "ostatus_subscribe",
3211 key: :email_blacklist,
3212 type: {:list, :string},
3213 description: "List of email domains users may not register with.",
3214 suggestions: ["mailinator.com", "maildrop.cc"]
3220 label: "CORS plug config",
3226 suggestions: [86_400]
3230 type: {:list, :string},
3231 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3235 type: {:list, :string},
3238 "X-RateLimit-Reset",
3239 "X-RateLimit-Limit",
3240 "X-RateLimit-Remaining",
3251 type: {:list, :string},
3252 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3258 key: Pleroma.Plugs.RemoteIp,
3261 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3262 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3268 description: "Enable/disable the plug. Default: disabled."
3272 type: {:list, :string},
3274 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
3279 type: {:list, :string},
3281 "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."
3285 type: {:list, :string},
3287 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"]`
3294 key: :web_cache_ttl,
3295 label: "Web cache TTL",
3298 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3304 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3305 suggestions: [30_000, nil]
3308 key: :activity_pub_question,
3310 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3311 suggestions: [30_000]
3321 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3326 description: "Enables the rendering of static HTML. Default: disabled."
3334 description: "Configure feed rendering",
3339 description: "Configure title rendering",
3344 description: "Maximum number of characters before truncating title",
3350 description: "Replacement which will be used after truncating string",
3351 suggestions: ["..."]
3359 key: :mrf_object_age,
3361 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3362 label: "MRF Object Age",
3365 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3370 description: "Required age (in seconds) of a post before actions are taken.",
3371 suggestions: [172_800]
3375 type: {:list, :atom},
3377 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3378 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3379 "`:reject` rejects the message entirely",
3380 suggestions: [:delist, :strip_followers, :reject]
3388 description: "Custom Runtime Modules",
3393 description: "A path to custom Elixir modules (such as MRF policies)."
3401 description: "Settings for notifications streamer",
3406 description: "Number of workers to send notifications",
3410 key: :overflow_workers,
3412 description: "Maximum number of workers created if pool is empty",
3419 key: :connections_pool,
3421 description: "Advanced settings for `Gun` connections pool",
3424 key: :connection_acquisition_wait,
3427 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3431 key: :connection_acquisition_retries,
3434 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3438 key: :max_connections,
3440 description: "Maximum number of connections in the pool. Default: 250 connections.",
3444 key: :connect_timeout,
3446 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3450 key: :reclaim_multiplier,
3453 "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",
3462 description: "Advanced settings for `Gun` workers pools",
3464 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3468 description: "Settings for #{pool_name} pool.",
3473 description: "Maximum number of concurrent requests in the pool.",
3480 "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",
3486 description: "Timeout for the pool while gun will wait for response",
3487 suggestions: [10_000]
3495 key: :hackney_pools,
3497 description: "Advanced settings for `Hackney` connections pools",
3502 description: "Settings for federation pool.",
3505 key: :max_connections,
3507 description: "Number workers in the pool.",
3513 description: "Timeout while `hackney` will wait for response.",
3514 suggestions: [150_000]
3521 description: "Settings for media pool.",
3524 key: :max_connections,
3526 description: "Number workers in the pool.",
3532 description: "Timeout while `hackney` will wait for response.",
3533 suggestions: [150_000]
3540 description: "Settings for upload pool.",
3543 key: :max_connections,
3545 description: "Number workers in the pool.",
3551 description: "Timeout while `hackney` will wait for response.",
3552 suggestions: [300_000]
3560 key: :restrict_unauthenticated,
3561 label: "Restrict Unauthenticated",
3564 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3569 description: "Settings for public and federated timelines.",
3574 description: "Disallow view public timeline."
3579 description: "Disallow view federated timeline."
3586 description: "Settings for user profiles.",
3591 description: "Disallow view local user profiles."
3596 description: "Disallow view remote user profiles."
3603 description: "Settings for statuses.",
3608 description: "Disallow view local statuses."
3613 description: "Disallow view remote statuses."
3621 key: Pleroma.Web.ApiSpec.CastAndValidate,
3628 "Enables strict input validation (useful in development, not recommended in production)"
3634 key: :instances_favicons,
3636 description: "Control favicons for instances",
3641 description: "Allow/disallow displaying and getting instances favicons"
3649 descriptions: "S3 service related settings",
3652 key: :access_key_id,
3654 description: "S3 access key ID",
3655 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3658 key: :secret_access_key,
3660 description: "Secret access key",
3661 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3666 description: "S3 host",
3667 suggestions: ["s3.eu-central-1.amazonaws.com"]
3675 description: "Installed frontends management",
3680 description: "Primary frontend, the one that is served for all pages by default",
3681 children: installed_frontend_options
3686 description: "Admin frontend",
3687 children: installed_frontend_options
3693 "A map containing available frontends and parameters for their installation.",
3694 children: frontend_options
3700 key: Pleroma.Web.Preload,
3702 description: "Preload-related settings",
3706 type: {:list, :module},
3707 description: "List of preload providers to enable",
3709 Pleroma.Web.Preload.Providers.Instance,
3710 Pleroma.Web.Preload.Providers.User,
3711 Pleroma.Web.Preload.Providers.Timelines,
3712 Pleroma.Web.Preload.Providers.StatusNet