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>\"}` value will be parsed into valid 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,
954 type: {:string, :image},
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."
970 description: "Welcome messages settings",
973 key: :direct_message,
975 descpiption: "Direct message settings",
980 description: "Enables sending a direct message to newly registered users"
985 description: "A message that will be sent to newly registered users",
987 "Hi, @username! Welcome on board!"
991 key: :sender_nickname,
993 description: "The nickname of the local user that sends a welcome message",
1003 descpiption: "Chat message settings",
1008 description: "Enables sending a chat message to newly registered users"
1014 "A message that will be sent to newly registered users as a chat message",
1016 "Hello, welcome on board!"
1020 key: :sender_nickname,
1022 description: "The nickname of the local user that sends a welcome chat message",
1032 descpiption: "Email message settings",
1037 description: "Enables sending an email to newly registered users"
1041 type: [:string, :tuple],
1043 "Email address and/or nickname that will be used to send the welcome email.",
1045 {"Pleroma App", "welcome@pleroma.app"}
1052 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1053 suggestions: ["Welcome to <%= instance_name%>"]
1059 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1060 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1066 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
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"
1239 type: {:string, :image},
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, ...)"
1296 type: {:string, :image},
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",
1328 type: {:string, :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,
1454 type: {:string, :image},
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: :followers_only,
1576 type: {:list, :string},
1577 description: "Force posts from the given instances to be visible by followers only",
1578 suggestions: ["example.com", "*.example.com"]
1581 key: :report_removal,
1582 type: {:list, :string},
1583 description: "List of instances to reject reports from",
1584 suggestions: ["example.com", "*.example.com"]
1587 key: :avatar_removal,
1588 type: {:list, :string},
1589 description: "List of instances to strip avatars from",
1590 suggestions: ["example.com", "*.example.com"]
1593 key: :banner_removal,
1594 type: {:list, :string},
1595 description: "List of instances to strip banners from",
1596 suggestions: ["example.com", "*.example.com"]
1599 key: :reject_deletes,
1600 type: {:list, :string},
1601 description: "List of instances to reject deletions from",
1602 suggestions: ["example.com", "*.example.com"]
1608 key: :mrf_activity_expiration,
1610 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1611 label: "MRF Activity Expiration Policy",
1613 description: "Adds automatic expiration to all local activities",
1618 description: "Default global expiration time for all local activities (in days)",
1619 suggestions: [90, 365]
1627 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1628 label: "MRF Subchain",
1631 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1632 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1636 type: {:map, {:list, :string}},
1637 description: "Matches a series of regular expressions against the actor field",
1640 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1648 key: :mrf_rejectnonpublic,
1650 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1651 description: "RejectNonPublic drops posts with non-public visibility settings.",
1652 label: "MRF Reject Non Public",
1656 key: :allow_followersonly,
1657 label: "Allow followers-only",
1659 description: "Whether to allow followers-only posts"
1664 description: "Whether to allow direct messages"
1670 key: :mrf_hellthread,
1672 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1673 label: "MRF Hellthread",
1675 description: "Block messages with excessive user mentions",
1678 key: :delist_threshold,
1681 "Number of mentioned users after which the message gets removed from timelines and" <>
1682 "disables notifications. Set to 0 to disable.",
1686 key: :reject_threshold,
1689 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1698 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1699 label: "MRF Keyword",
1701 description: "Reject or Word-Replace messages with a keyword or regex",
1705 type: {:list, :string},
1707 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1708 suggestions: ["foo", ~r/foo/iu]
1711 key: :federated_timeline_removal,
1712 type: {:list, :string},
1714 "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.",
1715 suggestions: ["foo", ~r/foo/iu]
1719 type: {:list, :tuple},
1721 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1722 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1730 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1731 label: "MRF Mention",
1733 description: "Block messages which mention a specific user",
1737 type: {:list, :string},
1738 description: "A list of actors for which any post mentioning them will be dropped",
1739 suggestions: ["actor1", "actor2"]
1745 key: :mrf_vocabulary,
1747 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1748 label: "MRF Vocabulary",
1750 description: "Filter messages which belong to certain activity vocabularies",
1754 type: {:list, :string},
1756 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1757 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1761 type: {:list, :string},
1763 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1764 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1770 # key: :mrf_user_allowlist,
1772 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1775 # "The keys in this section are the domain names that the policy should apply to." <>
1776 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1778 # %{"example.org" => ["https://example.org/users/admin"]}
1786 description: "Media proxy",
1791 description: "Enables proxying of remote media to the instance's proxy"
1798 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1799 suggestions: ["https://example.com"]
1807 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1813 description: "Enables media cache object invalidation."
1818 description: "Module which will be used to purge objects from the cache.",
1820 Pleroma.Web.MediaProxy.Invalidation.Script,
1821 Pleroma.Web.MediaProxy.Invalidation.Http
1828 label: "Proxy Options",
1830 description: "Options for Pleroma.ReverseProxy",
1832 redirect_on_failure: false,
1833 max_body_length: 25 * 1_048_576,
1835 follow_redirect: true,
1841 key: :redirect_on_failure,
1844 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1845 "Any error during body processing will not be redirected as the response is chunked."
1848 key: :max_body_length,
1851 "Limits the content length to be approximately the " <>
1852 "specified length. It is validated with the `content-length` header and also verified when proxying."
1858 description: "HTTP options",
1863 description: "Adapter specific options",
1868 label: "SSL Options",
1869 description: "SSL options for HTTP adapter",
1873 type: {:list, :atom},
1874 description: "List of TLS version to use",
1875 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1884 type: [:string, :tuple],
1885 description: "Proxy URL",
1886 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1894 type: {:list, :string},
1895 description: "List of hosts with scheme to bypass the mediaproxy",
1896 suggestions: ["http://example.com"]
1902 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1904 description: "HTTP invalidate settings",
1909 description: "HTTP method of request. Default: :purge"
1913 type: {:keyword, :string},
1914 description: "HTTP headers of request",
1915 suggestions: [{"x-refresh", 1}]
1920 description: "Request options",
1924 type: {:map, :string}
1932 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1934 description: "Script invalidate settings",
1939 description: "Path to shell script. Which will run purge cache.",
1940 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1948 description: "Gopher settings",
1953 description: "Enables the gopher interface"
1959 description: "IP address to bind to",
1960 suggestions: [{0, 0, 0, 0}]
1965 description: "Port to bind to",
1971 description: "Port advertised in URLs (optional, defaults to port)",
1979 label: "ActivityPub",
1981 description: "ActivityPub-related settings",
1984 key: :unfollow_blocked,
1986 description: "Whether blocks result in people getting unfollowed"
1989 key: :outgoing_blocks,
1991 description: "Whether to federate blocks to other instances"
1994 key: :sign_object_fetches,
1996 description: "Sign object fetches with HTTP signatures"
1999 key: :note_replies_output_limit,
2002 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2005 key: :follow_handshake_timeout,
2007 description: "Following handshake timeout",
2014 key: :http_security,
2015 label: "HTTP security",
2017 description: "HTTP security settings",
2022 description: "Whether the managed content security policy is enabled"
2028 description: "Whether to additionally send a Strict-Transport-Security header"
2032 label: "STS max age",
2034 description: "The maximum age for the Strict-Transport-Security header if sent",
2035 suggestions: [31_536_000]
2039 label: "CT max age",
2041 description: "The maximum age for the Expect-CT header if sent",
2042 suggestions: [2_592_000]
2045 key: :referrer_policy,
2047 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2048 suggestions: ["same-origin", "no-referrer"]
2052 label: "Report URI",
2054 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2055 suggestions: ["https://example.com/report-uri"]
2060 group: :web_push_encryption,
2061 key: :vapid_details,
2062 label: "Vapid Details",
2065 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2071 "A mailto link for the administrative contact." <>
2072 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2073 suggestions: ["mailto:moderators@pleroma.com"]
2078 description: "VAPID public key",
2079 suggestions: ["Public key"]
2084 description: "VAPID private key",
2085 suggestions: ["Private key"]
2091 key: Pleroma.Captcha,
2093 description: "Captcha-related settings",
2098 description: "Whether the captcha should be shown on registration"
2103 description: "The method/service to use for captcha",
2104 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2107 key: :seconds_valid,
2109 description: "The time in seconds for which the captcha is valid",
2116 key: Pleroma.Captcha.Kocaptcha,
2119 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2120 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2125 description: "The kocaptcha endpoint to use",
2126 suggestions: ["https://captcha.kotobank.ch"]
2132 label: "Pleroma Admin Token",
2135 "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)",
2140 description: "Admin token",
2142 "Please use a high entropy string or UUID"
2152 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2154 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2155 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2156 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2157 (see https://github.com/sorentwo/oban/issues/52).
2162 type: {:dropdown, :atom},
2163 description: "Logs verbose mode",
2164 suggestions: [false, :error, :warn, :info, :debug]
2168 type: {:keyword, :integer},
2170 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2172 activity_expiration: 10,
2173 attachments_cleanup: 5,
2175 federator_incoming: 50,
2176 federator_outgoing: 50,
2178 scheduled_activities: 10,
2184 key: :activity_expiration,
2186 description: "Activity expiration queue",
2190 key: :attachments_cleanup,
2192 description: "Attachment deletion queue",
2198 description: "Background queue",
2202 key: :federator_incoming,
2204 description: "Incoming federation queue",
2208 key: :federator_outgoing,
2210 description: "Outgoing federation queue",
2216 description: "Email sender queue, see Pleroma.Emails.Mailer",
2220 key: :scheduled_activities,
2222 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2226 key: :transmogrifier,
2228 description: "Transmogrifier queue",
2234 description: "Web push notifications queue",
2241 type: {:list, :tuple},
2242 description: "Settings for cron background jobs",
2244 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2245 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2246 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2247 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2248 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2257 description: "Includes custom worker options not interpretable directly by `Oban`",
2261 type: {:keyword, :integer},
2262 description: "Max retry attempts for failed jobs, per `Oban` queue",
2264 federator_incoming: 5,
2265 federator_outgoing: 5
2272 key: Pleroma.Web.Metadata,
2274 description: "Metadata-related settings",
2278 type: {:list, :module},
2279 description: "List of metadata providers to enable",
2281 Pleroma.Web.Metadata.Providers.OpenGraph,
2282 Pleroma.Web.Metadata.Providers.TwitterCard,
2283 Pleroma.Web.Metadata.Providers.RelMe,
2284 Pleroma.Web.Metadata.Providers.Feed
2289 label: "Unfurl NSFW",
2291 description: "When enabled NSFW attachments will be shown in previews"
2300 "If enabled the instance will parse metadata from attached links to generate link previews",
2305 description: "Enables RichMedia parsing of URLs"
2309 type: {:list, :string},
2310 description: "List of hosts which will be ignored by the metadata parser",
2311 suggestions: ["accounts.google.com", "xss.website"]
2315 label: "Ignore TLD",
2316 type: {:list, :string},
2317 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2318 suggestions: ["local", "localdomain", "lan"]
2322 type: {:list, :module},
2324 "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.",
2326 Pleroma.Web.RichMedia.Parsers.OEmbed,
2327 Pleroma.Web.RichMedia.Parsers.TwitterCard
2332 label: "TTL setters",
2333 type: {:list, :module},
2335 "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.",
2337 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2344 key: Pleroma.Formatter,
2345 label: "Auto Linker",
2348 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2352 type: [:string, :boolean],
2353 description: "Specify the class to be added to the generated link. Disable to clear.",
2354 suggestions: ["auto-linker", false]
2358 type: [:string, :boolean],
2359 description: "Override the rel attribute. Disable to clear.",
2360 suggestions: ["ugc", "noopener noreferrer", false]
2365 description: "Link URLs will open in a new window/tab."
2369 type: [:integer, :boolean],
2371 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2372 suggestions: [15, false]
2377 description: "Strip the scheme prefix."
2382 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2386 type: [:atom, :boolean],
2388 "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)",
2389 suggestions: [:no_scheme, true]
2395 key: Pleroma.ScheduledActivity,
2397 description: "Scheduled activities settings",
2400 key: :daily_user_limit,
2403 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2407 key: :total_user_limit,
2410 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2416 description: "Whether scheduled activities are sent to the job queue to be executed"
2422 key: Pleroma.ActivityExpiration,
2424 description: "Expired activity settings",
2429 description: "Whether expired activities will be sent to the job queue to be deleted"
2435 label: "Pleroma Authenticator",
2437 description: "Authenticator",
2440 key: Pleroma.Web.Auth.Authenticator,
2442 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2452 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2453 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2454 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2455 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2460 description: "Enables LDAP authentication"
2465 description: "LDAP server hostname",
2466 suggestions: ["localhosts"]
2471 description: "LDAP port, e.g. 389 or 636",
2472 suggestions: [389, 636]
2478 description: "Enable to use SSL, usually implies the port 636"
2482 label: "SSL options",
2484 description: "Additional SSL options",
2485 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2490 description: "Path to file with PEM encoded cacerts",
2491 suggestions: ["path/to/file/with/PEM/cacerts"]
2496 description: "Type of cert verification",
2497 suggestions: [:verify_peer]
2505 description: "Enable to use STARTTLS, usually implies the port 389"
2509 label: "TLS options",
2511 description: "Additional TLS options",
2512 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2517 description: "Path to file with PEM encoded cacerts",
2518 suggestions: ["path/to/file/with/PEM/cacerts"]
2523 description: "Type of cert verification",
2524 suggestions: [:verify_peer]
2531 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2532 suggestions: ["dc=example,dc=com"]
2539 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2548 description: "Authentication / authorization settings",
2551 key: :enforce_oauth_admin_scope_usage,
2552 label: "Enforce OAuth admin scope usage",
2555 "OAuth admin scope requirement toggle. " <>
2556 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2557 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2558 "`is_admin` user flag grants access to admin-specific actions."
2561 key: :auth_template,
2564 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2565 suggestions: ["show.html"]
2568 key: :oauth_consumer_template,
2569 label: "OAuth consumer template",
2572 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2573 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2574 suggestions: ["consumer.html"]
2577 key: :oauth_consumer_strategies,
2578 label: "OAuth consumer strategies",
2579 type: {:list, :string},
2581 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2582 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2583 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2584 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2590 key: :email_notifications,
2592 description: "Email notifications settings",
2598 "emails of \"what you've missed\" for users who have been inactive for a while",
2602 schedule: "0 0 * * 0",
2604 inactivity_threshold: 7
2612 description: "Globally enable or disable digest emails"
2618 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2619 suggestions: ["0 0 * * 0"]
2624 description: "Minimum interval between digest emails to one user",
2628 key: :inactivity_threshold,
2630 description: "Minimum user inactivity threshold",
2639 key: Pleroma.Emails.UserEmail,
2641 description: "Email template settings",
2645 type: {:string, :image},
2646 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2647 suggestions: ["some/path/logo.png"]
2652 description: "A map with color settings for email templates.",
2655 link_color: "#d8a070",
2656 background_color: "#2C3645",
2657 content_background_color: "#1B2635",
2658 header_color: "#d8a070",
2659 text_color: "#b9b9ba",
2660 text_muted_color: "#b9b9ba"
2667 suggestions: ["#d8a070"]
2670 key: :background_color,
2672 suggestions: ["#2C3645"]
2675 key: :content_background_color,
2677 suggestions: ["#1B2635"]
2682 suggestions: ["#d8a070"]
2687 suggestions: ["#b9b9ba"]
2690 key: :text_muted_color,
2692 suggestions: ["#b9b9ba"]
2700 key: Pleroma.Emails.NewUsersDigestEmail,
2702 description: "New users admin email digest",
2707 description: "Enables new users admin digest email when `true`"
2716 description: "Configure OAuth 2 provider capabilities",
2719 key: :token_expires_in,
2721 description: "The lifetime in seconds of the access token",
2725 key: :issue_new_refresh_token,
2728 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2731 key: :clean_expired_tokens,
2733 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2743 key: :shortcode_globs,
2744 type: {:list, :string},
2745 description: "Location of custom emoji files. * can be used as a wildcard.",
2746 suggestions: ["/emoji/custom/**/*.png"]
2749 key: :pack_extensions,
2750 type: {:list, :string},
2752 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2753 suggestions: [".png", ".gif"]
2757 type: {:keyword, {:list, :string}},
2759 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2760 " and the value is the location or array of locations. * can be used as a wildcard.",
2762 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2766 key: :default_manifest,
2769 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2770 " Currently only one manifest can be added (no arrays).",
2771 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2774 key: :shared_pack_cache_seconds_per_file,
2775 label: "Shared pack cache s/file",
2778 "When an emoji pack is shared, the archive is created and cached in memory" <>
2779 " for this amount of seconds multiplied by the number of files.",
2789 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2793 type: [:tuple, {:list, :tuple}],
2794 description: "For the search requests (account & status search etc.)",
2795 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2799 type: [:tuple, {:list, :tuple}],
2800 description: "For requests to timelines (each timeline has it's own limiter)",
2801 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2804 key: :app_account_creation,
2805 type: [:tuple, {:list, :tuple}],
2806 description: "For registering user accounts from the same IP address",
2807 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2810 key: :relations_actions,
2811 type: [:tuple, {:list, :tuple}],
2812 description: "For actions on relationships with all users (follow, unfollow)",
2813 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2816 key: :relation_id_action,
2817 label: "Relation ID action",
2818 type: [:tuple, {:list, :tuple}],
2819 description: "For actions on relation with a specific user (follow, unfollow)",
2820 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2823 key: :statuses_actions,
2824 type: [:tuple, {:list, :tuple}],
2826 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2827 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2830 key: :status_id_action,
2831 label: "Status ID action",
2832 type: [:tuple, {:list, :tuple}],
2834 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2835 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2838 key: :authentication,
2839 type: [:tuple, {:list, :tuple}],
2840 description: "For authentication create / password check / user existence check requests",
2841 suggestions: [{60_000, 15}]
2850 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2851 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2856 description: "Enables SSH"
2861 description: "Dir with SSH keys",
2862 suggestions: ["/some/path/ssh_keys"]
2867 description: "Handler module",
2868 suggestions: ["Pleroma.BBS.Handler"]
2873 description: "Port to connect",
2874 suggestions: [10_022]
2877 key: :password_authenticator,
2879 description: "Authenticator module",
2880 suggestions: ["Pleroma.BBS.Authenticator"]
2886 label: "Mime Types",
2888 description: "Mime Types settings",
2895 "application/xml" => ["xml"],
2896 "application/xrd+xml" => ["xrd+xml"],
2897 "application/jrd+json" => ["jrd+json"],
2898 "application/activity+json" => ["activity+json"],
2899 "application/ld+json" => ["activity+json"]
2904 key: "application/xml",
2905 type: {:list, :string},
2906 suggestions: ["xml"]
2909 key: "application/xrd+xml",
2910 type: {:list, :string},
2911 suggestions: ["xrd+xml"]
2914 key: "application/jrd+json",
2915 type: {:list, :string},
2916 suggestions: ["jrd+json"]
2919 key: "application/activity+json",
2920 type: {:list, :string},
2921 suggestions: ["activity+json"]
2924 key: "application/ld+json",
2925 type: {:list, :string},
2926 suggestions: ["activity+json"]
2936 description: "Pleroma chat settings",
2949 description: "HTTP settings",
2954 type: [:string, :tuple],
2955 description: "Proxy URL",
2956 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2959 key: :send_user_agent,
2964 type: [:string, :atom],
2966 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2967 suggestions: ["Pleroma", :default]
2972 description: "Adapter specific options",
2978 label: "SSL Options",
2979 description: "SSL options for HTTP adapter",
2983 type: {:list, :atom},
2984 description: "List of TLS version to use",
2985 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2996 label: "Markup Settings",
3000 key: :allow_inline_images,
3004 key: :allow_headings,
3017 type: {:list, :module},
3019 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3020 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3030 key: :deny_follow_blocked,
3037 key: :mrf_normalize_markup,
3039 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3040 label: "MRF Normalize Markup",
3041 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3047 suggestions: [Pleroma.HTML.Scrubber.Default]
3057 key: :restricted_nicknames,
3058 type: {:list, :string},
3059 description: "List of nicknames users may not register with.",
3078 "ostatus_subscribe",
3094 key: :email_blacklist,
3095 type: {:list, :string},
3096 description: "List of email domains users may not register with.",
3097 suggestions: ["mailinator.com", "maildrop.cc"]
3103 label: "CORS plug config",
3109 suggestions: [86_400]
3113 type: {:list, :string},
3114 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3118 type: {:list, :string},
3121 "X-RateLimit-Reset",
3122 "X-RateLimit-Limit",
3123 "X-RateLimit-Remaining",
3134 type: {:list, :string},
3135 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3141 key: Pleroma.Plugs.RemoteIp,
3144 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3145 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3151 description: "Enable/disable the plug. Default: disabled."
3155 type: {:list, :string},
3157 "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]`."
3161 type: {:list, :string},
3163 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3167 type: {:list, :string},
3169 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3175 key: :web_cache_ttl,
3176 label: "Web cache TTL",
3179 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3185 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3186 suggestions: [30_000, nil]
3189 key: :activity_pub_question,
3191 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3192 suggestions: [30_000]
3202 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3207 description: "Enables the rendering of static HTML. Default: disabled."
3215 description: "Configure feed rendering",
3220 description: "Configure title rendering",
3225 description: "Maximum number of characters before truncating title",
3231 description: "Replacement which will be used after truncating string",
3232 suggestions: ["..."]
3240 key: :mrf_object_age,
3242 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3243 label: "MRF Object Age",
3246 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3251 description: "Required age (in seconds) of a post before actions are taken.",
3252 suggestions: [172_800]
3256 type: {:list, :atom},
3258 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3259 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3260 "`:reject` rejects the message entirely",
3261 suggestions: [:delist, :strip_followers, :reject]
3269 description: "Custom Runtime Modules",
3274 description: "A path to custom Elixir modules (such as MRF policies)."
3282 description: "Settings for notifications streamer",
3287 description: "Number of workers to send notifications",
3291 key: :overflow_workers,
3293 description: "Maximum number of workers created if pool is empty",
3300 key: :connections_pool,
3302 description: "Advanced settings for `Gun` connections pool",
3305 key: :connection_acquisition_wait,
3308 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3312 key: :connection_acquisition_retries,
3315 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3319 key: :max_connections,
3321 description: "Maximum number of connections in the pool. Default: 250 connections.",
3325 key: :await_up_timeout,
3327 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3331 key: :reclaim_multiplier,
3334 "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",
3343 description: "Advanced settings for `Gun` workers pools",
3345 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3349 description: "Settings for #{pool_name} pool.",
3354 description: "Maximum number of concurrent requests in the pool.",
3361 "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",
3370 key: :hackney_pools,
3372 description: "Advanced settings for `Hackney` connections pools",
3377 description: "Settings for federation pool.",
3380 key: :max_connections,
3382 description: "Number workers in the pool.",
3388 description: "Timeout while `hackney` will wait for response.",
3389 suggestions: [150_000]
3396 description: "Settings for media pool.",
3399 key: :max_connections,
3401 description: "Number workers in the pool.",
3407 description: "Timeout while `hackney` will wait for response.",
3408 suggestions: [150_000]
3415 description: "Settings for upload pool.",
3418 key: :max_connections,
3420 description: "Number workers in the pool.",
3426 description: "Timeout while `hackney` will wait for response.",
3427 suggestions: [300_000]
3435 key: :restrict_unauthenticated,
3436 label: "Restrict Unauthenticated",
3439 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3444 description: "Settings for public and federated timelines.",
3449 description: "Disallow view public timeline."
3454 description: "Disallow view federated timeline."
3461 description: "Settings for user profiles.",
3466 description: "Disallow view local user profiles."
3471 description: "Disallow view remote user profiles."
3478 description: "Settings for statuses.",
3483 description: "Disallow view local statuses."
3488 description: "Disallow view remote statuses."
3496 key: Pleroma.Web.ApiSpec.CastAndValidate,
3503 "Enables strict input validation (useful in development, not recommended in production)"
3509 key: :instances_favicons,
3511 description: "Control favicons for instances",
3516 description: "Allow/disallow displaying and getting instances favicons"
3524 descriptions: "S3 service related settings",
3527 key: :access_key_id,
3529 description: "S3 access key ID",
3530 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3533 key: :secret_access_key,
3535 description: "Secret access key",
3536 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3541 description: "S3 host",
3542 suggestions: ["s3.eu-central-1.amazonaws.com"]
3550 description: "Installed frontends management",
3555 description: "Primary frontend, the one that is served for all pages by default",
3562 "Name of the installed primary frontend. Valid config must include both `Name` and `Reference` values."
3569 "Reference of the installed primary frontend to be used. Valid config must include both `Name` and `Reference` values."