2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
26 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
30 type: {:list, :module},
32 "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.",
33 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
39 "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`."
45 description: "Base URL for the uploads, needed if you use CDN",
47 "https://cdn-host.com"
54 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
58 label: "Proxy Options",
60 description: "Options for Pleroma.ReverseProxy",
62 redirect_on_failure: false,
63 max_body_length: 25 * 1_048_576,
65 follow_redirect: true,
71 key: :redirect_on_failure,
74 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
75 "Any error during body processing will not be redirected as the response is chunked."
78 key: :max_body_length,
81 "Limits the content length to be approximately the " <>
82 "specified length. It is validated with the `content-length` header and also verified when proxying."
88 description: "HTTP options",
93 description: "Adapter specific options",
99 description: "SSL options for HTTP adapter",
103 type: {:list, :atom},
104 description: "List of TLS versions to use",
105 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
114 type: [:string, :tuple],
115 description: "Proxy URL",
116 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
123 key: :filename_display_max_length,
125 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
131 key: Pleroma.Uploaders.Local,
133 description: "Local uploader-related settings",
138 description: "Path where user's uploads will be saved",
147 key: Pleroma.Uploaders.S3,
149 description: "S3 uploader-related settings",
154 description: "S3 bucket",
160 key: :bucket_namespace,
162 description: "S3 bucket namespace",
163 suggestions: ["pleroma"]
166 key: :public_endpoint,
168 description: "S3 endpoint",
169 suggestions: ["https://s3.amazonaws.com"]
172 key: :truncated_namespace,
175 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
176 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
179 key: :streaming_enabled,
182 "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."
188 key: Pleroma.Upload.Filter.Mogrify,
190 description: "Uploads mogrify filter settings",
194 type: [:string, {:list, :string}, {:list, :tuple}],
196 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
197 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
208 key: Pleroma.Upload.Filter.AnonymizeFilename,
210 description: "Filter replaces the filename of the upload",
216 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
217 " filename extension by using {extension}, for example custom-file-name.{extension}.",
219 "custom-file-name.{extension}"
226 key: Pleroma.Emails.Mailer,
228 description: "Mailer-related settings",
234 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
235 " or Swoosh.Adapters.Local for in-memory mailbox",
237 Swoosh.Adapters.SMTP,
238 Swoosh.Adapters.Sendgrid,
239 Swoosh.Adapters.Sendmail,
240 Swoosh.Adapters.Mandrill,
241 Swoosh.Adapters.Mailgun,
242 Swoosh.Adapters.Mailjet,
243 Swoosh.Adapters.Postmark,
244 Swoosh.Adapters.SparkPost,
245 Swoosh.Adapters.AmazonSES,
247 Swoosh.Adapters.SocketLabs,
248 Swoosh.Adapters.Gmail,
249 Swoosh.Adapters.Local
255 description: "Allow/disallow send emails"
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
262 suggestions: ["smtp.gmail.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
269 suggestions: ["pleroma"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
275 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
276 suggestions: ["password"]
279 group: {:subgroup, Swoosh.Adapters.SMTP},
283 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
286 group: {:subgroup, Swoosh.Adapters.SMTP},
290 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
291 suggestions: [:always, :never, :if_available]
294 group: {:subgroup, Swoosh.Adapters.SMTP},
297 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
298 suggestions: [:always, :never, :if_available]
301 group: {:subgroup, Swoosh.Adapters.SMTP},
304 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
308 group: {:subgroup, Swoosh.Adapters.SMTP},
311 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
315 group: {:subgroup, Swoosh.Adapters.SMTP},
317 label: "No MX lookups",
319 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
322 group: {:subgroup, Swoosh.Adapters.Sendgrid},
326 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
327 suggestions: ["my-api-key"]
330 group: {:subgroup, Swoosh.Adapters.Sendmail},
333 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
334 suggestions: ["/usr/bin/sendmail"]
337 group: {:subgroup, Swoosh.Adapters.Sendmail},
340 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
341 suggestions: ["-N delay,failure,success"]
344 group: {:subgroup, Swoosh.Adapters.Sendmail},
347 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
350 group: {:subgroup, Swoosh.Adapters.Mandrill},
354 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
355 suggestions: ["my-api-key"]
358 group: {:subgroup, Swoosh.Adapters.Mailgun},
362 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
363 suggestions: ["my-api-key"]
366 group: {:subgroup, Swoosh.Adapters.Mailgun},
369 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
370 suggestions: ["pleroma.com"]
373 group: {:subgroup, Swoosh.Adapters.Mailjet},
377 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
378 suggestions: ["my-api-key"]
381 group: {:subgroup, Swoosh.Adapters.Mailjet},
384 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
385 suggestions: ["my-secret-key"]
388 group: {:subgroup, Swoosh.Adapters.Postmark},
392 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
393 suggestions: ["my-api-key"]
396 group: {:subgroup, Swoosh.Adapters.SparkPost},
400 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
401 suggestions: ["my-api-key"]
404 group: {:subgroup, Swoosh.Adapters.SparkPost},
407 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
408 suggestions: ["https://api.sparkpost.com/api/v1"]
411 group: {:subgroup, Swoosh.Adapters.AmazonSES},
414 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
415 suggestions: ["us-east-1", "us-east-2"]
418 group: {:subgroup, Swoosh.Adapters.AmazonSES},
421 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
422 suggestions: ["aws-access-key"]
425 group: {:subgroup, Swoosh.Adapters.AmazonSES},
428 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
429 suggestions: ["aws-secret-key"]
432 group: {:subgroup, Swoosh.Adapters.Dyn},
436 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
437 suggestions: ["my-api-key"]
440 group: {:subgroup, Swoosh.Adapters.SocketLabs},
443 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
446 group: {:subgroup, Swoosh.Adapters.SocketLabs},
450 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
453 group: {:subgroup, Swoosh.Adapters.Gmail},
456 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
463 description: "`Swoosh.Adapters.Local` adapter specific settings",
466 group: {:subgroup, Swoosh.Adapters.Local},
469 description: "Run the preview server together as part of your app"
472 group: {:subgroup, Swoosh.Adapters.Local},
475 description: "The preview server port",
483 label: "URI Schemes",
485 description: "URI schemes related settings",
489 type: {:list, :string},
490 description: "List of the scheme part that is considered valid to be an URL",
515 description: "Instance-related settings",
520 description: "Name of the instance",
527 label: "Admin Email Address",
529 description: "Email used to reach an Administrator/Moderator of the instance",
536 label: "Sender Email Address",
538 description: "Envelope FROM address for mail sent via Pleroma",
547 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
555 description: "Posts character limit (CW/Subject included in the counter)",
563 description: "Character limit of the instance chat messages",
571 description: "Hard character limit beyond which remote posts will be dropped",
579 description: "File size limit of uploads (except for avatar, background, banner)",
585 key: :avatar_upload_limit,
587 description: "File size limit of user's profile avatars",
593 key: :background_upload_limit,
595 description: "File size limit of user's profile backgrounds",
601 key: :banner_upload_limit,
603 description: "File size limit of user's profile banners",
611 description: "A map with poll limits for local polls",
615 max_option_chars: 200,
617 max_expiration: 31_536_000
624 description: "Maximum number of options",
628 key: :max_option_chars,
630 description: "Maximum number of characters per option",
634 key: :min_expiration,
636 description: "Minimum expiration time (in seconds)",
640 key: :max_expiration,
642 description: "Maximum expiration time (in seconds)",
648 key: :registrations_open,
651 "Enable registrations for anyone. Invitations require this setting to be disabled."
654 key: :invites_enabled,
657 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
660 key: :account_activation_required,
662 description: "Require users to confirm their emails before signing in"
665 key: :account_approval_required,
667 description: "Require users to be manually approved by an admin before signing in"
672 description: "Enable federation with other instances"
675 key: :federation_incoming_replies_max_depth,
676 label: "Fed. incoming replies max depth",
679 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
680 " 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.",
686 key: :federation_reachability_timeout_days,
687 label: "Fed. reachability timeout days",
690 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
698 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
704 "Makes the client API in authenticated mode-only except for user-profiles." <>
705 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
706 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
709 key: :quarantined_instances,
710 type: {:list, :string},
712 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
719 key: :managed_config,
722 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
727 description: "Instance static directory",
733 key: :allowed_post_formats,
734 type: {:list, :string},
735 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
744 key: :extended_nickname_format,
747 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
748 " This will break federation with older software for theses nicknames."
751 key: :cleanup_attachments,
754 Enable to remove associated attachments when status is removed.
755 This will not affect duplicates and attachments without status.
756 Enabling this will increase load to database when deleting statuses on larger instances.
760 key: :max_pinned_statuses,
762 description: "The maximum number of pinned statuses. 0 will disable the feature.",
770 key: :autofollowed_nicknames,
771 type: {:list, :string},
773 "Set to nicknames of (local) users that every new user should automatically follow",
782 key: :attachment_links,
784 description: "Enable to automatically add attachment link text to statuses"
787 key: :max_report_comment_size,
789 description: "The maximum size of the report comment. Default: 1000.",
795 key: :safe_dm_mentions,
796 label: "Safe DM mentions",
799 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
800 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
806 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
809 key: :remote_post_retention_days,
812 "The default amount of days to retain remote posts when pruning the database",
818 key: :user_bio_length,
820 description: "A user bio maximum length. Default: 5000.",
826 key: :user_name_length,
828 description: "A user name maximum length. Default: 100.",
834 key: :skip_thread_containment,
836 description: "Skip filtering out broken threads. Default: enabled."
839 key: :limit_to_local_content,
840 type: {:dropdown, :atom},
842 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
850 key: :max_account_fields,
852 description: "The maximum number of custom fields in the user profile. Default: 10.",
858 key: :max_remote_account_fields,
861 "The maximum number of custom fields in the remote user profile. Default: 20.",
867 key: :account_field_name_length,
869 description: "An account field name maximum length. Default: 512.",
875 key: :account_field_value_length,
877 description: "An account field value maximum length. Default: 2048.",
883 key: :registration_reason_length,
885 description: "Maximum registration reason length. Default: 500.",
891 key: :external_user_synchronization,
893 description: "Enabling following/followers counters synchronization for external users"
896 key: :multi_factor_authentication,
898 description: "Multi-factor authentication settings",
901 totp: [digits: 6, period: 30],
902 backup_codes: [number: 5, length: 16]
908 label: "TOTP settings",
910 description: "TOTP settings",
911 suggestions: [digits: 6, period: 30],
918 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
925 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
932 description: "MFA backup codes settings",
933 suggestions: [number: 5, length: 16],
939 description: "Number of backup codes to generate."
946 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
953 key: :instance_thumbnail,
956 "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.",
957 suggestions: ["/instance/thumbnail.jpeg"]
960 key: :show_reactions,
962 description: "Let favourites and emoji reactions be viewed through the API."
969 description: "Welcome messages settings",
972 group: :direct_message,
974 descpiption: "Direct message settings",
979 description: "Enables sends direct message for new user after registration"
985 "A message that will be sent to a newly registered users as a direct message",
987 "Hi, @username! Welcome on board!"
991 key: :sender_nickname,
993 description: "The nickname of the local user that sends the welcome message",
1001 group: :chat_message,
1003 descpiption: "Chat message settings",
1008 description: "Enables sends chat message for new user after registration"
1014 "A message that will be sent to a newly registered users as a chat message",
1016 "Hi, @username! Welcome on board!"
1020 key: :sender_nickname,
1022 description: "The nickname of the local user that sends the welcome message",
1032 descpiption: "Email message settings",
1037 description: "Enables sends direct message for new user after registration"
1041 type: [:string, :tuple],
1043 "The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.",
1045 {"Pleroma App", "welcome@pleroma.app"}
1052 "The subject of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1053 suggestions: ["Welcome to <%= instance_name%>"]
1059 "The html content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1060 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1066 "The text content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1067 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1076 description: "Logger-related settings",
1080 type: [:atom, :tuple, :module],
1082 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1083 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1091 label: "ExSyslogger",
1092 description: "ExSyslogger-related settings",
1096 type: {:dropdown, :atom},
1097 description: "Log level",
1098 suggestions: [:debug, :info, :warn, :error]
1104 "A string that's prepended to every message, and is typically set to the app name",
1105 suggestions: ["pleroma"]
1110 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1111 suggestions: ["$metadata[$level] $message"]
1115 type: {:list, :atom},
1116 suggestions: [:request_id]
1124 label: "Console Logger",
1125 description: "Console logger settings",
1129 type: {:dropdown, :atom},
1130 description: "Log level",
1131 suggestions: [:debug, :info, :warn, :error]
1136 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1137 suggestions: ["$metadata[$level] $message"]
1141 type: {:list, :atom},
1142 suggestions: [:request_id]
1149 label: "Quack Logger",
1150 description: "Quack-related settings",
1154 type: {:dropdown, :atom},
1155 description: "Log level",
1156 suggestions: [:debug, :info, :warn, :error]
1160 type: {:list, :atom},
1161 description: "Configure which metadata you want to report on",
1178 label: "Webhook URL",
1180 description: "Configure the Slack incoming webhook",
1181 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1187 key: :frontend_configurations,
1190 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1191 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1192 "add your own configuration your settings all fields must be complete.",
1196 label: "Pleroma FE",
1198 description: "Settings for Pleroma FE",
1201 alwaysShowSubjectInput: true,
1202 background: "/static/aurora_borealis.jpg",
1203 collapseMessageWithSubject: false,
1206 hideFilteredStatuses: false,
1207 hideMutedPosts: false,
1208 hidePostStats: false,
1209 hideSitename: false,
1210 hideUserStats: false,
1211 loginMethod: "password",
1212 logo: "/static/logo.png",
1215 minimalScopesMode: false,
1216 noAttachmentLinks: false,
1217 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1218 postContentType: "text/plain",
1219 redirectRootLogin: "/main/friends",
1220 redirectRootNoLogin: "/main/all",
1222 sidebarRight: false,
1223 showFeaturesPanel: true,
1224 showInstanceSpecificPanel: false,
1225 subjectLineBehavior: "email",
1226 theme: "pleroma-dark",
1227 webPushNotifications: false
1232 key: :alwaysShowSubjectInput,
1233 label: "Always show subject input",
1235 description: "When disabled, auto-hide the subject field if it's empty"
1241 "URL of the background, unless viewing a user profile with a background that is set",
1242 suggestions: ["/images/city.jpg"]
1245 key: :collapseMessageWithSubject,
1246 label: "Collapse message with subject",
1249 "When a message has a subject (aka Content Warning), collapse it by default"
1253 label: "PleromaFE Chat",
1255 description: "Disables PleromaFE Chat component"
1261 description: "Enables green text on lines prefixed with the > character"
1264 key: :hideFilteredStatuses,
1265 label: "Hide Filtered Statuses",
1267 description: "Hides filtered statuses from timelines"
1270 key: :hideMutedPosts,
1271 label: "Hide Muted Posts",
1273 description: "Hides muted statuses from timelines"
1276 key: :hidePostStats,
1277 label: "Hide post stats",
1279 description: "Hide notices statistics (repeats, favorites, ...)"
1283 label: "Hide Sitename",
1285 description: "Hides instance name from PleromaFE banner"
1288 key: :hideUserStats,
1289 label: "Hide user stats",
1292 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1297 description: "URL of the logo, defaults to Pleroma's logo",
1298 suggestions: ["/static/logo.png"]
1302 label: "Logo margin",
1305 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1306 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1307 suggestions: [".1em"]
1314 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1315 "If you want a colorful logo you must disable logoMask."
1318 key: :minimalScopesMode,
1319 label: "Minimal scopes mode",
1322 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1323 "Also prevents replying to a DM with a public post from PleromaFE."
1326 key: :nsfwCensorImage,
1327 label: "NSFW Censor Image",
1330 "URL of the image to use for hiding NSFW media attachments in the timeline",
1331 suggestions: ["/static/img/nsfw.74818f9.png"]
1334 key: :postContentType,
1335 label: "Post Content Type",
1336 type: {:dropdown, :atom},
1337 description: "Default post formatting option",
1338 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1341 key: :redirectRootNoLogin,
1342 label: "Redirect root no login",
1345 "Relative URL which indicates where to redirect when a user isn't logged in",
1346 suggestions: ["/main/all"]
1349 key: :redirectRootLogin,
1350 label: "Redirect root login",
1353 "Relative URL which indicates where to redirect when a user is logged in",
1354 suggestions: ["/main/friends"]
1358 label: "Scope copy",
1360 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1364 label: "Sidebar on Right",
1366 description: "Change alignment of sidebar and panels to the right"
1369 key: :showFeaturesPanel,
1370 label: "Show instance features panel",
1373 "Enables panel displaying functionality of the instance on the About page"
1376 key: :showInstanceSpecificPanel,
1377 label: "Show instance specific panel",
1379 description: "Whether to show the instance's custom panel"
1382 key: :subjectLineBehavior,
1383 label: "Subject line behavior",
1385 description: "Allows changing the default behaviour of subject lines in replies.
1386 `email`: copy and preprend re:, as in email,
1387 `masto`: copy verbatim, as in Mastodon,
1388 `noop`: don't copy the subject.",
1389 suggestions: ["email", "masto", "noop"]
1394 description: "Which theme to use. Available themes are defined in styles.json",
1395 suggestions: ["pleroma-dark"]
1403 description: "Settings for Masto FE",
1406 showInstanceSpecificPanel: true
1411 key: :showInstanceSpecificPanel,
1412 label: "Show instance specific panel",
1414 description: "Whenether to show the instance's specific panel"
1425 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1429 type: {:keyword, :map},
1431 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1434 url: "/images/pleroma-fox-tan-smol.png",
1435 mime_type: "image/png"
1437 pleroma_fox_tan_shy: %{
1438 url: "/images/pleroma-fox-tan-shy.png",
1439 mime_type: "image/png"
1444 key: :default_mascot,
1447 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1453 key: :default_user_avatar,
1455 description: "URL of the default user avatar",
1456 suggestions: ["/images/avi.png"]
1465 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1469 type: {:list, :map},
1470 description: "Describe the icons of the app",
1473 src: "/static/logo.png"
1476 src: "/static/icon.png",
1480 src: "/static/icon.ico",
1481 sizes: "72x72 96x96 128x128 256x256"
1488 description: "Describe the theme color of the app",
1489 suggestions: ["#282c37", "mediumpurple"]
1492 key: :background_color,
1494 description: "Describe the background color of the app",
1495 suggestions: ["#191b22", "aliceblue"]
1505 description: "General MRF settings",
1509 type: [:module, {:list, :module}],
1511 "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.",
1512 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1516 label: "MRF transparency",
1519 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1522 key: :transparency_exclusions,
1523 label: "MRF transparency exclusions",
1524 type: {:list, :string},
1526 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1537 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1538 label: "MRF Simple",
1540 description: "Simple ingress policies",
1543 key: :media_removal,
1544 type: {:list, :string},
1545 description: "List of instances to strip media attachments from",
1546 suggestions: ["example.com", "*.example.com"]
1550 label: "Media NSFW",
1551 type: {:list, :string},
1552 description: "List of instances to tag all media as NSFW (sensitive) from",
1553 suggestions: ["example.com", "*.example.com"]
1556 key: :federated_timeline_removal,
1557 type: {:list, :string},
1559 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1560 suggestions: ["example.com", "*.example.com"]
1564 type: {:list, :string},
1565 description: "List of instances to reject activities from (except deletes)",
1566 suggestions: ["example.com", "*.example.com"]
1570 type: {:list, :string},
1571 description: "List of instances to only accept activities from (except deletes)",
1572 suggestions: ["example.com", "*.example.com"]
1575 key: :report_removal,
1576 type: {:list, :string},
1577 description: "List of instances to reject reports from",
1578 suggestions: ["example.com", "*.example.com"]
1581 key: :avatar_removal,
1582 type: {:list, :string},
1583 description: "List of instances to strip avatars from",
1584 suggestions: ["example.com", "*.example.com"]
1587 key: :banner_removal,
1588 type: {:list, :string},
1589 description: "List of instances to strip banners from",
1590 suggestions: ["example.com", "*.example.com"]
1593 key: :reject_deletes,
1594 type: {:list, :string},
1595 description: "List of instances to reject deletions from",
1596 suggestions: ["example.com", "*.example.com"]
1602 key: :mrf_activity_expiration,
1604 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1605 label: "MRF Activity Expiration Policy",
1607 description: "Adds automatic expiration to all local activities",
1612 description: "Default global expiration time for all local activities (in days)",
1613 suggestions: [90, 365]
1621 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1622 label: "MRF Subchain",
1625 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1626 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1630 type: {:map, {:list, :string}},
1631 description: "Matches a series of regular expressions against the actor field",
1634 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1642 key: :mrf_rejectnonpublic,
1644 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1645 description: "RejectNonPublic drops posts with non-public visibility settings.",
1646 label: "MRF Reject Non Public",
1650 key: :allow_followersonly,
1651 label: "Allow followers-only",
1653 description: "Whether to allow followers-only posts"
1658 description: "Whether to allow direct messages"
1664 key: :mrf_hellthread,
1666 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1667 label: "MRF Hellthread",
1669 description: "Block messages with excessive user mentions",
1672 key: :delist_threshold,
1675 "Number of mentioned users after which the message gets removed from timelines and" <>
1676 "disables notifications. Set to 0 to disable.",
1680 key: :reject_threshold,
1683 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1692 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1693 label: "MRF Keyword",
1695 description: "Reject or Word-Replace messages with a keyword or regex",
1699 type: {:list, :string},
1701 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1702 suggestions: ["foo", ~r/foo/iu]
1705 key: :federated_timeline_removal,
1706 type: {:list, :string},
1708 "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.",
1709 suggestions: ["foo", ~r/foo/iu]
1713 type: {:list, :tuple},
1715 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1716 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1724 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1725 label: "MRF Mention",
1727 description: "Block messages which mention a specific user",
1731 type: {:list, :string},
1732 description: "A list of actors for which any post mentioning them will be dropped",
1733 suggestions: ["actor1", "actor2"]
1739 key: :mrf_vocabulary,
1741 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1742 label: "MRF Vocabulary",
1744 description: "Filter messages which belong to certain activity vocabularies",
1748 type: {:list, :string},
1750 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1751 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1755 type: {:list, :string},
1757 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1758 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1764 # key: :mrf_user_allowlist,
1766 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1769 # "The keys in this section are the domain names that the policy should apply to." <>
1770 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1772 # %{"example.org" => ["https://example.org/users/admin"]}
1780 description: "Media proxy",
1785 description: "Enables proxying of remote media to the instance's proxy"
1792 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1793 suggestions: ["https://example.com"]
1801 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1807 description: "Enables invalidate media cache"
1812 description: "Module which will be used to cache purge.",
1814 Pleroma.Web.MediaProxy.Invalidation.Script,
1815 Pleroma.Web.MediaProxy.Invalidation.Http
1822 label: "Proxy Options",
1824 description: "Options for Pleroma.ReverseProxy",
1826 redirect_on_failure: false,
1827 max_body_length: 25 * 1_048_576,
1829 follow_redirect: true,
1835 key: :redirect_on_failure,
1838 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1839 "Any error during body processing will not be redirected as the response is chunked."
1842 key: :max_body_length,
1845 "Limits the content length to be approximately the " <>
1846 "specified length. It is validated with the `content-length` header and also verified when proxying."
1852 description: "HTTP options",
1857 description: "Adapter specific options",
1862 label: "SSL Options",
1863 description: "SSL options for HTTP adapter",
1867 type: {:list, :atom},
1868 description: "List of TLS version to use",
1869 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1878 type: [:string, :tuple],
1879 description: "Proxy URL",
1880 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1888 type: {:list, :string},
1889 description: "List of hosts with scheme to bypass the mediaproxy",
1890 suggestions: ["http://example.com"]
1896 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1898 description: "HTTP invalidate settings",
1903 description: "HTTP method of request. Default: :purge"
1907 type: {:keyword, :string},
1908 description: "HTTP headers of request",
1909 suggestions: [{"x-refresh", 1}]
1914 description: "Request options",
1918 type: {:map, :string}
1926 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1928 description: "Script invalidate settings",
1933 description: "Path to shell script. Which will run purge cache.",
1934 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1942 description: "Gopher settings",
1947 description: "Enables the gopher interface"
1953 description: "IP address to bind to",
1954 suggestions: [{0, 0, 0, 0}]
1959 description: "Port to bind to",
1965 description: "Port advertised in URLs (optional, defaults to port)",
1973 label: "ActivityPub",
1975 description: "ActivityPub-related settings",
1978 key: :unfollow_blocked,
1980 description: "Whether blocks result in people getting unfollowed"
1983 key: :outgoing_blocks,
1985 description: "Whether to federate blocks to other instances"
1988 key: :sign_object_fetches,
1990 description: "Sign object fetches with HTTP signatures"
1993 key: :note_replies_output_limit,
1996 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1999 key: :follow_handshake_timeout,
2001 description: "Following handshake timeout",
2008 key: :http_security,
2009 label: "HTTP security",
2011 description: "HTTP security settings",
2016 description: "Whether the managed content security policy is enabled"
2022 description: "Whether to additionally send a Strict-Transport-Security header"
2026 label: "STS max age",
2028 description: "The maximum age for the Strict-Transport-Security header if sent",
2029 suggestions: [31_536_000]
2033 label: "CT max age",
2035 description: "The maximum age for the Expect-CT header if sent",
2036 suggestions: [2_592_000]
2039 key: :referrer_policy,
2041 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2042 suggestions: ["same-origin", "no-referrer"]
2046 label: "Report URI",
2048 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2049 suggestions: ["https://example.com/report-uri"]
2054 group: :web_push_encryption,
2055 key: :vapid_details,
2056 label: "Vapid Details",
2059 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2065 "A mailto link for the administrative contact." <>
2066 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2067 suggestions: ["mailto:moderators@pleroma.com"]
2072 description: "VAPID public key",
2073 suggestions: ["Public key"]
2078 description: "VAPID private key",
2079 suggestions: ["Private key"]
2085 key: Pleroma.Captcha,
2087 description: "Captcha-related settings",
2092 description: "Whether the captcha should be shown on registration"
2097 description: "The method/service to use for captcha",
2098 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2101 key: :seconds_valid,
2103 description: "The time in seconds for which the captcha is valid",
2110 key: Pleroma.Captcha.Kocaptcha,
2113 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2114 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2119 description: "The kocaptcha endpoint to use",
2120 suggestions: ["https://captcha.kotobank.ch"]
2126 label: "Pleroma Admin Token",
2129 "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)",
2134 description: "Admin token",
2136 "Please use a high entropy string or UUID"
2146 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2148 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2149 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2150 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2151 (see https://github.com/sorentwo/oban/issues/52).
2156 type: {:dropdown, :atom},
2157 description: "Logs verbose mode",
2158 suggestions: [false, :error, :warn, :info, :debug]
2162 type: {:keyword, :integer},
2164 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2166 activity_expiration: 10,
2167 attachments_cleanup: 5,
2169 federator_incoming: 50,
2170 federator_outgoing: 50,
2172 scheduled_activities: 10,
2178 key: :activity_expiration,
2180 description: "Activity expiration queue",
2184 key: :attachments_cleanup,
2186 description: "Attachment deletion queue",
2192 description: "Background queue",
2196 key: :federator_incoming,
2198 description: "Incoming federation queue",
2202 key: :federator_outgoing,
2204 description: "Outgoing federation queue",
2210 description: "Email sender queue, see Pleroma.Emails.Mailer",
2214 key: :scheduled_activities,
2216 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2220 key: :transmogrifier,
2222 description: "Transmogrifier queue",
2228 description: "Web push notifications queue",
2235 type: {:list, :tuple},
2236 description: "Settings for cron background jobs",
2238 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2239 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2240 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2241 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2242 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2251 description: "Includes custom worker options not interpretable directly by `Oban`",
2255 type: {:keyword, :integer},
2256 description: "Max retry attempts for failed jobs, per `Oban` queue",
2258 federator_incoming: 5,
2259 federator_outgoing: 5
2266 key: Pleroma.Web.Metadata,
2268 description: "Metadata-related settings",
2272 type: {:list, :module},
2273 description: "List of metadata providers to enable",
2275 Pleroma.Web.Metadata.Providers.OpenGraph,
2276 Pleroma.Web.Metadata.Providers.TwitterCard,
2277 Pleroma.Web.Metadata.Providers.RelMe,
2278 Pleroma.Web.Metadata.Providers.Feed
2283 label: "Unfurl NSFW",
2285 description: "When enabled NSFW attachments will be shown in previews"
2294 "If enabled the instance will parse metadata from attached links to generate link previews",
2299 description: "Enables RichMedia parsing of URLs"
2303 type: {:list, :string},
2304 description: "List of hosts which will be ignored by the metadata parser",
2305 suggestions: ["accounts.google.com", "xss.website"]
2309 label: "Ignore TLD",
2310 type: {:list, :string},
2311 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2312 suggestions: ["local", "localdomain", "lan"]
2316 type: {:list, :module},
2318 "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.",
2320 Pleroma.Web.RichMedia.Parsers.OEmbed,
2321 Pleroma.Web.RichMedia.Parsers.TwitterCard
2326 label: "TTL setters",
2327 type: {:list, :module},
2329 "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.",
2331 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2338 key: Pleroma.Formatter,
2339 label: "Auto Linker",
2342 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2346 type: [:string, :boolean],
2347 description: "Specify the class to be added to the generated link. Disable to clear.",
2348 suggestions: ["auto-linker", false]
2352 type: [:string, :boolean],
2353 description: "Override the rel attribute. Disable to clear.",
2354 suggestions: ["ugc", "noopener noreferrer", false]
2359 description: "Link URLs will open in a new window/tab."
2363 type: [:integer, :boolean],
2365 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2366 suggestions: [15, false]
2371 description: "Strip the scheme prefix."
2376 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2380 type: [:atom, :boolean],
2382 "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)",
2383 suggestions: [:no_scheme, true]
2389 key: Pleroma.ScheduledActivity,
2391 description: "Scheduled activities settings",
2394 key: :daily_user_limit,
2397 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2401 key: :total_user_limit,
2404 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2410 description: "Whether scheduled activities are sent to the job queue to be executed"
2416 key: Pleroma.ActivityExpiration,
2418 description: "Expired activity settings",
2423 description: "Whether expired activities will be sent to the job queue to be deleted"
2429 label: "Pleroma Authenticator",
2431 description: "Authenticator",
2434 key: Pleroma.Web.Auth.Authenticator,
2436 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2446 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2447 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2448 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2449 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2454 description: "Enables LDAP authentication"
2459 description: "LDAP server hostname",
2460 suggestions: ["localhosts"]
2465 description: "LDAP port, e.g. 389 or 636",
2466 suggestions: [389, 636]
2472 description: "Enable to use SSL, usually implies the port 636"
2476 label: "SSL options",
2478 description: "Additional SSL options",
2479 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2484 description: "Path to file with PEM encoded cacerts",
2485 suggestions: ["path/to/file/with/PEM/cacerts"]
2490 description: "Type of cert verification",
2491 suggestions: [:verify_peer]
2499 description: "Enable to use STARTTLS, usually implies the port 389"
2503 label: "TLS options",
2505 description: "Additional TLS options",
2506 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2511 description: "Path to file with PEM encoded cacerts",
2512 suggestions: ["path/to/file/with/PEM/cacerts"]
2517 description: "Type of cert verification",
2518 suggestions: [:verify_peer]
2525 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2526 suggestions: ["dc=example,dc=com"]
2533 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2542 description: "Authentication / authorization settings",
2545 key: :enforce_oauth_admin_scope_usage,
2546 label: "Enforce OAuth admin scope usage",
2549 "OAuth admin scope requirement toggle. " <>
2550 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2551 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2552 "`is_admin` user flag grants access to admin-specific actions."
2555 key: :auth_template,
2558 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2559 suggestions: ["show.html"]
2562 key: :oauth_consumer_template,
2563 label: "OAuth consumer template",
2566 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2567 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2568 suggestions: ["consumer.html"]
2571 key: :oauth_consumer_strategies,
2572 label: "OAuth consumer strategies",
2573 type: {:list, :string},
2575 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2576 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2577 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2578 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2584 key: :email_notifications,
2586 description: "Email notifications settings",
2592 "emails of \"what you've missed\" for users who have been inactive for a while",
2596 schedule: "0 0 * * 0",
2598 inactivity_threshold: 7
2606 description: "Globally enable or disable digest emails"
2612 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2613 suggestions: ["0 0 * * 0"]
2618 description: "Minimum interval between digest emails to one user",
2622 key: :inactivity_threshold,
2624 description: "Minimum user inactivity threshold",
2633 key: Pleroma.Emails.UserEmail,
2635 description: "Email template settings",
2640 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2641 suggestions: ["some/path/logo.png"]
2646 description: "A map with color settings for email templates.",
2649 link_color: "#d8a070",
2650 background_color: "#2C3645",
2651 content_background_color: "#1B2635",
2652 header_color: "#d8a070",
2653 text_color: "#b9b9ba",
2654 text_muted_color: "#b9b9ba"
2661 suggestions: ["#d8a070"]
2664 key: :background_color,
2666 suggestions: ["#2C3645"]
2669 key: :content_background_color,
2671 suggestions: ["#1B2635"]
2676 suggestions: ["#d8a070"]
2681 suggestions: ["#b9b9ba"]
2684 key: :text_muted_color,
2686 suggestions: ["#b9b9ba"]
2694 key: Pleroma.Emails.NewUsersDigestEmail,
2696 description: "New users admin email digest",
2701 description: "Enables new users admin digest email when `true`"
2710 description: "Configure OAuth 2 provider capabilities",
2713 key: :token_expires_in,
2715 description: "The lifetime in seconds of the access token",
2719 key: :issue_new_refresh_token,
2722 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2725 key: :clean_expired_tokens,
2727 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2737 key: :shortcode_globs,
2738 type: {:list, :string},
2739 description: "Location of custom emoji files. * can be used as a wildcard.",
2740 suggestions: ["/emoji/custom/**/*.png"]
2743 key: :pack_extensions,
2744 type: {:list, :string},
2746 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2747 suggestions: [".png", ".gif"]
2751 type: {:keyword, {:list, :string}},
2753 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2754 " and the value is the location or array of locations. * can be used as a wildcard.",
2756 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2760 key: :default_manifest,
2763 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2764 " Currently only one manifest can be added (no arrays).",
2765 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2768 key: :shared_pack_cache_seconds_per_file,
2769 label: "Shared pack cache s/file",
2772 "When an emoji pack is shared, the archive is created and cached in memory" <>
2773 " for this amount of seconds multiplied by the number of files.",
2783 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2787 type: [:tuple, {:list, :tuple}],
2788 description: "For the search requests (account & status search etc.)",
2789 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2793 type: [:tuple, {:list, :tuple}],
2794 description: "For requests to timelines (each timeline has it's own limiter)",
2795 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2798 key: :app_account_creation,
2799 type: [:tuple, {:list, :tuple}],
2800 description: "For registering user accounts from the same IP address",
2801 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2804 key: :relations_actions,
2805 type: [:tuple, {:list, :tuple}],
2806 description: "For actions on relationships with all users (follow, unfollow)",
2807 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2810 key: :relation_id_action,
2811 label: "Relation ID action",
2812 type: [:tuple, {:list, :tuple}],
2813 description: "For actions on relation with a specific user (follow, unfollow)",
2814 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2817 key: :statuses_actions,
2818 type: [:tuple, {:list, :tuple}],
2820 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2821 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2824 key: :status_id_action,
2825 label: "Status ID action",
2826 type: [:tuple, {:list, :tuple}],
2828 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2829 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2832 key: :authentication,
2833 type: [:tuple, {:list, :tuple}],
2834 description: "For authentication create / password check / user existence check requests",
2835 suggestions: [{60_000, 15}]
2844 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2845 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2850 description: "Enables SSH"
2855 description: "Dir with SSH keys",
2856 suggestions: ["/some/path/ssh_keys"]
2861 description: "Handler module",
2862 suggestions: ["Pleroma.BBS.Handler"]
2867 description: "Port to connect",
2868 suggestions: [10_022]
2871 key: :password_authenticator,
2873 description: "Authenticator module",
2874 suggestions: ["Pleroma.BBS.Authenticator"]
2880 label: "Mime Types",
2882 description: "Mime Types settings",
2889 "application/xml" => ["xml"],
2890 "application/xrd+xml" => ["xrd+xml"],
2891 "application/jrd+json" => ["jrd+json"],
2892 "application/activity+json" => ["activity+json"],
2893 "application/ld+json" => ["activity+json"]
2898 key: "application/xml",
2899 type: {:list, :string},
2900 suggestions: ["xml"]
2903 key: "application/xrd+xml",
2904 type: {:list, :string},
2905 suggestions: ["xrd+xml"]
2908 key: "application/jrd+json",
2909 type: {:list, :string},
2910 suggestions: ["jrd+json"]
2913 key: "application/activity+json",
2914 type: {:list, :string},
2915 suggestions: ["activity+json"]
2918 key: "application/ld+json",
2919 type: {:list, :string},
2920 suggestions: ["activity+json"]
2930 description: "Pleroma chat settings",
2943 description: "HTTP settings",
2948 type: [:string, :tuple],
2949 description: "Proxy URL",
2950 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2953 key: :send_user_agent,
2958 type: [:string, :atom],
2960 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2961 suggestions: ["Pleroma", :default]
2966 description: "Adapter specific options",
2972 label: "SSL Options",
2973 description: "SSL options for HTTP adapter",
2977 type: {:list, :atom},
2978 description: "List of TLS version to use",
2979 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2990 label: "Markup Settings",
2994 key: :allow_inline_images,
2998 key: :allow_headings,
3011 type: {:list, :module},
3013 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3014 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3024 key: :deny_follow_blocked,
3031 key: :mrf_normalize_markup,
3033 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3034 label: "MRF Normalize Markup",
3035 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3041 suggestions: [Pleroma.HTML.Scrubber.Default]
3051 key: :restricted_nicknames,
3052 type: {:list, :string},
3071 "ostatus_subscribe",
3090 label: "CORS plug config",
3096 suggestions: [86_400]
3100 type: {:list, :string},
3101 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3105 type: {:list, :string},
3108 "X-RateLimit-Reset",
3109 "X-RateLimit-Limit",
3110 "X-RateLimit-Remaining",
3121 type: {:list, :string},
3122 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3128 key: Pleroma.Plugs.RemoteIp,
3131 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3132 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3138 description: "Enable/disable the plug. Default: disabled."
3142 type: {:list, :string},
3144 "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]`."
3148 type: {:list, :string},
3150 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3154 type: {:list, :string},
3156 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3162 key: :web_cache_ttl,
3163 label: "Web cache TTL",
3166 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3172 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3173 suggestions: [30_000, nil]
3176 key: :activity_pub_question,
3178 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3179 suggestions: [30_000]
3189 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3194 description: "Enables the rendering of static HTML. Default: disabled."
3202 description: "Configure feed rendering",
3207 description: "Configure title rendering",
3212 description: "Maximum number of characters before truncating title",
3218 description: "Replacement which will be used after truncating string",
3219 suggestions: ["..."]
3227 key: :mrf_object_age,
3229 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3230 label: "MRF Object Age",
3233 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3238 description: "Required age (in seconds) of a post before actions are taken.",
3239 suggestions: [172_800]
3243 type: {:list, :atom},
3245 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3246 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3247 "`:reject` rejects the message entirely",
3248 suggestions: [:delist, :strip_followers, :reject]
3256 description: "Custom Runtime Modules",
3261 description: "A path to custom Elixir modules (such as MRF policies)."
3269 description: "Settings for notifications streamer",
3274 description: "Number of workers to send notifications",
3278 key: :overflow_workers,
3280 description: "Maximum number of workers created if pool is empty",
3287 key: :connections_pool,
3289 description: "Advanced settings for `gun` connections pool",
3292 key: :connection_acquisition_wait,
3295 "Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries. Default: 250ms.",
3299 key: :connection_acquisition_retries,
3302 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3306 key: :max_connections,
3308 description: "Maximum number of connections in the pool. Default: 250 connections.",
3312 key: :await_up_timeout,
3314 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3318 key: :reclaim_multiplier,
3321 "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",
3330 description: "Advanced settings for `gun` workers pools",
3332 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3336 description: "Settings for #{pool_name} pool.",
3341 description: "Maximum number of concurrent requests in the pool.",
3348 "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",
3357 key: :hackney_pools,
3359 description: "Advanced settings for `hackney` connections pools",
3364 description: "Settings for federation pool.",
3367 key: :max_connections,
3369 description: "Number workers in the pool.",
3375 description: "Timeout while `hackney` will wait for response.",
3376 suggestions: [150_000]
3383 description: "Settings for media pool.",
3386 key: :max_connections,
3388 description: "Number workers in the pool.",
3394 description: "Timeout while `hackney` will wait for response.",
3395 suggestions: [150_000]
3402 description: "Settings for upload pool.",
3405 key: :max_connections,
3407 description: "Number workers in the pool.",
3413 description: "Timeout while `hackney` will wait for response.",
3414 suggestions: [300_000]
3422 key: :restrict_unauthenticated,
3425 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3430 description: "Settings for public and federated timelines.",
3435 description: "Disallow view public timeline."
3440 description: "Disallow view federated timeline."
3447 description: "Settings for user profiles.",
3452 description: "Disallow view local user profiles."
3457 description: "Disallow view remote user profiles."
3464 description: "Settings for statuses.",
3469 description: "Disallow view local statuses."
3474 description: "Disallow view remote statuses."
3482 key: Pleroma.Web.ApiSpec.CastAndValidate,
3489 "Enables strict input validation (useful in development, not recommended in production)"
3495 key: :instances_favicons,
3497 description: "Control favicons for instances",
3502 description: "Allow/disallow displaying and getting instances favicons"
3510 descriptions: "S3 service related settings",
3513 key: :access_key_id,
3515 description: "S3 access key ID",
3516 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3519 key: :secret_access_key,
3521 description: "Secret access key",
3522 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3527 description: "S3 host",
3528 suggestions: ["s3.eu-central-1.amazonaws.com"]
3536 description: "Installed frontends management",
3541 description: "Primary frontend, the one that is served for all pages by default",
3546 description: "Name of the installed primary frontend"
3551 description: "reference of the installed primary frontend to be used"