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."
48 description: "URL of the git repository of the frontend"
54 "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`.",
55 example: "https://some.url/builds/${ref}.zip"
60 description: "The directory inside the zip file "
64 config :pleroma, :config_description, [
69 description: "Upload general settings",
74 description: "Module which will be used for uploads",
75 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
79 type: {:list, :module},
81 "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.",
82 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
88 "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`."
94 description: "Base URL for the uploads, needed if you use CDN",
96 "https://cdn-host.com"
103 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
107 label: "Proxy Options",
109 description: "Options for Pleroma.ReverseProxy",
111 redirect_on_failure: false,
112 max_body_length: 25 * 1_048_576,
114 follow_redirect: true,
120 key: :redirect_on_failure,
123 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
124 "Any error during body processing will not be redirected as the response is chunked."
127 key: :max_body_length,
130 "Limits the content length to be approximately the " <>
131 "specified length. It is validated with the `content-length` header and also verified when proxying."
137 description: "HTTP options",
142 description: "Adapter specific options",
147 label: "SSL Options",
148 description: "SSL options for HTTP adapter",
152 type: {:list, :atom},
153 description: "List of TLS versions to use",
154 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
163 type: [:string, :tuple],
164 description: "Proxy URL",
165 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
172 key: :filename_display_max_length,
174 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
180 key: Pleroma.Uploaders.Local,
182 description: "Local uploader-related settings",
187 description: "Path where user's uploads will be saved",
196 key: Pleroma.Uploaders.S3,
198 description: "S3 uploader-related settings",
203 description: "S3 bucket",
209 key: :bucket_namespace,
211 description: "S3 bucket namespace",
212 suggestions: ["pleroma"]
215 key: :public_endpoint,
217 description: "S3 endpoint",
218 suggestions: ["https://s3.amazonaws.com"]
221 key: :truncated_namespace,
224 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
225 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
228 key: :streaming_enabled,
231 "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."
237 key: Pleroma.Upload.Filter.Mogrify,
239 description: "Uploads mogrify filter settings",
243 type: [:string, {:list, :string}, {:list, :tuple}],
245 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
246 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
257 key: Pleroma.Upload.Filter.AnonymizeFilename,
259 description: "Filter replaces the filename of the upload",
265 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
266 " filename extension by using {extension}, for example custom-file-name.{extension}.",
268 "custom-file-name.{extension}"
275 key: Pleroma.Emails.Mailer,
277 description: "Mailer-related settings",
283 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
284 " or Swoosh.Adapters.Local for in-memory mailbox",
286 Swoosh.Adapters.SMTP,
287 Swoosh.Adapters.Sendgrid,
288 Swoosh.Adapters.Sendmail,
289 Swoosh.Adapters.Mandrill,
290 Swoosh.Adapters.Mailgun,
291 Swoosh.Adapters.Mailjet,
292 Swoosh.Adapters.Postmark,
293 Swoosh.Adapters.SparkPost,
294 Swoosh.Adapters.AmazonSES,
296 Swoosh.Adapters.SocketLabs,
297 Swoosh.Adapters.Gmail,
298 Swoosh.Adapters.Local
304 description: "Allow/disallow send emails"
307 group: {:subgroup, Swoosh.Adapters.SMTP},
310 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
311 suggestions: ["smtp.gmail.com"]
314 group: {:subgroup, Swoosh.Adapters.SMTP},
317 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
318 suggestions: ["pleroma"]
321 group: {:subgroup, Swoosh.Adapters.SMTP},
324 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
325 suggestions: ["password"]
328 group: {:subgroup, Swoosh.Adapters.SMTP},
332 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
335 group: {:subgroup, Swoosh.Adapters.SMTP},
339 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
340 suggestions: [:always, :never, :if_available]
343 group: {:subgroup, Swoosh.Adapters.SMTP},
346 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
347 suggestions: [:always, :never, :if_available]
350 group: {:subgroup, Swoosh.Adapters.SMTP},
353 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
357 group: {:subgroup, Swoosh.Adapters.SMTP},
360 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
364 group: {:subgroup, Swoosh.Adapters.SMTP},
366 label: "No MX lookups",
368 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
371 group: {:subgroup, Swoosh.Adapters.Sendgrid},
375 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
376 suggestions: ["my-api-key"]
379 group: {:subgroup, Swoosh.Adapters.Sendmail},
382 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
383 suggestions: ["/usr/bin/sendmail"]
386 group: {:subgroup, Swoosh.Adapters.Sendmail},
389 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
390 suggestions: ["-N delay,failure,success"]
393 group: {:subgroup, Swoosh.Adapters.Sendmail},
396 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
399 group: {:subgroup, Swoosh.Adapters.Mandrill},
403 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
404 suggestions: ["my-api-key"]
407 group: {:subgroup, Swoosh.Adapters.Mailgun},
411 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
412 suggestions: ["my-api-key"]
415 group: {:subgroup, Swoosh.Adapters.Mailgun},
418 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
419 suggestions: ["pleroma.com"]
422 group: {:subgroup, Swoosh.Adapters.Mailjet},
426 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
427 suggestions: ["my-api-key"]
430 group: {:subgroup, Swoosh.Adapters.Mailjet},
433 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
434 suggestions: ["my-secret-key"]
437 group: {:subgroup, Swoosh.Adapters.Postmark},
441 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
442 suggestions: ["my-api-key"]
445 group: {:subgroup, Swoosh.Adapters.SparkPost},
449 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
450 suggestions: ["my-api-key"]
453 group: {:subgroup, Swoosh.Adapters.SparkPost},
456 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
457 suggestions: ["https://api.sparkpost.com/api/v1"]
460 group: {:subgroup, Swoosh.Adapters.AmazonSES},
463 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
464 suggestions: ["us-east-1", "us-east-2"]
467 group: {:subgroup, Swoosh.Adapters.AmazonSES},
470 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
471 suggestions: ["aws-access-key"]
474 group: {:subgroup, Swoosh.Adapters.AmazonSES},
477 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
478 suggestions: ["aws-secret-key"]
481 group: {:subgroup, Swoosh.Adapters.Dyn},
485 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
486 suggestions: ["my-api-key"]
489 group: {:subgroup, Swoosh.Adapters.SocketLabs},
492 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
495 group: {:subgroup, Swoosh.Adapters.SocketLabs},
499 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
502 group: {:subgroup, Swoosh.Adapters.Gmail},
505 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
512 description: "`Swoosh.Adapters.Local` adapter specific settings",
515 group: {:subgroup, Swoosh.Adapters.Local},
518 description: "Run the preview server together as part of your app"
521 group: {:subgroup, Swoosh.Adapters.Local},
524 description: "The preview server port",
532 label: "URI Schemes",
534 description: "URI schemes related settings",
538 type: {:list, :string},
539 description: "List of the scheme part that is considered valid to be an URL",
564 description: "Instance-related settings",
569 description: "Name of the instance",
576 label: "Admin Email Address",
578 description: "Email used to reach an Administrator/Moderator of the instance",
585 label: "Sender Email Address",
587 description: "Envelope FROM address for mail sent via Pleroma",
596 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
604 description: "Posts character limit (CW/Subject included in the counter)",
612 description: "Character limit of the instance chat messages",
620 description: "Hard character limit beyond which remote posts will be dropped",
628 description: "File size limit of uploads (except for avatar, background, banner)",
634 key: :avatar_upload_limit,
636 description: "File size limit of user's profile avatars",
642 key: :background_upload_limit,
644 description: "File size limit of user's profile backgrounds",
650 key: :banner_upload_limit,
652 description: "File size limit of user's profile banners",
660 description: "A map with poll limits for local polls",
664 max_option_chars: 200,
666 max_expiration: 31_536_000
673 description: "Maximum number of options",
677 key: :max_option_chars,
679 description: "Maximum number of characters per option",
683 key: :min_expiration,
685 description: "Minimum expiration time (in seconds)",
689 key: :max_expiration,
691 description: "Maximum expiration time (in seconds)",
697 key: :registrations_open,
700 "Enable registrations for anyone. Invitations require this setting to be disabled."
703 key: :invites_enabled,
706 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
709 key: :account_activation_required,
711 description: "Require users to confirm their emails before signing in"
714 key: :account_approval_required,
716 description: "Require users to be manually approved by an admin before signing in"
721 description: "Enable federation with other instances"
724 key: :federation_incoming_replies_max_depth,
725 label: "Fed. incoming replies max depth",
728 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
729 " 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.",
735 key: :federation_reachability_timeout_days,
736 label: "Fed. reachability timeout days",
739 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
747 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
753 "Makes the client API in authenticated mode-only except for user-profiles." <>
754 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
755 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
758 key: :quarantined_instances,
759 type: {:list, :string},
761 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
770 description: "Instance static directory",
776 key: :allowed_post_formats,
777 type: {:list, :string},
778 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
787 key: :extended_nickname_format,
790 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
791 " This will break federation with older software for theses nicknames."
794 key: :cleanup_attachments,
797 Enable to remove associated attachments when status is removed.
798 This will not affect duplicates and attachments without status.
799 Enabling this will increase load to database when deleting statuses on larger instances.
803 key: :max_pinned_statuses,
805 description: "The maximum number of pinned statuses. 0 will disable the feature.",
813 key: :autofollowed_nicknames,
814 type: {:list, :string},
816 "Set to nicknames of (local) users that every new user should automatically follow",
825 key: :attachment_links,
827 description: "Enable to automatically add attachment link text to statuses"
830 key: :max_report_comment_size,
832 description: "The maximum size of the report comment. Default: 1000.",
838 key: :safe_dm_mentions,
839 label: "Safe DM mentions",
842 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
843 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
849 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
852 key: :remote_post_retention_days,
855 "The default amount of days to retain remote posts when pruning the database",
861 key: :user_bio_length,
863 description: "A user bio maximum length. Default: 5000.",
869 key: :user_name_length,
871 description: "A user name maximum length. Default: 100.",
877 key: :skip_thread_containment,
879 description: "Skip filtering out broken threads. Default: enabled."
882 key: :limit_to_local_content,
883 type: {:dropdown, :atom},
885 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
893 key: :max_account_fields,
895 description: "The maximum number of custom fields in the user profile. Default: 10.",
901 key: :max_remote_account_fields,
904 "The maximum number of custom fields in the remote user profile. Default: 20.",
910 key: :account_field_name_length,
912 description: "An account field name maximum length. Default: 512.",
918 key: :account_field_value_length,
920 description: "An account field value maximum length. Default: 2048.",
926 key: :registration_reason_length,
928 description: "Maximum registration reason length. Default: 500.",
934 key: :external_user_synchronization,
936 description: "Enabling following/followers counters synchronization for external users"
939 key: :multi_factor_authentication,
941 description: "Multi-factor authentication settings",
944 totp: [digits: 6, period: 30],
945 backup_codes: [number: 5, length: 16]
951 label: "TOTP settings",
953 description: "TOTP settings",
954 suggestions: [digits: 6, period: 30],
961 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
968 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
975 description: "MFA backup codes settings",
976 suggestions: [number: 5, length: 16],
982 description: "Number of backup codes to generate."
989 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
996 key: :instance_thumbnail,
997 type: {:string, :image},
999 "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.",
1000 suggestions: ["/instance/thumbnail.jpeg"]
1003 key: :show_reactions,
1005 description: "Let favourites and emoji reactions be viewed through the API."
1013 description: "Welcome messages settings",
1016 key: :direct_message,
1018 descpiption: "Direct message settings",
1023 description: "Enables sending a direct message to newly registered users"
1028 description: "A message that will be sent to newly registered users",
1030 "Hi, @username! Welcome on board!"
1034 key: :sender_nickname,
1036 description: "The nickname of the local user that sends a welcome message",
1046 descpiption: "Chat message settings",
1051 description: "Enables sending a chat message to newly registered users"
1057 "A message that will be sent to newly registered users as a chat message",
1059 "Hello, welcome on board!"
1063 key: :sender_nickname,
1065 description: "The nickname of the local user that sends a welcome chat message",
1075 descpiption: "Email message settings",
1080 description: "Enables sending an email to newly registered users"
1084 type: [:string, :tuple],
1086 "Email address and/or nickname that will be used to send the welcome email.",
1088 {"Pleroma App", "welcome@pleroma.app"}
1095 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1096 suggestions: ["Welcome to <%= instance_name%>"]
1102 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1103 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1109 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1110 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1119 description: "Logger-related settings",
1123 type: [:atom, :tuple, :module],
1125 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1126 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1134 label: "ExSyslogger",
1135 description: "ExSyslogger-related settings",
1139 type: {:dropdown, :atom},
1140 description: "Log level",
1141 suggestions: [:debug, :info, :warn, :error]
1147 "A string that's prepended to every message, and is typically set to the app name",
1148 suggestions: ["pleroma"]
1153 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1154 suggestions: ["$metadata[$level] $message"]
1158 type: {:list, :atom},
1159 suggestions: [:request_id]
1167 label: "Console Logger",
1168 description: "Console logger settings",
1172 type: {:dropdown, :atom},
1173 description: "Log level",
1174 suggestions: [:debug, :info, :warn, :error]
1179 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1180 suggestions: ["$metadata[$level] $message"]
1184 type: {:list, :atom},
1185 suggestions: [:request_id]
1192 label: "Quack Logger",
1193 description: "Quack-related settings",
1197 type: {:dropdown, :atom},
1198 description: "Log level",
1199 suggestions: [:debug, :info, :warn, :error]
1203 type: {:list, :atom},
1204 description: "Configure which metadata you want to report on",
1221 label: "Webhook URL",
1223 description: "Configure the Slack incoming webhook",
1224 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1230 key: :frontend_configurations,
1233 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1234 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1235 "add your own configuration your settings all fields must be complete.",
1239 label: "Pleroma FE",
1241 description: "Settings for Pleroma FE",
1244 alwaysShowSubjectInput: true,
1245 background: "/static/aurora_borealis.jpg",
1246 collapseMessageWithSubject: false,
1249 hideFilteredStatuses: false,
1250 hideMutedPosts: false,
1251 hidePostStats: false,
1252 hideSitename: false,
1253 hideUserStats: false,
1254 loginMethod: "password",
1255 logo: "/static/logo.png",
1258 minimalScopesMode: false,
1259 noAttachmentLinks: false,
1260 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1261 postContentType: "text/plain",
1262 redirectRootLogin: "/main/friends",
1263 redirectRootNoLogin: "/main/all",
1265 sidebarRight: false,
1266 showFeaturesPanel: true,
1267 showInstanceSpecificPanel: false,
1268 subjectLineBehavior: "email",
1269 theme: "pleroma-dark",
1270 webPushNotifications: false
1275 key: :alwaysShowSubjectInput,
1276 label: "Always show subject input",
1278 description: "When disabled, auto-hide the subject field if it's empty"
1282 type: {:string, :image},
1284 "URL of the background, unless viewing a user profile with a background that is set",
1285 suggestions: ["/images/city.jpg"]
1288 key: :collapseMessageWithSubject,
1289 label: "Collapse message with subject",
1292 "When a message has a subject (aka Content Warning), collapse it by default"
1296 label: "PleromaFE Chat",
1298 description: "Disables PleromaFE Chat component"
1304 description: "Enables green text on lines prefixed with the > character"
1307 key: :hideFilteredStatuses,
1308 label: "Hide Filtered Statuses",
1310 description: "Hides filtered statuses from timelines"
1313 key: :hideMutedPosts,
1314 label: "Hide Muted Posts",
1316 description: "Hides muted statuses from timelines"
1319 key: :hidePostStats,
1320 label: "Hide post stats",
1322 description: "Hide notices statistics (repeats, favorites, ...)"
1326 label: "Hide Sitename",
1328 description: "Hides instance name from PleromaFE banner"
1331 key: :hideUserStats,
1332 label: "Hide user stats",
1335 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1339 type: {:string, :image},
1340 description: "URL of the logo, defaults to Pleroma's logo",
1341 suggestions: ["/static/logo.png"]
1345 label: "Logo margin",
1348 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1349 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1350 suggestions: [".1em"]
1357 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1358 "If you want a colorful logo you must disable logoMask."
1361 key: :minimalScopesMode,
1362 label: "Minimal scopes mode",
1365 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1366 "Also prevents replying to a DM with a public post from PleromaFE."
1369 key: :nsfwCensorImage,
1370 label: "NSFW Censor Image",
1371 type: {:string, :image},
1373 "URL of the image to use for hiding NSFW media attachments in the timeline",
1374 suggestions: ["/static/img/nsfw.74818f9.png"]
1377 key: :postContentType,
1378 label: "Post Content Type",
1379 type: {:dropdown, :atom},
1380 description: "Default post formatting option",
1381 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1384 key: :redirectRootNoLogin,
1385 label: "Redirect root no login",
1388 "Relative URL which indicates where to redirect when a user isn't logged in",
1389 suggestions: ["/main/all"]
1392 key: :redirectRootLogin,
1393 label: "Redirect root login",
1396 "Relative URL which indicates where to redirect when a user is logged in",
1397 suggestions: ["/main/friends"]
1401 label: "Scope copy",
1403 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1407 label: "Sidebar on Right",
1409 description: "Change alignment of sidebar and panels to the right"
1412 key: :showFeaturesPanel,
1413 label: "Show instance features panel",
1416 "Enables panel displaying functionality of the instance on the About page"
1419 key: :showInstanceSpecificPanel,
1420 label: "Show instance specific panel",
1422 description: "Whether to show the instance's custom panel"
1425 key: :subjectLineBehavior,
1426 label: "Subject line behavior",
1428 description: "Allows changing the default behaviour of subject lines in replies.
1429 `email`: copy and preprend re:, as in email,
1430 `masto`: copy verbatim, as in Mastodon,
1431 `noop`: don't copy the subject.",
1432 suggestions: ["email", "masto", "noop"]
1437 description: "Which theme to use. Available themes are defined in styles.json",
1438 suggestions: ["pleroma-dark"]
1446 description: "Settings for Masto FE",
1449 showInstanceSpecificPanel: true
1454 key: :showInstanceSpecificPanel,
1455 label: "Show instance specific panel",
1457 description: "Whenether to show the instance's specific panel"
1468 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1472 type: {:keyword, :map},
1474 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1477 url: "/images/pleroma-fox-tan-smol.png",
1478 mime_type: "image/png"
1480 pleroma_fox_tan_shy: %{
1481 url: "/images/pleroma-fox-tan-shy.png",
1482 mime_type: "image/png"
1487 key: :default_mascot,
1490 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1496 key: :default_user_avatar,
1497 type: {:string, :image},
1498 description: "URL of the default user avatar",
1499 suggestions: ["/images/avi.png"]
1508 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1512 type: {:list, :map},
1513 description: "Describe the icons of the app",
1516 src: "/static/logo.png"
1519 src: "/static/icon.png",
1523 src: "/static/icon.ico",
1524 sizes: "72x72 96x96 128x128 256x256"
1531 description: "Describe the theme color of the app",
1532 suggestions: ["#282c37", "mediumpurple"]
1535 key: :background_color,
1537 description: "Describe the background color of the app",
1538 suggestions: ["#191b22", "aliceblue"]
1548 description: "General MRF settings",
1552 type: [:module, {:list, :module}],
1554 "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.",
1555 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1559 label: "MRF transparency",
1562 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1565 key: :transparency_exclusions,
1566 label: "MRF transparency exclusions",
1567 type: {:list, :string},
1569 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1580 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1581 label: "MRF Simple",
1583 description: "Simple ingress policies",
1586 key: :media_removal,
1587 type: {:list, :string},
1588 description: "List of instances to strip media attachments from",
1589 suggestions: ["example.com", "*.example.com"]
1593 label: "Media NSFW",
1594 type: {:list, :string},
1595 description: "List of instances to tag all media as NSFW (sensitive) from",
1596 suggestions: ["example.com", "*.example.com"]
1599 key: :federated_timeline_removal,
1600 type: {:list, :string},
1602 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1603 suggestions: ["example.com", "*.example.com"]
1607 type: {:list, :string},
1608 description: "List of instances to reject activities from (except deletes)",
1609 suggestions: ["example.com", "*.example.com"]
1613 type: {:list, :string},
1614 description: "List of instances to only accept activities from (except deletes)",
1615 suggestions: ["example.com", "*.example.com"]
1618 key: :followers_only,
1619 type: {:list, :string},
1620 description: "Force posts from the given instances to be visible by followers only",
1621 suggestions: ["example.com", "*.example.com"]
1624 key: :report_removal,
1625 type: {:list, :string},
1626 description: "List of instances to reject reports from",
1627 suggestions: ["example.com", "*.example.com"]
1630 key: :avatar_removal,
1631 type: {:list, :string},
1632 description: "List of instances to strip avatars from",
1633 suggestions: ["example.com", "*.example.com"]
1636 key: :banner_removal,
1637 type: {:list, :string},
1638 description: "List of instances to strip banners from",
1639 suggestions: ["example.com", "*.example.com"]
1642 key: :reject_deletes,
1643 type: {:list, :string},
1644 description: "List of instances to reject deletions from",
1645 suggestions: ["example.com", "*.example.com"]
1651 key: :mrf_activity_expiration,
1653 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1654 label: "MRF Activity Expiration Policy",
1656 description: "Adds automatic expiration to all local activities",
1661 description: "Default global expiration time for all local activities (in days)",
1662 suggestions: [90, 365]
1670 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1671 label: "MRF Subchain",
1674 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1675 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1679 type: {:map, {:list, :string}},
1680 description: "Matches a series of regular expressions against the actor field",
1683 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1691 key: :mrf_rejectnonpublic,
1693 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1694 description: "RejectNonPublic drops posts with non-public visibility settings.",
1695 label: "MRF Reject Non Public",
1699 key: :allow_followersonly,
1700 label: "Allow followers-only",
1702 description: "Whether to allow followers-only posts"
1707 description: "Whether to allow direct messages"
1713 key: :mrf_hellthread,
1715 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1716 label: "MRF Hellthread",
1718 description: "Block messages with excessive user mentions",
1721 key: :delist_threshold,
1724 "Number of mentioned users after which the message gets removed from timelines and" <>
1725 "disables notifications. Set to 0 to disable.",
1729 key: :reject_threshold,
1732 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1741 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1742 label: "MRF Keyword",
1744 description: "Reject or Word-Replace messages with a keyword or regex",
1748 type: {:list, :string},
1750 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1751 suggestions: ["foo", ~r/foo/iu]
1754 key: :federated_timeline_removal,
1755 type: {:list, :string},
1757 "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.",
1758 suggestions: ["foo", ~r/foo/iu]
1762 type: {:list, :tuple},
1764 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1765 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1773 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1774 label: "MRF Mention",
1776 description: "Block messages which mention a specific user",
1780 type: {:list, :string},
1781 description: "A list of actors for which any post mentioning them will be dropped",
1782 suggestions: ["actor1", "actor2"]
1788 key: :mrf_vocabulary,
1790 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1791 label: "MRF Vocabulary",
1793 description: "Filter messages which belong to certain activity vocabularies",
1797 type: {:list, :string},
1799 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1800 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1804 type: {:list, :string},
1806 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1807 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1813 # key: :mrf_user_allowlist,
1815 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1818 # "The keys in this section are the domain names that the policy should apply to." <>
1819 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1821 # %{"example.org" => ["https://example.org/users/admin"]}
1829 description: "Media proxy",
1834 description: "Enables proxying of remote media to the instance's proxy"
1841 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1842 suggestions: ["https://example.com"]
1850 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1856 description: "Enables media cache object invalidation."
1861 description: "Module which will be used to purge objects from the cache.",
1863 Pleroma.Web.MediaProxy.Invalidation.Script,
1864 Pleroma.Web.MediaProxy.Invalidation.Http
1871 label: "Proxy Options",
1873 description: "Options for Pleroma.ReverseProxy",
1875 redirect_on_failure: false,
1876 max_body_length: 25 * 1_048_576,
1878 follow_redirect: true,
1884 key: :redirect_on_failure,
1887 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1888 "Any error during body processing will not be redirected as the response is chunked."
1891 key: :max_body_length,
1894 "Limits the content length to be approximately the " <>
1895 "specified length. It is validated with the `content-length` header and also verified when proxying."
1901 description: "HTTP options",
1906 description: "Adapter specific options",
1911 label: "SSL Options",
1912 description: "SSL options for HTTP adapter",
1916 type: {:list, :atom},
1917 description: "List of TLS version to use",
1918 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1927 type: [:string, :tuple],
1928 description: "Proxy URL",
1929 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1937 type: {:list, :string},
1938 description: "List of hosts with scheme to bypass the mediaproxy",
1939 suggestions: ["http://example.com"]
1945 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1947 description: "HTTP invalidate settings",
1952 description: "HTTP method of request. Default: :purge"
1956 type: {:keyword, :string},
1957 description: "HTTP headers of request",
1958 suggestions: [{"x-refresh", 1}]
1963 description: "Request options",
1967 type: {:map, :string}
1975 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1977 description: "Script invalidate settings",
1982 description: "Path to shell script. Which will run purge cache.",
1983 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1991 description: "Gopher settings",
1996 description: "Enables the gopher interface"
2002 description: "IP address to bind to",
2003 suggestions: [{0, 0, 0, 0}]
2008 description: "Port to bind to",
2014 description: "Port advertised in URLs (optional, defaults to port)",
2022 label: "ActivityPub",
2024 description: "ActivityPub-related settings",
2027 key: :unfollow_blocked,
2029 description: "Whether blocks result in people getting unfollowed"
2032 key: :outgoing_blocks,
2034 description: "Whether to federate blocks to other instances"
2037 key: :sign_object_fetches,
2039 description: "Sign object fetches with HTTP signatures"
2042 key: :note_replies_output_limit,
2045 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2048 key: :follow_handshake_timeout,
2050 description: "Following handshake timeout",
2057 key: :http_security,
2058 label: "HTTP security",
2060 description: "HTTP security settings",
2065 description: "Whether the managed content security policy is enabled"
2071 description: "Whether to additionally send a Strict-Transport-Security header"
2075 label: "STS max age",
2077 description: "The maximum age for the Strict-Transport-Security header if sent",
2078 suggestions: [31_536_000]
2082 label: "CT max age",
2084 description: "The maximum age for the Expect-CT header if sent",
2085 suggestions: [2_592_000]
2088 key: :referrer_policy,
2090 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2091 suggestions: ["same-origin", "no-referrer"]
2095 label: "Report URI",
2097 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2098 suggestions: ["https://example.com/report-uri"]
2103 group: :web_push_encryption,
2104 key: :vapid_details,
2105 label: "Vapid Details",
2108 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2114 "A mailto link for the administrative contact." <>
2115 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2116 suggestions: ["mailto:moderators@pleroma.com"]
2121 description: "VAPID public key",
2122 suggestions: ["Public key"]
2127 description: "VAPID private key",
2128 suggestions: ["Private key"]
2134 key: Pleroma.Captcha,
2136 description: "Captcha-related settings",
2141 description: "Whether the captcha should be shown on registration"
2146 description: "The method/service to use for captcha",
2147 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2150 key: :seconds_valid,
2152 description: "The time in seconds for which the captcha is valid",
2159 key: Pleroma.Captcha.Kocaptcha,
2162 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2163 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2168 description: "The kocaptcha endpoint to use",
2169 suggestions: ["https://captcha.kotobank.ch"]
2175 label: "Pleroma Admin Token",
2178 "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)",
2183 description: "Admin token",
2185 "Please use a high entropy string or UUID"
2195 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2197 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2198 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2199 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2200 (see https://github.com/sorentwo/oban/issues/52).
2205 type: {:dropdown, :atom},
2206 description: "Logs verbose mode",
2207 suggestions: [false, :error, :warn, :info, :debug]
2211 type: {:keyword, :integer},
2213 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2215 activity_expiration: 10,
2216 attachments_cleanup: 5,
2218 federator_incoming: 50,
2219 federator_outgoing: 50,
2221 scheduled_activities: 10,
2227 key: :activity_expiration,
2229 description: "Activity expiration queue",
2233 key: :attachments_cleanup,
2235 description: "Attachment deletion queue",
2241 description: "Background queue",
2245 key: :federator_incoming,
2247 description: "Incoming federation queue",
2251 key: :federator_outgoing,
2253 description: "Outgoing federation queue",
2259 description: "Email sender queue, see Pleroma.Emails.Mailer",
2263 key: :scheduled_activities,
2265 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2269 key: :transmogrifier,
2271 description: "Transmogrifier queue",
2277 description: "Web push notifications queue",
2284 type: {:list, :tuple},
2285 description: "Settings for cron background jobs",
2287 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2288 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2297 description: "Includes custom worker options not interpretable directly by `Oban`",
2301 type: {:keyword, :integer},
2302 description: "Max retry attempts for failed jobs, per `Oban` queue",
2304 federator_incoming: 5,
2305 federator_outgoing: 5
2312 key: Pleroma.Web.Metadata,
2314 description: "Metadata-related settings",
2318 type: {:list, :module},
2319 description: "List of metadata providers to enable",
2321 Pleroma.Web.Metadata.Providers.OpenGraph,
2322 Pleroma.Web.Metadata.Providers.TwitterCard,
2323 Pleroma.Web.Metadata.Providers.RelMe,
2324 Pleroma.Web.Metadata.Providers.Feed
2329 label: "Unfurl NSFW",
2331 description: "When enabled NSFW attachments will be shown in previews"
2340 "If enabled the instance will parse metadata from attached links to generate link previews",
2345 description: "Enables RichMedia parsing of URLs"
2349 type: {:list, :string},
2350 description: "List of hosts which will be ignored by the metadata parser",
2351 suggestions: ["accounts.google.com", "xss.website"]
2355 label: "Ignore TLD",
2356 type: {:list, :string},
2357 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2358 suggestions: ["local", "localdomain", "lan"]
2362 type: {:list, :module},
2364 "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.",
2366 Pleroma.Web.RichMedia.Parsers.OEmbed,
2367 Pleroma.Web.RichMedia.Parsers.TwitterCard
2372 label: "TTL setters",
2373 type: {:list, :module},
2375 "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.",
2377 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2381 key: :failure_backoff,
2384 "Amount of milliseconds after request failure, during which the request will not be retried.",
2385 suggestions: [60_000]
2391 key: Pleroma.Formatter,
2392 label: "Auto Linker",
2395 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2399 type: [:string, :boolean],
2400 description: "Specify the class to be added to the generated link. Disable to clear.",
2401 suggestions: ["auto-linker", false]
2405 type: [:string, :boolean],
2406 description: "Override the rel attribute. Disable to clear.",
2407 suggestions: ["ugc", "noopener noreferrer", false]
2412 description: "Link URLs will open in a new window/tab."
2416 type: [:integer, :boolean],
2418 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2419 suggestions: [15, false]
2424 description: "Strip the scheme prefix."
2429 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2433 type: [:atom, :boolean],
2435 "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)",
2436 suggestions: [:no_scheme, true]
2442 key: Pleroma.ScheduledActivity,
2444 description: "Scheduled activities settings",
2447 key: :daily_user_limit,
2450 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2454 key: :total_user_limit,
2457 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2463 description: "Whether scheduled activities are sent to the job queue to be executed"
2469 key: Pleroma.Workers.PurgeExpiredActivity,
2471 description: "Expired activities settings",
2476 description: "Enables expired activities addition & deletion"
2481 description: "Minimum lifetime for ephemeral activity (in seconds)",
2488 label: "Pleroma Authenticator",
2490 description: "Authenticator",
2493 key: Pleroma.Web.Auth.Authenticator,
2495 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2505 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2506 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2507 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2508 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2513 description: "Enables LDAP authentication"
2518 description: "LDAP server hostname",
2519 suggestions: ["localhosts"]
2524 description: "LDAP port, e.g. 389 or 636",
2525 suggestions: [389, 636]
2531 description: "Enable to use SSL, usually implies the port 636"
2535 label: "SSL options",
2537 description: "Additional SSL options",
2538 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2543 description: "Path to file with PEM encoded cacerts",
2544 suggestions: ["path/to/file/with/PEM/cacerts"]
2549 description: "Type of cert verification",
2550 suggestions: [:verify_peer]
2558 description: "Enable to use STARTTLS, usually implies the port 389"
2562 label: "TLS options",
2564 description: "Additional TLS options",
2565 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2570 description: "Path to file with PEM encoded cacerts",
2571 suggestions: ["path/to/file/with/PEM/cacerts"]
2576 description: "Type of cert verification",
2577 suggestions: [:verify_peer]
2584 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2585 suggestions: ["dc=example,dc=com"]
2592 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2601 description: "Authentication / authorization settings",
2604 key: :enforce_oauth_admin_scope_usage,
2605 label: "Enforce OAuth admin scope usage",
2608 "OAuth admin scope requirement toggle. " <>
2609 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2610 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2611 "`is_admin` user flag grants access to admin-specific actions."
2614 key: :auth_template,
2617 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2618 suggestions: ["show.html"]
2621 key: :oauth_consumer_template,
2622 label: "OAuth consumer template",
2625 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2626 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2627 suggestions: ["consumer.html"]
2630 key: :oauth_consumer_strategies,
2631 label: "OAuth consumer strategies",
2632 type: {:list, :string},
2634 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2635 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2636 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2637 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2643 key: :email_notifications,
2645 description: "Email notifications settings",
2651 "emails of \"what you've missed\" for users who have been inactive for a while",
2655 schedule: "0 0 * * 0",
2657 inactivity_threshold: 7
2665 description: "Globally enable or disable digest emails"
2671 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2672 suggestions: ["0 0 * * 0"]
2677 description: "Minimum interval between digest emails to one user",
2681 key: :inactivity_threshold,
2683 description: "Minimum user inactivity threshold",
2692 key: Pleroma.Emails.UserEmail,
2694 description: "Email template settings",
2698 type: {:string, :image},
2699 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2700 suggestions: ["some/path/logo.png"]
2705 description: "A map with color settings for email templates.",
2708 link_color: "#d8a070",
2709 background_color: "#2C3645",
2710 content_background_color: "#1B2635",
2711 header_color: "#d8a070",
2712 text_color: "#b9b9ba",
2713 text_muted_color: "#b9b9ba"
2720 suggestions: ["#d8a070"]
2723 key: :background_color,
2725 suggestions: ["#2C3645"]
2728 key: :content_background_color,
2730 suggestions: ["#1B2635"]
2735 suggestions: ["#d8a070"]
2740 suggestions: ["#b9b9ba"]
2743 key: :text_muted_color,
2745 suggestions: ["#b9b9ba"]
2753 key: Pleroma.Emails.NewUsersDigestEmail,
2755 description: "New users admin email digest",
2760 description: "Enables new users admin digest email when `true`"
2769 description: "Configure OAuth 2 provider capabilities",
2772 key: :token_expires_in,
2774 description: "The lifetime in seconds of the access token",
2778 key: :issue_new_refresh_token,
2781 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2784 key: :clean_expired_tokens,
2786 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2796 key: :shortcode_globs,
2797 type: {:list, :string},
2798 description: "Location of custom emoji files. * can be used as a wildcard.",
2799 suggestions: ["/emoji/custom/**/*.png"]
2802 key: :pack_extensions,
2803 type: {:list, :string},
2805 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2806 suggestions: [".png", ".gif"]
2810 type: {:keyword, {:list, :string}},
2812 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2813 " and the value is the location or array of locations. * can be used as a wildcard.",
2815 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2819 key: :default_manifest,
2822 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2823 " Currently only one manifest can be added (no arrays).",
2824 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2827 key: :shared_pack_cache_seconds_per_file,
2828 label: "Shared pack cache s/file",
2831 "When an emoji pack is shared, the archive is created and cached in memory" <>
2832 " for this amount of seconds multiplied by the number of files.",
2842 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2846 type: [:tuple, {:list, :tuple}],
2847 description: "For the search requests (account & status search etc.)",
2848 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2852 type: [:tuple, {:list, :tuple}],
2853 description: "For requests to timelines (each timeline has it's own limiter)",
2854 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2857 key: :app_account_creation,
2858 type: [:tuple, {:list, :tuple}],
2859 description: "For registering user accounts from the same IP address",
2860 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2863 key: :relations_actions,
2864 type: [:tuple, {:list, :tuple}],
2865 description: "For actions on relationships with all users (follow, unfollow)",
2866 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2869 key: :relation_id_action,
2870 label: "Relation ID action",
2871 type: [:tuple, {:list, :tuple}],
2872 description: "For actions on relation with a specific user (follow, unfollow)",
2873 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2876 key: :statuses_actions,
2877 type: [:tuple, {:list, :tuple}],
2879 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2880 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2883 key: :status_id_action,
2884 label: "Status ID action",
2885 type: [:tuple, {:list, :tuple}],
2887 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2888 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2891 key: :authentication,
2892 type: [:tuple, {:list, :tuple}],
2893 description: "For authentication create / password check / user existence check requests",
2894 suggestions: [{60_000, 15}]
2903 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2904 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2909 description: "Enables SSH"
2914 description: "Dir with SSH keys",
2915 suggestions: ["/some/path/ssh_keys"]
2920 description: "Handler module",
2921 suggestions: ["Pleroma.BBS.Handler"]
2926 description: "Port to connect",
2927 suggestions: [10_022]
2930 key: :password_authenticator,
2932 description: "Authenticator module",
2933 suggestions: ["Pleroma.BBS.Authenticator"]
2939 label: "Mime Types",
2941 description: "Mime Types settings",
2948 "application/xml" => ["xml"],
2949 "application/xrd+xml" => ["xrd+xml"],
2950 "application/jrd+json" => ["jrd+json"],
2951 "application/activity+json" => ["activity+json"],
2952 "application/ld+json" => ["activity+json"]
2957 key: "application/xml",
2958 type: {:list, :string},
2959 suggestions: ["xml"]
2962 key: "application/xrd+xml",
2963 type: {:list, :string},
2964 suggestions: ["xrd+xml"]
2967 key: "application/jrd+json",
2968 type: {:list, :string},
2969 suggestions: ["jrd+json"]
2972 key: "application/activity+json",
2973 type: {:list, :string},
2974 suggestions: ["activity+json"]
2977 key: "application/ld+json",
2978 type: {:list, :string},
2979 suggestions: ["activity+json"]
2989 description: "Pleroma chat settings",
3002 description: "HTTP settings",
3007 type: [:string, :tuple],
3008 description: "Proxy URL",
3009 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3012 key: :send_user_agent,
3017 type: [:string, :atom],
3019 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3020 suggestions: ["Pleroma", :default]
3025 description: "Adapter specific options",
3031 label: "SSL Options",
3032 description: "SSL options for HTTP adapter",
3036 type: {:list, :atom},
3037 description: "List of TLS version to use",
3038 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3049 label: "Markup Settings",
3053 key: :allow_inline_images,
3057 key: :allow_headings,
3070 type: {:list, :module},
3072 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3073 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3083 key: :deny_follow_blocked,
3090 key: :mrf_normalize_markup,
3092 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3093 label: "MRF Normalize Markup",
3094 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3100 suggestions: [Pleroma.HTML.Scrubber.Default]
3110 key: :restricted_nicknames,
3111 type: {:list, :string},
3112 description: "List of nicknames users may not register with.",
3131 "ostatus_subscribe",
3147 key: :email_blacklist,
3148 type: {:list, :string},
3149 description: "List of email domains users may not register with.",
3150 suggestions: ["mailinator.com", "maildrop.cc"]
3156 label: "CORS plug config",
3162 suggestions: [86_400]
3166 type: {:list, :string},
3167 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3171 type: {:list, :string},
3174 "X-RateLimit-Reset",
3175 "X-RateLimit-Limit",
3176 "X-RateLimit-Remaining",
3187 type: {:list, :string},
3188 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3194 key: Pleroma.Plugs.RemoteIp,
3197 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3198 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3204 description: "Enable/disable the plug. Default: disabled."
3208 type: {:list, :string},
3210 "A list of strings naming the `req_headers` to use when deriving the `remote_ip`. Order does not matter. Default: `~w[forwarded x-forwarded-for x-client-ip x-real-ip]`."
3214 type: {:list, :string},
3216 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3220 type: {:list, :string},
3222 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3228 key: :web_cache_ttl,
3229 label: "Web cache TTL",
3232 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3238 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3239 suggestions: [30_000, nil]
3242 key: :activity_pub_question,
3244 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3245 suggestions: [30_000]
3255 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3260 description: "Enables the rendering of static HTML. Default: disabled."
3268 description: "Configure feed rendering",
3273 description: "Configure title rendering",
3278 description: "Maximum number of characters before truncating title",
3284 description: "Replacement which will be used after truncating string",
3285 suggestions: ["..."]
3293 key: :mrf_object_age,
3295 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3296 label: "MRF Object Age",
3299 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3304 description: "Required age (in seconds) of a post before actions are taken.",
3305 suggestions: [172_800]
3309 type: {:list, :atom},
3311 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3312 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3313 "`:reject` rejects the message entirely",
3314 suggestions: [:delist, :strip_followers, :reject]
3322 description: "Custom Runtime Modules",
3327 description: "A path to custom Elixir modules (such as MRF policies)."
3335 description: "Settings for notifications streamer",
3340 description: "Number of workers to send notifications",
3344 key: :overflow_workers,
3346 description: "Maximum number of workers created if pool is empty",
3353 key: :connections_pool,
3355 description: "Advanced settings for `Gun` connections pool",
3358 key: :connection_acquisition_wait,
3361 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3365 key: :connection_acquisition_retries,
3368 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3372 key: :max_connections,
3374 description: "Maximum number of connections in the pool. Default: 250 connections.",
3378 key: :connect_timeout,
3380 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3384 key: :reclaim_multiplier,
3387 "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",
3396 description: "Advanced settings for `Gun` workers pools",
3398 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3402 description: "Settings for #{pool_name} pool.",
3407 description: "Maximum number of concurrent requests in the pool.",
3414 "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",
3420 description: "Timeout for the pool while gun will wait for response",
3421 suggestions: [10_000]
3429 key: :hackney_pools,
3431 description: "Advanced settings for `Hackney` connections pools",
3436 description: "Settings for federation pool.",
3439 key: :max_connections,
3441 description: "Number workers in the pool.",
3447 description: "Timeout while `hackney` will wait for response.",
3448 suggestions: [150_000]
3455 description: "Settings for media pool.",
3458 key: :max_connections,
3460 description: "Number workers in the pool.",
3466 description: "Timeout while `hackney` will wait for response.",
3467 suggestions: [150_000]
3474 description: "Settings for upload pool.",
3477 key: :max_connections,
3479 description: "Number workers in the pool.",
3485 description: "Timeout while `hackney` will wait for response.",
3486 suggestions: [300_000]
3494 key: :restrict_unauthenticated,
3495 label: "Restrict Unauthenticated",
3498 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3503 description: "Settings for public and federated timelines.",
3508 description: "Disallow view public timeline."
3513 description: "Disallow view federated timeline."
3520 description: "Settings for user profiles.",
3525 description: "Disallow view local user profiles."
3530 description: "Disallow view remote user profiles."
3537 description: "Settings for statuses.",
3542 description: "Disallow view local statuses."
3547 description: "Disallow view remote statuses."
3555 key: Pleroma.Web.ApiSpec.CastAndValidate,
3562 "Enables strict input validation (useful in development, not recommended in production)"
3568 key: :instances_favicons,
3570 description: "Control favicons for instances",
3575 description: "Allow/disallow displaying and getting instances favicons"
3583 descriptions: "S3 service related settings",
3586 key: :access_key_id,
3588 description: "S3 access key ID",
3589 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3592 key: :secret_access_key,
3594 description: "Secret access key",
3595 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3600 description: "S3 host",
3601 suggestions: ["s3.eu-central-1.amazonaws.com"]
3609 description: "Installed frontends management",
3614 description: "Primary frontend, the one that is served for all pages by default",
3615 children: installed_frontend_options
3620 description: "Admin frontend",
3621 children: installed_frontend_options
3627 "A map containing available frontends and parameters for their installation.",
3636 key: Pleroma.Web.Preload,
3638 description: "Preload-related settings",
3642 type: {:list, :module},
3643 description: "List of preload providers to enable",
3645 Pleroma.Web.Preload.Providers.Instance,
3646 Pleroma.Web.Preload.Providers.User,
3647 Pleroma.Web.Preload.Providers.Timelines,
3648 Pleroma.Web.Preload.Providers.StatusNet