2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 installed_frontend_options = [
21 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
28 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
37 description: "Name of the frontend."
43 description: "Reference of the frontend to be used."
48 description: "URL of the git repository of the frontend"
54 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
55 example: "https://some.url/builds/${ref}.zip"
60 description: "The directory inside the zip file "
64 config :pleroma, :config_description, [
69 description: "Upload general settings",
74 description: "Module which will be used for uploads",
75 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
79 type: {:list, :module},
81 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
82 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
88 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
94 description: "Base URL for the uploads, needed if you use CDN",
96 "https://cdn-host.com"
103 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
107 label: "Proxy Options",
109 description: "Options for Pleroma.ReverseProxy",
111 redirect_on_failure: false,
112 max_body_length: 25 * 1_048_576,
114 follow_redirect: true,
120 key: :redirect_on_failure,
123 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
124 "Any error during body processing will not be redirected as the response is chunked."
127 key: :max_body_length,
130 "Limits the content length to be approximately the " <>
131 "specified length. It is validated with the `content-length` header and also verified when proxying."
137 description: "HTTP options",
142 description: "Adapter specific options",
147 label: "SSL Options",
148 description: "SSL options for HTTP adapter",
152 type: {:list, :atom},
153 description: "List of TLS versions to use",
154 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
163 type: [:string, :tuple],
164 description: "Proxy URL",
165 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
172 key: :filename_display_max_length,
174 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
180 key: Pleroma.Uploaders.Local,
182 description: "Local uploader-related settings",
187 description: "Path where user's uploads will be saved",
196 key: Pleroma.Uploaders.S3,
198 description: "S3 uploader-related settings",
203 description: "S3 bucket",
209 key: :bucket_namespace,
211 description: "S3 bucket namespace",
212 suggestions: ["pleroma"]
215 key: :public_endpoint,
217 description: "S3 endpoint",
218 suggestions: ["https://s3.amazonaws.com"]
221 key: :truncated_namespace,
224 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
225 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
228 key: :streaming_enabled,
231 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
237 key: Pleroma.Upload.Filter.Mogrify,
239 description: "Uploads mogrify filter settings",
243 type: [:string, {:list, :string}, {:list, :tuple}],
245 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
246 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
257 key: Pleroma.Upload.Filter.AnonymizeFilename,
259 description: "Filter replaces the filename of the upload",
265 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
266 " filename extension by using {extension}, for example custom-file-name.{extension}.",
268 "custom-file-name.{extension}"
275 key: Pleroma.Emails.Mailer,
277 description: "Mailer-related settings",
283 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
284 " or Swoosh.Adapters.Local for in-memory mailbox",
286 Swoosh.Adapters.SMTP,
287 Swoosh.Adapters.Sendgrid,
288 Swoosh.Adapters.Sendmail,
289 Swoosh.Adapters.Mandrill,
290 Swoosh.Adapters.Mailgun,
291 Swoosh.Adapters.Mailjet,
292 Swoosh.Adapters.Postmark,
293 Swoosh.Adapters.SparkPost,
294 Swoosh.Adapters.AmazonSES,
296 Swoosh.Adapters.SocketLabs,
297 Swoosh.Adapters.Gmail,
298 Swoosh.Adapters.Local
304 description: "Allow/disallow send emails"
307 group: {:subgroup, Swoosh.Adapters.SMTP},
310 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
311 suggestions: ["smtp.gmail.com"]
314 group: {:subgroup, Swoosh.Adapters.SMTP},
317 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
318 suggestions: ["pleroma"]
321 group: {:subgroup, Swoosh.Adapters.SMTP},
324 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
325 suggestions: ["password"]
328 group: {:subgroup, Swoosh.Adapters.SMTP},
332 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
335 group: {:subgroup, Swoosh.Adapters.SMTP},
339 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
340 suggestions: [:always, :never, :if_available]
343 group: {:subgroup, Swoosh.Adapters.SMTP},
346 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
347 suggestions: [:always, :never, :if_available]
350 group: {:subgroup, Swoosh.Adapters.SMTP},
353 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
357 group: {:subgroup, Swoosh.Adapters.SMTP},
360 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
364 group: {:subgroup, Swoosh.Adapters.SMTP},
366 label: "No MX lookups",
368 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
371 group: {:subgroup, Swoosh.Adapters.Sendgrid},
375 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
376 suggestions: ["my-api-key"]
379 group: {:subgroup, Swoosh.Adapters.Sendmail},
382 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
383 suggestions: ["/usr/bin/sendmail"]
386 group: {:subgroup, Swoosh.Adapters.Sendmail},
389 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
390 suggestions: ["-N delay,failure,success"]
393 group: {:subgroup, Swoosh.Adapters.Sendmail},
396 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
399 group: {:subgroup, Swoosh.Adapters.Mandrill},
403 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
404 suggestions: ["my-api-key"]
407 group: {:subgroup, Swoosh.Adapters.Mailgun},
411 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
412 suggestions: ["my-api-key"]
415 group: {:subgroup, Swoosh.Adapters.Mailgun},
418 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
419 suggestions: ["pleroma.com"]
422 group: {:subgroup, Swoosh.Adapters.Mailjet},
426 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
427 suggestions: ["my-api-key"]
430 group: {:subgroup, Swoosh.Adapters.Mailjet},
433 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
434 suggestions: ["my-secret-key"]
437 group: {:subgroup, Swoosh.Adapters.Postmark},
441 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
442 suggestions: ["my-api-key"]
445 group: {:subgroup, Swoosh.Adapters.SparkPost},
449 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
450 suggestions: ["my-api-key"]
453 group: {:subgroup, Swoosh.Adapters.SparkPost},
456 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
457 suggestions: ["https://api.sparkpost.com/api/v1"]
460 group: {:subgroup, Swoosh.Adapters.AmazonSES},
463 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
464 suggestions: ["us-east-1", "us-east-2"]
467 group: {:subgroup, Swoosh.Adapters.AmazonSES},
470 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
471 suggestions: ["aws-access-key"]
474 group: {:subgroup, Swoosh.Adapters.AmazonSES},
477 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
478 suggestions: ["aws-secret-key"]
481 group: {:subgroup, Swoosh.Adapters.Dyn},
485 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
486 suggestions: ["my-api-key"]
489 group: {:subgroup, Swoosh.Adapters.SocketLabs},
492 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
495 group: {:subgroup, Swoosh.Adapters.SocketLabs},
499 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
502 group: {:subgroup, Swoosh.Adapters.Gmail},
505 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
512 description: "`Swoosh.Adapters.Local` adapter specific settings",
515 group: {:subgroup, Swoosh.Adapters.Local},
518 description: "Run the preview server together as part of your app"
521 group: {:subgroup, Swoosh.Adapters.Local},
524 description: "The preview server port",
532 label: "URI Schemes",
534 description: "URI schemes related settings",
538 type: {:list, :string},
539 description: "List of the scheme part that is considered valid to be an URL",
564 description: "Instance-related settings",
569 description: "Name of the instance",
576 label: "Admin Email Address",
578 description: "Email used to reach an Administrator/Moderator of the instance",
585 label: "Sender Email Address",
587 description: "Envelope FROM address for mail sent via Pleroma",
596 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
604 description: "Posts character limit (CW/Subject included in the counter)",
612 description: "Character limit of the instance chat messages",
620 description: "Hard character limit beyond which remote posts will be dropped",
628 description: "File size limit of uploads (except for avatar, background, banner)",
634 key: :avatar_upload_limit,
636 description: "File size limit of user's profile avatars",
642 key: :background_upload_limit,
644 description: "File size limit of user's profile backgrounds",
650 key: :banner_upload_limit,
652 description: "File size limit of user's profile banners",
660 description: "A map with poll limits for local polls",
664 max_option_chars: 200,
666 max_expiration: 31_536_000
673 description: "Maximum number of options",
677 key: :max_option_chars,
679 description: "Maximum number of characters per option",
683 key: :min_expiration,
685 description: "Minimum expiration time (in seconds)",
689 key: :max_expiration,
691 description: "Maximum expiration time (in seconds)",
697 key: :registrations_open,
700 "Enable registrations for anyone. Invitations require this setting to be disabled."
703 key: :invites_enabled,
706 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
709 key: :account_activation_required,
711 description: "Require users to confirm their emails before signing in"
714 key: :account_approval_required,
716 description: "Require users to be manually approved by an admin before signing in"
721 description: "Enable federation with other instances"
724 key: :federation_incoming_replies_max_depth,
725 label: "Fed. incoming replies max depth",
728 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
729 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
735 key: :federation_reachability_timeout_days,
736 label: "Fed. reachability timeout days",
739 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
747 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
753 "Makes the client API in authenticated mode-only except for user-profiles." <>
754 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
755 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
758 key: :quarantined_instances,
759 type: {:list, :string},
761 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
768 key: :managed_config,
771 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
776 description: "Instance static directory",
782 key: :allowed_post_formats,
783 type: {:list, :string},
784 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
793 key: :extended_nickname_format,
796 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
797 " This will break federation with older software for theses nicknames."
800 key: :cleanup_attachments,
803 Enable to remove associated attachments when status is removed.
804 This will not affect duplicates and attachments without status.
805 Enabling this will increase load to database when deleting statuses on larger instances.
809 key: :max_pinned_statuses,
811 description: "The maximum number of pinned statuses. 0 will disable the feature.",
819 key: :autofollowed_nicknames,
820 type: {:list, :string},
822 "Set to nicknames of (local) users that every new user should automatically follow",
831 key: :attachment_links,
833 description: "Enable to automatically add attachment link text to statuses"
836 key: :max_report_comment_size,
838 description: "The maximum size of the report comment. Default: 1000.",
844 key: :safe_dm_mentions,
845 label: "Safe DM mentions",
848 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
849 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
855 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
858 key: :remote_post_retention_days,
861 "The default amount of days to retain remote posts when pruning the database",
867 key: :user_bio_length,
869 description: "A user bio maximum length. Default: 5000.",
875 key: :user_name_length,
877 description: "A user name maximum length. Default: 100.",
883 key: :skip_thread_containment,
885 description: "Skip filtering out broken threads. Default: enabled."
888 key: :limit_to_local_content,
889 type: {:dropdown, :atom},
891 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
899 key: :max_account_fields,
901 description: "The maximum number of custom fields in the user profile. Default: 10.",
907 key: :max_remote_account_fields,
910 "The maximum number of custom fields in the remote user profile. Default: 20.",
916 key: :account_field_name_length,
918 description: "An account field name maximum length. Default: 512.",
924 key: :account_field_value_length,
926 description: "An account field value maximum length. Default: 2048.",
932 key: :registration_reason_length,
934 description: "Maximum registration reason length. Default: 500.",
940 key: :external_user_synchronization,
942 description: "Enabling following/followers counters synchronization for external users"
945 key: :multi_factor_authentication,
947 description: "Multi-factor authentication settings",
950 totp: [digits: 6, period: 30],
951 backup_codes: [number: 5, length: 16]
957 label: "TOTP settings",
959 description: "TOTP settings",
960 suggestions: [digits: 6, period: 30],
967 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
974 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
981 description: "MFA backup codes settings",
982 suggestions: [number: 5, length: 16],
988 description: "Number of backup codes to generate."
995 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
1002 key: :instance_thumbnail,
1003 type: {:string, :image},
1005 "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.",
1006 suggestions: ["/instance/thumbnail.jpeg"]
1009 key: :show_reactions,
1011 description: "Let favourites and emoji reactions be viewed through the API."
1019 description: "Welcome messages settings",
1022 key: :direct_message,
1024 descpiption: "Direct message settings",
1029 description: "Enables sending a direct message to newly registered users"
1034 description: "A message that will be sent to newly registered users",
1036 "Hi, @username! Welcome on board!"
1040 key: :sender_nickname,
1042 description: "The nickname of the local user that sends a welcome message",
1052 descpiption: "Chat message settings",
1057 description: "Enables sending a chat message to newly registered users"
1063 "A message that will be sent to newly registered users as a chat message",
1065 "Hello, welcome on board!"
1069 key: :sender_nickname,
1071 description: "The nickname of the local user that sends a welcome chat message",
1081 descpiption: "Email message settings",
1086 description: "Enables sending an email to newly registered users"
1090 type: [:string, :tuple],
1092 "Email address and/or nickname that will be used to send the welcome email.",
1094 {"Pleroma App", "welcome@pleroma.app"}
1101 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1102 suggestions: ["Welcome to <%= instance_name%>"]
1108 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1109 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1115 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1116 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1125 description: "Logger-related settings",
1129 type: [:atom, :tuple, :module],
1131 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1132 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1140 label: "ExSyslogger",
1141 description: "ExSyslogger-related settings",
1145 type: {:dropdown, :atom},
1146 description: "Log level",
1147 suggestions: [:debug, :info, :warn, :error]
1153 "A string that's prepended to every message, and is typically set to the app name",
1154 suggestions: ["pleroma"]
1159 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1160 suggestions: ["$metadata[$level] $message"]
1164 type: {:list, :atom},
1165 suggestions: [:request_id]
1173 label: "Console Logger",
1174 description: "Console logger settings",
1178 type: {:dropdown, :atom},
1179 description: "Log level",
1180 suggestions: [:debug, :info, :warn, :error]
1185 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1186 suggestions: ["$metadata[$level] $message"]
1190 type: {:list, :atom},
1191 suggestions: [:request_id]
1198 label: "Quack Logger",
1199 description: "Quack-related settings",
1203 type: {:dropdown, :atom},
1204 description: "Log level",
1205 suggestions: [:debug, :info, :warn, :error]
1209 type: {:list, :atom},
1210 description: "Configure which metadata you want to report on",
1227 label: "Webhook URL",
1229 description: "Configure the Slack incoming webhook",
1230 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1236 key: :frontend_configurations,
1239 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1240 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1241 "add your own configuration your settings all fields must be complete.",
1245 label: "Pleroma FE",
1247 description: "Settings for Pleroma FE",
1250 alwaysShowSubjectInput: true,
1251 background: "/static/aurora_borealis.jpg",
1252 collapseMessageWithSubject: false,
1255 hideFilteredStatuses: false,
1256 hideMutedPosts: false,
1257 hidePostStats: false,
1258 hideSitename: false,
1259 hideUserStats: false,
1260 loginMethod: "password",
1261 logo: "/static/logo.png",
1264 minimalScopesMode: false,
1265 noAttachmentLinks: false,
1266 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1267 postContentType: "text/plain",
1268 redirectRootLogin: "/main/friends",
1269 redirectRootNoLogin: "/main/all",
1271 sidebarRight: false,
1272 showFeaturesPanel: true,
1273 showInstanceSpecificPanel: false,
1274 subjectLineBehavior: "email",
1275 theme: "pleroma-dark",
1276 webPushNotifications: false
1281 key: :alwaysShowSubjectInput,
1282 label: "Always show subject input",
1284 description: "When disabled, auto-hide the subject field if it's empty"
1288 type: {:string, :image},
1290 "URL of the background, unless viewing a user profile with a background that is set",
1291 suggestions: ["/images/city.jpg"]
1294 key: :collapseMessageWithSubject,
1295 label: "Collapse message with subject",
1298 "When a message has a subject (aka Content Warning), collapse it by default"
1302 label: "PleromaFE Chat",
1304 description: "Disables PleromaFE Chat component"
1310 description: "Enables green text on lines prefixed with the > character"
1313 key: :hideFilteredStatuses,
1314 label: "Hide Filtered Statuses",
1316 description: "Hides filtered statuses from timelines"
1319 key: :hideMutedPosts,
1320 label: "Hide Muted Posts",
1322 description: "Hides muted statuses from timelines"
1325 key: :hidePostStats,
1326 label: "Hide post stats",
1328 description: "Hide notices statistics (repeats, favorites, ...)"
1332 label: "Hide Sitename",
1334 description: "Hides instance name from PleromaFE banner"
1337 key: :hideUserStats,
1338 label: "Hide user stats",
1341 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1345 type: {:string, :image},
1346 description: "URL of the logo, defaults to Pleroma's logo",
1347 suggestions: ["/static/logo.png"]
1351 label: "Logo margin",
1354 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1355 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1356 suggestions: [".1em"]
1363 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1364 "If you want a colorful logo you must disable logoMask."
1367 key: :minimalScopesMode,
1368 label: "Minimal scopes mode",
1371 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1372 "Also prevents replying to a DM with a public post from PleromaFE."
1375 key: :nsfwCensorImage,
1376 label: "NSFW Censor Image",
1377 type: {:string, :image},
1379 "URL of the image to use for hiding NSFW media attachments in the timeline",
1380 suggestions: ["/static/img/nsfw.74818f9.png"]
1383 key: :postContentType,
1384 label: "Post Content Type",
1385 type: {:dropdown, :atom},
1386 description: "Default post formatting option",
1387 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1390 key: :redirectRootNoLogin,
1391 label: "Redirect root no login",
1394 "Relative URL which indicates where to redirect when a user isn't logged in",
1395 suggestions: ["/main/all"]
1398 key: :redirectRootLogin,
1399 label: "Redirect root login",
1402 "Relative URL which indicates where to redirect when a user is logged in",
1403 suggestions: ["/main/friends"]
1407 label: "Scope copy",
1409 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1413 label: "Sidebar on Right",
1415 description: "Change alignment of sidebar and panels to the right"
1418 key: :showFeaturesPanel,
1419 label: "Show instance features panel",
1422 "Enables panel displaying functionality of the instance on the About page"
1425 key: :showInstanceSpecificPanel,
1426 label: "Show instance specific panel",
1428 description: "Whether to show the instance's custom panel"
1431 key: :subjectLineBehavior,
1432 label: "Subject line behavior",
1434 description: "Allows changing the default behaviour of subject lines in replies.
1435 `email`: copy and preprend re:, as in email,
1436 `masto`: copy verbatim, as in Mastodon,
1437 `noop`: don't copy the subject.",
1438 suggestions: ["email", "masto", "noop"]
1443 description: "Which theme to use. Available themes are defined in styles.json",
1444 suggestions: ["pleroma-dark"]
1452 description: "Settings for Masto FE",
1455 showInstanceSpecificPanel: true
1460 key: :showInstanceSpecificPanel,
1461 label: "Show instance specific panel",
1463 description: "Whenether to show the instance's specific panel"
1474 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1478 type: {:keyword, :map},
1480 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1483 url: "/images/pleroma-fox-tan-smol.png",
1484 mime_type: "image/png"
1486 pleroma_fox_tan_shy: %{
1487 url: "/images/pleroma-fox-tan-shy.png",
1488 mime_type: "image/png"
1493 key: :default_mascot,
1496 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1502 key: :default_user_avatar,
1503 type: {:string, :image},
1504 description: "URL of the default user avatar",
1505 suggestions: ["/images/avi.png"]
1514 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1518 type: {:list, :map},
1519 description: "Describe the icons of the app",
1522 src: "/static/logo.png"
1525 src: "/static/icon.png",
1529 src: "/static/icon.ico",
1530 sizes: "72x72 96x96 128x128 256x256"
1537 description: "Describe the theme color of the app",
1538 suggestions: ["#282c37", "mediumpurple"]
1541 key: :background_color,
1543 description: "Describe the background color of the app",
1544 suggestions: ["#191b22", "aliceblue"]
1554 description: "General MRF settings",
1558 type: [:module, {:list, :module}],
1560 "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.",
1561 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1565 label: "MRF transparency",
1568 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1571 key: :transparency_exclusions,
1572 label: "MRF transparency exclusions",
1573 type: {:list, :string},
1575 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1586 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1587 label: "MRF Simple",
1589 description: "Simple ingress policies",
1592 key: :media_removal,
1593 type: {:list, :string},
1594 description: "List of instances to strip media attachments from",
1595 suggestions: ["example.com", "*.example.com"]
1599 label: "Media NSFW",
1600 type: {:list, :string},
1601 description: "List of instances to tag all media as NSFW (sensitive) from",
1602 suggestions: ["example.com", "*.example.com"]
1605 key: :federated_timeline_removal,
1606 type: {:list, :string},
1608 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1609 suggestions: ["example.com", "*.example.com"]
1613 type: {:list, :string},
1614 description: "List of instances to reject activities from (except deletes)",
1615 suggestions: ["example.com", "*.example.com"]
1619 type: {:list, :string},
1620 description: "List of instances to only accept activities from (except deletes)",
1621 suggestions: ["example.com", "*.example.com"]
1624 key: :followers_only,
1625 type: {:list, :string},
1626 description: "Force posts from the given instances to be visible by followers only",
1627 suggestions: ["example.com", "*.example.com"]
1630 key: :report_removal,
1631 type: {:list, :string},
1632 description: "List of instances to reject reports from",
1633 suggestions: ["example.com", "*.example.com"]
1636 key: :avatar_removal,
1637 type: {:list, :string},
1638 description: "List of instances to strip avatars from",
1639 suggestions: ["example.com", "*.example.com"]
1642 key: :banner_removal,
1643 type: {:list, :string},
1644 description: "List of instances to strip banners from",
1645 suggestions: ["example.com", "*.example.com"]
1648 key: :reject_deletes,
1649 type: {:list, :string},
1650 description: "List of instances to reject deletions from",
1651 suggestions: ["example.com", "*.example.com"]
1657 key: :mrf_activity_expiration,
1659 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1660 label: "MRF Activity Expiration Policy",
1662 description: "Adds automatic expiration to all local activities",
1667 description: "Default global expiration time for all local activities (in days)",
1668 suggestions: [90, 365]
1676 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1677 label: "MRF Subchain",
1680 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1681 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1685 type: {:map, {:list, :string}},
1686 description: "Matches a series of regular expressions against the actor field",
1689 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1697 key: :mrf_rejectnonpublic,
1699 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1700 description: "RejectNonPublic drops posts with non-public visibility settings.",
1701 label: "MRF Reject Non Public",
1705 key: :allow_followersonly,
1706 label: "Allow followers-only",
1708 description: "Whether to allow followers-only posts"
1713 description: "Whether to allow direct messages"
1719 key: :mrf_hellthread,
1721 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1722 label: "MRF Hellthread",
1724 description: "Block messages with excessive user mentions",
1727 key: :delist_threshold,
1730 "Number of mentioned users after which the message gets removed from timelines and" <>
1731 "disables notifications. Set to 0 to disable.",
1735 key: :reject_threshold,
1738 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1747 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1748 label: "MRF Keyword",
1750 description: "Reject or Word-Replace messages with a keyword or regex",
1754 type: {:list, :string},
1756 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1757 suggestions: ["foo", ~r/foo/iu]
1760 key: :federated_timeline_removal,
1761 type: {:list, :string},
1763 "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.",
1764 suggestions: ["foo", ~r/foo/iu]
1768 type: {:list, :tuple},
1770 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1771 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1779 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1780 label: "MRF Mention",
1782 description: "Block messages which mention a specific user",
1786 type: {:list, :string},
1787 description: "A list of actors for which any post mentioning them will be dropped",
1788 suggestions: ["actor1", "actor2"]
1794 key: :mrf_vocabulary,
1796 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1797 label: "MRF Vocabulary",
1799 description: "Filter messages which belong to certain activity vocabularies",
1803 type: {:list, :string},
1805 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1806 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1810 type: {:list, :string},
1812 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1813 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1819 # key: :mrf_user_allowlist,
1821 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1824 # "The keys in this section are the domain names that the policy should apply to." <>
1825 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1827 # %{"example.org" => ["https://example.org/users/admin"]}
1835 description: "Media proxy",
1840 description: "Enables proxying of remote media to the instance's proxy"
1847 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1848 suggestions: ["https://example.com"]
1856 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1862 description: "Enables media cache object invalidation."
1867 description: "Module which will be used to purge objects from the cache.",
1869 Pleroma.Web.MediaProxy.Invalidation.Script,
1870 Pleroma.Web.MediaProxy.Invalidation.Http
1877 label: "Proxy Options",
1879 description: "Options for Pleroma.ReverseProxy",
1881 redirect_on_failure: false,
1882 max_body_length: 25 * 1_048_576,
1883 max_read_duration: 30_000,
1885 follow_redirect: true,
1891 key: :redirect_on_failure,
1894 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1895 "Any error during body processing will not be redirected as the response is chunked."
1898 key: :max_body_length,
1901 "Limits the content length to be approximately the " <>
1902 "specified length. It is validated with the `content-length` header and also verified when proxying."
1905 key: :max_read_duration,
1907 description: "Timeout (in milliseconds) of GET request to remote URI."
1913 description: "HTTP options",
1918 description: "Adapter specific options",
1923 label: "SSL Options",
1924 description: "SSL options for HTTP adapter",
1928 type: {:list, :atom},
1929 description: "List of TLS version to use",
1930 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1939 type: [:string, :tuple],
1940 description: "Proxy URL",
1941 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1949 type: {:list, :string},
1950 description: "List of hosts with scheme to bypass the mediaproxy",
1951 suggestions: ["http://example.com"]
1957 key: :media_preview_proxy,
1959 description: "Media preview proxy",
1965 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1968 key: :thumbnail_max_width,
1970 description: "Max width of preview thumbnail."
1973 key: :thumbnail_max_height,
1975 description: "Max height of preview thumbnail."
1978 key: :image_quality,
1980 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1985 description: "Media proxy options",
1987 head_request_max_read_duration: 5_000
1991 key: :head_request_max_read_duration,
1993 description: "Timeout (in milliseconds) of HEAD request to remote URI."
1999 type: {:list, :string},
2000 description: "List of hosts with scheme to bypass the mediaproxy",
2001 suggestions: ["http://example.com"]
2007 key: Pleroma.Web.MediaProxy.Invalidation.Http,
2009 description: "HTTP invalidate settings",
2014 description: "HTTP method of request. Default: :purge"
2018 type: {:keyword, :string},
2019 description: "HTTP headers of request",
2020 suggestions: [{"x-refresh", 1}]
2025 description: "Request options",
2029 type: {:map, :string}
2037 key: Pleroma.Web.MediaProxy.Invalidation.Script,
2039 description: "Script invalidate settings",
2044 description: "Path to shell script. Which will run purge cache.",
2045 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2053 description: "Gopher settings",
2058 description: "Enables the gopher interface"
2064 description: "IP address to bind to",
2065 suggestions: [{0, 0, 0, 0}]
2070 description: "Port to bind to",
2076 description: "Port advertised in URLs (optional, defaults to port)",
2084 label: "ActivityPub",
2086 description: "ActivityPub-related settings",
2089 key: :unfollow_blocked,
2091 description: "Whether blocks result in people getting unfollowed"
2094 key: :outgoing_blocks,
2096 description: "Whether to federate blocks to other instances"
2099 key: :sign_object_fetches,
2101 description: "Sign object fetches with HTTP signatures"
2104 key: :note_replies_output_limit,
2107 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2110 key: :follow_handshake_timeout,
2112 description: "Following handshake timeout",
2119 key: :http_security,
2120 label: "HTTP security",
2122 description: "HTTP security settings",
2127 description: "Whether the managed content security policy is enabled"
2133 description: "Whether to additionally send a Strict-Transport-Security header"
2137 label: "STS max age",
2139 description: "The maximum age for the Strict-Transport-Security header if sent",
2140 suggestions: [31_536_000]
2144 label: "CT max age",
2146 description: "The maximum age for the Expect-CT header if sent",
2147 suggestions: [2_592_000]
2150 key: :referrer_policy,
2152 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2153 suggestions: ["same-origin", "no-referrer"]
2157 label: "Report URI",
2159 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2160 suggestions: ["https://example.com/report-uri"]
2165 group: :web_push_encryption,
2166 key: :vapid_details,
2167 label: "Vapid Details",
2170 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2176 "A mailto link for the administrative contact." <>
2177 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2178 suggestions: ["mailto:moderators@pleroma.com"]
2183 description: "VAPID public key",
2184 suggestions: ["Public key"]
2189 description: "VAPID private key",
2190 suggestions: ["Private key"]
2196 key: Pleroma.Captcha,
2198 description: "Captcha-related settings",
2203 description: "Whether the captcha should be shown on registration"
2208 description: "The method/service to use for captcha",
2209 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2212 key: :seconds_valid,
2214 description: "The time in seconds for which the captcha is valid",
2221 key: Pleroma.Captcha.Kocaptcha,
2224 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2225 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2230 description: "The kocaptcha endpoint to use",
2231 suggestions: ["https://captcha.kotobank.ch"]
2237 label: "Pleroma Admin Token",
2240 "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)",
2245 description: "Admin token",
2247 "Please use a high entropy string or UUID"
2257 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2259 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2260 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2261 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2262 (see https://github.com/sorentwo/oban/issues/52).
2267 type: {:dropdown, :atom},
2268 description: "Logs verbose mode",
2269 suggestions: [false, :error, :warn, :info, :debug]
2273 type: {:keyword, :integer},
2275 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2277 activity_expiration: 10,
2278 attachments_cleanup: 5,
2280 federator_incoming: 50,
2281 federator_outgoing: 50,
2283 scheduled_activities: 10,
2289 key: :activity_expiration,
2291 description: "Activity expiration queue",
2295 key: :attachments_cleanup,
2297 description: "Attachment deletion queue",
2303 description: "Background queue",
2307 key: :federator_incoming,
2309 description: "Incoming federation queue",
2313 key: :federator_outgoing,
2315 description: "Outgoing federation queue",
2321 description: "Email sender queue, see Pleroma.Emails.Mailer",
2325 key: :scheduled_activities,
2327 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2331 key: :transmogrifier,
2333 description: "Transmogrifier queue",
2339 description: "Web push notifications queue",
2346 type: {:list, :tuple},
2347 description: "Settings for cron background jobs",
2349 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2350 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2351 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2352 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2353 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2362 description: "Includes custom worker options not interpretable directly by `Oban`",
2366 type: {:keyword, :integer},
2367 description: "Max retry attempts for failed jobs, per `Oban` queue",
2369 federator_incoming: 5,
2370 federator_outgoing: 5
2377 key: Pleroma.Web.Metadata,
2379 description: "Metadata-related settings",
2383 type: {:list, :module},
2384 description: "List of metadata providers to enable",
2386 Pleroma.Web.Metadata.Providers.OpenGraph,
2387 Pleroma.Web.Metadata.Providers.TwitterCard,
2388 Pleroma.Web.Metadata.Providers.RelMe,
2389 Pleroma.Web.Metadata.Providers.Feed
2394 label: "Unfurl NSFW",
2396 description: "When enabled NSFW attachments will be shown in previews"
2405 "If enabled the instance will parse metadata from attached links to generate link previews",
2410 description: "Enables RichMedia parsing of URLs"
2414 type: {:list, :string},
2415 description: "List of hosts which will be ignored by the metadata parser",
2416 suggestions: ["accounts.google.com", "xss.website"]
2420 label: "Ignore TLD",
2421 type: {:list, :string},
2422 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2423 suggestions: ["local", "localdomain", "lan"]
2427 type: {:list, :module},
2429 "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.",
2431 Pleroma.Web.RichMedia.Parsers.OEmbed,
2432 Pleroma.Web.RichMedia.Parsers.TwitterCard
2437 label: "TTL setters",
2438 type: {:list, :module},
2440 "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.",
2442 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2449 key: Pleroma.Formatter,
2450 label: "Auto Linker",
2453 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2457 type: [:string, :boolean],
2458 description: "Specify the class to be added to the generated link. Disable to clear.",
2459 suggestions: ["auto-linker", false]
2463 type: [:string, :boolean],
2464 description: "Override the rel attribute. Disable to clear.",
2465 suggestions: ["ugc", "noopener noreferrer", false]
2470 description: "Link URLs will open in a new window/tab."
2474 type: [:integer, :boolean],
2476 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2477 suggestions: [15, false]
2482 description: "Strip the scheme prefix."
2487 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2491 type: [:atom, :boolean],
2493 "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)",
2494 suggestions: [:no_scheme, true]
2500 key: Pleroma.ScheduledActivity,
2502 description: "Scheduled activities settings",
2505 key: :daily_user_limit,
2508 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2512 key: :total_user_limit,
2515 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2521 description: "Whether scheduled activities are sent to the job queue to be executed"
2527 key: Pleroma.ActivityExpiration,
2529 description: "Expired activity settings",
2534 description: "Whether expired activities will be sent to the job queue to be deleted"
2540 label: "Pleroma Authenticator",
2542 description: "Authenticator",
2545 key: Pleroma.Web.Auth.Authenticator,
2547 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2557 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2558 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2559 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2560 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2565 description: "Enables LDAP authentication"
2570 description: "LDAP server hostname",
2571 suggestions: ["localhosts"]
2576 description: "LDAP port, e.g. 389 or 636",
2577 suggestions: [389, 636]
2583 description: "Enable to use SSL, usually implies the port 636"
2587 label: "SSL options",
2589 description: "Additional SSL options",
2590 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2595 description: "Path to file with PEM encoded cacerts",
2596 suggestions: ["path/to/file/with/PEM/cacerts"]
2601 description: "Type of cert verification",
2602 suggestions: [:verify_peer]
2610 description: "Enable to use STARTTLS, usually implies the port 389"
2614 label: "TLS options",
2616 description: "Additional TLS options",
2617 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2622 description: "Path to file with PEM encoded cacerts",
2623 suggestions: ["path/to/file/with/PEM/cacerts"]
2628 description: "Type of cert verification",
2629 suggestions: [:verify_peer]
2636 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2637 suggestions: ["dc=example,dc=com"]
2644 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2653 description: "Authentication / authorization settings",
2656 key: :enforce_oauth_admin_scope_usage,
2657 label: "Enforce OAuth admin scope usage",
2660 "OAuth admin scope requirement toggle. " <>
2661 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2662 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2663 "`is_admin` user flag grants access to admin-specific actions."
2666 key: :auth_template,
2669 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2670 suggestions: ["show.html"]
2673 key: :oauth_consumer_template,
2674 label: "OAuth consumer template",
2677 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2678 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2679 suggestions: ["consumer.html"]
2682 key: :oauth_consumer_strategies,
2683 label: "OAuth consumer strategies",
2684 type: {:list, :string},
2686 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2687 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2688 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2689 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2695 key: :email_notifications,
2697 description: "Email notifications settings",
2703 "emails of \"what you've missed\" for users who have been inactive for a while",
2707 schedule: "0 0 * * 0",
2709 inactivity_threshold: 7
2717 description: "Globally enable or disable digest emails"
2723 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2724 suggestions: ["0 0 * * 0"]
2729 description: "Minimum interval between digest emails to one user",
2733 key: :inactivity_threshold,
2735 description: "Minimum user inactivity threshold",
2744 key: Pleroma.Emails.UserEmail,
2746 description: "Email template settings",
2750 type: {:string, :image},
2751 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2752 suggestions: ["some/path/logo.png"]
2757 description: "A map with color settings for email templates.",
2760 link_color: "#d8a070",
2761 background_color: "#2C3645",
2762 content_background_color: "#1B2635",
2763 header_color: "#d8a070",
2764 text_color: "#b9b9ba",
2765 text_muted_color: "#b9b9ba"
2772 suggestions: ["#d8a070"]
2775 key: :background_color,
2777 suggestions: ["#2C3645"]
2780 key: :content_background_color,
2782 suggestions: ["#1B2635"]
2787 suggestions: ["#d8a070"]
2792 suggestions: ["#b9b9ba"]
2795 key: :text_muted_color,
2797 suggestions: ["#b9b9ba"]
2805 key: Pleroma.Emails.NewUsersDigestEmail,
2807 description: "New users admin email digest",
2812 description: "Enables new users admin digest email when `true`"
2821 description: "Configure OAuth 2 provider capabilities",
2824 key: :token_expires_in,
2826 description: "The lifetime in seconds of the access token",
2830 key: :issue_new_refresh_token,
2833 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2836 key: :clean_expired_tokens,
2838 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2848 key: :shortcode_globs,
2849 type: {:list, :string},
2850 description: "Location of custom emoji files. * can be used as a wildcard.",
2851 suggestions: ["/emoji/custom/**/*.png"]
2854 key: :pack_extensions,
2855 type: {:list, :string},
2857 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2858 suggestions: [".png", ".gif"]
2862 type: {:keyword, {:list, :string}},
2864 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2865 " and the value is the location or array of locations. * can be used as a wildcard.",
2867 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2871 key: :default_manifest,
2874 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2875 " Currently only one manifest can be added (no arrays).",
2876 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2879 key: :shared_pack_cache_seconds_per_file,
2880 label: "Shared pack cache s/file",
2883 "When an emoji pack is shared, the archive is created and cached in memory" <>
2884 " for this amount of seconds multiplied by the number of files.",
2894 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2898 type: [:tuple, {:list, :tuple}],
2899 description: "For the search requests (account & status search etc.)",
2900 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2904 type: [:tuple, {:list, :tuple}],
2905 description: "For requests to timelines (each timeline has it's own limiter)",
2906 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2909 key: :app_account_creation,
2910 type: [:tuple, {:list, :tuple}],
2911 description: "For registering user accounts from the same IP address",
2912 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2915 key: :relations_actions,
2916 type: [:tuple, {:list, :tuple}],
2917 description: "For actions on relationships with all users (follow, unfollow)",
2918 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2921 key: :relation_id_action,
2922 label: "Relation ID action",
2923 type: [:tuple, {:list, :tuple}],
2924 description: "For actions on relation with a specific user (follow, unfollow)",
2925 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2928 key: :statuses_actions,
2929 type: [:tuple, {:list, :tuple}],
2931 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2932 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2935 key: :status_id_action,
2936 label: "Status ID action",
2937 type: [:tuple, {:list, :tuple}],
2939 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2940 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2943 key: :authentication,
2944 type: [:tuple, {:list, :tuple}],
2945 description: "For authentication create / password check / user existence check requests",
2946 suggestions: [{60_000, 15}]
2955 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2956 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2961 description: "Enables SSH"
2966 description: "Dir with SSH keys",
2967 suggestions: ["/some/path/ssh_keys"]
2972 description: "Handler module",
2973 suggestions: ["Pleroma.BBS.Handler"]
2978 description: "Port to connect",
2979 suggestions: [10_022]
2982 key: :password_authenticator,
2984 description: "Authenticator module",
2985 suggestions: ["Pleroma.BBS.Authenticator"]
2991 label: "Mime Types",
2993 description: "Mime Types settings",
3000 "application/xml" => ["xml"],
3001 "application/xrd+xml" => ["xrd+xml"],
3002 "application/jrd+json" => ["jrd+json"],
3003 "application/activity+json" => ["activity+json"],
3004 "application/ld+json" => ["activity+json"]
3009 key: "application/xml",
3010 type: {:list, :string},
3011 suggestions: ["xml"]
3014 key: "application/xrd+xml",
3015 type: {:list, :string},
3016 suggestions: ["xrd+xml"]
3019 key: "application/jrd+json",
3020 type: {:list, :string},
3021 suggestions: ["jrd+json"]
3024 key: "application/activity+json",
3025 type: {:list, :string},
3026 suggestions: ["activity+json"]
3029 key: "application/ld+json",
3030 type: {:list, :string},
3031 suggestions: ["activity+json"]
3041 description: "Pleroma chat settings",
3054 description: "HTTP settings",
3059 type: [:string, :tuple],
3060 description: "Proxy URL",
3061 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3064 key: :send_user_agent,
3069 type: [:string, :atom],
3071 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3072 suggestions: ["Pleroma", :default]
3077 description: "Adapter specific options",
3083 label: "SSL Options",
3084 description: "SSL options for HTTP adapter",
3088 type: {:list, :atom},
3089 description: "List of TLS version to use",
3090 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3101 label: "Markup Settings",
3105 key: :allow_inline_images,
3109 key: :allow_headings,
3122 type: {:list, :module},
3124 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3125 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3135 key: :deny_follow_blocked,
3142 key: :mrf_normalize_markup,
3144 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3145 label: "MRF Normalize Markup",
3146 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3152 suggestions: [Pleroma.HTML.Scrubber.Default]
3162 key: :restricted_nicknames,
3163 type: {:list, :string},
3164 description: "List of nicknames users may not register with.",
3183 "ostatus_subscribe",
3199 key: :email_blacklist,
3200 type: {:list, :string},
3201 description: "List of email domains users may not register with.",
3202 suggestions: ["mailinator.com", "maildrop.cc"]
3208 label: "CORS plug config",
3214 suggestions: [86_400]
3218 type: {:list, :string},
3219 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3223 type: {:list, :string},
3226 "X-RateLimit-Reset",
3227 "X-RateLimit-Limit",
3228 "X-RateLimit-Remaining",
3239 type: {:list, :string},
3240 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3246 key: Pleroma.Plugs.RemoteIp,
3249 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3250 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3256 description: "Enable/disable the plug. Default: disabled."
3260 type: {:list, :string},
3262 "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]`."
3266 type: {:list, :string},
3268 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3272 type: {:list, :string},
3274 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3280 key: :web_cache_ttl,
3281 label: "Web cache TTL",
3284 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3290 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3291 suggestions: [30_000, nil]
3294 key: :activity_pub_question,
3296 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3297 suggestions: [30_000]
3307 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3312 description: "Enables the rendering of static HTML. Default: disabled."
3320 description: "Configure feed rendering",
3325 description: "Configure title rendering",
3330 description: "Maximum number of characters before truncating title",
3336 description: "Replacement which will be used after truncating string",
3337 suggestions: ["..."]
3345 key: :mrf_object_age,
3347 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3348 label: "MRF Object Age",
3351 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3356 description: "Required age (in seconds) of a post before actions are taken.",
3357 suggestions: [172_800]
3361 type: {:list, :atom},
3363 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3364 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3365 "`:reject` rejects the message entirely",
3366 suggestions: [:delist, :strip_followers, :reject]
3374 description: "Custom Runtime Modules",
3379 description: "A path to custom Elixir modules (such as MRF policies)."
3387 description: "Settings for notifications streamer",
3392 description: "Number of workers to send notifications",
3396 key: :overflow_workers,
3398 description: "Maximum number of workers created if pool is empty",
3405 key: :connections_pool,
3407 description: "Advanced settings for `Gun` connections pool",
3410 key: :connection_acquisition_wait,
3413 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3417 key: :connection_acquisition_retries,
3420 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3424 key: :max_connections,
3426 description: "Maximum number of connections in the pool. Default: 250 connections.",
3430 key: :await_up_timeout,
3432 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3436 key: :reclaim_multiplier,
3439 "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",
3448 description: "Advanced settings for `Gun` workers pools",
3450 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3454 description: "Settings for #{pool_name} pool.",
3459 description: "Maximum number of concurrent requests in the pool.",
3466 "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",
3475 key: :hackney_pools,
3477 description: "Advanced settings for `Hackney` connections pools",
3482 description: "Settings for federation pool.",
3485 key: :max_connections,
3487 description: "Number workers in the pool.",
3493 description: "Timeout while `hackney` will wait for response.",
3494 suggestions: [150_000]
3501 description: "Settings for media pool.",
3504 key: :max_connections,
3506 description: "Number workers in the pool.",
3512 description: "Timeout while `hackney` will wait for response.",
3513 suggestions: [150_000]
3520 description: "Settings for upload pool.",
3523 key: :max_connections,
3525 description: "Number workers in the pool.",
3531 description: "Timeout while `hackney` will wait for response.",
3532 suggestions: [300_000]
3540 key: :restrict_unauthenticated,
3541 label: "Restrict Unauthenticated",
3544 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3549 description: "Settings for public and federated timelines.",
3554 description: "Disallow view public timeline."
3559 description: "Disallow view federated timeline."
3566 description: "Settings for user profiles.",
3571 description: "Disallow view local user profiles."
3576 description: "Disallow view remote user profiles."
3583 description: "Settings for statuses.",
3588 description: "Disallow view local statuses."
3593 description: "Disallow view remote statuses."
3601 key: Pleroma.Web.ApiSpec.CastAndValidate,
3608 "Enables strict input validation (useful in development, not recommended in production)"
3614 key: :instances_favicons,
3616 description: "Control favicons for instances",
3621 description: "Allow/disallow displaying and getting instances favicons"
3629 descriptions: "S3 service related settings",
3632 key: :access_key_id,
3634 description: "S3 access key ID",
3635 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3638 key: :secret_access_key,
3640 description: "Secret access key",
3641 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3646 description: "S3 host",
3647 suggestions: ["s3.eu-central-1.amazonaws.com"]
3655 description: "Installed frontends management",
3660 description: "Primary frontend, the one that is served for all pages by default",
3661 children: installed_frontend_options
3666 description: "Admin frontend",
3667 children: installed_frontend_options
3673 "A map containing available frontends and parameters for their installation.",
3682 key: Pleroma.Web.Preload,
3684 description: "Preload-related settings",
3688 type: {:list, :module},
3689 description: "List of preload providers to enable",
3691 Pleroma.Web.Preload.Providers.Instance,
3692 Pleroma.Web.Preload.Providers.User,
3693 Pleroma.Web.Preload.Providers.Timelines,
3694 Pleroma.Web.Preload.Providers.StatusNet