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",
852 key: :attachment_links,
854 description: "Enable to automatically add attachment link text to statuses"
857 key: :max_report_comment_size,
859 description: "The maximum size of the report comment. Default: 1000.",
865 key: :safe_dm_mentions,
866 label: "Safe DM mentions",
869 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
870 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
876 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
879 key: :remote_post_retention_days,
882 "The default amount of days to retain remote posts when pruning the database",
888 key: :user_bio_length,
890 description: "A user bio maximum length. Default: 5000.",
896 key: :user_name_length,
898 description: "A user name maximum length. Default: 100.",
904 key: :skip_thread_containment,
906 description: "Skip filtering out broken threads. Default: enabled."
909 key: :limit_to_local_content,
910 type: {:dropdown, :atom},
912 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
920 key: :max_account_fields,
922 description: "The maximum number of custom fields in the user profile. Default: 10.",
928 key: :max_remote_account_fields,
931 "The maximum number of custom fields in the remote user profile. Default: 20.",
937 key: :account_field_name_length,
939 description: "An account field name maximum length. Default: 512.",
945 key: :account_field_value_length,
947 description: "An account field value maximum length. Default: 2048.",
953 key: :registration_reason_length,
955 description: "Maximum registration reason length. Default: 500.",
961 key: :external_user_synchronization,
963 description: "Enabling following/followers counters synchronization for external users"
966 key: :multi_factor_authentication,
968 description: "Multi-factor authentication settings",
971 totp: [digits: 6, period: 30],
972 backup_codes: [number: 5, length: 16]
978 label: "TOTP settings",
980 description: "TOTP settings",
981 suggestions: [digits: 6, period: 30],
988 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
995 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
1002 description: "MFA backup codes settings",
1003 suggestions: [number: 5, length: 16],
1009 description: "Number of backup codes to generate."
1016 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
1023 key: :instance_thumbnail,
1024 type: {:string, :image},
1026 "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.",
1027 suggestions: ["/instance/thumbnail.jpeg"]
1030 key: :show_reactions,
1032 description: "Let favourites and emoji reactions be viewed through the API."
1040 description: "Welcome messages settings",
1043 key: :direct_message,
1045 descpiption: "Direct message settings",
1050 description: "Enables sending a direct message to newly registered users"
1055 description: "A message that will be sent to newly registered users",
1057 "Hi, @username! Welcome on board!"
1061 key: :sender_nickname,
1063 description: "The nickname of the local user that sends a welcome message",
1073 descpiption: "Chat message settings",
1078 description: "Enables sending a chat message to newly registered users"
1084 "A message that will be sent to newly registered users as a chat message",
1086 "Hello, welcome on board!"
1090 key: :sender_nickname,
1092 description: "The nickname of the local user that sends a welcome chat message",
1102 descpiption: "Email message settings",
1107 description: "Enables sending an email to newly registered users"
1111 type: [:string, :tuple],
1113 "Email address and/or nickname that will be used to send the welcome email.",
1115 {"Pleroma App", "welcome@pleroma.app"}
1122 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1123 suggestions: ["Welcome to <%= instance_name%>"]
1129 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1130 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1136 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1137 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1146 description: "Logger-related settings",
1150 type: [:atom, :tuple, :module],
1152 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1153 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1161 label: "ExSyslogger",
1162 description: "ExSyslogger-related settings",
1166 type: {:dropdown, :atom},
1167 description: "Log level",
1168 suggestions: [:debug, :info, :warn, :error]
1174 "A string that's prepended to every message, and is typically set to the app name",
1175 suggestions: ["pleroma"]
1180 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1181 suggestions: ["$metadata[$level] $message"]
1185 type: {:list, :atom},
1186 suggestions: [:request_id]
1194 label: "Console Logger",
1195 description: "Console logger settings",
1199 type: {:dropdown, :atom},
1200 description: "Log level",
1201 suggestions: [:debug, :info, :warn, :error]
1206 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1207 suggestions: ["$metadata[$level] $message"]
1211 type: {:list, :atom},
1212 suggestions: [:request_id]
1219 label: "Quack Logger",
1220 description: "Quack-related settings",
1224 type: {:dropdown, :atom},
1225 description: "Log level",
1226 suggestions: [:debug, :info, :warn, :error]
1230 type: {:list, :atom},
1231 description: "Configure which metadata you want to report on",
1248 label: "Webhook URL",
1250 description: "Configure the Slack incoming webhook",
1251 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1257 key: :frontend_configurations,
1260 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1261 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1262 "add your own configuration your settings all fields must be complete.",
1266 label: "Pleroma FE",
1268 description: "Settings for Pleroma FE",
1271 alwaysShowSubjectInput: true,
1272 background: "/static/aurora_borealis.jpg",
1273 collapseMessageWithSubject: false,
1276 hideFilteredStatuses: false,
1277 hideMutedPosts: false,
1278 hidePostStats: false,
1279 hideSitename: false,
1280 hideUserStats: false,
1281 loginMethod: "password",
1282 logo: "/static/logo.png",
1285 minimalScopesMode: false,
1286 noAttachmentLinks: false,
1287 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1288 postContentType: "text/plain",
1289 redirectRootLogin: "/main/friends",
1290 redirectRootNoLogin: "/main/all",
1292 sidebarRight: false,
1293 showFeaturesPanel: true,
1294 showInstanceSpecificPanel: false,
1295 subjectLineBehavior: "email",
1296 theme: "pleroma-dark",
1297 webPushNotifications: false
1302 key: :alwaysShowSubjectInput,
1303 label: "Always show subject input",
1305 description: "When disabled, auto-hide the subject field if it's empty"
1309 type: {:string, :image},
1311 "URL of the background, unless viewing a user profile with a background that is set",
1312 suggestions: ["/images/city.jpg"]
1315 key: :collapseMessageWithSubject,
1316 label: "Collapse message with subject",
1319 "When a message has a subject (aka Content Warning), collapse it by default"
1323 label: "PleromaFE Chat",
1325 description: "Disables PleromaFE Chat component"
1331 description: "Enables green text on lines prefixed with the > character"
1334 key: :hideFilteredStatuses,
1335 label: "Hide Filtered Statuses",
1337 description: "Hides filtered statuses from timelines"
1340 key: :hideMutedPosts,
1341 label: "Hide Muted Posts",
1343 description: "Hides muted statuses from timelines"
1346 key: :hidePostStats,
1347 label: "Hide post stats",
1349 description: "Hide notices statistics (repeats, favorites, ...)"
1353 label: "Hide Sitename",
1355 description: "Hides instance name from PleromaFE banner"
1358 key: :hideUserStats,
1359 label: "Hide user stats",
1362 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1366 type: {:string, :image},
1367 description: "URL of the logo, defaults to Pleroma's logo",
1368 suggestions: ["/static/logo.png"]
1372 label: "Logo margin",
1375 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1376 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1377 suggestions: [".1em"]
1384 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1385 "If you want a colorful logo you must disable logoMask."
1388 key: :minimalScopesMode,
1389 label: "Minimal scopes mode",
1392 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1393 "Also prevents replying to a DM with a public post from PleromaFE."
1396 key: :nsfwCensorImage,
1397 label: "NSFW Censor Image",
1398 type: {:string, :image},
1400 "URL of the image to use for hiding NSFW media attachments in the timeline",
1401 suggestions: ["/static/img/nsfw.74818f9.png"]
1404 key: :postContentType,
1405 label: "Post Content Type",
1406 type: {:dropdown, :atom},
1407 description: "Default post formatting option",
1408 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1411 key: :redirectRootNoLogin,
1412 label: "Redirect root no login",
1415 "Relative URL which indicates where to redirect when a user isn't logged in",
1416 suggestions: ["/main/all"]
1419 key: :redirectRootLogin,
1420 label: "Redirect root login",
1423 "Relative URL which indicates where to redirect when a user is logged in",
1424 suggestions: ["/main/friends"]
1428 label: "Scope copy",
1430 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1434 label: "Sidebar on Right",
1436 description: "Change alignment of sidebar and panels to the right"
1439 key: :showFeaturesPanel,
1440 label: "Show instance features panel",
1443 "Enables panel displaying functionality of the instance on the About page"
1446 key: :showInstanceSpecificPanel,
1447 label: "Show instance specific panel",
1449 description: "Whether to show the instance's custom panel"
1452 key: :subjectLineBehavior,
1453 label: "Subject line behavior",
1455 description: "Allows changing the default behaviour of subject lines in replies.
1456 `email`: copy and preprend re:, as in email,
1457 `masto`: copy verbatim, as in Mastodon,
1458 `noop`: don't copy the subject.",
1459 suggestions: ["email", "masto", "noop"]
1464 description: "Which theme to use. Available themes are defined in styles.json",
1465 suggestions: ["pleroma-dark"]
1473 description: "Settings for Masto FE",
1476 showInstanceSpecificPanel: true
1481 key: :showInstanceSpecificPanel,
1482 label: "Show instance specific panel",
1484 description: "Whenether to show the instance's specific panel"
1495 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1499 type: {:keyword, :map},
1501 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1504 url: "/images/pleroma-fox-tan-smol.png",
1505 mime_type: "image/png"
1507 pleroma_fox_tan_shy: %{
1508 url: "/images/pleroma-fox-tan-shy.png",
1509 mime_type: "image/png"
1514 key: :default_mascot,
1517 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1523 key: :default_user_avatar,
1524 type: {:string, :image},
1525 description: "URL of the default user avatar",
1526 suggestions: ["/images/avi.png"]
1535 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1539 type: {:list, :map},
1540 description: "Describe the icons of the app",
1543 src: "/static/logo.png"
1546 src: "/static/icon.png",
1550 src: "/static/icon.ico",
1551 sizes: "72x72 96x96 128x128 256x256"
1558 description: "Describe the theme color of the app",
1559 suggestions: ["#282c37", "mediumpurple"]
1562 key: :background_color,
1564 description: "Describe the background color of the app",
1565 suggestions: ["#191b22", "aliceblue"]
1575 description: "General MRF settings",
1579 type: [:module, {:list, :module}],
1581 "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.",
1582 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1586 label: "MRF transparency",
1589 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1592 key: :transparency_exclusions,
1593 label: "MRF transparency exclusions",
1594 type: {:list, :string},
1596 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1607 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1608 label: "MRF Simple",
1610 description: "Simple ingress policies",
1613 key: :media_removal,
1614 type: {:list, :string},
1615 description: "List of instances to strip media attachments from",
1616 suggestions: ["example.com", "*.example.com"]
1620 label: "Media NSFW",
1621 type: {:list, :string},
1622 description: "List of instances to tag all media as NSFW (sensitive) from",
1623 suggestions: ["example.com", "*.example.com"]
1626 key: :federated_timeline_removal,
1627 type: {:list, :string},
1629 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1630 suggestions: ["example.com", "*.example.com"]
1634 type: {:list, :string},
1635 description: "List of instances to reject activities from (except deletes)",
1636 suggestions: ["example.com", "*.example.com"]
1640 type: {:list, :string},
1641 description: "List of instances to only accept activities from (except deletes)",
1642 suggestions: ["example.com", "*.example.com"]
1645 key: :followers_only,
1646 type: {:list, :string},
1647 description: "Force posts from the given instances to be visible by followers only",
1648 suggestions: ["example.com", "*.example.com"]
1651 key: :report_removal,
1652 type: {:list, :string},
1653 description: "List of instances to reject reports from",
1654 suggestions: ["example.com", "*.example.com"]
1657 key: :avatar_removal,
1658 type: {:list, :string},
1659 description: "List of instances to strip avatars from",
1660 suggestions: ["example.com", "*.example.com"]
1663 key: :banner_removal,
1664 type: {:list, :string},
1665 description: "List of instances to strip banners from",
1666 suggestions: ["example.com", "*.example.com"]
1669 key: :reject_deletes,
1670 type: {:list, :string},
1671 description: "List of instances to reject deletions from",
1672 suggestions: ["example.com", "*.example.com"]
1678 key: :mrf_activity_expiration,
1680 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1681 label: "MRF Activity Expiration Policy",
1683 description: "Adds automatic expiration to all local activities",
1688 description: "Default global expiration time for all local activities (in days)",
1689 suggestions: [90, 365]
1697 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1698 label: "MRF Subchain",
1701 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1702 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1706 type: {:map, {:list, :string}},
1707 description: "Matches a series of regular expressions against the actor field",
1710 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1718 key: :mrf_rejectnonpublic,
1720 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1721 description: "RejectNonPublic drops posts with non-public visibility settings.",
1722 label: "MRF Reject Non Public",
1726 key: :allow_followersonly,
1727 label: "Allow followers-only",
1729 description: "Whether to allow followers-only posts"
1734 description: "Whether to allow direct messages"
1740 key: :mrf_hellthread,
1742 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1743 label: "MRF Hellthread",
1745 description: "Block messages with excessive user mentions",
1748 key: :delist_threshold,
1751 "Number of mentioned users after which the message gets removed from timelines and" <>
1752 "disables notifications. Set to 0 to disable.",
1756 key: :reject_threshold,
1759 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1768 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1769 label: "MRF Keyword",
1771 description: "Reject or Word-Replace messages with a keyword or regex",
1775 type: {:list, :string},
1777 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1778 suggestions: ["foo", ~r/foo/iu]
1781 key: :federated_timeline_removal,
1782 type: {:list, :string},
1784 "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.",
1785 suggestions: ["foo", ~r/foo/iu]
1789 type: {:list, :tuple},
1791 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1792 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1800 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1801 label: "MRF Mention",
1803 description: "Block messages which mention a specific user",
1807 type: {:list, :string},
1808 description: "A list of actors for which any post mentioning them will be dropped",
1809 suggestions: ["actor1", "actor2"]
1815 key: :mrf_vocabulary,
1817 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1818 label: "MRF Vocabulary",
1820 description: "Filter messages which belong to certain activity vocabularies",
1824 type: {:list, :string},
1826 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1827 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1831 type: {:list, :string},
1833 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1834 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1840 # key: :mrf_user_allowlist,
1842 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1845 # "The keys in this section are the domain names that the policy should apply to." <>
1846 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1848 # %{"example.org" => ["https://example.org/users/admin"]}
1856 description: "Media proxy",
1861 description: "Enables proxying of remote media to the instance's proxy"
1868 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1869 suggestions: ["https://example.com"]
1877 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1883 description: "Enables media cache object invalidation."
1888 description: "Module which will be used to purge objects from the cache.",
1890 Pleroma.Web.MediaProxy.Invalidation.Script,
1891 Pleroma.Web.MediaProxy.Invalidation.Http
1898 label: "Proxy Options",
1900 description: "Options for Pleroma.ReverseProxy",
1902 redirect_on_failure: false,
1903 max_body_length: 25 * 1_048_576,
1904 max_read_duration: 30_000,
1906 follow_redirect: true,
1912 key: :redirect_on_failure,
1915 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1916 "Any error during body processing will not be redirected as the response is chunked."
1919 key: :max_body_length,
1922 "Limits the content length to be approximately the " <>
1923 "specified length. It is validated with the `content-length` header and also verified when proxying."
1926 key: :max_read_duration,
1928 description: "Timeout (in milliseconds) of GET request to remote URI."
1934 description: "HTTP options",
1939 description: "Adapter specific options",
1944 label: "SSL Options",
1945 description: "SSL options for HTTP adapter",
1949 type: {:list, :atom},
1950 description: "List of TLS version to use",
1951 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1960 type: [:string, :tuple],
1961 description: "Proxy URL",
1962 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1970 type: {:list, :string},
1971 description: "List of hosts with scheme to bypass the mediaproxy",
1972 suggestions: ["http://example.com"]
1978 key: :media_preview_proxy,
1980 description: "Media preview proxy",
1986 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1989 key: :thumbnail_max_width,
1992 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1995 key: :thumbnail_max_height,
1998 "Max height of preview thumbnail for images (video preview always has original dimensions)."
2001 key: :image_quality,
2003 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
2006 key: :min_content_length,
2009 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
2015 key: Pleroma.Web.MediaProxy.Invalidation.Http,
2017 description: "HTTP invalidate settings",
2022 description: "HTTP method of request. Default: :purge"
2026 type: {:keyword, :string},
2027 description: "HTTP headers of request",
2028 suggestions: [{"x-refresh", 1}]
2033 description: "Request options",
2037 type: {:map, :string}
2045 key: Pleroma.Web.MediaProxy.Invalidation.Script,
2047 description: "Script invalidate settings",
2052 description: "Path to shell script. Which will run purge cache.",
2053 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2061 description: "Gopher settings",
2066 description: "Enables the gopher interface"
2072 description: "IP address to bind to",
2073 suggestions: [{0, 0, 0, 0}]
2078 description: "Port to bind to",
2084 description: "Port advertised in URLs (optional, defaults to port)",
2092 label: "ActivityPub",
2094 description: "ActivityPub-related settings",
2097 key: :unfollow_blocked,
2099 description: "Whether blocks result in people getting unfollowed"
2102 key: :outgoing_blocks,
2104 description: "Whether to federate blocks to other instances"
2107 key: :sign_object_fetches,
2109 description: "Sign object fetches with HTTP signatures"
2112 key: :note_replies_output_limit,
2115 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2118 key: :follow_handshake_timeout,
2120 description: "Following handshake timeout",
2127 key: :http_security,
2128 label: "HTTP security",
2130 description: "HTTP security settings",
2135 description: "Whether the managed content security policy is enabled"
2141 description: "Whether to additionally send a Strict-Transport-Security header"
2145 label: "STS max age",
2147 description: "The maximum age for the Strict-Transport-Security header if sent",
2148 suggestions: [31_536_000]
2152 label: "CT max age",
2154 description: "The maximum age for the Expect-CT header if sent",
2155 suggestions: [2_592_000]
2158 key: :referrer_policy,
2160 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2161 suggestions: ["same-origin", "no-referrer"]
2165 label: "Report URI",
2167 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2168 suggestions: ["https://example.com/report-uri"]
2173 group: :web_push_encryption,
2174 key: :vapid_details,
2175 label: "Vapid Details",
2178 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2184 "A mailto link for the administrative contact." <>
2185 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2186 suggestions: ["mailto:moderators@pleroma.com"]
2191 description: "VAPID public key",
2192 suggestions: ["Public key"]
2197 description: "VAPID private key",
2198 suggestions: ["Private key"]
2204 key: Pleroma.Captcha,
2206 description: "Captcha-related settings",
2211 description: "Whether the captcha should be shown on registration"
2216 description: "The method/service to use for captcha",
2217 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2220 key: :seconds_valid,
2222 description: "The time in seconds for which the captcha is valid",
2229 key: Pleroma.Captcha.Kocaptcha,
2232 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2233 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2238 description: "The kocaptcha endpoint to use",
2239 suggestions: ["https://captcha.kotobank.ch"]
2245 label: "Pleroma Admin Token",
2248 "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)",
2253 description: "Admin token",
2255 "Please use a high entropy string or UUID"
2265 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2267 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2268 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2269 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2270 (see https://github.com/sorentwo/oban/issues/52).
2275 type: {:dropdown, :atom},
2276 description: "Logs verbose mode",
2277 suggestions: [false, :error, :warn, :info, :debug]
2281 type: {:keyword, :integer},
2283 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2285 activity_expiration: 10,
2286 attachments_cleanup: 5,
2288 federator_incoming: 50,
2289 federator_outgoing: 50,
2291 scheduled_activities: 10,
2297 key: :activity_expiration,
2299 description: "Activity expiration queue",
2303 key: :attachments_cleanup,
2305 description: "Attachment deletion queue",
2311 description: "Background queue",
2315 key: :federator_incoming,
2317 description: "Incoming federation queue",
2321 key: :federator_outgoing,
2323 description: "Outgoing federation queue",
2329 description: "Email sender queue, see Pleroma.Emails.Mailer",
2333 key: :scheduled_activities,
2335 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2339 key: :transmogrifier,
2341 description: "Transmogrifier queue",
2347 description: "Web push notifications queue",
2354 type: {:list, :tuple},
2355 description: "Settings for cron background jobs",
2357 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2358 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2367 description: "Includes custom worker options not interpretable directly by `Oban`",
2371 type: {:keyword, :integer},
2372 description: "Max retry attempts for failed jobs, per `Oban` queue",
2374 federator_incoming: 5,
2375 federator_outgoing: 5
2382 key: Pleroma.Web.Metadata,
2384 description: "Metadata-related settings",
2388 type: {:list, :module},
2389 description: "List of metadata providers to enable",
2391 Pleroma.Web.Metadata.Providers.OpenGraph,
2392 Pleroma.Web.Metadata.Providers.TwitterCard,
2393 Pleroma.Web.Metadata.Providers.RelMe,
2394 Pleroma.Web.Metadata.Providers.Feed
2399 label: "Unfurl NSFW",
2401 description: "When enabled NSFW attachments will be shown in previews"
2410 "If enabled the instance will parse metadata from attached links to generate link previews",
2415 description: "Enables RichMedia parsing of URLs"
2419 type: {:list, :string},
2420 description: "List of hosts which will be ignored by the metadata parser",
2421 suggestions: ["accounts.google.com", "xss.website"]
2425 label: "Ignore TLD",
2426 type: {:list, :string},
2427 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2428 suggestions: ["local", "localdomain", "lan"]
2432 type: {:list, :module},
2434 "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.",
2436 Pleroma.Web.RichMedia.Parsers.OEmbed,
2437 Pleroma.Web.RichMedia.Parsers.TwitterCard
2442 label: "TTL setters",
2443 type: {:list, :module},
2445 "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.",
2447 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2451 key: :failure_backoff,
2454 "Amount of milliseconds after request failure, during which the request will not be retried.",
2455 suggestions: [60_000]
2461 key: Pleroma.Formatter,
2465 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2469 type: [:string, :boolean],
2470 description: "Specify the class to be added to the generated link. Disable to clear.",
2471 suggestions: ["auto-linker", false]
2475 type: [:string, :boolean],
2476 description: "Override the rel attribute. Disable to clear.",
2477 suggestions: ["ugc", "noopener noreferrer", false]
2482 description: "Link URLs will open in a new window/tab."
2486 type: [:integer, :boolean],
2488 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2489 suggestions: [15, false]
2494 description: "Strip the scheme prefix."
2499 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2503 type: [:atom, :boolean],
2505 "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)",
2506 suggestions: [:no_scheme, true]
2512 key: Pleroma.ScheduledActivity,
2514 description: "Scheduled activities settings",
2517 key: :daily_user_limit,
2520 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2524 key: :total_user_limit,
2527 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2533 description: "Whether scheduled activities are sent to the job queue to be executed"
2539 key: Pleroma.Workers.PurgeExpiredActivity,
2541 description: "Expired activities settings",
2546 description: "Enables expired activities addition & deletion"
2551 description: "Minimum lifetime for ephemeral activity (in seconds)",
2558 label: "Pleroma Authenticator",
2560 description: "Authenticator",
2563 key: Pleroma.Web.Auth.Authenticator,
2565 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2575 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2576 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2577 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2578 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2583 description: "Enables LDAP authentication"
2588 description: "LDAP server hostname",
2589 suggestions: ["localhosts"]
2594 description: "LDAP port, e.g. 389 or 636",
2595 suggestions: [389, 636]
2601 description: "Enable to use SSL, usually implies the port 636"
2605 label: "SSL options",
2607 description: "Additional SSL options",
2608 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2613 description: "Path to file with PEM encoded cacerts",
2614 suggestions: ["path/to/file/with/PEM/cacerts"]
2619 description: "Type of cert verification",
2620 suggestions: [:verify_peer]
2628 description: "Enable to use STARTTLS, usually implies the port 389"
2632 label: "TLS options",
2634 description: "Additional TLS options",
2635 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2640 description: "Path to file with PEM encoded cacerts",
2641 suggestions: ["path/to/file/with/PEM/cacerts"]
2646 description: "Type of cert verification",
2647 suggestions: [:verify_peer]
2654 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2655 suggestions: ["dc=example,dc=com"]
2662 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2671 description: "Authentication / authorization settings",
2674 key: :enforce_oauth_admin_scope_usage,
2675 label: "Enforce OAuth admin scope usage",
2678 "OAuth admin scope requirement toggle. " <>
2679 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2680 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2681 "`is_admin` user flag grants access to admin-specific actions."
2684 key: :auth_template,
2687 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2688 suggestions: ["show.html"]
2691 key: :oauth_consumer_template,
2692 label: "OAuth consumer template",
2695 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2696 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2697 suggestions: ["consumer.html"]
2700 key: :oauth_consumer_strategies,
2701 label: "OAuth consumer strategies",
2702 type: {:list, :string},
2704 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2705 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2706 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2707 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2713 key: :email_notifications,
2715 description: "Email notifications settings",
2721 "emails of \"what you've missed\" for users who have been inactive for a while",
2725 schedule: "0 0 * * 0",
2727 inactivity_threshold: 7
2735 description: "Globally enable or disable digest emails"
2741 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2742 suggestions: ["0 0 * * 0"]
2747 description: "Minimum interval between digest emails to one user",
2751 key: :inactivity_threshold,
2753 description: "Minimum user inactivity threshold",
2762 key: Pleroma.Emails.UserEmail,
2764 description: "Email template settings",
2768 type: {:string, :image},
2769 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2770 suggestions: ["some/path/logo.png"]
2775 description: "A map with color settings for email templates.",
2778 link_color: "#d8a070",
2779 background_color: "#2C3645",
2780 content_background_color: "#1B2635",
2781 header_color: "#d8a070",
2782 text_color: "#b9b9ba",
2783 text_muted_color: "#b9b9ba"
2790 suggestions: ["#d8a070"]
2793 key: :background_color,
2795 suggestions: ["#2C3645"]
2798 key: :content_background_color,
2800 suggestions: ["#1B2635"]
2805 suggestions: ["#d8a070"]
2810 suggestions: ["#b9b9ba"]
2813 key: :text_muted_color,
2815 suggestions: ["#b9b9ba"]
2823 key: Pleroma.Emails.NewUsersDigestEmail,
2825 description: "New users admin email digest",
2830 description: "Enables new users admin digest email when `true`"
2839 description: "Configure OAuth 2 provider capabilities",
2842 key: :token_expires_in,
2844 description: "The lifetime in seconds of the access token",
2848 key: :issue_new_refresh_token,
2851 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2854 key: :clean_expired_tokens,
2856 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2866 key: :shortcode_globs,
2867 type: {:list, :string},
2868 description: "Location of custom emoji files. * can be used as a wildcard.",
2869 suggestions: ["/emoji/custom/**/*.png"]
2872 key: :pack_extensions,
2873 type: {:list, :string},
2875 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2876 suggestions: [".png", ".gif"]
2880 type: {:keyword, {:list, :string}},
2882 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2883 " and the value is the location or array of locations. * can be used as a wildcard.",
2885 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2889 key: :default_manifest,
2892 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2893 " Currently only one manifest can be added (no arrays).",
2894 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2897 key: :shared_pack_cache_seconds_per_file,
2898 label: "Shared pack cache s/file",
2901 "When an emoji pack is shared, the archive is created and cached in memory" <>
2902 " for this amount of seconds multiplied by the number of files.",
2912 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2916 type: [:tuple, {:list, :tuple}],
2917 description: "For the search requests (account & status search etc.)",
2918 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2922 type: [:tuple, {:list, :tuple}],
2923 description: "For requests to timelines (each timeline has it's own limiter)",
2924 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2927 key: :app_account_creation,
2928 type: [:tuple, {:list, :tuple}],
2929 description: "For registering user accounts from the same IP address",
2930 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2933 key: :relations_actions,
2934 type: [:tuple, {:list, :tuple}],
2935 description: "For actions on relationships with all users (follow, unfollow)",
2936 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2939 key: :relation_id_action,
2940 label: "Relation ID action",
2941 type: [:tuple, {:list, :tuple}],
2942 description: "For actions on relation with a specific user (follow, unfollow)",
2943 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2946 key: :statuses_actions,
2947 type: [:tuple, {:list, :tuple}],
2949 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2950 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2953 key: :status_id_action,
2954 label: "Status ID action",
2955 type: [:tuple, {:list, :tuple}],
2957 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2958 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2961 key: :authentication,
2962 type: [:tuple, {:list, :tuple}],
2963 description: "For authentication create / password check / user existence check requests",
2964 suggestions: [{60_000, 15}]
2973 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2974 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2979 description: "Enables SSH"
2984 description: "Dir with SSH keys",
2985 suggestions: ["/some/path/ssh_keys"]
2990 description: "Handler module",
2991 suggestions: ["Pleroma.BBS.Handler"]
2996 description: "Port to connect",
2997 suggestions: [10_022]
3000 key: :password_authenticator,
3002 description: "Authenticator module",
3003 suggestions: ["Pleroma.BBS.Authenticator"]
3009 label: "Mime Types",
3011 description: "Mime Types settings",
3018 "application/xml" => ["xml"],
3019 "application/xrd+xml" => ["xrd+xml"],
3020 "application/jrd+json" => ["jrd+json"],
3021 "application/activity+json" => ["activity+json"],
3022 "application/ld+json" => ["activity+json"]
3027 key: "application/xml",
3028 type: {:list, :string},
3029 suggestions: ["xml"]
3032 key: "application/xrd+xml",
3033 type: {:list, :string},
3034 suggestions: ["xrd+xml"]
3037 key: "application/jrd+json",
3038 type: {:list, :string},
3039 suggestions: ["jrd+json"]
3042 key: "application/activity+json",
3043 type: {:list, :string},
3044 suggestions: ["activity+json"]
3047 key: "application/ld+json",
3048 type: {:list, :string},
3049 suggestions: ["activity+json"]
3059 description: "Pleroma chat settings",
3072 description: "HTTP settings",
3077 type: [:string, :tuple],
3078 description: "Proxy URL",
3079 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3082 key: :send_user_agent,
3087 type: [:string, :atom],
3089 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3090 suggestions: ["Pleroma", :default]
3095 description: "Adapter specific options",
3101 label: "SSL Options",
3102 description: "SSL options for HTTP adapter",
3106 type: {:list, :atom},
3107 description: "List of TLS version to use",
3108 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3119 label: "Markup Settings",
3123 key: :allow_inline_images,
3127 key: :allow_headings,
3140 type: {:list, :module},
3142 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3143 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3153 key: :deny_follow_blocked,
3160 key: :mrf_normalize_markup,
3162 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3163 label: "MRF Normalize Markup",
3164 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3170 suggestions: [Pleroma.HTML.Scrubber.Default]
3180 key: :restricted_nicknames,
3181 type: {:list, :string},
3182 description: "List of nicknames users may not register with.",
3201 "ostatus_subscribe",
3217 key: :email_blacklist,
3218 type: {:list, :string},
3219 description: "List of email domains users may not register with.",
3220 suggestions: ["mailinator.com", "maildrop.cc"]
3226 label: "CORS plug config",
3232 suggestions: [86_400]
3236 type: {:list, :string},
3237 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3241 type: {:list, :string},
3244 "X-RateLimit-Reset",
3245 "X-RateLimit-Limit",
3246 "X-RateLimit-Remaining",
3257 type: {:list, :string},
3258 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3264 key: Pleroma.Web.Plugs.RemoteIp,
3267 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3268 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3274 description: "Enable/disable the plug. Default: disabled."
3278 type: {:list, :string},
3280 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
3285 type: {:list, :string},
3287 "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."
3291 type: {:list, :string},
3293 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"]`
3300 key: :web_cache_ttl,
3301 label: "Web cache TTL",
3304 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3310 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3311 suggestions: [30_000, nil]
3314 key: :activity_pub_question,
3316 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3317 suggestions: [30_000]
3327 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3332 description: "Enables the rendering of static HTML. Default: disabled."
3340 description: "Configure feed rendering",
3345 description: "Configure title rendering",
3350 description: "Maximum number of characters before truncating title",
3356 description: "Replacement which will be used after truncating string",
3357 suggestions: ["..."]
3365 key: :mrf_object_age,
3367 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3368 label: "MRF Object Age",
3371 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3376 description: "Required age (in seconds) of a post before actions are taken.",
3377 suggestions: [172_800]
3381 type: {:list, :atom},
3383 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3384 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3385 "`:reject` rejects the message entirely",
3386 suggestions: [:delist, :strip_followers, :reject]
3394 description: "Custom Runtime Modules",
3399 description: "A path to custom Elixir modules (such as MRF policies)."
3407 description: "Settings for notifications streamer",
3412 description: "Number of workers to send notifications",
3416 key: :overflow_workers,
3418 description: "Maximum number of workers created if pool is empty",
3425 key: :connections_pool,
3427 description: "Advanced settings for `Gun` connections pool",
3430 key: :connection_acquisition_wait,
3433 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3437 key: :connection_acquisition_retries,
3440 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3444 key: :max_connections,
3446 description: "Maximum number of connections in the pool. Default: 250 connections.",
3450 key: :connect_timeout,
3452 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3456 key: :reclaim_multiplier,
3459 "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",
3468 description: "Advanced settings for `Gun` workers pools",
3470 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3474 description: "Settings for #{pool_name} pool.",
3479 description: "Maximum number of concurrent requests in the pool.",
3486 "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",
3492 description: "Timeout for the pool while gun will wait for response",
3493 suggestions: [10_000]
3501 key: :hackney_pools,
3503 description: "Advanced settings for `Hackney` connections pools",
3508 description: "Settings for federation pool.",
3511 key: :max_connections,
3513 description: "Number workers in the pool.",
3519 description: "Timeout while `hackney` will wait for response.",
3520 suggestions: [150_000]
3527 description: "Settings for media pool.",
3530 key: :max_connections,
3532 description: "Number workers in the pool.",
3538 description: "Timeout while `hackney` will wait for response.",
3539 suggestions: [150_000]
3546 description: "Settings for upload pool.",
3549 key: :max_connections,
3551 description: "Number workers in the pool.",
3557 description: "Timeout while `hackney` will wait for response.",
3558 suggestions: [300_000]
3566 key: :restrict_unauthenticated,
3567 label: "Restrict Unauthenticated",
3570 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3575 description: "Settings for public and federated timelines.",
3580 description: "Disallow view public timeline."
3585 description: "Disallow view federated timeline."
3592 description: "Settings for user profiles.",
3597 description: "Disallow view local user profiles."
3602 description: "Disallow view remote user profiles."
3609 description: "Settings for statuses.",
3614 description: "Disallow view local statuses."
3619 description: "Disallow view remote statuses."
3627 key: Pleroma.Web.ApiSpec.CastAndValidate,
3634 "Enables strict input validation (useful in development, not recommended in production)"
3640 key: :instances_favicons,
3642 description: "Control favicons for instances",
3647 description: "Allow/disallow displaying and getting instances favicons"
3655 descriptions: "S3 service related settings",
3658 key: :access_key_id,
3660 description: "S3 access key ID",
3661 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3664 key: :secret_access_key,
3666 description: "Secret access key",
3667 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3672 description: "S3 host",
3673 suggestions: ["s3.eu-central-1.amazonaws.com"]
3681 description: "Installed frontends management",
3686 description: "Primary frontend, the one that is served for all pages by default",
3687 children: installed_frontend_options
3692 description: "Admin frontend",
3693 children: installed_frontend_options
3699 "A map containing available frontends and parameters for their installation.",
3700 children: frontend_options
3706 key: Pleroma.Web.Preload,
3708 description: "Preload-related settings",
3712 type: {:list, :module},
3713 description: "List of preload providers to enable",
3715 Pleroma.Web.Preload.Providers.Instance,
3716 Pleroma.Web.Preload.Providers.User,
3717 Pleroma.Web.Preload.Providers.Timelines,
3718 Pleroma.Web.Preload.Providers.StatusNet
3727 description: "Majic/libmagic configuration",
3732 description: "Number of majic workers to start.",