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,
1884 follow_redirect: true,
1890 key: :redirect_on_failure,
1893 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1894 "Any error during body processing will not be redirected as the response is chunked."
1897 key: :max_body_length,
1900 "Limits the content length to be approximately the " <>
1901 "specified length. It is validated with the `content-length` header and also verified when proxying."
1907 description: "HTTP options",
1912 description: "Adapter specific options",
1917 label: "SSL Options",
1918 description: "SSL options for HTTP adapter",
1922 type: {:list, :atom},
1923 description: "List of TLS version to use",
1924 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1933 type: [:string, :tuple],
1934 description: "Proxy URL",
1935 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1943 type: {:list, :string},
1944 description: "List of hosts with scheme to bypass the mediaproxy",
1945 suggestions: ["http://example.com"]
1951 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1953 description: "HTTP invalidate settings",
1958 description: "HTTP method of request. Default: :purge"
1962 type: {:keyword, :string},
1963 description: "HTTP headers of request",
1964 suggestions: [{"x-refresh", 1}]
1969 description: "Request options",
1973 type: {:map, :string}
1981 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1983 description: "Script invalidate settings",
1988 description: "Path to shell script. Which will run purge cache.",
1989 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1997 description: "Gopher settings",
2002 description: "Enables the gopher interface"
2008 description: "IP address to bind to",
2009 suggestions: [{0, 0, 0, 0}]
2014 description: "Port to bind to",
2020 description: "Port advertised in URLs (optional, defaults to port)",
2028 label: "ActivityPub",
2030 description: "ActivityPub-related settings",
2033 key: :unfollow_blocked,
2035 description: "Whether blocks result in people getting unfollowed"
2038 key: :outgoing_blocks,
2040 description: "Whether to federate blocks to other instances"
2043 key: :sign_object_fetches,
2045 description: "Sign object fetches with HTTP signatures"
2048 key: :note_replies_output_limit,
2051 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2054 key: :follow_handshake_timeout,
2056 description: "Following handshake timeout",
2063 key: :http_security,
2064 label: "HTTP security",
2066 description: "HTTP security settings",
2071 description: "Whether the managed content security policy is enabled"
2077 description: "Whether to additionally send a Strict-Transport-Security header"
2081 label: "STS max age",
2083 description: "The maximum age for the Strict-Transport-Security header if sent",
2084 suggestions: [31_536_000]
2088 label: "CT max age",
2090 description: "The maximum age for the Expect-CT header if sent",
2091 suggestions: [2_592_000]
2094 key: :referrer_policy,
2096 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2097 suggestions: ["same-origin", "no-referrer"]
2101 label: "Report URI",
2103 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2104 suggestions: ["https://example.com/report-uri"]
2109 group: :web_push_encryption,
2110 key: :vapid_details,
2111 label: "Vapid Details",
2114 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2120 "A mailto link for the administrative contact." <>
2121 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2122 suggestions: ["mailto:moderators@pleroma.com"]
2127 description: "VAPID public key",
2128 suggestions: ["Public key"]
2133 description: "VAPID private key",
2134 suggestions: ["Private key"]
2140 key: Pleroma.Captcha,
2142 description: "Captcha-related settings",
2147 description: "Whether the captcha should be shown on registration"
2152 description: "The method/service to use for captcha",
2153 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2156 key: :seconds_valid,
2158 description: "The time in seconds for which the captcha is valid",
2165 key: Pleroma.Captcha.Kocaptcha,
2168 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2169 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2174 description: "The kocaptcha endpoint to use",
2175 suggestions: ["https://captcha.kotobank.ch"]
2181 label: "Pleroma Admin Token",
2184 "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)",
2189 description: "Admin token",
2191 "Please use a high entropy string or UUID"
2201 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2203 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2204 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2205 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2206 (see https://github.com/sorentwo/oban/issues/52).
2211 type: {:dropdown, :atom},
2212 description: "Logs verbose mode",
2213 suggestions: [false, :error, :warn, :info, :debug]
2217 type: {:keyword, :integer},
2219 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2221 activity_expiration: 10,
2222 attachments_cleanup: 5,
2224 federator_incoming: 50,
2225 federator_outgoing: 50,
2227 scheduled_activities: 10,
2233 key: :activity_expiration,
2235 description: "Activity expiration queue",
2239 key: :attachments_cleanup,
2241 description: "Attachment deletion queue",
2247 description: "Background queue",
2251 key: :federator_incoming,
2253 description: "Incoming federation queue",
2257 key: :federator_outgoing,
2259 description: "Outgoing federation queue",
2265 description: "Email sender queue, see Pleroma.Emails.Mailer",
2269 key: :scheduled_activities,
2271 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2275 key: :transmogrifier,
2277 description: "Transmogrifier queue",
2283 description: "Web push notifications queue",
2290 type: {:list, :tuple},
2291 description: "Settings for cron background jobs",
2293 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2294 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2295 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2296 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2297 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2306 description: "Includes custom worker options not interpretable directly by `Oban`",
2310 type: {:keyword, :integer},
2311 description: "Max retry attempts for failed jobs, per `Oban` queue",
2313 federator_incoming: 5,
2314 federator_outgoing: 5
2321 key: Pleroma.Web.Metadata,
2323 description: "Metadata-related settings",
2327 type: {:list, :module},
2328 description: "List of metadata providers to enable",
2330 Pleroma.Web.Metadata.Providers.OpenGraph,
2331 Pleroma.Web.Metadata.Providers.TwitterCard,
2332 Pleroma.Web.Metadata.Providers.RelMe,
2333 Pleroma.Web.Metadata.Providers.Feed
2338 label: "Unfurl NSFW",
2340 description: "When enabled NSFW attachments will be shown in previews"
2349 "If enabled the instance will parse metadata from attached links to generate link previews",
2354 description: "Enables RichMedia parsing of URLs"
2358 type: {:list, :string},
2359 description: "List of hosts which will be ignored by the metadata parser",
2360 suggestions: ["accounts.google.com", "xss.website"]
2364 label: "Ignore TLD",
2365 type: {:list, :string},
2366 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2367 suggestions: ["local", "localdomain", "lan"]
2371 type: {:list, :module},
2373 "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.",
2375 Pleroma.Web.RichMedia.Parsers.OEmbed,
2376 Pleroma.Web.RichMedia.Parsers.TwitterCard
2381 label: "TTL setters",
2382 type: {:list, :module},
2384 "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.",
2386 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2393 key: Pleroma.Formatter,
2394 label: "Auto Linker",
2397 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2401 type: [:string, :boolean],
2402 description: "Specify the class to be added to the generated link. Disable to clear.",
2403 suggestions: ["auto-linker", false]
2407 type: [:string, :boolean],
2408 description: "Override the rel attribute. Disable to clear.",
2409 suggestions: ["ugc", "noopener noreferrer", false]
2414 description: "Link URLs will open in a new window/tab."
2418 type: [:integer, :boolean],
2420 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2421 suggestions: [15, false]
2426 description: "Strip the scheme prefix."
2431 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2435 type: [:atom, :boolean],
2437 "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)",
2438 suggestions: [:no_scheme, true]
2444 key: Pleroma.ScheduledActivity,
2446 description: "Scheduled activities settings",
2449 key: :daily_user_limit,
2452 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2456 key: :total_user_limit,
2459 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2465 description: "Whether scheduled activities are sent to the job queue to be executed"
2471 key: Pleroma.ActivityExpiration,
2473 description: "Expired activity settings",
2478 description: "Whether expired activities will be sent to the job queue to be deleted"
2484 label: "Pleroma Authenticator",
2486 description: "Authenticator",
2489 key: Pleroma.Web.Auth.Authenticator,
2491 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2501 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2502 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2503 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2504 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2509 description: "Enables LDAP authentication"
2514 description: "LDAP server hostname",
2515 suggestions: ["localhosts"]
2520 description: "LDAP port, e.g. 389 or 636",
2521 suggestions: [389, 636]
2527 description: "Enable to use SSL, usually implies the port 636"
2531 label: "SSL options",
2533 description: "Additional SSL options",
2534 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2539 description: "Path to file with PEM encoded cacerts",
2540 suggestions: ["path/to/file/with/PEM/cacerts"]
2545 description: "Type of cert verification",
2546 suggestions: [:verify_peer]
2554 description: "Enable to use STARTTLS, usually implies the port 389"
2558 label: "TLS options",
2560 description: "Additional TLS options",
2561 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2566 description: "Path to file with PEM encoded cacerts",
2567 suggestions: ["path/to/file/with/PEM/cacerts"]
2572 description: "Type of cert verification",
2573 suggestions: [:verify_peer]
2580 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2581 suggestions: ["dc=example,dc=com"]
2588 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2597 description: "Authentication / authorization settings",
2600 key: :enforce_oauth_admin_scope_usage,
2601 label: "Enforce OAuth admin scope usage",
2604 "OAuth admin scope requirement toggle. " <>
2605 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2606 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2607 "`is_admin` user flag grants access to admin-specific actions."
2610 key: :auth_template,
2613 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2614 suggestions: ["show.html"]
2617 key: :oauth_consumer_template,
2618 label: "OAuth consumer template",
2621 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2622 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2623 suggestions: ["consumer.html"]
2626 key: :oauth_consumer_strategies,
2627 label: "OAuth consumer strategies",
2628 type: {:list, :string},
2630 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2631 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2632 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2633 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2639 key: :email_notifications,
2641 description: "Email notifications settings",
2647 "emails of \"what you've missed\" for users who have been inactive for a while",
2651 schedule: "0 0 * * 0",
2653 inactivity_threshold: 7
2661 description: "Globally enable or disable digest emails"
2667 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2668 suggestions: ["0 0 * * 0"]
2673 description: "Minimum interval between digest emails to one user",
2677 key: :inactivity_threshold,
2679 description: "Minimum user inactivity threshold",
2688 key: Pleroma.Emails.UserEmail,
2690 description: "Email template settings",
2694 type: {:string, :image},
2695 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2696 suggestions: ["some/path/logo.png"]
2701 description: "A map with color settings for email templates.",
2704 link_color: "#d8a070",
2705 background_color: "#2C3645",
2706 content_background_color: "#1B2635",
2707 header_color: "#d8a070",
2708 text_color: "#b9b9ba",
2709 text_muted_color: "#b9b9ba"
2716 suggestions: ["#d8a070"]
2719 key: :background_color,
2721 suggestions: ["#2C3645"]
2724 key: :content_background_color,
2726 suggestions: ["#1B2635"]
2731 suggestions: ["#d8a070"]
2736 suggestions: ["#b9b9ba"]
2739 key: :text_muted_color,
2741 suggestions: ["#b9b9ba"]
2749 key: Pleroma.Emails.NewUsersDigestEmail,
2751 description: "New users admin email digest",
2756 description: "Enables new users admin digest email when `true`"
2765 description: "Configure OAuth 2 provider capabilities",
2768 key: :token_expires_in,
2770 description: "The lifetime in seconds of the access token",
2774 key: :issue_new_refresh_token,
2777 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2780 key: :clean_expired_tokens,
2782 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2792 key: :shortcode_globs,
2793 type: {:list, :string},
2794 description: "Location of custom emoji files. * can be used as a wildcard.",
2795 suggestions: ["/emoji/custom/**/*.png"]
2798 key: :pack_extensions,
2799 type: {:list, :string},
2801 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2802 suggestions: [".png", ".gif"]
2806 type: {:keyword, {:list, :string}},
2808 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2809 " and the value is the location or array of locations. * can be used as a wildcard.",
2811 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2815 key: :default_manifest,
2818 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2819 " Currently only one manifest can be added (no arrays).",
2820 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2823 key: :shared_pack_cache_seconds_per_file,
2824 label: "Shared pack cache s/file",
2827 "When an emoji pack is shared, the archive is created and cached in memory" <>
2828 " for this amount of seconds multiplied by the number of files.",
2838 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2842 type: [:tuple, {:list, :tuple}],
2843 description: "For the search requests (account & status search etc.)",
2844 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2848 type: [:tuple, {:list, :tuple}],
2849 description: "For requests to timelines (each timeline has it's own limiter)",
2850 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2853 key: :app_account_creation,
2854 type: [:tuple, {:list, :tuple}],
2855 description: "For registering user accounts from the same IP address",
2856 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2859 key: :relations_actions,
2860 type: [:tuple, {:list, :tuple}],
2861 description: "For actions on relationships with all users (follow, unfollow)",
2862 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2865 key: :relation_id_action,
2866 label: "Relation ID action",
2867 type: [:tuple, {:list, :tuple}],
2868 description: "For actions on relation with a specific user (follow, unfollow)",
2869 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2872 key: :statuses_actions,
2873 type: [:tuple, {:list, :tuple}],
2875 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2876 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2879 key: :status_id_action,
2880 label: "Status ID action",
2881 type: [:tuple, {:list, :tuple}],
2883 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2884 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2887 key: :authentication,
2888 type: [:tuple, {:list, :tuple}],
2889 description: "For authentication create / password check / user existence check requests",
2890 suggestions: [{60_000, 15}]
2899 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2900 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2905 description: "Enables SSH"
2910 description: "Dir with SSH keys",
2911 suggestions: ["/some/path/ssh_keys"]
2916 description: "Handler module",
2917 suggestions: ["Pleroma.BBS.Handler"]
2922 description: "Port to connect",
2923 suggestions: [10_022]
2926 key: :password_authenticator,
2928 description: "Authenticator module",
2929 suggestions: ["Pleroma.BBS.Authenticator"]
2935 label: "Mime Types",
2937 description: "Mime Types settings",
2944 "application/xml" => ["xml"],
2945 "application/xrd+xml" => ["xrd+xml"],
2946 "application/jrd+json" => ["jrd+json"],
2947 "application/activity+json" => ["activity+json"],
2948 "application/ld+json" => ["activity+json"]
2953 key: "application/xml",
2954 type: {:list, :string},
2955 suggestions: ["xml"]
2958 key: "application/xrd+xml",
2959 type: {:list, :string},
2960 suggestions: ["xrd+xml"]
2963 key: "application/jrd+json",
2964 type: {:list, :string},
2965 suggestions: ["jrd+json"]
2968 key: "application/activity+json",
2969 type: {:list, :string},
2970 suggestions: ["activity+json"]
2973 key: "application/ld+json",
2974 type: {:list, :string},
2975 suggestions: ["activity+json"]
2985 description: "Pleroma chat settings",
2998 description: "HTTP settings",
3003 type: [:string, :tuple],
3004 description: "Proxy URL",
3005 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3008 key: :send_user_agent,
3013 type: [:string, :atom],
3015 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3016 suggestions: ["Pleroma", :default]
3021 description: "Adapter specific options",
3027 label: "SSL Options",
3028 description: "SSL options for HTTP adapter",
3032 type: {:list, :atom},
3033 description: "List of TLS version to use",
3034 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3045 label: "Markup Settings",
3049 key: :allow_inline_images,
3053 key: :allow_headings,
3066 type: {:list, :module},
3068 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3069 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3079 key: :deny_follow_blocked,
3086 key: :mrf_normalize_markup,
3088 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3089 label: "MRF Normalize Markup",
3090 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3096 suggestions: [Pleroma.HTML.Scrubber.Default]
3106 key: :restricted_nicknames,
3107 type: {:list, :string},
3108 description: "List of nicknames users may not register with.",
3127 "ostatus_subscribe",
3143 key: :email_blacklist,
3144 type: {:list, :string},
3145 description: "List of email domains users may not register with.",
3146 suggestions: ["mailinator.com", "maildrop.cc"]
3152 label: "CORS plug config",
3158 suggestions: [86_400]
3162 type: {:list, :string},
3163 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3167 type: {:list, :string},
3170 "X-RateLimit-Reset",
3171 "X-RateLimit-Limit",
3172 "X-RateLimit-Remaining",
3183 type: {:list, :string},
3184 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3190 key: Pleroma.Plugs.RemoteIp,
3193 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3194 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3200 description: "Enable/disable the plug. Default: disabled."
3204 type: {:list, :string},
3206 "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]`."
3210 type: {:list, :string},
3212 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3216 type: {:list, :string},
3218 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3224 key: :web_cache_ttl,
3225 label: "Web cache TTL",
3228 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3234 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3235 suggestions: [30_000, nil]
3238 key: :activity_pub_question,
3240 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3241 suggestions: [30_000]
3251 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3256 description: "Enables the rendering of static HTML. Default: disabled."
3264 description: "Configure feed rendering",
3269 description: "Configure title rendering",
3274 description: "Maximum number of characters before truncating title",
3280 description: "Replacement which will be used after truncating string",
3281 suggestions: ["..."]
3289 key: :mrf_object_age,
3291 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3292 label: "MRF Object Age",
3295 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3300 description: "Required age (in seconds) of a post before actions are taken.",
3301 suggestions: [172_800]
3305 type: {:list, :atom},
3307 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3308 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3309 "`:reject` rejects the message entirely",
3310 suggestions: [:delist, :strip_followers, :reject]
3318 description: "Custom Runtime Modules",
3323 description: "A path to custom Elixir modules (such as MRF policies)."
3331 description: "Settings for notifications streamer",
3336 description: "Number of workers to send notifications",
3340 key: :overflow_workers,
3342 description: "Maximum number of workers created if pool is empty",
3349 key: :connections_pool,
3351 description: "Advanced settings for `Gun` connections pool",
3354 key: :connection_acquisition_wait,
3357 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3361 key: :connection_acquisition_retries,
3364 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3368 key: :max_connections,
3370 description: "Maximum number of connections in the pool. Default: 250 connections.",
3374 key: :await_up_timeout,
3376 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3380 key: :reclaim_multiplier,
3383 "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",
3392 description: "Advanced settings for `Gun` workers pools",
3394 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3398 description: "Settings for #{pool_name} pool.",
3403 description: "Maximum number of concurrent requests in the pool.",
3410 "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",
3419 key: :hackney_pools,
3421 description: "Advanced settings for `Hackney` connections pools",
3426 description: "Settings for federation pool.",
3429 key: :max_connections,
3431 description: "Number workers in the pool.",
3437 description: "Timeout while `hackney` will wait for response.",
3438 suggestions: [150_000]
3445 description: "Settings for media pool.",
3448 key: :max_connections,
3450 description: "Number workers in the pool.",
3456 description: "Timeout while `hackney` will wait for response.",
3457 suggestions: [150_000]
3464 description: "Settings for upload pool.",
3467 key: :max_connections,
3469 description: "Number workers in the pool.",
3475 description: "Timeout while `hackney` will wait for response.",
3476 suggestions: [300_000]
3484 key: :restrict_unauthenticated,
3485 label: "Restrict Unauthenticated",
3488 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3493 description: "Settings for public and federated timelines.",
3498 description: "Disallow view public timeline."
3503 description: "Disallow view federated timeline."
3510 description: "Settings for user profiles.",
3515 description: "Disallow view local user profiles."
3520 description: "Disallow view remote user profiles."
3527 description: "Settings for statuses.",
3532 description: "Disallow view local statuses."
3537 description: "Disallow view remote statuses."
3545 key: Pleroma.Web.ApiSpec.CastAndValidate,
3552 "Enables strict input validation (useful in development, not recommended in production)"
3558 key: :instances_favicons,
3560 description: "Control favicons for instances",
3565 description: "Allow/disallow displaying and getting instances favicons"
3573 descriptions: "S3 service related settings",
3576 key: :access_key_id,
3578 description: "S3 access key ID",
3579 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3582 key: :secret_access_key,
3584 description: "Secret access key",
3585 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3590 description: "S3 host",
3591 suggestions: ["s3.eu-central-1.amazonaws.com"]
3599 description: "Installed frontends management",
3604 description: "Primary frontend, the one that is served for all pages by default",
3605 children: installed_frontend_options
3610 description: "Admin frontend",
3611 children: installed_frontend_options
3617 "A map containing available frontends and parameters for their installation.",
3626 key: Pleroma.Web.Preload,
3628 description: "Preload-related settings",
3632 type: {:list, :module},
3633 description: "List of preload providers to enable",
3635 Pleroma.Web.Preload.Providers.Instance,
3636 Pleroma.Web.Preload.Providers.User,
3637 Pleroma.Web.Preload.Providers.Timelines,
3638 Pleroma.Web.Preload.Providers.StatusNet