2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 installed_frontend_options = [
21 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
28 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
37 description: "Name of the frontend."
43 description: "Reference of the frontend to be used."
47 label: "Git Repository URL",
49 description: "URL of the git repository of the frontend"
56 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
57 example: "https://some.url/builds/${ref}.zip"
61 label: "Build directory",
63 description: "The directory inside the zip file "
67 config :pleroma, :config_description, [
72 description: "Upload general settings",
77 description: "Module which will be used for uploads",
78 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
82 type: {:list, :module},
84 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
85 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
91 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
97 description: "Base URL for the uploads, needed if you use CDN",
99 "https://cdn-host.com"
106 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
110 label: "Proxy Options",
112 description: "Options for Pleroma.ReverseProxy",
114 redirect_on_failure: false,
115 max_body_length: 25 * 1_048_576,
117 follow_redirect: true,
123 key: :redirect_on_failure,
126 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
127 "Any error during body processing will not be redirected as the response is chunked."
130 key: :max_body_length,
133 "Limits the content length to be approximately the " <>
134 "specified length. It is validated with the `content-length` header and also verified when proxying."
140 description: "HTTP options",
145 description: "Adapter specific options",
150 label: "SSL Options",
151 description: "SSL options for HTTP adapter",
155 type: {:list, :atom},
156 description: "List of TLS versions to use",
157 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
166 type: [:string, :tuple],
167 description: "Proxy URL",
168 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
175 key: :filename_display_max_length,
177 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
183 key: Pleroma.Uploaders.Local,
185 description: "Local uploader-related settings",
190 description: "Path where user's uploads will be saved",
199 key: Pleroma.Uploaders.S3,
201 description: "S3 uploader-related settings",
206 description: "S3 bucket",
212 key: :bucket_namespace,
214 description: "S3 bucket namespace",
215 suggestions: ["pleroma"]
218 key: :public_endpoint,
220 description: "S3 endpoint",
221 suggestions: ["https://s3.amazonaws.com"]
224 key: :truncated_namespace,
227 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
228 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
231 key: :streaming_enabled,
234 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
240 key: Pleroma.Upload.Filter.Mogrify,
242 description: "Uploads mogrify filter settings",
246 type: [:string, {:list, :string}, {:list, :tuple}],
248 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
249 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
260 key: Pleroma.Upload.Filter.AnonymizeFilename,
262 description: "Filter replaces the filename of the upload",
268 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
269 " filename extension by using {extension}, for example custom-file-name.{extension}.",
271 "custom-file-name.{extension}"
280 description: "Websocket based federation",
285 description: "Enable FedSockets"
291 key: Pleroma.Emails.Mailer,
293 description: "Mailer-related settings",
299 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
300 " or Swoosh.Adapters.Local for in-memory mailbox",
302 Swoosh.Adapters.SMTP,
303 Swoosh.Adapters.Sendgrid,
304 Swoosh.Adapters.Sendmail,
305 Swoosh.Adapters.Mandrill,
306 Swoosh.Adapters.Mailgun,
307 Swoosh.Adapters.Mailjet,
308 Swoosh.Adapters.Postmark,
309 Swoosh.Adapters.SparkPost,
310 Swoosh.Adapters.AmazonSES,
312 Swoosh.Adapters.SocketLabs,
313 Swoosh.Adapters.Gmail,
314 Swoosh.Adapters.Local
320 description: "Allow/disallow send emails"
323 group: {:subgroup, Swoosh.Adapters.SMTP},
326 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
327 suggestions: ["smtp.gmail.com"]
330 group: {:subgroup, Swoosh.Adapters.SMTP},
333 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
334 suggestions: ["pleroma"]
337 group: {:subgroup, Swoosh.Adapters.SMTP},
340 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
341 suggestions: ["password"]
344 group: {:subgroup, Swoosh.Adapters.SMTP},
348 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
351 group: {:subgroup, Swoosh.Adapters.SMTP},
355 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
356 suggestions: [:always, :never, :if_available]
359 group: {:subgroup, Swoosh.Adapters.SMTP},
362 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
363 suggestions: [:always, :never, :if_available]
366 group: {:subgroup, Swoosh.Adapters.SMTP},
369 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
373 group: {:subgroup, Swoosh.Adapters.SMTP},
376 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
380 group: {:subgroup, Swoosh.Adapters.SMTP},
382 label: "No MX lookups",
384 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
387 group: {:subgroup, Swoosh.Adapters.Sendgrid},
391 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
392 suggestions: ["my-api-key"]
395 group: {:subgroup, Swoosh.Adapters.Sendmail},
398 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
399 suggestions: ["/usr/bin/sendmail"]
402 group: {:subgroup, Swoosh.Adapters.Sendmail},
405 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
406 suggestions: ["-N delay,failure,success"]
409 group: {:subgroup, Swoosh.Adapters.Sendmail},
412 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
415 group: {:subgroup, Swoosh.Adapters.Mandrill},
419 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
420 suggestions: ["my-api-key"]
423 group: {:subgroup, Swoosh.Adapters.Mailgun},
427 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
428 suggestions: ["my-api-key"]
431 group: {:subgroup, Swoosh.Adapters.Mailgun},
434 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
435 suggestions: ["pleroma.com"]
438 group: {:subgroup, Swoosh.Adapters.Mailjet},
442 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
443 suggestions: ["my-api-key"]
446 group: {:subgroup, Swoosh.Adapters.Mailjet},
449 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
450 suggestions: ["my-secret-key"]
453 group: {:subgroup, Swoosh.Adapters.Postmark},
457 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
458 suggestions: ["my-api-key"]
461 group: {:subgroup, Swoosh.Adapters.SparkPost},
465 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
466 suggestions: ["my-api-key"]
469 group: {:subgroup, Swoosh.Adapters.SparkPost},
472 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
473 suggestions: ["https://api.sparkpost.com/api/v1"]
476 group: {:subgroup, Swoosh.Adapters.AmazonSES},
479 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
480 suggestions: ["us-east-1", "us-east-2"]
483 group: {:subgroup, Swoosh.Adapters.AmazonSES},
486 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
487 suggestions: ["aws-access-key"]
490 group: {:subgroup, Swoosh.Adapters.AmazonSES},
493 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
494 suggestions: ["aws-secret-key"]
497 group: {:subgroup, Swoosh.Adapters.Dyn},
501 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
502 suggestions: ["my-api-key"]
505 group: {:subgroup, Swoosh.Adapters.SocketLabs},
508 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
511 group: {:subgroup, Swoosh.Adapters.SocketLabs},
515 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
518 group: {:subgroup, Swoosh.Adapters.Gmail},
521 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
528 description: "`Swoosh.Adapters.Local` adapter specific settings",
531 group: {:subgroup, Swoosh.Adapters.Local},
534 description: "Run the preview server together as part of your app"
537 group: {:subgroup, Swoosh.Adapters.Local},
540 description: "The preview server port",
548 label: "URI Schemes",
550 description: "URI schemes related settings",
554 type: {:list, :string},
555 description: "List of the scheme part that is considered valid to be an URL",
580 description: "Instance-related settings",
585 description: "Name of the instance",
592 label: "Admin Email Address",
594 description: "Email used to reach an Administrator/Moderator of the instance",
601 label: "Sender Email Address",
603 description: "Envelope FROM address for mail sent via Pleroma",
612 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
620 description: "Posts character limit (CW/Subject included in the counter)",
628 description: "Character limit of the instance chat messages",
636 description: "Hard character limit beyond which remote posts will be dropped",
644 description: "File size limit of uploads (except for avatar, background, banner)",
650 key: :avatar_upload_limit,
652 description: "File size limit of user's profile avatars",
658 key: :background_upload_limit,
660 description: "File size limit of user's profile backgrounds",
666 key: :banner_upload_limit,
668 description: "File size limit of user's profile banners",
676 description: "A map with poll limits for local polls",
680 max_option_chars: 200,
682 max_expiration: 31_536_000
689 description: "Maximum number of options",
693 key: :max_option_chars,
695 description: "Maximum number of characters per option",
699 key: :min_expiration,
701 description: "Minimum expiration time (in seconds)",
705 key: :max_expiration,
707 description: "Maximum expiration time (in seconds)",
713 key: :registrations_open,
716 "Enable registrations for anyone. Invitations require this setting to be disabled."
719 key: :invites_enabled,
722 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
725 key: :account_activation_required,
727 description: "Require users to confirm their emails before signing in"
730 key: :account_approval_required,
732 description: "Require users to be manually approved by an admin before signing in"
737 description: "Enable federation with other instances"
740 key: :federation_incoming_replies_max_depth,
741 label: "Fed. incoming replies max depth",
744 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
745 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
751 key: :federation_reachability_timeout_days,
752 label: "Fed. reachability timeout days",
755 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
763 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
769 "Makes the client API in authenticated mode-only except for user-profiles." <>
770 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
771 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
774 key: :quarantined_instances,
775 type: {:list, :string},
777 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
786 description: "Instance static directory",
792 key: :allowed_post_formats,
793 type: {:list, :string},
794 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
803 key: :extended_nickname_format,
806 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
807 " This will break federation with older software for theses nicknames."
810 key: :cleanup_attachments,
813 Enable to remove associated attachments when status is removed.
814 This will not affect duplicates and attachments without status.
815 Enabling this will increase load to database when deleting statuses on larger instances.
819 key: :max_pinned_statuses,
821 description: "The maximum number of pinned statuses. 0 will disable the feature.",
829 key: :autofollowed_nicknames,
830 type: {:list, :string},
832 "Set to nicknames of (local) users that every new user should automatically follow"
835 key: :attachment_links,
837 description: "Enable to automatically add attachment link text to statuses"
840 key: :max_report_comment_size,
842 description: "The maximum size of the report comment. Default: 1000.",
848 key: :safe_dm_mentions,
849 label: "Safe DM mentions",
852 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
853 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
859 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
862 key: :remote_post_retention_days,
865 "The default amount of days to retain remote posts when pruning the database",
871 key: :user_bio_length,
873 description: "A user bio maximum length. Default: 5000.",
879 key: :user_name_length,
881 description: "A user name maximum length. Default: 100.",
887 key: :skip_thread_containment,
889 description: "Skip filtering out broken threads. Default: enabled."
892 key: :limit_to_local_content,
893 type: {:dropdown, :atom},
895 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
903 key: :max_account_fields,
905 description: "The maximum number of custom fields in the user profile. Default: 10.",
911 key: :max_remote_account_fields,
914 "The maximum number of custom fields in the remote user profile. Default: 20.",
920 key: :account_field_name_length,
922 description: "An account field name maximum length. Default: 512.",
928 key: :account_field_value_length,
930 description: "An account field value maximum length. Default: 2048.",
936 key: :registration_reason_length,
938 description: "Maximum registration reason length. Default: 500.",
944 key: :external_user_synchronization,
946 description: "Enabling following/followers counters synchronization for external users"
949 key: :multi_factor_authentication,
951 description: "Multi-factor authentication settings",
954 totp: [digits: 6, period: 30],
955 backup_codes: [number: 5, length: 16]
961 label: "TOTP settings",
963 description: "TOTP settings",
964 suggestions: [digits: 6, period: 30],
971 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
978 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
985 description: "MFA backup codes settings",
986 suggestions: [number: 5, length: 16],
992 description: "Number of backup codes to generate."
999 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
1006 key: :instance_thumbnail,
1007 type: {:string, :image},
1009 "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.",
1010 suggestions: ["/instance/thumbnail.jpeg"]
1013 key: :show_reactions,
1015 description: "Let favourites and emoji reactions be viewed through the API."
1023 description: "Welcome messages settings",
1026 key: :direct_message,
1028 descpiption: "Direct message settings",
1033 description: "Enables sending a direct message to newly registered users"
1038 description: "A message that will be sent to newly registered users",
1040 "Hi, @username! Welcome on board!"
1044 key: :sender_nickname,
1046 description: "The nickname of the local user that sends a welcome message",
1056 descpiption: "Chat message settings",
1061 description: "Enables sending a chat message to newly registered users"
1067 "A message that will be sent to newly registered users as a chat message",
1069 "Hello, welcome on board!"
1073 key: :sender_nickname,
1075 description: "The nickname of the local user that sends a welcome chat message",
1085 descpiption: "Email message settings",
1090 description: "Enables sending an email to newly registered users"
1094 type: [:string, :tuple],
1096 "Email address and/or nickname that will be used to send the welcome email.",
1098 {"Pleroma App", "welcome@pleroma.app"}
1105 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1106 suggestions: ["Welcome to <%= instance_name%>"]
1112 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1113 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1119 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1120 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1129 description: "Logger-related settings",
1133 type: [:atom, :tuple, :module],
1135 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1136 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1144 label: "ExSyslogger",
1145 description: "ExSyslogger-related settings",
1149 type: {:dropdown, :atom},
1150 description: "Log level",
1151 suggestions: [:debug, :info, :warn, :error]
1157 "A string that's prepended to every message, and is typically set to the app name",
1158 suggestions: ["pleroma"]
1163 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1164 suggestions: ["$metadata[$level] $message"]
1168 type: {:list, :atom},
1169 suggestions: [:request_id]
1177 label: "Console Logger",
1178 description: "Console logger settings",
1182 type: {:dropdown, :atom},
1183 description: "Log level",
1184 suggestions: [:debug, :info, :warn, :error]
1189 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1190 suggestions: ["$metadata[$level] $message"]
1194 type: {:list, :atom},
1195 suggestions: [:request_id]
1202 label: "Quack Logger",
1203 description: "Quack-related settings",
1207 type: {:dropdown, :atom},
1208 description: "Log level",
1209 suggestions: [:debug, :info, :warn, :error]
1213 type: {:list, :atom},
1214 description: "Configure which metadata you want to report on",
1231 label: "Webhook URL",
1233 description: "Configure the Slack incoming webhook",
1234 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1240 key: :frontend_configurations,
1243 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1244 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1245 "add your own configuration your settings all fields must be complete.",
1249 label: "Pleroma FE",
1251 description: "Settings for Pleroma FE",
1254 alwaysShowSubjectInput: true,
1255 background: "/static/aurora_borealis.jpg",
1256 collapseMessageWithSubject: false,
1259 hideFilteredStatuses: false,
1260 hideMutedPosts: false,
1261 hidePostStats: false,
1262 hideSitename: false,
1263 hideUserStats: false,
1264 loginMethod: "password",
1265 logo: "/static/logo.png",
1268 minimalScopesMode: false,
1269 noAttachmentLinks: false,
1270 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1271 postContentType: "text/plain",
1272 redirectRootLogin: "/main/friends",
1273 redirectRootNoLogin: "/main/all",
1275 sidebarRight: false,
1276 showFeaturesPanel: true,
1277 showInstanceSpecificPanel: false,
1278 subjectLineBehavior: "email",
1279 theme: "pleroma-dark",
1280 webPushNotifications: false
1285 key: :alwaysShowSubjectInput,
1286 label: "Always show subject input",
1288 description: "When disabled, auto-hide the subject field if it's empty"
1292 type: {:string, :image},
1294 "URL of the background, unless viewing a user profile with a background that is set",
1295 suggestions: ["/images/city.jpg"]
1298 key: :collapseMessageWithSubject,
1299 label: "Collapse message with subject",
1302 "When a message has a subject (aka Content Warning), collapse it by default"
1306 label: "PleromaFE Chat",
1308 description: "Disables PleromaFE Chat component"
1314 description: "Enables green text on lines prefixed with the > character"
1317 key: :hideFilteredStatuses,
1318 label: "Hide Filtered Statuses",
1320 description: "Hides filtered statuses from timelines"
1323 key: :hideMutedPosts,
1324 label: "Hide Muted Posts",
1326 description: "Hides muted statuses from timelines"
1329 key: :hidePostStats,
1330 label: "Hide post stats",
1332 description: "Hide notices statistics (repeats, favorites, ...)"
1336 label: "Hide Sitename",
1338 description: "Hides instance name from PleromaFE banner"
1341 key: :hideUserStats,
1342 label: "Hide user stats",
1345 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1349 type: {:string, :image},
1350 description: "URL of the logo, defaults to Pleroma's logo",
1351 suggestions: ["/static/logo.png"]
1355 label: "Logo margin",
1358 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1359 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1360 suggestions: [".1em"]
1367 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1368 "If you want a colorful logo you must disable logoMask."
1371 key: :minimalScopesMode,
1372 label: "Minimal scopes mode",
1375 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1376 "Also prevents replying to a DM with a public post from PleromaFE."
1379 key: :nsfwCensorImage,
1380 label: "NSFW Censor Image",
1381 type: {:string, :image},
1383 "URL of the image to use for hiding NSFW media attachments in the timeline",
1384 suggestions: ["/static/img/nsfw.74818f9.png"]
1387 key: :postContentType,
1388 label: "Post Content Type",
1389 type: {:dropdown, :atom},
1390 description: "Default post formatting option",
1391 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1394 key: :redirectRootNoLogin,
1395 label: "Redirect root no login",
1398 "Relative URL which indicates where to redirect when a user isn't logged in",
1399 suggestions: ["/main/all"]
1402 key: :redirectRootLogin,
1403 label: "Redirect root login",
1406 "Relative URL which indicates where to redirect when a user is logged in",
1407 suggestions: ["/main/friends"]
1411 label: "Scope copy",
1413 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1417 label: "Sidebar on Right",
1419 description: "Change alignment of sidebar and panels to the right"
1422 key: :showFeaturesPanel,
1423 label: "Show instance features panel",
1426 "Enables panel displaying functionality of the instance on the About page"
1429 key: :showInstanceSpecificPanel,
1430 label: "Show instance specific panel",
1432 description: "Whether to show the instance's custom panel"
1435 key: :subjectLineBehavior,
1436 label: "Subject line behavior",
1438 description: "Allows changing the default behaviour of subject lines in replies.
1439 `email`: copy and preprend re:, as in email,
1440 `masto`: copy verbatim, as in Mastodon,
1441 `noop`: don't copy the subject.",
1442 suggestions: ["email", "masto", "noop"]
1447 description: "Which theme to use. Available themes are defined in styles.json",
1448 suggestions: ["pleroma-dark"]
1456 description: "Settings for Masto FE",
1459 showInstanceSpecificPanel: true
1464 key: :showInstanceSpecificPanel,
1465 label: "Show instance specific panel",
1467 description: "Whenether to show the instance's specific panel"
1478 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1482 type: {:keyword, :map},
1484 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1487 url: "/images/pleroma-fox-tan-smol.png",
1488 mime_type: "image/png"
1490 pleroma_fox_tan_shy: %{
1491 url: "/images/pleroma-fox-tan-shy.png",
1492 mime_type: "image/png"
1497 key: :default_mascot,
1500 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1506 key: :default_user_avatar,
1507 type: {:string, :image},
1508 description: "URL of the default user avatar",
1509 suggestions: ["/images/avi.png"]
1518 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1522 type: {:list, :map},
1523 description: "Describe the icons of the app",
1526 src: "/static/logo.png"
1529 src: "/static/icon.png",
1533 src: "/static/icon.ico",
1534 sizes: "72x72 96x96 128x128 256x256"
1541 description: "Describe the theme color of the app",
1542 suggestions: ["#282c37", "mediumpurple"]
1545 key: :background_color,
1547 description: "Describe the background color of the app",
1548 suggestions: ["#191b22", "aliceblue"]
1558 description: "General MRF settings",
1562 type: [:module, {:list, :module}],
1564 "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.",
1565 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1569 label: "MRF transparency",
1572 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1575 key: :transparency_exclusions,
1576 label: "MRF transparency exclusions",
1577 type: {:list, :string},
1579 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1590 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1591 label: "MRF Simple",
1593 description: "Simple ingress policies",
1596 key: :media_removal,
1597 type: {:list, :string},
1598 description: "List of instances to strip media attachments from",
1599 suggestions: ["example.com", "*.example.com"]
1603 label: "Media NSFW",
1604 type: {:list, :string},
1605 description: "List of instances to tag all media as NSFW (sensitive) from",
1606 suggestions: ["example.com", "*.example.com"]
1609 key: :federated_timeline_removal,
1610 type: {:list, :string},
1612 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1613 suggestions: ["example.com", "*.example.com"]
1617 type: {:list, :string},
1618 description: "List of instances to reject activities from (except deletes)",
1619 suggestions: ["example.com", "*.example.com"]
1623 type: {:list, :string},
1624 description: "List of instances to only accept activities from (except deletes)",
1625 suggestions: ["example.com", "*.example.com"]
1628 key: :followers_only,
1629 type: {:list, :string},
1630 description: "Force posts from the given instances to be visible by followers only",
1631 suggestions: ["example.com", "*.example.com"]
1634 key: :report_removal,
1635 type: {:list, :string},
1636 description: "List of instances to reject reports from",
1637 suggestions: ["example.com", "*.example.com"]
1640 key: :avatar_removal,
1641 type: {:list, :string},
1642 description: "List of instances to strip avatars from",
1643 suggestions: ["example.com", "*.example.com"]
1646 key: :banner_removal,
1647 type: {:list, :string},
1648 description: "List of instances to strip banners from",
1649 suggestions: ["example.com", "*.example.com"]
1652 key: :reject_deletes,
1653 type: {:list, :string},
1654 description: "List of instances to reject deletions from",
1655 suggestions: ["example.com", "*.example.com"]
1661 key: :mrf_activity_expiration,
1663 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1664 label: "MRF Activity Expiration Policy",
1666 description: "Adds automatic expiration to all local activities",
1671 description: "Default global expiration time for all local activities (in days)",
1672 suggestions: [90, 365]
1680 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1681 label: "MRF Subchain",
1684 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1685 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1689 type: {:map, {:list, :string}},
1690 description: "Matches a series of regular expressions against the actor field",
1693 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1701 key: :mrf_rejectnonpublic,
1703 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1704 description: "RejectNonPublic drops posts with non-public visibility settings.",
1705 label: "MRF Reject Non Public",
1709 key: :allow_followersonly,
1710 label: "Allow followers-only",
1712 description: "Whether to allow followers-only posts"
1717 description: "Whether to allow direct messages"
1723 key: :mrf_hellthread,
1725 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1726 label: "MRF Hellthread",
1728 description: "Block messages with excessive user mentions",
1731 key: :delist_threshold,
1734 "Number of mentioned users after which the message gets removed from timelines and" <>
1735 "disables notifications. Set to 0 to disable.",
1739 key: :reject_threshold,
1742 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1751 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1752 label: "MRF Keyword",
1754 description: "Reject or Word-Replace messages with a keyword or regex",
1758 type: {:list, :string},
1760 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1761 suggestions: ["foo", ~r/foo/iu]
1764 key: :federated_timeline_removal,
1765 type: {:list, :string},
1767 "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.",
1768 suggestions: ["foo", ~r/foo/iu]
1772 type: {:list, :tuple},
1774 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1775 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1783 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1784 label: "MRF Mention",
1786 description: "Block messages which mention a specific user",
1790 type: {:list, :string},
1791 description: "A list of actors for which any post mentioning them will be dropped",
1792 suggestions: ["actor1", "actor2"]
1798 key: :mrf_vocabulary,
1800 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1801 label: "MRF Vocabulary",
1803 description: "Filter messages which belong to certain activity vocabularies",
1807 type: {:list, :string},
1809 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1810 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1814 type: {:list, :string},
1816 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1817 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1823 # key: :mrf_user_allowlist,
1825 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1828 # "The keys in this section are the domain names that the policy should apply to." <>
1829 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1831 # %{"example.org" => ["https://example.org/users/admin"]}
1839 description: "Media proxy",
1844 description: "Enables proxying of remote media to the instance's proxy"
1851 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1852 suggestions: ["https://example.com"]
1860 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1866 description: "Enables media cache object invalidation."
1871 description: "Module which will be used to purge objects from the cache.",
1873 Pleroma.Web.MediaProxy.Invalidation.Script,
1874 Pleroma.Web.MediaProxy.Invalidation.Http
1881 label: "Proxy Options",
1883 description: "Options for Pleroma.ReverseProxy",
1885 redirect_on_failure: false,
1886 max_body_length: 25 * 1_048_576,
1887 max_read_duration: 30_000,
1889 follow_redirect: true,
1895 key: :redirect_on_failure,
1898 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1899 "Any error during body processing will not be redirected as the response is chunked."
1902 key: :max_body_length,
1905 "Limits the content length to be approximately the " <>
1906 "specified length. It is validated with the `content-length` header and also verified when proxying."
1909 key: :max_read_duration,
1911 description: "Timeout (in milliseconds) of GET request to remote URI."
1917 description: "HTTP options",
1922 description: "Adapter specific options",
1927 label: "SSL Options",
1928 description: "SSL options for HTTP adapter",
1932 type: {:list, :atom},
1933 description: "List of TLS version to use",
1934 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1943 type: [:string, :tuple],
1944 description: "Proxy URL",
1945 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1953 type: {:list, :string},
1954 description: "List of hosts with scheme to bypass the mediaproxy",
1955 suggestions: ["http://example.com"]
1961 key: :media_preview_proxy,
1963 description: "Media preview proxy",
1969 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1972 key: :thumbnail_max_width,
1975 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1978 key: :thumbnail_max_height,
1981 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1984 key: :image_quality,
1986 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1989 key: :min_content_length,
1992 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1998 key: Pleroma.Web.MediaProxy.Invalidation.Http,
2000 description: "HTTP invalidate settings",
2005 description: "HTTP method of request. Default: :purge"
2009 type: {:keyword, :string},
2010 description: "HTTP headers of request",
2011 suggestions: [{"x-refresh", 1}]
2016 description: "Request options",
2020 type: {:map, :string}
2028 key: Pleroma.Web.MediaProxy.Invalidation.Script,
2030 description: "Script invalidate settings",
2035 description: "Path to shell script. Which will run purge cache.",
2036 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2044 description: "Gopher settings",
2049 description: "Enables the gopher interface"
2055 description: "IP address to bind to",
2056 suggestions: [{0, 0, 0, 0}]
2061 description: "Port to bind to",
2067 description: "Port advertised in URLs (optional, defaults to port)",
2075 label: "ActivityPub",
2077 description: "ActivityPub-related settings",
2080 key: :unfollow_blocked,
2082 description: "Whether blocks result in people getting unfollowed"
2085 key: :outgoing_blocks,
2087 description: "Whether to federate blocks to other instances"
2090 key: :sign_object_fetches,
2092 description: "Sign object fetches with HTTP signatures"
2095 key: :note_replies_output_limit,
2098 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2101 key: :follow_handshake_timeout,
2103 description: "Following handshake timeout",
2110 key: :http_security,
2111 label: "HTTP security",
2113 description: "HTTP security settings",
2118 description: "Whether the managed content security policy is enabled"
2124 description: "Whether to additionally send a Strict-Transport-Security header"
2128 label: "STS max age",
2130 description: "The maximum age for the Strict-Transport-Security header if sent",
2131 suggestions: [31_536_000]
2135 label: "CT max age",
2137 description: "The maximum age for the Expect-CT header if sent",
2138 suggestions: [2_592_000]
2141 key: :referrer_policy,
2143 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2144 suggestions: ["same-origin", "no-referrer"]
2148 label: "Report URI",
2150 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2151 suggestions: ["https://example.com/report-uri"]
2156 group: :web_push_encryption,
2157 key: :vapid_details,
2158 label: "Vapid Details",
2161 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2167 "A mailto link for the administrative contact." <>
2168 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2169 suggestions: ["mailto:moderators@pleroma.com"]
2174 description: "VAPID public key",
2175 suggestions: ["Public key"]
2180 description: "VAPID private key",
2181 suggestions: ["Private key"]
2187 key: Pleroma.Captcha,
2189 description: "Captcha-related settings",
2194 description: "Whether the captcha should be shown on registration"
2199 description: "The method/service to use for captcha",
2200 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2203 key: :seconds_valid,
2205 description: "The time in seconds for which the captcha is valid",
2212 key: Pleroma.Captcha.Kocaptcha,
2215 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2216 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2221 description: "The kocaptcha endpoint to use",
2222 suggestions: ["https://captcha.kotobank.ch"]
2228 label: "Pleroma Admin Token",
2231 "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)",
2236 description: "Admin token",
2238 "Please use a high entropy string or UUID"
2248 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2250 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2251 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2252 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2253 (see https://github.com/sorentwo/oban/issues/52).
2258 type: {:dropdown, :atom},
2259 description: "Logs verbose mode",
2260 suggestions: [false, :error, :warn, :info, :debug]
2264 type: {:keyword, :integer},
2266 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2268 activity_expiration: 10,
2269 attachments_cleanup: 5,
2271 federator_incoming: 50,
2272 federator_outgoing: 50,
2274 scheduled_activities: 10,
2280 key: :activity_expiration,
2282 description: "Activity expiration queue",
2288 description: "Backup queue",
2292 key: :attachments_cleanup,
2294 description: "Attachment deletion queue",
2300 description: "Background queue",
2304 key: :federator_incoming,
2306 description: "Incoming federation queue",
2310 key: :federator_outgoing,
2312 description: "Outgoing federation queue",
2318 description: "Email sender queue, see Pleroma.Emails.Mailer",
2322 key: :scheduled_activities,
2324 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2328 key: :transmogrifier,
2330 description: "Transmogrifier queue",
2336 description: "Web push notifications queue",
2343 type: {:list, :tuple},
2344 description: "Settings for cron background jobs",
2346 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2347 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2356 description: "Includes custom worker options not interpretable directly by `Oban`",
2360 type: {:keyword, :integer},
2361 description: "Max retry attempts for failed jobs, per `Oban` queue",
2363 federator_incoming: 5,
2364 federator_outgoing: 5
2371 key: Pleroma.Web.Metadata,
2373 description: "Metadata-related settings",
2377 type: {:list, :module},
2378 description: "List of metadata providers to enable",
2380 Pleroma.Web.Metadata.Providers.OpenGraph,
2381 Pleroma.Web.Metadata.Providers.TwitterCard,
2382 Pleroma.Web.Metadata.Providers.RelMe,
2383 Pleroma.Web.Metadata.Providers.Feed
2388 label: "Unfurl NSFW",
2390 description: "When enabled NSFW attachments will be shown in previews"
2399 "If enabled the instance will parse metadata from attached links to generate link previews",
2404 description: "Enables RichMedia parsing of URLs"
2408 type: {:list, :string},
2409 description: "List of hosts which will be ignored by the metadata parser",
2410 suggestions: ["accounts.google.com", "xss.website"]
2414 label: "Ignore TLD",
2415 type: {:list, :string},
2416 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2417 suggestions: ["local", "localdomain", "lan"]
2421 type: {:list, :module},
2423 "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.",
2425 Pleroma.Web.RichMedia.Parsers.OEmbed,
2426 Pleroma.Web.RichMedia.Parsers.TwitterCard
2431 label: "TTL setters",
2432 type: {:list, :module},
2434 "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.",
2436 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2440 key: :failure_backoff,
2443 "Amount of milliseconds after request failure, during which the request will not be retried.",
2444 suggestions: [60_000]
2450 key: Pleroma.Formatter,
2454 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2458 type: [:string, :boolean],
2459 description: "Specify the class to be added to the generated link. Disable to clear.",
2460 suggestions: ["auto-linker", false]
2464 type: [:string, :boolean],
2465 description: "Override the rel attribute. Disable to clear.",
2466 suggestions: ["ugc", "noopener noreferrer", false]
2471 description: "Link URLs will open in a new window/tab."
2475 type: [:integer, :boolean],
2477 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2478 suggestions: [15, false]
2483 description: "Strip the scheme prefix."
2488 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2492 type: [:atom, :boolean],
2494 "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)",
2495 suggestions: [:no_scheme, true]
2501 key: Pleroma.ScheduledActivity,
2503 description: "Scheduled activities settings",
2506 key: :daily_user_limit,
2509 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2513 key: :total_user_limit,
2516 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2522 description: "Whether scheduled activities are sent to the job queue to be executed"
2528 key: Pleroma.Workers.PurgeExpiredActivity,
2530 description: "Expired activities settings",
2535 description: "Enables expired activities addition & deletion"
2540 description: "Minimum lifetime for ephemeral activity (in seconds)",
2547 label: "Pleroma Authenticator",
2549 description: "Authenticator",
2552 key: Pleroma.Web.Auth.Authenticator,
2554 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2564 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2565 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2566 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2567 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2572 description: "Enables LDAP authentication"
2577 description: "LDAP server hostname",
2578 suggestions: ["localhosts"]
2583 description: "LDAP port, e.g. 389 or 636",
2584 suggestions: [389, 636]
2590 description: "Enable to use SSL, usually implies the port 636"
2594 label: "SSL options",
2596 description: "Additional SSL options",
2597 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2602 description: "Path to file with PEM encoded cacerts",
2603 suggestions: ["path/to/file/with/PEM/cacerts"]
2608 description: "Type of cert verification",
2609 suggestions: [:verify_peer]
2617 description: "Enable to use STARTTLS, usually implies the port 389"
2621 label: "TLS options",
2623 description: "Additional TLS options",
2624 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2629 description: "Path to file with PEM encoded cacerts",
2630 suggestions: ["path/to/file/with/PEM/cacerts"]
2635 description: "Type of cert verification",
2636 suggestions: [:verify_peer]
2643 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2644 suggestions: ["dc=example,dc=com"]
2651 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2660 description: "Authentication / authorization settings",
2663 key: :enforce_oauth_admin_scope_usage,
2664 label: "Enforce OAuth admin scope usage",
2667 "OAuth admin scope requirement toggle. " <>
2668 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2669 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2670 "`is_admin` user flag grants access to admin-specific actions."
2673 key: :auth_template,
2676 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2677 suggestions: ["show.html"]
2680 key: :oauth_consumer_template,
2681 label: "OAuth consumer template",
2684 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2685 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2686 suggestions: ["consumer.html"]
2689 key: :oauth_consumer_strategies,
2690 label: "OAuth consumer strategies",
2691 type: {:list, :string},
2693 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2694 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2695 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2696 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2702 key: :email_notifications,
2704 description: "Email notifications settings",
2710 "emails of \"what you've missed\" for users who have been inactive for a while",
2714 schedule: "0 0 * * 0",
2716 inactivity_threshold: 7
2724 description: "Globally enable or disable digest emails"
2730 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2731 suggestions: ["0 0 * * 0"]
2736 description: "Minimum interval between digest emails to one user",
2740 key: :inactivity_threshold,
2742 description: "Minimum user inactivity threshold",
2751 key: Pleroma.Emails.UserEmail,
2753 description: "Email template settings",
2757 type: {:string, :image},
2758 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2759 suggestions: ["some/path/logo.png"]
2764 description: "A map with color settings for email templates.",
2767 link_color: "#d8a070",
2768 background_color: "#2C3645",
2769 content_background_color: "#1B2635",
2770 header_color: "#d8a070",
2771 text_color: "#b9b9ba",
2772 text_muted_color: "#b9b9ba"
2779 suggestions: ["#d8a070"]
2782 key: :background_color,
2784 suggestions: ["#2C3645"]
2787 key: :content_background_color,
2789 suggestions: ["#1B2635"]
2794 suggestions: ["#d8a070"]
2799 suggestions: ["#b9b9ba"]
2802 key: :text_muted_color,
2804 suggestions: ["#b9b9ba"]
2812 key: Pleroma.Emails.NewUsersDigestEmail,
2814 description: "New users admin email digest",
2819 description: "Enables new users admin digest email when `true`"
2828 description: "Configure OAuth 2 provider capabilities",
2831 key: :token_expires_in,
2833 description: "The lifetime in seconds of the access token",
2837 key: :issue_new_refresh_token,
2840 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2843 key: :clean_expired_tokens,
2845 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2855 key: :shortcode_globs,
2856 type: {:list, :string},
2857 description: "Location of custom emoji files. * can be used as a wildcard.",
2858 suggestions: ["/emoji/custom/**/*.png"]
2861 key: :pack_extensions,
2862 type: {:list, :string},
2864 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2865 suggestions: [".png", ".gif"]
2869 type: {:keyword, {:list, :string}},
2871 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2872 " and the value is the location or array of locations. * can be used as a wildcard.",
2874 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2878 key: :default_manifest,
2881 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2882 " Currently only one manifest can be added (no arrays).",
2883 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2886 key: :shared_pack_cache_seconds_per_file,
2887 label: "Shared pack cache s/file",
2890 "When an emoji pack is shared, the archive is created and cached in memory" <>
2891 " for this amount of seconds multiplied by the number of files.",
2901 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2905 type: [:tuple, {:list, :tuple}],
2906 description: "For the search requests (account & status search etc.)",
2907 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2911 type: [:tuple, {:list, :tuple}],
2912 description: "For requests to timelines (each timeline has it's own limiter)",
2913 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2916 key: :app_account_creation,
2917 type: [:tuple, {:list, :tuple}],
2918 description: "For registering user accounts from the same IP address",
2919 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2922 key: :relations_actions,
2923 type: [:tuple, {:list, :tuple}],
2924 description: "For actions on relationships with all users (follow, unfollow)",
2925 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2928 key: :relation_id_action,
2929 label: "Relation ID action",
2930 type: [:tuple, {:list, :tuple}],
2931 description: "For actions on relation with a specific user (follow, unfollow)",
2932 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2935 key: :statuses_actions,
2936 type: [:tuple, {:list, :tuple}],
2938 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2939 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2942 key: :status_id_action,
2943 label: "Status ID action",
2944 type: [:tuple, {:list, :tuple}],
2946 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2947 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2950 key: :authentication,
2951 type: [:tuple, {:list, :tuple}],
2952 description: "For authentication create / password check / user existence check requests",
2953 suggestions: [{60_000, 15}]
2962 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2963 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2968 description: "Enables SSH"
2973 description: "Dir with SSH keys",
2974 suggestions: ["/some/path/ssh_keys"]
2979 description: "Handler module",
2980 suggestions: ["Pleroma.BBS.Handler"]
2985 description: "Port to connect",
2986 suggestions: [10_022]
2989 key: :password_authenticator,
2991 description: "Authenticator module",
2992 suggestions: ["Pleroma.BBS.Authenticator"]
2998 label: "Mime Types",
3000 description: "Mime Types settings",
3007 "application/xml" => ["xml"],
3008 "application/xrd+xml" => ["xrd+xml"],
3009 "application/jrd+json" => ["jrd+json"],
3010 "application/activity+json" => ["activity+json"],
3011 "application/ld+json" => ["activity+json"]
3016 key: "application/xml",
3017 type: {:list, :string},
3018 suggestions: ["xml"]
3021 key: "application/xrd+xml",
3022 type: {:list, :string},
3023 suggestions: ["xrd+xml"]
3026 key: "application/jrd+json",
3027 type: {:list, :string},
3028 suggestions: ["jrd+json"]
3031 key: "application/activity+json",
3032 type: {:list, :string},
3033 suggestions: ["activity+json"]
3036 key: "application/ld+json",
3037 type: {:list, :string},
3038 suggestions: ["activity+json"]
3048 description: "Pleroma chat settings",
3061 description: "HTTP settings",
3066 type: [:string, :tuple],
3067 description: "Proxy URL",
3068 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3071 key: :send_user_agent,
3076 type: [:string, :atom],
3078 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3079 suggestions: ["Pleroma", :default]
3084 description: "Adapter specific options",
3090 label: "SSL Options",
3091 description: "SSL options for HTTP adapter",
3095 type: {:list, :atom},
3096 description: "List of TLS version to use",
3097 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3108 label: "Markup Settings",
3112 key: :allow_inline_images,
3116 key: :allow_headings,
3129 type: {:list, :module},
3131 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3132 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3142 key: :deny_follow_blocked,
3149 key: :mrf_normalize_markup,
3151 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3152 label: "MRF Normalize Markup",
3153 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3159 suggestions: [Pleroma.HTML.Scrubber.Default]
3169 key: :restricted_nicknames,
3170 type: {:list, :string},
3171 description: "List of nicknames users may not register with.",
3190 "ostatus_subscribe",
3206 key: :email_blacklist,
3207 type: {:list, :string},
3208 description: "List of email domains users may not register with.",
3209 suggestions: ["mailinator.com", "maildrop.cc"]
3215 label: "CORS plug config",
3221 suggestions: [86_400]
3225 type: {:list, :string},
3226 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3230 type: {:list, :string},
3233 "X-RateLimit-Reset",
3234 "X-RateLimit-Limit",
3235 "X-RateLimit-Remaining",
3246 type: {:list, :string},
3247 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3253 key: Pleroma.Web.Plugs.RemoteIp,
3256 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3257 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3263 description: "Enable/disable the plug. Default: disabled."
3267 type: {:list, :string},
3269 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
3274 type: {:list, :string},
3276 "A list of upstream proxy IP subnets in CIDR notation from which we will parse the content of `headers`. Defaults to `[]`. IPv4 entries without a bitmask will be assumed to be /32 and IPv6 /128."
3280 type: {:list, :string},
3282 A list of reserved IP subnets in CIDR notation which should be ignored if found in `headers`. Defaults to `["127.0.0.0/8", "::1/128", "fc00::/7", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]`
3289 key: :web_cache_ttl,
3290 label: "Web cache TTL",
3293 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3299 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3300 suggestions: [30_000, nil]
3303 key: :activity_pub_question,
3305 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3306 suggestions: [30_000]
3316 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3321 description: "Enables the rendering of static HTML. Default: disabled."
3329 description: "Configure feed rendering",
3334 description: "Configure title rendering",
3339 description: "Maximum number of characters before truncating title",
3345 description: "Replacement which will be used after truncating string",
3346 suggestions: ["..."]
3354 key: :mrf_object_age,
3356 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3357 label: "MRF Object Age",
3360 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3365 description: "Required age (in seconds) of a post before actions are taken.",
3366 suggestions: [172_800]
3370 type: {:list, :atom},
3372 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3373 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3374 "`:reject` rejects the message entirely",
3375 suggestions: [:delist, :strip_followers, :reject]
3383 description: "Custom Runtime Modules",
3388 description: "A path to custom Elixir modules (such as MRF policies)."
3396 description: "Settings for notifications streamer",
3401 description: "Number of workers to send notifications",
3405 key: :overflow_workers,
3407 description: "Maximum number of workers created if pool is empty",
3414 key: :connections_pool,
3416 description: "Advanced settings for `Gun` connections pool",
3419 key: :connection_acquisition_wait,
3422 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3426 key: :connection_acquisition_retries,
3429 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3433 key: :max_connections,
3435 description: "Maximum number of connections in the pool. Default: 250 connections.",
3439 key: :connect_timeout,
3441 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3445 key: :reclaim_multiplier,
3448 "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",
3457 description: "Advanced settings for `Gun` workers pools",
3459 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3463 description: "Settings for #{pool_name} pool.",
3468 description: "Maximum number of concurrent requests in the pool.",
3475 "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",
3481 description: "Timeout for the pool while gun will wait for response",
3482 suggestions: [10_000]
3490 key: :hackney_pools,
3492 description: "Advanced settings for `Hackney` connections pools",
3497 description: "Settings for federation pool.",
3500 key: :max_connections,
3502 description: "Number workers in the pool.",
3508 description: "Timeout while `hackney` will wait for response.",
3509 suggestions: [150_000]
3516 description: "Settings for media pool.",
3519 key: :max_connections,
3521 description: "Number workers in the pool.",
3527 description: "Timeout while `hackney` will wait for response.",
3528 suggestions: [150_000]
3535 description: "Settings for upload pool.",
3538 key: :max_connections,
3540 description: "Number workers in the pool.",
3546 description: "Timeout while `hackney` will wait for response.",
3547 suggestions: [300_000]
3555 key: :restrict_unauthenticated,
3556 label: "Restrict Unauthenticated",
3559 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3564 description: "Settings for public and federated timelines.",
3569 description: "Disallow view public timeline."
3574 description: "Disallow view federated timeline."
3581 description: "Settings for user profiles.",
3586 description: "Disallow view local user profiles."
3591 description: "Disallow view remote user profiles."
3598 description: "Settings for statuses.",
3603 description: "Disallow view local statuses."
3608 description: "Disallow view remote statuses."
3616 key: Pleroma.Web.ApiSpec.CastAndValidate,
3623 "Enables strict input validation (useful in development, not recommended in production)"
3629 key: :instances_favicons,
3631 description: "Control favicons for instances",
3636 description: "Allow/disallow displaying and getting instances favicons"
3644 descriptions: "S3 service related settings",
3647 key: :access_key_id,
3649 description: "S3 access key ID",
3650 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3653 key: :secret_access_key,
3655 description: "Secret access key",
3656 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3661 description: "S3 host",
3662 suggestions: ["s3.eu-central-1.amazonaws.com"]
3670 description: "Installed frontends management",
3675 description: "Primary frontend, the one that is served for all pages by default",
3676 children: installed_frontend_options
3681 description: "Admin frontend",
3682 children: installed_frontend_options
3688 "A map containing available frontends and parameters for their installation.",
3689 children: frontend_options
3695 key: Pleroma.Web.Preload,
3697 description: "Preload-related settings",
3701 type: {:list, :module},
3702 description: "List of preload providers to enable",
3704 Pleroma.Web.Preload.Providers.Instance,
3705 Pleroma.Web.Preload.Providers.User,
3706 Pleroma.Web.Preload.Providers.Timelines,
3707 Pleroma.Web.Preload.Providers.StatusNet
3716 description: "Majic/libmagic configuration",
3721 description: "Number of majic workers to start.",
3728 key: Pleroma.User.Backup,
3730 description: "Account Backup",
3733 key: :purge_after_days,
3735 description: "Remove backup achives after N days",
3741 description: "Limit user to export not more often than once per N days",
3748 key: Pleroma.Web.Endpoint.MetricsExporter,
3750 description: "Prometheus app metrics endpoint configuration",
3755 description: "[Pleroma extension] Enables app metrics endpoint."
3759 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3761 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3765 type: [:boolean, :tuple],
3766 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3767 suggestion: [false, {:basic, "myusername", "mypassword"}]
3772 description: "App metrics endpoint URI path.",
3773 suggestions: ["/api/pleroma/app_metrics"]
3778 description: "App metrics endpoint output format.",
3779 suggestions: [:text, :protobuf]