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: :autofollowing_nicknames,
842 type: {:list, :string},
844 "Set to nicknames of (local) users that automatically follows every newly registered user"
847 key: :attachment_links,
849 description: "Enable to automatically add attachment link text to statuses"
852 key: :max_report_comment_size,
854 description: "The maximum size of the report comment. Default: 1000.",
860 key: :safe_dm_mentions,
861 label: "Safe DM mentions",
864 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
865 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
871 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
874 key: :remote_post_retention_days,
877 "The default amount of days to retain remote posts when pruning the database",
883 key: :user_bio_length,
885 description: "A user bio maximum length. Default: 5000.",
891 key: :user_name_length,
893 description: "A user name maximum length. Default: 100.",
899 key: :skip_thread_containment,
901 description: "Skip filtering out broken threads. Default: enabled."
904 key: :limit_to_local_content,
905 type: {:dropdown, :atom},
907 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
915 key: :max_account_fields,
917 description: "The maximum number of custom fields in the user profile. Default: 10.",
923 key: :max_remote_account_fields,
926 "The maximum number of custom fields in the remote user profile. Default: 20.",
932 key: :account_field_name_length,
934 description: "An account field name maximum length. Default: 512.",
940 key: :account_field_value_length,
942 description: "An account field value maximum length. Default: 2048.",
948 key: :registration_reason_length,
950 description: "Maximum registration reason length. Default: 500.",
956 key: :external_user_synchronization,
958 description: "Enabling following/followers counters synchronization for external users"
961 key: :multi_factor_authentication,
963 description: "Multi-factor authentication settings",
966 totp: [digits: 6, period: 30],
967 backup_codes: [number: 5, length: 16]
973 label: "TOTP settings",
975 description: "TOTP settings",
976 suggestions: [digits: 6, period: 30],
983 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
990 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
997 description: "MFA backup codes settings",
998 suggestions: [number: 5, length: 16],
1004 description: "Number of backup codes to generate."
1011 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
1018 key: :instance_thumbnail,
1019 type: {:string, :image},
1021 "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.",
1022 suggestions: ["/instance/thumbnail.jpeg"]
1025 key: :show_reactions,
1027 description: "Let favourites and emoji reactions be viewed through the API."
1035 description: "Welcome messages settings",
1038 key: :direct_message,
1040 descpiption: "Direct message settings",
1045 description: "Enables sending a direct message to newly registered users"
1050 description: "A message that will be sent to newly registered users",
1052 "Hi, @username! Welcome on board!"
1056 key: :sender_nickname,
1058 description: "The nickname of the local user that sends a welcome message",
1068 descpiption: "Chat message settings",
1073 description: "Enables sending a chat message to newly registered users"
1079 "A message that will be sent to newly registered users as a chat message",
1081 "Hello, welcome on board!"
1085 key: :sender_nickname,
1087 description: "The nickname of the local user that sends a welcome chat message",
1097 descpiption: "Email message settings",
1102 description: "Enables sending an email to newly registered users"
1106 type: [:string, :tuple],
1108 "Email address and/or nickname that will be used to send the welcome email.",
1110 {"Pleroma App", "welcome@pleroma.app"}
1117 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1118 suggestions: ["Welcome to <%= instance_name%>"]
1124 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1125 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1131 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1132 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1141 description: "Logger-related settings",
1145 type: [:atom, :tuple, :module],
1147 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1148 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1156 label: "ExSyslogger",
1157 description: "ExSyslogger-related settings",
1161 type: {:dropdown, :atom},
1162 description: "Log level",
1163 suggestions: [:debug, :info, :warn, :error]
1169 "A string that's prepended to every message, and is typically set to the app name",
1170 suggestions: ["pleroma"]
1175 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1176 suggestions: ["$metadata[$level] $message"]
1180 type: {:list, :atom},
1181 suggestions: [:request_id]
1189 label: "Console Logger",
1190 description: "Console logger settings",
1194 type: {:dropdown, :atom},
1195 description: "Log level",
1196 suggestions: [:debug, :info, :warn, :error]
1201 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1202 suggestions: ["$metadata[$level] $message"]
1206 type: {:list, :atom},
1207 suggestions: [:request_id]
1214 label: "Quack Logger",
1215 description: "Quack-related settings",
1219 type: {:dropdown, :atom},
1220 description: "Log level",
1221 suggestions: [:debug, :info, :warn, :error]
1225 type: {:list, :atom},
1226 description: "Configure which metadata you want to report on",
1243 label: "Webhook URL",
1245 description: "Configure the Slack incoming webhook",
1246 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1252 key: :frontend_configurations,
1255 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1256 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1257 "add your own configuration your settings all fields must be complete.",
1261 label: "Pleroma FE",
1263 description: "Settings for Pleroma FE",
1266 alwaysShowSubjectInput: true,
1267 background: "/static/aurora_borealis.jpg",
1268 collapseMessageWithSubject: false,
1271 hideFilteredStatuses: false,
1272 hideMutedPosts: false,
1273 hidePostStats: false,
1274 hideSitename: false,
1275 hideUserStats: false,
1276 loginMethod: "password",
1277 logo: "/static/logo.png",
1280 minimalScopesMode: false,
1281 noAttachmentLinks: false,
1282 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1283 postContentType: "text/plain",
1284 redirectRootLogin: "/main/friends",
1285 redirectRootNoLogin: "/main/all",
1287 sidebarRight: false,
1288 showFeaturesPanel: true,
1289 showInstanceSpecificPanel: false,
1290 subjectLineBehavior: "email",
1291 theme: "pleroma-dark",
1292 webPushNotifications: false
1297 key: :alwaysShowSubjectInput,
1298 label: "Always show subject input",
1300 description: "When disabled, auto-hide the subject field if it's empty"
1304 type: {:string, :image},
1306 "URL of the background, unless viewing a user profile with a background that is set",
1307 suggestions: ["/images/city.jpg"]
1310 key: :collapseMessageWithSubject,
1311 label: "Collapse message with subject",
1314 "When a message has a subject (aka Content Warning), collapse it by default"
1318 label: "PleromaFE Chat",
1320 description: "Disables PleromaFE Chat component"
1326 description: "Enables green text on lines prefixed with the > character"
1329 key: :hideFilteredStatuses,
1330 label: "Hide Filtered Statuses",
1332 description: "Hides filtered statuses from timelines"
1335 key: :hideMutedPosts,
1336 label: "Hide Muted Posts",
1338 description: "Hides muted statuses from timelines"
1341 key: :hidePostStats,
1342 label: "Hide post stats",
1344 description: "Hide notices statistics (repeats, favorites, ...)"
1348 label: "Hide Sitename",
1350 description: "Hides instance name from PleromaFE banner"
1353 key: :hideUserStats,
1354 label: "Hide user stats",
1357 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1361 type: {:string, :image},
1362 description: "URL of the logo, defaults to Pleroma's logo",
1363 suggestions: ["/static/logo.png"]
1367 label: "Logo margin",
1370 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1371 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1372 suggestions: [".1em"]
1379 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1380 "If you want a colorful logo you must disable logoMask."
1383 key: :minimalScopesMode,
1384 label: "Minimal scopes mode",
1387 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1388 "Also prevents replying to a DM with a public post from PleromaFE."
1391 key: :nsfwCensorImage,
1392 label: "NSFW Censor Image",
1393 type: {:string, :image},
1395 "URL of the image to use for hiding NSFW media attachments in the timeline",
1396 suggestions: ["/static/img/nsfw.74818f9.png"]
1399 key: :postContentType,
1400 label: "Post Content Type",
1401 type: {:dropdown, :atom},
1402 description: "Default post formatting option",
1403 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1406 key: :redirectRootNoLogin,
1407 label: "Redirect root no login",
1410 "Relative URL which indicates where to redirect when a user isn't logged in",
1411 suggestions: ["/main/all"]
1414 key: :redirectRootLogin,
1415 label: "Redirect root login",
1418 "Relative URL which indicates where to redirect when a user is logged in",
1419 suggestions: ["/main/friends"]
1423 label: "Scope copy",
1425 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1429 label: "Sidebar on Right",
1431 description: "Change alignment of sidebar and panels to the right"
1434 key: :showFeaturesPanel,
1435 label: "Show instance features panel",
1438 "Enables panel displaying functionality of the instance on the About page"
1441 key: :showInstanceSpecificPanel,
1442 label: "Show instance specific panel",
1444 description: "Whether to show the instance's custom panel"
1447 key: :subjectLineBehavior,
1448 label: "Subject line behavior",
1450 description: "Allows changing the default behaviour of subject lines in replies.
1451 `email`: copy and preprend re:, as in email,
1452 `masto`: copy verbatim, as in Mastodon,
1453 `noop`: don't copy the subject.",
1454 suggestions: ["email", "masto", "noop"]
1459 description: "Which theme to use. Available themes are defined in styles.json",
1460 suggestions: ["pleroma-dark"]
1468 description: "Settings for Masto FE",
1471 showInstanceSpecificPanel: true
1476 key: :showInstanceSpecificPanel,
1477 label: "Show instance specific panel",
1479 description: "Whenether to show the instance's specific panel"
1490 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1494 type: {:keyword, :map},
1496 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1499 url: "/images/pleroma-fox-tan-smol.png",
1500 mime_type: "image/png"
1502 pleroma_fox_tan_shy: %{
1503 url: "/images/pleroma-fox-tan-shy.png",
1504 mime_type: "image/png"
1509 key: :default_mascot,
1512 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1518 key: :default_user_avatar,
1519 type: {:string, :image},
1520 description: "URL of the default user avatar",
1521 suggestions: ["/images/avi.png"]
1530 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1534 type: {:list, :map},
1535 description: "Describe the icons of the app",
1538 src: "/static/logo.png"
1541 src: "/static/icon.png",
1545 src: "/static/icon.ico",
1546 sizes: "72x72 96x96 128x128 256x256"
1553 description: "Describe the theme color of the app",
1554 suggestions: ["#282c37", "mediumpurple"]
1557 key: :background_color,
1559 description: "Describe the background color of the app",
1560 suggestions: ["#191b22", "aliceblue"]
1570 description: "General MRF settings",
1574 type: [:module, {:list, :module}],
1576 "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.",
1577 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1581 label: "MRF transparency",
1584 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1587 key: :transparency_exclusions,
1588 label: "MRF transparency exclusions",
1589 type: {:list, :string},
1591 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1602 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1603 label: "MRF Simple",
1605 description: "Simple ingress policies",
1608 key: :media_removal,
1609 type: {:list, :string},
1610 description: "List of instances to strip media attachments from",
1611 suggestions: ["example.com", "*.example.com"]
1615 label: "Media NSFW",
1616 type: {:list, :string},
1617 description: "List of instances to tag all media as NSFW (sensitive) from",
1618 suggestions: ["example.com", "*.example.com"]
1621 key: :federated_timeline_removal,
1622 type: {:list, :string},
1624 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1625 suggestions: ["example.com", "*.example.com"]
1629 type: {:list, :string},
1630 description: "List of instances to reject activities from (except deletes)",
1631 suggestions: ["example.com", "*.example.com"]
1635 type: {:list, :string},
1636 description: "List of instances to only accept activities from (except deletes)",
1637 suggestions: ["example.com", "*.example.com"]
1640 key: :followers_only,
1641 type: {:list, :string},
1642 description: "Force posts from the given instances to be visible by followers only",
1643 suggestions: ["example.com", "*.example.com"]
1646 key: :report_removal,
1647 type: {:list, :string},
1648 description: "List of instances to reject reports from",
1649 suggestions: ["example.com", "*.example.com"]
1652 key: :avatar_removal,
1653 type: {:list, :string},
1654 description: "List of instances to strip avatars from",
1655 suggestions: ["example.com", "*.example.com"]
1658 key: :banner_removal,
1659 type: {:list, :string},
1660 description: "List of instances to strip banners from",
1661 suggestions: ["example.com", "*.example.com"]
1664 key: :reject_deletes,
1665 type: {:list, :string},
1666 description: "List of instances to reject deletions from",
1667 suggestions: ["example.com", "*.example.com"]
1673 key: :mrf_activity_expiration,
1675 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1676 label: "MRF Activity Expiration Policy",
1678 description: "Adds automatic expiration to all local activities",
1683 description: "Default global expiration time for all local activities (in days)",
1684 suggestions: [90, 365]
1692 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1693 label: "MRF Subchain",
1696 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1697 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1701 type: {:map, {:list, :string}},
1702 description: "Matches a series of regular expressions against the actor field",
1705 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1713 key: :mrf_rejectnonpublic,
1715 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1716 description: "RejectNonPublic drops posts with non-public visibility settings.",
1717 label: "MRF Reject Non Public",
1721 key: :allow_followersonly,
1722 label: "Allow followers-only",
1724 description: "Whether to allow followers-only posts"
1729 description: "Whether to allow direct messages"
1735 key: :mrf_hellthread,
1737 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1738 label: "MRF Hellthread",
1740 description: "Block messages with excessive user mentions",
1743 key: :delist_threshold,
1746 "Number of mentioned users after which the message gets removed from timelines and" <>
1747 "disables notifications. Set to 0 to disable.",
1751 key: :reject_threshold,
1754 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1763 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1764 label: "MRF Keyword",
1766 description: "Reject or Word-Replace messages with a keyword or regex",
1770 type: {:list, :string},
1772 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1773 suggestions: ["foo", ~r/foo/iu]
1776 key: :federated_timeline_removal,
1777 type: {:list, :string},
1779 "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.",
1780 suggestions: ["foo", ~r/foo/iu]
1784 type: {:list, :tuple},
1786 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1787 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1795 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1796 label: "MRF Mention",
1798 description: "Block messages which mention a specific user",
1802 type: {:list, :string},
1803 description: "A list of actors for which any post mentioning them will be dropped",
1804 suggestions: ["actor1", "actor2"]
1810 key: :mrf_vocabulary,
1812 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1813 label: "MRF Vocabulary",
1815 description: "Filter messages which belong to certain activity vocabularies",
1819 type: {:list, :string},
1821 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1822 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1826 type: {:list, :string},
1828 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1829 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1835 # key: :mrf_user_allowlist,
1837 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1840 # "The keys in this section are the domain names that the policy should apply to." <>
1841 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1843 # %{"example.org" => ["https://example.org/users/admin"]}
1851 description: "Media proxy",
1856 description: "Enables proxying of remote media to the instance's proxy"
1863 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1864 suggestions: ["https://example.com"]
1872 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1878 description: "Enables media cache object invalidation."
1883 description: "Module which will be used to purge objects from the cache.",
1885 Pleroma.Web.MediaProxy.Invalidation.Script,
1886 Pleroma.Web.MediaProxy.Invalidation.Http
1893 label: "Proxy Options",
1895 description: "Options for Pleroma.ReverseProxy",
1897 redirect_on_failure: false,
1898 max_body_length: 25 * 1_048_576,
1899 max_read_duration: 30_000,
1901 follow_redirect: true,
1907 key: :redirect_on_failure,
1910 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1911 "Any error during body processing will not be redirected as the response is chunked."
1914 key: :max_body_length,
1917 "Limits the content length to be approximately the " <>
1918 "specified length. It is validated with the `content-length` header and also verified when proxying."
1921 key: :max_read_duration,
1923 description: "Timeout (in milliseconds) of GET request to remote URI."
1929 description: "HTTP options",
1934 description: "Adapter specific options",
1939 label: "SSL Options",
1940 description: "SSL options for HTTP adapter",
1944 type: {:list, :atom},
1945 description: "List of TLS version to use",
1946 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1955 type: [:string, :tuple],
1956 description: "Proxy URL",
1957 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1965 type: {:list, :string},
1966 description: "List of hosts with scheme to bypass the mediaproxy",
1967 suggestions: ["http://example.com"]
1973 key: :media_preview_proxy,
1975 description: "Media preview proxy",
1981 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1984 key: :thumbnail_max_width,
1987 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1990 key: :thumbnail_max_height,
1993 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1996 key: :image_quality,
1998 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
2001 key: :min_content_length,
2004 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
2010 key: Pleroma.Web.MediaProxy.Invalidation.Http,
2012 description: "HTTP invalidate settings",
2017 description: "HTTP method of request. Default: :purge"
2021 type: {:keyword, :string},
2022 description: "HTTP headers of request",
2023 suggestions: [{"x-refresh", 1}]
2028 description: "Request options",
2032 type: {:map, :string}
2040 key: Pleroma.Web.MediaProxy.Invalidation.Script,
2042 description: "Script invalidate settings",
2047 description: "Path to shell script. Which will run purge cache.",
2048 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2056 description: "Gopher settings",
2061 description: "Enables the gopher interface"
2067 description: "IP address to bind to",
2068 suggestions: [{0, 0, 0, 0}]
2073 description: "Port to bind to",
2079 description: "Port advertised in URLs (optional, defaults to port)",
2087 label: "ActivityPub",
2089 description: "ActivityPub-related settings",
2092 key: :unfollow_blocked,
2094 description: "Whether blocks result in people getting unfollowed"
2097 key: :outgoing_blocks,
2099 description: "Whether to federate blocks to other instances"
2102 key: :sign_object_fetches,
2104 description: "Sign object fetches with HTTP signatures"
2107 key: :note_replies_output_limit,
2110 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2113 key: :follow_handshake_timeout,
2115 description: "Following handshake timeout",
2122 key: :http_security,
2123 label: "HTTP security",
2125 description: "HTTP security settings",
2130 description: "Whether the managed content security policy is enabled"
2136 description: "Whether to additionally send a Strict-Transport-Security header"
2140 label: "STS max age",
2142 description: "The maximum age for the Strict-Transport-Security header if sent",
2143 suggestions: [31_536_000]
2147 label: "CT max age",
2149 description: "The maximum age for the Expect-CT header if sent",
2150 suggestions: [2_592_000]
2153 key: :referrer_policy,
2155 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2156 suggestions: ["same-origin", "no-referrer"]
2160 label: "Report URI",
2162 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2163 suggestions: ["https://example.com/report-uri"]
2168 group: :web_push_encryption,
2169 key: :vapid_details,
2170 label: "Vapid Details",
2173 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2179 "A mailto link for the administrative contact." <>
2180 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2181 suggestions: ["mailto:moderators@pleroma.com"]
2186 description: "VAPID public key",
2187 suggestions: ["Public key"]
2192 description: "VAPID private key",
2193 suggestions: ["Private key"]
2199 key: Pleroma.Captcha,
2201 description: "Captcha-related settings",
2206 description: "Whether the captcha should be shown on registration"
2211 description: "The method/service to use for captcha",
2212 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2215 key: :seconds_valid,
2217 description: "The time in seconds for which the captcha is valid",
2224 key: Pleroma.Captcha.Kocaptcha,
2227 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2228 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2233 description: "The kocaptcha endpoint to use",
2234 suggestions: ["https://captcha.kotobank.ch"]
2240 label: "Pleroma Admin Token",
2243 "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)",
2248 description: "Admin token",
2250 "Please use a high entropy string or UUID"
2260 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2262 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2263 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2264 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2265 (see https://github.com/sorentwo/oban/issues/52).
2270 type: {:dropdown, :atom},
2271 description: "Logs verbose mode",
2272 suggestions: [false, :error, :warn, :info, :debug]
2276 type: {:keyword, :integer},
2278 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2280 activity_expiration: 10,
2281 attachments_cleanup: 5,
2283 federator_incoming: 50,
2284 federator_outgoing: 50,
2286 scheduled_activities: 10,
2292 key: :activity_expiration,
2294 description: "Activity expiration queue",
2298 key: :attachments_cleanup,
2300 description: "Attachment deletion queue",
2306 description: "Background queue",
2310 key: :federator_incoming,
2312 description: "Incoming federation queue",
2316 key: :federator_outgoing,
2318 description: "Outgoing federation queue",
2324 description: "Email sender queue, see Pleroma.Emails.Mailer",
2328 key: :scheduled_activities,
2330 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2334 key: :transmogrifier,
2336 description: "Transmogrifier queue",
2342 description: "Web push notifications queue",
2349 type: {:list, :tuple},
2350 description: "Settings for cron background jobs",
2352 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2353 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2362 description: "Includes custom worker options not interpretable directly by `Oban`",
2366 type: {:keyword, :integer},
2367 description: "Max retry attempts for failed jobs, per `Oban` queue",
2369 federator_incoming: 5,
2370 federator_outgoing: 5
2377 key: Pleroma.Web.Metadata,
2379 description: "Metadata-related settings",
2383 type: {:list, :module},
2384 description: "List of metadata providers to enable",
2386 Pleroma.Web.Metadata.Providers.OpenGraph,
2387 Pleroma.Web.Metadata.Providers.TwitterCard,
2388 Pleroma.Web.Metadata.Providers.RelMe,
2389 Pleroma.Web.Metadata.Providers.Feed
2394 label: "Unfurl NSFW",
2396 description: "When enabled NSFW attachments will be shown in previews"
2405 "If enabled the instance will parse metadata from attached links to generate link previews",
2410 description: "Enables RichMedia parsing of URLs"
2414 type: {:list, :string},
2415 description: "List of hosts which will be ignored by the metadata parser",
2416 suggestions: ["accounts.google.com", "xss.website"]
2420 label: "Ignore TLD",
2421 type: {:list, :string},
2422 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2423 suggestions: ["local", "localdomain", "lan"]
2427 type: {:list, :module},
2429 "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.",
2431 Pleroma.Web.RichMedia.Parsers.OEmbed,
2432 Pleroma.Web.RichMedia.Parsers.TwitterCard
2437 label: "TTL setters",
2438 type: {:list, :module},
2440 "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.",
2442 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2446 key: :failure_backoff,
2449 "Amount of milliseconds after request failure, during which the request will not be retried.",
2450 suggestions: [60_000]
2456 key: Pleroma.Formatter,
2460 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2464 type: [:string, :boolean],
2465 description: "Specify the class to be added to the generated link. Disable to clear.",
2466 suggestions: ["auto-linker", false]
2470 type: [:string, :boolean],
2471 description: "Override the rel attribute. Disable to clear.",
2472 suggestions: ["ugc", "noopener noreferrer", false]
2477 description: "Link URLs will open in a new window/tab."
2481 type: [:integer, :boolean],
2483 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2484 suggestions: [15, false]
2489 description: "Strip the scheme prefix."
2494 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2498 type: [:atom, :boolean],
2500 "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)",
2501 suggestions: [:no_scheme, true]
2507 key: Pleroma.ScheduledActivity,
2509 description: "Scheduled activities settings",
2512 key: :daily_user_limit,
2515 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2519 key: :total_user_limit,
2522 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2528 description: "Whether scheduled activities are sent to the job queue to be executed"
2534 key: Pleroma.Workers.PurgeExpiredActivity,
2536 description: "Expired activities settings",
2541 description: "Enables expired activities addition & deletion"
2546 description: "Minimum lifetime for ephemeral activity (in seconds)",
2553 label: "Pleroma Authenticator",
2555 description: "Authenticator",
2558 key: Pleroma.Web.Auth.Authenticator,
2560 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2570 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2571 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2572 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2573 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2578 description: "Enables LDAP authentication"
2583 description: "LDAP server hostname",
2584 suggestions: ["localhosts"]
2589 description: "LDAP port, e.g. 389 or 636",
2590 suggestions: [389, 636]
2596 description: "Enable to use SSL, usually implies the port 636"
2600 label: "SSL options",
2602 description: "Additional SSL options",
2603 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2608 description: "Path to file with PEM encoded cacerts",
2609 suggestions: ["path/to/file/with/PEM/cacerts"]
2614 description: "Type of cert verification",
2615 suggestions: [:verify_peer]
2623 description: "Enable to use STARTTLS, usually implies the port 389"
2627 label: "TLS options",
2629 description: "Additional TLS options",
2630 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2635 description: "Path to file with PEM encoded cacerts",
2636 suggestions: ["path/to/file/with/PEM/cacerts"]
2641 description: "Type of cert verification",
2642 suggestions: [:verify_peer]
2649 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2650 suggestions: ["dc=example,dc=com"]
2657 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2666 description: "Authentication / authorization settings",
2669 key: :enforce_oauth_admin_scope_usage,
2670 label: "Enforce OAuth admin scope usage",
2673 "OAuth admin scope requirement toggle. " <>
2674 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2675 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2676 "`is_admin` user flag grants access to admin-specific actions."
2679 key: :auth_template,
2682 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2683 suggestions: ["show.html"]
2686 key: :oauth_consumer_template,
2687 label: "OAuth consumer template",
2690 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2691 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2692 suggestions: ["consumer.html"]
2695 key: :oauth_consumer_strategies,
2696 label: "OAuth consumer strategies",
2697 type: {:list, :string},
2699 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2700 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2701 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2702 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2708 key: :email_notifications,
2710 description: "Email notifications settings",
2716 "emails of \"what you've missed\" for users who have been inactive for a while",
2720 schedule: "0 0 * * 0",
2722 inactivity_threshold: 7
2730 description: "Globally enable or disable digest emails"
2736 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2737 suggestions: ["0 0 * * 0"]
2742 description: "Minimum interval between digest emails to one user",
2746 key: :inactivity_threshold,
2748 description: "Minimum user inactivity threshold",
2757 key: Pleroma.Emails.UserEmail,
2759 description: "Email template settings",
2763 type: {:string, :image},
2764 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2765 suggestions: ["some/path/logo.png"]
2770 description: "A map with color settings for email templates.",
2773 link_color: "#d8a070",
2774 background_color: "#2C3645",
2775 content_background_color: "#1B2635",
2776 header_color: "#d8a070",
2777 text_color: "#b9b9ba",
2778 text_muted_color: "#b9b9ba"
2785 suggestions: ["#d8a070"]
2788 key: :background_color,
2790 suggestions: ["#2C3645"]
2793 key: :content_background_color,
2795 suggestions: ["#1B2635"]
2800 suggestions: ["#d8a070"]
2805 suggestions: ["#b9b9ba"]
2808 key: :text_muted_color,
2810 suggestions: ["#b9b9ba"]
2818 key: Pleroma.Emails.NewUsersDigestEmail,
2820 description: "New users admin email digest",
2825 description: "Enables new users admin digest email when `true`"
2834 description: "Configure OAuth 2 provider capabilities",
2837 key: :token_expires_in,
2839 description: "The lifetime in seconds of the access token",
2843 key: :issue_new_refresh_token,
2846 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2849 key: :clean_expired_tokens,
2851 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2861 key: :shortcode_globs,
2862 type: {:list, :string},
2863 description: "Location of custom emoji files. * can be used as a wildcard.",
2864 suggestions: ["/emoji/custom/**/*.png"]
2867 key: :pack_extensions,
2868 type: {:list, :string},
2870 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2871 suggestions: [".png", ".gif"]
2875 type: {:keyword, {:list, :string}},
2877 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2878 " and the value is the location or array of locations. * can be used as a wildcard.",
2880 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2884 key: :default_manifest,
2887 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2888 " Currently only one manifest can be added (no arrays).",
2889 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2892 key: :shared_pack_cache_seconds_per_file,
2893 label: "Shared pack cache s/file",
2896 "When an emoji pack is shared, the archive is created and cached in memory" <>
2897 " for this amount of seconds multiplied by the number of files.",
2907 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2911 type: [:tuple, {:list, :tuple}],
2912 description: "For the search requests (account & status search etc.)",
2913 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2917 type: [:tuple, {:list, :tuple}],
2918 description: "For requests to timelines (each timeline has it's own limiter)",
2919 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2922 key: :app_account_creation,
2923 type: [:tuple, {:list, :tuple}],
2924 description: "For registering user accounts from the same IP address",
2925 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2928 key: :relations_actions,
2929 type: [:tuple, {:list, :tuple}],
2930 description: "For actions on relationships with all users (follow, unfollow)",
2931 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2934 key: :relation_id_action,
2935 label: "Relation ID action",
2936 type: [:tuple, {:list, :tuple}],
2937 description: "For actions on relation with a specific user (follow, unfollow)",
2938 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2941 key: :statuses_actions,
2942 type: [:tuple, {:list, :tuple}],
2944 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2945 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2948 key: :status_id_action,
2949 label: "Status ID action",
2950 type: [:tuple, {:list, :tuple}],
2952 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2953 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2956 key: :authentication,
2957 type: [:tuple, {:list, :tuple}],
2958 description: "For authentication create / password check / user existence check requests",
2959 suggestions: [{60_000, 15}]
2968 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2969 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2974 description: "Enables SSH"
2979 description: "Dir with SSH keys",
2980 suggestions: ["/some/path/ssh_keys"]
2985 description: "Handler module",
2986 suggestions: ["Pleroma.BBS.Handler"]
2991 description: "Port to connect",
2992 suggestions: [10_022]
2995 key: :password_authenticator,
2997 description: "Authenticator module",
2998 suggestions: ["Pleroma.BBS.Authenticator"]
3004 label: "Mime Types",
3006 description: "Mime Types settings",
3013 "application/xml" => ["xml"],
3014 "application/xrd+xml" => ["xrd+xml"],
3015 "application/jrd+json" => ["jrd+json"],
3016 "application/activity+json" => ["activity+json"],
3017 "application/ld+json" => ["activity+json"]
3022 key: "application/xml",
3023 type: {:list, :string},
3024 suggestions: ["xml"]
3027 key: "application/xrd+xml",
3028 type: {:list, :string},
3029 suggestions: ["xrd+xml"]
3032 key: "application/jrd+json",
3033 type: {:list, :string},
3034 suggestions: ["jrd+json"]
3037 key: "application/activity+json",
3038 type: {:list, :string},
3039 suggestions: ["activity+json"]
3042 key: "application/ld+json",
3043 type: {:list, :string},
3044 suggestions: ["activity+json"]
3054 description: "Pleroma chat settings",
3067 description: "HTTP settings",
3072 type: [:string, :tuple],
3073 description: "Proxy URL",
3074 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3077 key: :send_user_agent,
3082 type: [:string, :atom],
3084 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3085 suggestions: ["Pleroma", :default]
3090 description: "Adapter specific options",
3096 label: "SSL Options",
3097 description: "SSL options for HTTP adapter",
3101 type: {:list, :atom},
3102 description: "List of TLS version to use",
3103 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3114 label: "Markup Settings",
3118 key: :allow_inline_images,
3122 key: :allow_headings,
3135 type: {:list, :module},
3137 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3138 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3148 key: :deny_follow_blocked,
3155 key: :mrf_normalize_markup,
3157 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3158 label: "MRF Normalize Markup",
3159 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3165 suggestions: [Pleroma.HTML.Scrubber.Default]
3175 key: :restricted_nicknames,
3176 type: {:list, :string},
3177 description: "List of nicknames users may not register with.",
3196 "ostatus_subscribe",
3212 key: :email_blacklist,
3213 type: {:list, :string},
3214 description: "List of email domains users may not register with.",
3215 suggestions: ["mailinator.com", "maildrop.cc"]
3221 label: "CORS plug config",
3227 suggestions: [86_400]
3231 type: {:list, :string},
3232 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3236 type: {:list, :string},
3239 "X-RateLimit-Reset",
3240 "X-RateLimit-Limit",
3241 "X-RateLimit-Remaining",
3252 type: {:list, :string},
3253 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3259 key: Pleroma.Web.Plugs.RemoteIp,
3262 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3263 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3269 description: "Enable/disable the plug. Default: disabled."
3273 type: {:list, :string},
3275 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
3280 type: {:list, :string},
3282 "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."
3286 type: {:list, :string},
3288 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"]`
3295 key: :web_cache_ttl,
3296 label: "Web cache TTL",
3299 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3305 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3306 suggestions: [30_000, nil]
3309 key: :activity_pub_question,
3311 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3312 suggestions: [30_000]
3322 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3327 description: "Enables the rendering of static HTML. Default: disabled."
3335 description: "Configure feed rendering",
3340 description: "Configure title rendering",
3345 description: "Maximum number of characters before truncating title",
3351 description: "Replacement which will be used after truncating string",
3352 suggestions: ["..."]
3360 key: :mrf_object_age,
3362 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3363 label: "MRF Object Age",
3366 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3371 description: "Required age (in seconds) of a post before actions are taken.",
3372 suggestions: [172_800]
3376 type: {:list, :atom},
3378 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3379 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3380 "`:reject` rejects the message entirely",
3381 suggestions: [:delist, :strip_followers, :reject]
3389 description: "Custom Runtime Modules",
3394 description: "A path to custom Elixir modules (such as MRF policies)."
3402 description: "Settings for notifications streamer",
3407 description: "Number of workers to send notifications",
3411 key: :overflow_workers,
3413 description: "Maximum number of workers created if pool is empty",
3420 key: :connections_pool,
3422 description: "Advanced settings for `Gun` connections pool",
3425 key: :connection_acquisition_wait,
3428 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3432 key: :connection_acquisition_retries,
3435 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3439 key: :max_connections,
3441 description: "Maximum number of connections in the pool. Default: 250 connections.",
3445 key: :connect_timeout,
3447 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3451 key: :reclaim_multiplier,
3454 "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",
3463 description: "Advanced settings for `Gun` workers pools",
3465 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3469 description: "Settings for #{pool_name} pool.",
3474 description: "Maximum number of concurrent requests in the pool.",
3481 "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",
3487 description: "Timeout for the pool while gun will wait for response",
3488 suggestions: [10_000]
3496 key: :hackney_pools,
3498 description: "Advanced settings for `Hackney` connections pools",
3503 description: "Settings for federation pool.",
3506 key: :max_connections,
3508 description: "Number workers in the pool.",
3514 description: "Timeout while `hackney` will wait for response.",
3515 suggestions: [150_000]
3522 description: "Settings for media pool.",
3525 key: :max_connections,
3527 description: "Number workers in the pool.",
3533 description: "Timeout while `hackney` will wait for response.",
3534 suggestions: [150_000]
3541 description: "Settings for upload pool.",
3544 key: :max_connections,
3546 description: "Number workers in the pool.",
3552 description: "Timeout while `hackney` will wait for response.",
3553 suggestions: [300_000]
3561 key: :restrict_unauthenticated,
3562 label: "Restrict Unauthenticated",
3565 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3570 description: "Settings for public and federated timelines.",
3575 description: "Disallow view public timeline."
3580 description: "Disallow view federated timeline."
3587 description: "Settings for user profiles.",
3592 description: "Disallow view local user profiles."
3597 description: "Disallow view remote user profiles."
3604 description: "Settings for statuses.",
3609 description: "Disallow view local statuses."
3614 description: "Disallow view remote statuses."
3622 key: Pleroma.Web.ApiSpec.CastAndValidate,
3629 "Enables strict input validation (useful in development, not recommended in production)"
3635 key: :instances_favicons,
3637 description: "Control favicons for instances",
3642 description: "Allow/disallow displaying and getting instances favicons"
3650 descriptions: "S3 service related settings",
3653 key: :access_key_id,
3655 description: "S3 access key ID",
3656 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3659 key: :secret_access_key,
3661 description: "Secret access key",
3662 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3667 description: "S3 host",
3668 suggestions: ["s3.eu-central-1.amazonaws.com"]
3676 description: "Installed frontends management",
3681 description: "Primary frontend, the one that is served for all pages by default",
3682 children: installed_frontend_options
3687 description: "Admin frontend",
3688 children: installed_frontend_options
3694 "A map containing available frontends and parameters for their installation.",
3695 children: frontend_options
3701 key: Pleroma.Web.Preload,
3703 description: "Preload-related settings",
3707 type: {:list, :module},
3708 description: "List of preload providers to enable",
3710 Pleroma.Web.Preload.Providers.Instance,
3711 Pleroma.Web.Preload.Providers.User,
3712 Pleroma.Web.Preload.Providers.Timelines,
3713 Pleroma.Web.Preload.Providers.StatusNet
3722 description: "Majic/libmagic configuration",
3727 description: "Number of majic workers to start.",