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,
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"
986 "A message that will be sent to newly registered users",
988 "Hi, @username! Welcome on board!"
992 key: :sender_nickname,
994 description: "The nickname of the local user that sends a welcome message",
1004 descpiption: "Chat message settings",
1009 description: "Enables sending a chat message to newly registered users"
1015 "A message that will be sent to newly registered users as a chat message",
1017 "Hello, welcome on board!"
1021 key: :sender_nickname,
1023 description: "The nickname of the local user that sends a welcome chat message",
1033 descpiption: "Email message settings",
1038 description: "Enables sending an email to newly registered users"
1042 type: [:string, :tuple],
1044 "Email address and/or nickname that will be used to send the welcome email.",
1046 {"Pleroma App", "welcome@pleroma.app"}
1053 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1054 suggestions: ["Welcome to <%= instance_name%>"]
1060 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1061 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1067 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1068 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1077 description: "Logger-related settings",
1081 type: [:atom, :tuple, :module],
1083 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1084 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1092 label: "ExSyslogger",
1093 description: "ExSyslogger-related settings",
1097 type: {:dropdown, :atom},
1098 description: "Log level",
1099 suggestions: [:debug, :info, :warn, :error]
1105 "A string that's prepended to every message, and is typically set to the app name",
1106 suggestions: ["pleroma"]
1111 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1112 suggestions: ["$metadata[$level] $message"]
1116 type: {:list, :atom},
1117 suggestions: [:request_id]
1125 label: "Console Logger",
1126 description: "Console logger settings",
1130 type: {:dropdown, :atom},
1131 description: "Log level",
1132 suggestions: [:debug, :info, :warn, :error]
1137 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1138 suggestions: ["$metadata[$level] $message"]
1142 type: {:list, :atom},
1143 suggestions: [:request_id]
1150 label: "Quack Logger",
1151 description: "Quack-related settings",
1155 type: {:dropdown, :atom},
1156 description: "Log level",
1157 suggestions: [:debug, :info, :warn, :error]
1161 type: {:list, :atom},
1162 description: "Configure which metadata you want to report on",
1179 label: "Webhook URL",
1181 description: "Configure the Slack incoming webhook",
1182 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1188 key: :frontend_configurations,
1191 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1192 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1193 "add your own configuration your settings all fields must be complete.",
1197 label: "Pleroma FE",
1199 description: "Settings for Pleroma FE",
1202 alwaysShowSubjectInput: true,
1203 background: "/static/aurora_borealis.jpg",
1204 collapseMessageWithSubject: false,
1207 hideFilteredStatuses: false,
1208 hideMutedPosts: false,
1209 hidePostStats: false,
1210 hideSitename: false,
1211 hideUserStats: false,
1212 loginMethod: "password",
1213 logo: "/static/logo.png",
1216 minimalScopesMode: false,
1217 noAttachmentLinks: false,
1218 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1219 postContentType: "text/plain",
1220 redirectRootLogin: "/main/friends",
1221 redirectRootNoLogin: "/main/all",
1223 sidebarRight: false,
1224 showFeaturesPanel: true,
1225 showInstanceSpecificPanel: false,
1226 subjectLineBehavior: "email",
1227 theme: "pleroma-dark",
1228 webPushNotifications: false
1233 key: :alwaysShowSubjectInput,
1234 label: "Always show subject input",
1236 description: "When disabled, auto-hide the subject field if it's empty"
1242 "URL of the background, unless viewing a user profile with a background that is set",
1243 suggestions: ["/images/city.jpg"]
1246 key: :collapseMessageWithSubject,
1247 label: "Collapse message with subject",
1250 "When a message has a subject (aka Content Warning), collapse it by default"
1254 label: "PleromaFE Chat",
1256 description: "Disables PleromaFE Chat component"
1262 description: "Enables green text on lines prefixed with the > character"
1265 key: :hideFilteredStatuses,
1266 label: "Hide Filtered Statuses",
1268 description: "Hides filtered statuses from timelines"
1271 key: :hideMutedPosts,
1272 label: "Hide Muted Posts",
1274 description: "Hides muted statuses from timelines"
1277 key: :hidePostStats,
1278 label: "Hide post stats",
1280 description: "Hide notices statistics (repeats, favorites, ...)"
1284 label: "Hide Sitename",
1286 description: "Hides instance name from PleromaFE banner"
1289 key: :hideUserStats,
1290 label: "Hide user stats",
1293 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1298 description: "URL of the logo, defaults to Pleroma's logo",
1299 suggestions: ["/static/logo.png"]
1303 label: "Logo margin",
1306 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1307 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1308 suggestions: [".1em"]
1315 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1316 "If you want a colorful logo you must disable logoMask."
1319 key: :minimalScopesMode,
1320 label: "Minimal scopes mode",
1323 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1324 "Also prevents replying to a DM with a public post from PleromaFE."
1327 key: :nsfwCensorImage,
1328 label: "NSFW Censor Image",
1331 "URL of the image to use for hiding NSFW media attachments in the timeline",
1332 suggestions: ["/static/img/nsfw.74818f9.png"]
1335 key: :postContentType,
1336 label: "Post Content Type",
1337 type: {:dropdown, :atom},
1338 description: "Default post formatting option",
1339 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1342 key: :redirectRootNoLogin,
1343 label: "Redirect root no login",
1346 "Relative URL which indicates where to redirect when a user isn't logged in",
1347 suggestions: ["/main/all"]
1350 key: :redirectRootLogin,
1351 label: "Redirect root login",
1354 "Relative URL which indicates where to redirect when a user is logged in",
1355 suggestions: ["/main/friends"]
1359 label: "Scope copy",
1361 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1365 label: "Sidebar on Right",
1367 description: "Change alignment of sidebar and panels to the right"
1370 key: :showFeaturesPanel,
1371 label: "Show instance features panel",
1374 "Enables panel displaying functionality of the instance on the About page"
1377 key: :showInstanceSpecificPanel,
1378 label: "Show instance specific panel",
1380 description: "Whether to show the instance's custom panel"
1383 key: :subjectLineBehavior,
1384 label: "Subject line behavior",
1386 description: "Allows changing the default behaviour of subject lines in replies.
1387 `email`: copy and preprend re:, as in email,
1388 `masto`: copy verbatim, as in Mastodon,
1389 `noop`: don't copy the subject.",
1390 suggestions: ["email", "masto", "noop"]
1395 description: "Which theme to use. Available themes are defined in styles.json",
1396 suggestions: ["pleroma-dark"]
1404 description: "Settings for Masto FE",
1407 showInstanceSpecificPanel: true
1412 key: :showInstanceSpecificPanel,
1413 label: "Show instance specific panel",
1415 description: "Whenether to show the instance's specific panel"
1426 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1430 type: {:keyword, :map},
1432 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1435 url: "/images/pleroma-fox-tan-smol.png",
1436 mime_type: "image/png"
1438 pleroma_fox_tan_shy: %{
1439 url: "/images/pleroma-fox-tan-shy.png",
1440 mime_type: "image/png"
1445 key: :default_mascot,
1448 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1454 key: :default_user_avatar,
1456 description: "URL of the default user avatar",
1457 suggestions: ["/images/avi.png"]
1466 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1470 type: {:list, :map},
1471 description: "Describe the icons of the app",
1474 src: "/static/logo.png"
1477 src: "/static/icon.png",
1481 src: "/static/icon.ico",
1482 sizes: "72x72 96x96 128x128 256x256"
1489 description: "Describe the theme color of the app",
1490 suggestions: ["#282c37", "mediumpurple"]
1493 key: :background_color,
1495 description: "Describe the background color of the app",
1496 suggestions: ["#191b22", "aliceblue"]
1506 description: "General MRF settings",
1510 type: [:module, {:list, :module}],
1512 "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.",
1513 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1517 label: "MRF transparency",
1520 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1523 key: :transparency_exclusions,
1524 label: "MRF transparency exclusions",
1525 type: {:list, :string},
1527 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1538 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1539 label: "MRF Simple",
1541 description: "Simple ingress policies",
1544 key: :media_removal,
1545 type: {:list, :string},
1546 description: "List of instances to strip media attachments from",
1547 suggestions: ["example.com", "*.example.com"]
1551 label: "Media NSFW",
1552 type: {:list, :string},
1553 description: "List of instances to tag all media as NSFW (sensitive) from",
1554 suggestions: ["example.com", "*.example.com"]
1557 key: :federated_timeline_removal,
1558 type: {:list, :string},
1560 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1561 suggestions: ["example.com", "*.example.com"]
1565 type: {:list, :string},
1566 description: "List of instances to reject activities from (except deletes)",
1567 suggestions: ["example.com", "*.example.com"]
1571 type: {:list, :string},
1572 description: "List of instances to only accept activities from (except deletes)",
1573 suggestions: ["example.com", "*.example.com"]
1576 key: :followers_only,
1577 type: {:list, :string},
1578 description: "Force posts from the given instances to be visible by followers only",
1579 suggestions: ["example.com", "*.example.com"]
1582 key: :report_removal,
1583 type: {:list, :string},
1584 description: "List of instances to reject reports from",
1585 suggestions: ["example.com", "*.example.com"]
1588 key: :avatar_removal,
1589 type: {:list, :string},
1590 description: "List of instances to strip avatars from",
1591 suggestions: ["example.com", "*.example.com"]
1594 key: :banner_removal,
1595 type: {:list, :string},
1596 description: "List of instances to strip banners from",
1597 suggestions: ["example.com", "*.example.com"]
1600 key: :reject_deletes,
1601 type: {:list, :string},
1602 description: "List of instances to reject deletions from",
1603 suggestions: ["example.com", "*.example.com"]
1609 key: :mrf_activity_expiration,
1611 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1612 label: "MRF Activity Expiration Policy",
1614 description: "Adds automatic expiration to all local activities",
1619 description: "Default global expiration time for all local activities (in days)",
1620 suggestions: [90, 365]
1628 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1629 label: "MRF Subchain",
1632 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1633 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1637 type: {:map, {:list, :string}},
1638 description: "Matches a series of regular expressions against the actor field",
1641 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1649 key: :mrf_rejectnonpublic,
1651 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1652 description: "RejectNonPublic drops posts with non-public visibility settings.",
1653 label: "MRF Reject Non Public",
1657 key: :allow_followersonly,
1658 label: "Allow followers-only",
1660 description: "Whether to allow followers-only posts"
1665 description: "Whether to allow direct messages"
1671 key: :mrf_hellthread,
1673 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1674 label: "MRF Hellthread",
1676 description: "Block messages with excessive user mentions",
1679 key: :delist_threshold,
1682 "Number of mentioned users after which the message gets removed from timelines and" <>
1683 "disables notifications. Set to 0 to disable.",
1687 key: :reject_threshold,
1690 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1699 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1700 label: "MRF Keyword",
1702 description: "Reject or Word-Replace messages with a keyword or regex",
1706 type: {:list, :string},
1708 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1709 suggestions: ["foo", ~r/foo/iu]
1712 key: :federated_timeline_removal,
1713 type: {:list, :string},
1715 "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.",
1716 suggestions: ["foo", ~r/foo/iu]
1720 type: {:list, :tuple},
1722 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1723 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1731 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1732 label: "MRF Mention",
1734 description: "Block messages which mention a specific user",
1738 type: {:list, :string},
1739 description: "A list of actors for which any post mentioning them will be dropped",
1740 suggestions: ["actor1", "actor2"]
1746 key: :mrf_vocabulary,
1748 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1749 label: "MRF Vocabulary",
1751 description: "Filter messages which belong to certain activity vocabularies",
1755 type: {:list, :string},
1757 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1758 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1762 type: {:list, :string},
1764 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1765 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1771 # key: :mrf_user_allowlist,
1773 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1776 # "The keys in this section are the domain names that the policy should apply to." <>
1777 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1779 # %{"example.org" => ["https://example.org/users/admin"]}
1787 description: "Media proxy",
1792 description: "Enables proxying of remote media to the instance's proxy"
1799 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1800 suggestions: ["https://example.com"]
1808 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1814 description: "Enables invalidate media cache"
1819 description: "Module which will be used to cache purge.",
1821 Pleroma.Web.MediaProxy.Invalidation.Script,
1822 Pleroma.Web.MediaProxy.Invalidation.Http
1829 label: "Proxy Options",
1831 description: "Options for Pleroma.ReverseProxy",
1833 redirect_on_failure: false,
1834 max_body_length: 25 * 1_048_576,
1836 follow_redirect: true,
1842 key: :redirect_on_failure,
1845 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1846 "Any error during body processing will not be redirected as the response is chunked."
1849 key: :max_body_length,
1852 "Limits the content length to be approximately the " <>
1853 "specified length. It is validated with the `content-length` header and also verified when proxying."
1859 description: "HTTP options",
1864 description: "Adapter specific options",
1869 label: "SSL Options",
1870 description: "SSL options for HTTP adapter",
1874 type: {:list, :atom},
1875 description: "List of TLS version to use",
1876 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1885 type: [:string, :tuple],
1886 description: "Proxy URL",
1887 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1895 type: {:list, :string},
1896 description: "List of hosts with scheme to bypass the mediaproxy",
1897 suggestions: ["http://example.com"]
1903 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1905 description: "HTTP invalidate settings",
1910 description: "HTTP method of request. Default: :purge"
1914 type: {:keyword, :string},
1915 description: "HTTP headers of request",
1916 suggestions: [{"x-refresh", 1}]
1921 description: "Request options",
1925 type: {:map, :string}
1933 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1935 description: "Script invalidate settings",
1940 description: "Path to shell script. Which will run purge cache.",
1941 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1949 description: "Gopher settings",
1954 description: "Enables the gopher interface"
1960 description: "IP address to bind to",
1961 suggestions: [{0, 0, 0, 0}]
1966 description: "Port to bind to",
1972 description: "Port advertised in URLs (optional, defaults to port)",
1980 label: "ActivityPub",
1982 description: "ActivityPub-related settings",
1985 key: :unfollow_blocked,
1987 description: "Whether blocks result in people getting unfollowed"
1990 key: :outgoing_blocks,
1992 description: "Whether to federate blocks to other instances"
1995 key: :sign_object_fetches,
1997 description: "Sign object fetches with HTTP signatures"
2000 key: :note_replies_output_limit,
2003 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2006 key: :follow_handshake_timeout,
2008 description: "Following handshake timeout",
2015 key: :http_security,
2016 label: "HTTP security",
2018 description: "HTTP security settings",
2023 description: "Whether the managed content security policy is enabled"
2029 description: "Whether to additionally send a Strict-Transport-Security header"
2033 label: "STS max age",
2035 description: "The maximum age for the Strict-Transport-Security header if sent",
2036 suggestions: [31_536_000]
2040 label: "CT max age",
2042 description: "The maximum age for the Expect-CT header if sent",
2043 suggestions: [2_592_000]
2046 key: :referrer_policy,
2048 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2049 suggestions: ["same-origin", "no-referrer"]
2053 label: "Report URI",
2055 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2056 suggestions: ["https://example.com/report-uri"]
2061 group: :web_push_encryption,
2062 key: :vapid_details,
2063 label: "Vapid Details",
2066 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2072 "A mailto link for the administrative contact." <>
2073 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2074 suggestions: ["mailto:moderators@pleroma.com"]
2079 description: "VAPID public key",
2080 suggestions: ["Public key"]
2085 description: "VAPID private key",
2086 suggestions: ["Private key"]
2092 key: Pleroma.Captcha,
2094 description: "Captcha-related settings",
2099 description: "Whether the captcha should be shown on registration"
2104 description: "The method/service to use for captcha",
2105 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2108 key: :seconds_valid,
2110 description: "The time in seconds for which the captcha is valid",
2117 key: Pleroma.Captcha.Kocaptcha,
2120 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2121 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2126 description: "The kocaptcha endpoint to use",
2127 suggestions: ["https://captcha.kotobank.ch"]
2133 label: "Pleroma Admin Token",
2136 "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)",
2141 description: "Admin token",
2143 "Please use a high entropy string or UUID"
2153 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2155 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2156 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2157 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2158 (see https://github.com/sorentwo/oban/issues/52).
2163 type: {:dropdown, :atom},
2164 description: "Logs verbose mode",
2165 suggestions: [false, :error, :warn, :info, :debug]
2169 type: {:keyword, :integer},
2171 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2173 activity_expiration: 10,
2174 attachments_cleanup: 5,
2176 federator_incoming: 50,
2177 federator_outgoing: 50,
2179 scheduled_activities: 10,
2185 key: :activity_expiration,
2187 description: "Activity expiration queue",
2191 key: :attachments_cleanup,
2193 description: "Attachment deletion queue",
2199 description: "Background queue",
2203 key: :federator_incoming,
2205 description: "Incoming federation queue",
2209 key: :federator_outgoing,
2211 description: "Outgoing federation queue",
2217 description: "Email sender queue, see Pleroma.Emails.Mailer",
2221 key: :scheduled_activities,
2223 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2227 key: :transmogrifier,
2229 description: "Transmogrifier queue",
2235 description: "Web push notifications queue",
2242 type: {:list, :tuple},
2243 description: "Settings for cron background jobs",
2245 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2246 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2247 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2248 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2249 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2258 description: "Includes custom worker options not interpretable directly by `Oban`",
2262 type: {:keyword, :integer},
2263 description: "Max retry attempts for failed jobs, per `Oban` queue",
2265 federator_incoming: 5,
2266 federator_outgoing: 5
2273 key: Pleroma.Web.Metadata,
2275 description: "Metadata-related settings",
2279 type: {:list, :module},
2280 description: "List of metadata providers to enable",
2282 Pleroma.Web.Metadata.Providers.OpenGraph,
2283 Pleroma.Web.Metadata.Providers.TwitterCard,
2284 Pleroma.Web.Metadata.Providers.RelMe,
2285 Pleroma.Web.Metadata.Providers.Feed
2290 label: "Unfurl NSFW",
2292 description: "When enabled NSFW attachments will be shown in previews"
2301 "If enabled the instance will parse metadata from attached links to generate link previews",
2306 description: "Enables RichMedia parsing of URLs"
2310 type: {:list, :string},
2311 description: "List of hosts which will be ignored by the metadata parser",
2312 suggestions: ["accounts.google.com", "xss.website"]
2316 label: "Ignore TLD",
2317 type: {:list, :string},
2318 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2319 suggestions: ["local", "localdomain", "lan"]
2323 type: {:list, :module},
2325 "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.",
2327 Pleroma.Web.RichMedia.Parsers.OEmbed,
2328 Pleroma.Web.RichMedia.Parsers.TwitterCard
2333 label: "TTL setters",
2334 type: {:list, :module},
2336 "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.",
2338 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2345 key: Pleroma.Formatter,
2346 label: "Auto Linker",
2349 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2353 type: [:string, :boolean],
2354 description: "Specify the class to be added to the generated link. Disable to clear.",
2355 suggestions: ["auto-linker", false]
2359 type: [:string, :boolean],
2360 description: "Override the rel attribute. Disable to clear.",
2361 suggestions: ["ugc", "noopener noreferrer", false]
2366 description: "Link URLs will open in a new window/tab."
2370 type: [:integer, :boolean],
2372 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2373 suggestions: [15, false]
2378 description: "Strip the scheme prefix."
2383 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2387 type: [:atom, :boolean],
2389 "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)",
2390 suggestions: [:no_scheme, true]
2396 key: Pleroma.ScheduledActivity,
2398 description: "Scheduled activities settings",
2401 key: :daily_user_limit,
2404 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2408 key: :total_user_limit,
2411 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2417 description: "Whether scheduled activities are sent to the job queue to be executed"
2423 key: Pleroma.ActivityExpiration,
2425 description: "Expired activity settings",
2430 description: "Whether expired activities will be sent to the job queue to be deleted"
2436 label: "Pleroma Authenticator",
2438 description: "Authenticator",
2441 key: Pleroma.Web.Auth.Authenticator,
2443 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2453 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2454 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2455 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2456 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2461 description: "Enables LDAP authentication"
2466 description: "LDAP server hostname",
2467 suggestions: ["localhosts"]
2472 description: "LDAP port, e.g. 389 or 636",
2473 suggestions: [389, 636]
2479 description: "Enable to use SSL, usually implies the port 636"
2483 label: "SSL options",
2485 description: "Additional SSL options",
2486 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2491 description: "Path to file with PEM encoded cacerts",
2492 suggestions: ["path/to/file/with/PEM/cacerts"]
2497 description: "Type of cert verification",
2498 suggestions: [:verify_peer]
2506 description: "Enable to use STARTTLS, usually implies the port 389"
2510 label: "TLS options",
2512 description: "Additional TLS options",
2513 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2518 description: "Path to file with PEM encoded cacerts",
2519 suggestions: ["path/to/file/with/PEM/cacerts"]
2524 description: "Type of cert verification",
2525 suggestions: [:verify_peer]
2532 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2533 suggestions: ["dc=example,dc=com"]
2540 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2549 description: "Authentication / authorization settings",
2552 key: :enforce_oauth_admin_scope_usage,
2553 label: "Enforce OAuth admin scope usage",
2556 "OAuth admin scope requirement toggle. " <>
2557 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2558 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2559 "`is_admin` user flag grants access to admin-specific actions."
2562 key: :auth_template,
2565 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2566 suggestions: ["show.html"]
2569 key: :oauth_consumer_template,
2570 label: "OAuth consumer template",
2573 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2574 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2575 suggestions: ["consumer.html"]
2578 key: :oauth_consumer_strategies,
2579 label: "OAuth consumer strategies",
2580 type: {:list, :string},
2582 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2583 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2584 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2585 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2591 key: :email_notifications,
2593 description: "Email notifications settings",
2599 "emails of \"what you've missed\" for users who have been inactive for a while",
2603 schedule: "0 0 * * 0",
2605 inactivity_threshold: 7
2613 description: "Globally enable or disable digest emails"
2619 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2620 suggestions: ["0 0 * * 0"]
2625 description: "Minimum interval between digest emails to one user",
2629 key: :inactivity_threshold,
2631 description: "Minimum user inactivity threshold",
2640 key: Pleroma.Emails.UserEmail,
2642 description: "Email template settings",
2647 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2648 suggestions: ["some/path/logo.png"]
2653 description: "A map with color settings for email templates.",
2656 link_color: "#d8a070",
2657 background_color: "#2C3645",
2658 content_background_color: "#1B2635",
2659 header_color: "#d8a070",
2660 text_color: "#b9b9ba",
2661 text_muted_color: "#b9b9ba"
2668 suggestions: ["#d8a070"]
2671 key: :background_color,
2673 suggestions: ["#2C3645"]
2676 key: :content_background_color,
2678 suggestions: ["#1B2635"]
2683 suggestions: ["#d8a070"]
2688 suggestions: ["#b9b9ba"]
2691 key: :text_muted_color,
2693 suggestions: ["#b9b9ba"]
2701 key: Pleroma.Emails.NewUsersDigestEmail,
2703 description: "New users admin email digest",
2708 description: "Enables new users admin digest email when `true`"
2717 description: "Configure OAuth 2 provider capabilities",
2720 key: :token_expires_in,
2722 description: "The lifetime in seconds of the access token",
2726 key: :issue_new_refresh_token,
2729 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2732 key: :clean_expired_tokens,
2734 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2744 key: :shortcode_globs,
2745 type: {:list, :string},
2746 description: "Location of custom emoji files. * can be used as a wildcard.",
2747 suggestions: ["/emoji/custom/**/*.png"]
2750 key: :pack_extensions,
2751 type: {:list, :string},
2753 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2754 suggestions: [".png", ".gif"]
2758 type: {:keyword, {:list, :string}},
2760 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2761 " and the value is the location or array of locations. * can be used as a wildcard.",
2763 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2767 key: :default_manifest,
2770 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2771 " Currently only one manifest can be added (no arrays).",
2772 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2775 key: :shared_pack_cache_seconds_per_file,
2776 label: "Shared pack cache s/file",
2779 "When an emoji pack is shared, the archive is created and cached in memory" <>
2780 " for this amount of seconds multiplied by the number of files.",
2790 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2794 type: [:tuple, {:list, :tuple}],
2795 description: "For the search requests (account & status search etc.)",
2796 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2800 type: [:tuple, {:list, :tuple}],
2801 description: "For requests to timelines (each timeline has it's own limiter)",
2802 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2805 key: :app_account_creation,
2806 type: [:tuple, {:list, :tuple}],
2807 description: "For registering user accounts from the same IP address",
2808 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2811 key: :relations_actions,
2812 type: [:tuple, {:list, :tuple}],
2813 description: "For actions on relationships with all users (follow, unfollow)",
2814 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2817 key: :relation_id_action,
2818 label: "Relation ID action",
2819 type: [:tuple, {:list, :tuple}],
2820 description: "For actions on relation with a specific user (follow, unfollow)",
2821 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2824 key: :statuses_actions,
2825 type: [:tuple, {:list, :tuple}],
2827 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2828 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2831 key: :status_id_action,
2832 label: "Status ID action",
2833 type: [:tuple, {:list, :tuple}],
2835 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2836 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2839 key: :authentication,
2840 type: [:tuple, {:list, :tuple}],
2841 description: "For authentication create / password check / user existence check requests",
2842 suggestions: [{60_000, 15}]
2851 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2852 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2857 description: "Enables SSH"
2862 description: "Dir with SSH keys",
2863 suggestions: ["/some/path/ssh_keys"]
2868 description: "Handler module",
2869 suggestions: ["Pleroma.BBS.Handler"]
2874 description: "Port to connect",
2875 suggestions: [10_022]
2878 key: :password_authenticator,
2880 description: "Authenticator module",
2881 suggestions: ["Pleroma.BBS.Authenticator"]
2887 label: "Mime Types",
2889 description: "Mime Types settings",
2896 "application/xml" => ["xml"],
2897 "application/xrd+xml" => ["xrd+xml"],
2898 "application/jrd+json" => ["jrd+json"],
2899 "application/activity+json" => ["activity+json"],
2900 "application/ld+json" => ["activity+json"]
2905 key: "application/xml",
2906 type: {:list, :string},
2907 suggestions: ["xml"]
2910 key: "application/xrd+xml",
2911 type: {:list, :string},
2912 suggestions: ["xrd+xml"]
2915 key: "application/jrd+json",
2916 type: {:list, :string},
2917 suggestions: ["jrd+json"]
2920 key: "application/activity+json",
2921 type: {:list, :string},
2922 suggestions: ["activity+json"]
2925 key: "application/ld+json",
2926 type: {:list, :string},
2927 suggestions: ["activity+json"]
2937 description: "Pleroma chat settings",
2950 description: "HTTP settings",
2955 type: [:string, :tuple],
2956 description: "Proxy URL",
2957 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2960 key: :send_user_agent,
2965 type: [:string, :atom],
2967 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2968 suggestions: ["Pleroma", :default]
2973 description: "Adapter specific options",
2979 label: "SSL Options",
2980 description: "SSL options for HTTP adapter",
2984 type: {:list, :atom},
2985 description: "List of TLS version to use",
2986 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2997 label: "Markup Settings",
3001 key: :allow_inline_images,
3005 key: :allow_headings,
3018 type: {:list, :module},
3020 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3021 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3031 key: :deny_follow_blocked,
3038 key: :mrf_normalize_markup,
3040 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3041 label: "MRF Normalize Markup",
3042 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3048 suggestions: [Pleroma.HTML.Scrubber.Default]
3058 key: :restricted_nicknames,
3059 type: {:list, :string},
3078 "ostatus_subscribe",
3097 label: "CORS plug config",
3103 suggestions: [86_400]
3107 type: {:list, :string},
3108 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3112 type: {:list, :string},
3115 "X-RateLimit-Reset",
3116 "X-RateLimit-Limit",
3117 "X-RateLimit-Remaining",
3128 type: {:list, :string},
3129 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3135 key: Pleroma.Plugs.RemoteIp,
3138 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3139 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3145 description: "Enable/disable the plug. Default: disabled."
3149 type: {:list, :string},
3151 "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]`."
3155 type: {:list, :string},
3157 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3161 type: {:list, :string},
3163 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3169 key: :web_cache_ttl,
3170 label: "Web cache TTL",
3173 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3179 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3180 suggestions: [30_000, nil]
3183 key: :activity_pub_question,
3185 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3186 suggestions: [30_000]
3196 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3201 description: "Enables the rendering of static HTML. Default: disabled."
3209 description: "Configure feed rendering",
3214 description: "Configure title rendering",
3219 description: "Maximum number of characters before truncating title",
3225 description: "Replacement which will be used after truncating string",
3226 suggestions: ["..."]
3234 key: :mrf_object_age,
3236 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3237 label: "MRF Object Age",
3240 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3245 description: "Required age (in seconds) of a post before actions are taken.",
3246 suggestions: [172_800]
3250 type: {:list, :atom},
3252 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3253 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3254 "`:reject` rejects the message entirely",
3255 suggestions: [:delist, :strip_followers, :reject]
3263 description: "Custom Runtime Modules",
3268 description: "A path to custom Elixir modules (such as MRF policies)."
3276 description: "Settings for notifications streamer",
3281 description: "Number of workers to send notifications",
3285 key: :overflow_workers,
3287 description: "Maximum number of workers created if pool is empty",
3294 key: :connections_pool,
3296 description: "Advanced settings for `gun` connections pool",
3299 key: :connection_acquisition_wait,
3302 "Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries. Default: 250ms.",
3306 key: :connection_acquisition_retries,
3309 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3313 key: :max_connections,
3315 description: "Maximum number of connections in the pool. Default: 250 connections.",
3319 key: :await_up_timeout,
3321 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3325 key: :reclaim_multiplier,
3328 "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",
3337 description: "Advanced settings for `gun` workers pools",
3339 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3343 description: "Settings for #{pool_name} pool.",
3348 description: "Maximum number of concurrent requests in the pool.",
3355 "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",
3364 key: :hackney_pools,
3366 description: "Advanced settings for `hackney` connections pools",
3371 description: "Settings for federation pool.",
3374 key: :max_connections,
3376 description: "Number workers in the pool.",
3382 description: "Timeout while `hackney` will wait for response.",
3383 suggestions: [150_000]
3390 description: "Settings for media pool.",
3393 key: :max_connections,
3395 description: "Number workers in the pool.",
3401 description: "Timeout while `hackney` will wait for response.",
3402 suggestions: [150_000]
3409 description: "Settings for upload pool.",
3412 key: :max_connections,
3414 description: "Number workers in the pool.",
3420 description: "Timeout while `hackney` will wait for response.",
3421 suggestions: [300_000]
3429 key: :restrict_unauthenticated,
3432 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3437 description: "Settings for public and federated timelines.",
3442 description: "Disallow view public timeline."
3447 description: "Disallow view federated timeline."
3454 description: "Settings for user profiles.",
3459 description: "Disallow view local user profiles."
3464 description: "Disallow view remote user profiles."
3471 description: "Settings for statuses.",
3476 description: "Disallow view local statuses."
3481 description: "Disallow view remote statuses."
3489 key: Pleroma.Web.ApiSpec.CastAndValidate,
3496 "Enables strict input validation (useful in development, not recommended in production)"
3502 key: :instances_favicons,
3504 description: "Control favicons for instances",
3509 description: "Allow/disallow displaying and getting instances favicons"
3517 descriptions: "S3 service related settings",
3520 key: :access_key_id,
3522 description: "S3 access key ID",
3523 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3526 key: :secret_access_key,
3528 description: "Secret access key",
3529 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3534 description: "S3 host",
3535 suggestions: ["s3.eu-central-1.amazonaws.com"]
3543 description: "Installed frontends management",
3548 description: "Primary frontend, the one that is served for all pages by default",
3553 description: "Name of the installed primary frontend"
3558 description: "reference of the installed primary frontend to be used"