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]
1674 key: :mrf_force_bot_unlisted,
1676 related_policy: "Pleroma.Web.ActivityPub.MRF.ForceBotUnlistedPolicy",
1677 label: "MRF Force Bot Unlisted Policy",
1679 description: "Makes bot posts to disappear from public timelines"
1685 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1686 label: "MRF Subchain",
1689 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1690 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1694 type: {:map, {:list, :string}},
1695 description: "Matches a series of regular expressions against the actor field",
1698 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1706 key: :mrf_rejectnonpublic,
1708 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1709 description: "RejectNonPublic drops posts with non-public visibility settings.",
1710 label: "MRF Reject Non Public",
1714 key: :allow_followersonly,
1715 label: "Allow followers-only",
1717 description: "Whether to allow followers-only posts"
1722 description: "Whether to allow direct messages"
1728 key: :mrf_hellthread,
1730 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1731 label: "MRF Hellthread",
1733 description: "Block messages with excessive user mentions",
1736 key: :delist_threshold,
1739 "Number of mentioned users after which the message gets removed from timelines and" <>
1740 "disables notifications. Set to 0 to disable.",
1744 key: :reject_threshold,
1747 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1756 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1757 label: "MRF Keyword",
1759 description: "Reject or Word-Replace messages with a keyword or regex",
1763 type: {:list, :string},
1765 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1766 suggestions: ["foo", ~r/foo/iu]
1769 key: :federated_timeline_removal,
1770 type: {:list, :string},
1772 "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.",
1773 suggestions: ["foo", ~r/foo/iu]
1777 type: {:list, :tuple},
1779 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1780 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1788 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1789 label: "MRF Mention",
1791 description: "Block messages which mention a specific user",
1795 type: {:list, :string},
1796 description: "A list of actors for which any post mentioning them will be dropped",
1797 suggestions: ["actor1", "actor2"]
1803 key: :mrf_vocabulary,
1805 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1806 label: "MRF Vocabulary",
1808 description: "Filter messages which belong to certain activity vocabularies",
1812 type: {:list, :string},
1814 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1815 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1819 type: {:list, :string},
1821 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1822 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1828 # key: :mrf_user_allowlist,
1830 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1833 # "The keys in this section are the domain names that the policy should apply to." <>
1834 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1836 # %{"example.org" => ["https://example.org/users/admin"]}
1844 description: "Media proxy",
1849 description: "Enables proxying of remote media to the instance's proxy"
1856 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1857 suggestions: ["https://example.com"]
1865 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1871 description: "Enables media cache object invalidation."
1876 description: "Module which will be used to purge objects from the cache.",
1878 Pleroma.Web.MediaProxy.Invalidation.Script,
1879 Pleroma.Web.MediaProxy.Invalidation.Http
1886 label: "Proxy Options",
1888 description: "Options for Pleroma.ReverseProxy",
1890 redirect_on_failure: false,
1891 max_body_length: 25 * 1_048_576,
1893 follow_redirect: true,
1899 key: :redirect_on_failure,
1902 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1903 "Any error during body processing will not be redirected as the response is chunked."
1906 key: :max_body_length,
1909 "Limits the content length to be approximately the " <>
1910 "specified length. It is validated with the `content-length` header and also verified when proxying."
1916 description: "HTTP options",
1921 description: "Adapter specific options",
1926 label: "SSL Options",
1927 description: "SSL options for HTTP adapter",
1931 type: {:list, :atom},
1932 description: "List of TLS version to use",
1933 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1942 type: [:string, :tuple],
1943 description: "Proxy URL",
1944 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1952 type: {:list, :string},
1953 description: "List of hosts with scheme to bypass the mediaproxy",
1954 suggestions: ["http://example.com"]
1960 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1962 description: "HTTP invalidate settings",
1967 description: "HTTP method of request. Default: :purge"
1971 type: {:keyword, :string},
1972 description: "HTTP headers of request",
1973 suggestions: [{"x-refresh", 1}]
1978 description: "Request options",
1982 type: {:map, :string}
1990 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1992 description: "Script invalidate settings",
1997 description: "Path to shell script. Which will run purge cache.",
1998 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2006 description: "Gopher settings",
2011 description: "Enables the gopher interface"
2017 description: "IP address to bind to",
2018 suggestions: [{0, 0, 0, 0}]
2023 description: "Port to bind to",
2029 description: "Port advertised in URLs (optional, defaults to port)",
2037 label: "ActivityPub",
2039 description: "ActivityPub-related settings",
2042 key: :unfollow_blocked,
2044 description: "Whether blocks result in people getting unfollowed"
2047 key: :outgoing_blocks,
2049 description: "Whether to federate blocks to other instances"
2052 key: :sign_object_fetches,
2054 description: "Sign object fetches with HTTP signatures"
2057 key: :note_replies_output_limit,
2060 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2063 key: :follow_handshake_timeout,
2065 description: "Following handshake timeout",
2072 key: :http_security,
2073 label: "HTTP security",
2075 description: "HTTP security settings",
2080 description: "Whether the managed content security policy is enabled"
2086 description: "Whether to additionally send a Strict-Transport-Security header"
2090 label: "STS max age",
2092 description: "The maximum age for the Strict-Transport-Security header if sent",
2093 suggestions: [31_536_000]
2097 label: "CT max age",
2099 description: "The maximum age for the Expect-CT header if sent",
2100 suggestions: [2_592_000]
2103 key: :referrer_policy,
2105 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2106 suggestions: ["same-origin", "no-referrer"]
2110 label: "Report URI",
2112 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2113 suggestions: ["https://example.com/report-uri"]
2118 group: :web_push_encryption,
2119 key: :vapid_details,
2120 label: "Vapid Details",
2123 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2129 "A mailto link for the administrative contact." <>
2130 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2131 suggestions: ["mailto:moderators@pleroma.com"]
2136 description: "VAPID public key",
2137 suggestions: ["Public key"]
2142 description: "VAPID private key",
2143 suggestions: ["Private key"]
2149 key: Pleroma.Captcha,
2151 description: "Captcha-related settings",
2156 description: "Whether the captcha should be shown on registration"
2161 description: "The method/service to use for captcha",
2162 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2165 key: :seconds_valid,
2167 description: "The time in seconds for which the captcha is valid",
2174 key: Pleroma.Captcha.Kocaptcha,
2177 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2178 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2183 description: "The kocaptcha endpoint to use",
2184 suggestions: ["https://captcha.kotobank.ch"]
2190 label: "Pleroma Admin Token",
2193 "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)",
2198 description: "Admin token",
2200 "Please use a high entropy string or UUID"
2210 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2212 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2213 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2214 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2215 (see https://github.com/sorentwo/oban/issues/52).
2220 type: {:dropdown, :atom},
2221 description: "Logs verbose mode",
2222 suggestions: [false, :error, :warn, :info, :debug]
2226 type: {:keyword, :integer},
2228 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2230 activity_expiration: 10,
2231 attachments_cleanup: 5,
2233 federator_incoming: 50,
2234 federator_outgoing: 50,
2236 scheduled_activities: 10,
2242 key: :activity_expiration,
2244 description: "Activity expiration queue",
2248 key: :attachments_cleanup,
2250 description: "Attachment deletion queue",
2256 description: "Background queue",
2260 key: :federator_incoming,
2262 description: "Incoming federation queue",
2266 key: :federator_outgoing,
2268 description: "Outgoing federation queue",
2274 description: "Email sender queue, see Pleroma.Emails.Mailer",
2278 key: :scheduled_activities,
2280 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2284 key: :transmogrifier,
2286 description: "Transmogrifier queue",
2292 description: "Web push notifications queue",
2299 type: {:list, :tuple},
2300 description: "Settings for cron background jobs",
2302 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2303 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2304 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2305 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2314 description: "Includes custom worker options not interpretable directly by `Oban`",
2318 type: {:keyword, :integer},
2319 description: "Max retry attempts for failed jobs, per `Oban` queue",
2321 federator_incoming: 5,
2322 federator_outgoing: 5
2329 key: Pleroma.Web.Metadata,
2331 description: "Metadata-related settings",
2335 type: {:list, :module},
2336 description: "List of metadata providers to enable",
2338 Pleroma.Web.Metadata.Providers.OpenGraph,
2339 Pleroma.Web.Metadata.Providers.TwitterCard,
2340 Pleroma.Web.Metadata.Providers.RelMe,
2341 Pleroma.Web.Metadata.Providers.Feed
2346 label: "Unfurl NSFW",
2348 description: "When enabled NSFW attachments will be shown in previews"
2357 "If enabled the instance will parse metadata from attached links to generate link previews",
2362 description: "Enables RichMedia parsing of URLs"
2366 type: {:list, :string},
2367 description: "List of hosts which will be ignored by the metadata parser",
2368 suggestions: ["accounts.google.com", "xss.website"]
2372 label: "Ignore TLD",
2373 type: {:list, :string},
2374 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2375 suggestions: ["local", "localdomain", "lan"]
2379 type: {:list, :module},
2381 "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.",
2383 Pleroma.Web.RichMedia.Parsers.OEmbed,
2384 Pleroma.Web.RichMedia.Parsers.TwitterCard
2389 label: "TTL setters",
2390 type: {:list, :module},
2392 "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.",
2394 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2398 key: :failure_backoff,
2401 "Amount of milliseconds after request failure, during which the request will not be retried.",
2402 suggestions: [60_000]
2408 key: Pleroma.Formatter,
2409 label: "Auto Linker",
2412 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2416 type: [:string, :boolean],
2417 description: "Specify the class to be added to the generated link. Disable to clear.",
2418 suggestions: ["auto-linker", false]
2422 type: [:string, :boolean],
2423 description: "Override the rel attribute. Disable to clear.",
2424 suggestions: ["ugc", "noopener noreferrer", false]
2429 description: "Link URLs will open in a new window/tab."
2433 type: [:integer, :boolean],
2435 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2436 suggestions: [15, false]
2441 description: "Strip the scheme prefix."
2446 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2450 type: [:atom, :boolean],
2452 "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)",
2453 suggestions: [:no_scheme, true]
2459 key: Pleroma.ScheduledActivity,
2461 description: "Scheduled activities settings",
2464 key: :daily_user_limit,
2467 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2471 key: :total_user_limit,
2474 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2480 description: "Whether scheduled activities are sent to the job queue to be executed"
2486 key: Pleroma.ActivityExpiration,
2488 description: "Expired activity settings",
2493 description: "Whether expired activities will be sent to the job queue to be deleted"
2499 label: "Pleroma Authenticator",
2501 description: "Authenticator",
2504 key: Pleroma.Web.Auth.Authenticator,
2506 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2516 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2517 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2518 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2519 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2524 description: "Enables LDAP authentication"
2529 description: "LDAP server hostname",
2530 suggestions: ["localhosts"]
2535 description: "LDAP port, e.g. 389 or 636",
2536 suggestions: [389, 636]
2542 description: "Enable to use SSL, usually implies the port 636"
2546 label: "SSL options",
2548 description: "Additional SSL options",
2549 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2554 description: "Path to file with PEM encoded cacerts",
2555 suggestions: ["path/to/file/with/PEM/cacerts"]
2560 description: "Type of cert verification",
2561 suggestions: [:verify_peer]
2569 description: "Enable to use STARTTLS, usually implies the port 389"
2573 label: "TLS options",
2575 description: "Additional TLS options",
2576 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2581 description: "Path to file with PEM encoded cacerts",
2582 suggestions: ["path/to/file/with/PEM/cacerts"]
2587 description: "Type of cert verification",
2588 suggestions: [:verify_peer]
2595 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2596 suggestions: ["dc=example,dc=com"]
2603 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2612 description: "Authentication / authorization settings",
2615 key: :enforce_oauth_admin_scope_usage,
2616 label: "Enforce OAuth admin scope usage",
2619 "OAuth admin scope requirement toggle. " <>
2620 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2621 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2622 "`is_admin` user flag grants access to admin-specific actions."
2625 key: :auth_template,
2628 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2629 suggestions: ["show.html"]
2632 key: :oauth_consumer_template,
2633 label: "OAuth consumer template",
2636 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2637 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2638 suggestions: ["consumer.html"]
2641 key: :oauth_consumer_strategies,
2642 label: "OAuth consumer strategies",
2643 type: {:list, :string},
2645 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2646 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2647 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2648 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2654 key: :email_notifications,
2656 description: "Email notifications settings",
2662 "emails of \"what you've missed\" for users who have been inactive for a while",
2666 schedule: "0 0 * * 0",
2668 inactivity_threshold: 7
2676 description: "Globally enable or disable digest emails"
2682 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2683 suggestions: ["0 0 * * 0"]
2688 description: "Minimum interval between digest emails to one user",
2692 key: :inactivity_threshold,
2694 description: "Minimum user inactivity threshold",
2703 key: Pleroma.Emails.UserEmail,
2705 description: "Email template settings",
2709 type: {:string, :image},
2710 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2711 suggestions: ["some/path/logo.png"]
2716 description: "A map with color settings for email templates.",
2719 link_color: "#d8a070",
2720 background_color: "#2C3645",
2721 content_background_color: "#1B2635",
2722 header_color: "#d8a070",
2723 text_color: "#b9b9ba",
2724 text_muted_color: "#b9b9ba"
2731 suggestions: ["#d8a070"]
2734 key: :background_color,
2736 suggestions: ["#2C3645"]
2739 key: :content_background_color,
2741 suggestions: ["#1B2635"]
2746 suggestions: ["#d8a070"]
2751 suggestions: ["#b9b9ba"]
2754 key: :text_muted_color,
2756 suggestions: ["#b9b9ba"]
2764 key: Pleroma.Emails.NewUsersDigestEmail,
2766 description: "New users admin email digest",
2771 description: "Enables new users admin digest email when `true`"
2780 description: "Configure OAuth 2 provider capabilities",
2783 key: :token_expires_in,
2785 description: "The lifetime in seconds of the access token",
2789 key: :issue_new_refresh_token,
2792 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2795 key: :clean_expired_tokens,
2797 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2807 key: :shortcode_globs,
2808 type: {:list, :string},
2809 description: "Location of custom emoji files. * can be used as a wildcard.",
2810 suggestions: ["/emoji/custom/**/*.png"]
2813 key: :pack_extensions,
2814 type: {:list, :string},
2816 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2817 suggestions: [".png", ".gif"]
2821 type: {:keyword, {:list, :string}},
2823 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2824 " and the value is the location or array of locations. * can be used as a wildcard.",
2826 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2830 key: :default_manifest,
2833 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2834 " Currently only one manifest can be added (no arrays).",
2835 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2838 key: :shared_pack_cache_seconds_per_file,
2839 label: "Shared pack cache s/file",
2842 "When an emoji pack is shared, the archive is created and cached in memory" <>
2843 " for this amount of seconds multiplied by the number of files.",
2853 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2857 type: [:tuple, {:list, :tuple}],
2858 description: "For the search requests (account & status search etc.)",
2859 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2863 type: [:tuple, {:list, :tuple}],
2864 description: "For requests to timelines (each timeline has it's own limiter)",
2865 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2868 key: :app_account_creation,
2869 type: [:tuple, {:list, :tuple}],
2870 description: "For registering user accounts from the same IP address",
2871 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2874 key: :relations_actions,
2875 type: [:tuple, {:list, :tuple}],
2876 description: "For actions on relationships with all users (follow, unfollow)",
2877 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2880 key: :relation_id_action,
2881 label: "Relation ID action",
2882 type: [:tuple, {:list, :tuple}],
2883 description: "For actions on relation with a specific user (follow, unfollow)",
2884 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2887 key: :statuses_actions,
2888 type: [:tuple, {:list, :tuple}],
2890 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2891 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2894 key: :status_id_action,
2895 label: "Status ID action",
2896 type: [:tuple, {:list, :tuple}],
2898 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2899 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2902 key: :authentication,
2903 type: [:tuple, {:list, :tuple}],
2904 description: "For authentication create / password check / user existence check requests",
2905 suggestions: [{60_000, 15}]
2914 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2915 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2920 description: "Enables SSH"
2925 description: "Dir with SSH keys",
2926 suggestions: ["/some/path/ssh_keys"]
2931 description: "Handler module",
2932 suggestions: ["Pleroma.BBS.Handler"]
2937 description: "Port to connect",
2938 suggestions: [10_022]
2941 key: :password_authenticator,
2943 description: "Authenticator module",
2944 suggestions: ["Pleroma.BBS.Authenticator"]
2950 label: "Mime Types",
2952 description: "Mime Types settings",
2959 "application/xml" => ["xml"],
2960 "application/xrd+xml" => ["xrd+xml"],
2961 "application/jrd+json" => ["jrd+json"],
2962 "application/activity+json" => ["activity+json"],
2963 "application/ld+json" => ["activity+json"]
2968 key: "application/xml",
2969 type: {:list, :string},
2970 suggestions: ["xml"]
2973 key: "application/xrd+xml",
2974 type: {:list, :string},
2975 suggestions: ["xrd+xml"]
2978 key: "application/jrd+json",
2979 type: {:list, :string},
2980 suggestions: ["jrd+json"]
2983 key: "application/activity+json",
2984 type: {:list, :string},
2985 suggestions: ["activity+json"]
2988 key: "application/ld+json",
2989 type: {:list, :string},
2990 suggestions: ["activity+json"]
3000 description: "Pleroma chat settings",
3013 description: "HTTP settings",
3018 type: [:string, :tuple],
3019 description: "Proxy URL",
3020 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3023 key: :send_user_agent,
3028 type: [:string, :atom],
3030 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3031 suggestions: ["Pleroma", :default]
3036 description: "Adapter specific options",
3042 label: "SSL Options",
3043 description: "SSL options for HTTP adapter",
3047 type: {:list, :atom},
3048 description: "List of TLS version to use",
3049 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3060 label: "Markup Settings",
3064 key: :allow_inline_images,
3068 key: :allow_headings,
3081 type: {:list, :module},
3083 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3084 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3094 key: :deny_follow_blocked,
3101 key: :mrf_normalize_markup,
3103 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3104 label: "MRF Normalize Markup",
3105 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3111 suggestions: [Pleroma.HTML.Scrubber.Default]
3121 key: :restricted_nicknames,
3122 type: {:list, :string},
3123 description: "List of nicknames users may not register with.",
3142 "ostatus_subscribe",
3158 key: :email_blacklist,
3159 type: {:list, :string},
3160 description: "List of email domains users may not register with.",
3161 suggestions: ["mailinator.com", "maildrop.cc"]
3167 label: "CORS plug config",
3173 suggestions: [86_400]
3177 type: {:list, :string},
3178 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3182 type: {:list, :string},
3185 "X-RateLimit-Reset",
3186 "X-RateLimit-Limit",
3187 "X-RateLimit-Remaining",
3198 type: {:list, :string},
3199 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3205 key: Pleroma.Plugs.RemoteIp,
3208 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3209 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3215 description: "Enable/disable the plug. Default: disabled."
3219 type: {:list, :string},
3221 "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]`."
3225 type: {:list, :string},
3227 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3231 type: {:list, :string},
3233 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3239 key: :web_cache_ttl,
3240 label: "Web cache TTL",
3243 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3249 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3250 suggestions: [30_000, nil]
3253 key: :activity_pub_question,
3255 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3256 suggestions: [30_000]
3266 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3271 description: "Enables the rendering of static HTML. Default: disabled."
3279 description: "Configure feed rendering",
3284 description: "Configure title rendering",
3289 description: "Maximum number of characters before truncating title",
3295 description: "Replacement which will be used after truncating string",
3296 suggestions: ["..."]
3304 key: :mrf_object_age,
3306 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3307 label: "MRF Object Age",
3310 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3315 description: "Required age (in seconds) of a post before actions are taken.",
3316 suggestions: [172_800]
3320 type: {:list, :atom},
3322 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3323 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3324 "`:reject` rejects the message entirely",
3325 suggestions: [:delist, :strip_followers, :reject]
3333 description: "Custom Runtime Modules",
3338 description: "A path to custom Elixir modules (such as MRF policies)."
3346 description: "Settings for notifications streamer",
3351 description: "Number of workers to send notifications",
3355 key: :overflow_workers,
3357 description: "Maximum number of workers created if pool is empty",
3364 key: :connections_pool,
3366 description: "Advanced settings for `Gun` connections pool",
3369 key: :connection_acquisition_wait,
3372 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3376 key: :connection_acquisition_retries,
3379 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3383 key: :max_connections,
3385 description: "Maximum number of connections in the pool. Default: 250 connections.",
3389 key: :connect_timeout,
3391 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3395 key: :reclaim_multiplier,
3398 "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",
3407 description: "Advanced settings for `Gun` workers pools",
3409 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3413 description: "Settings for #{pool_name} pool.",
3418 description: "Maximum number of concurrent requests in the pool.",
3425 "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",
3431 description: "Timeout for the pool while gun will wait for response",
3432 suggestions: [10_000]
3440 key: :hackney_pools,
3442 description: "Advanced settings for `Hackney` connections pools",
3447 description: "Settings for federation pool.",
3450 key: :max_connections,
3452 description: "Number workers in the pool.",
3458 description: "Timeout while `hackney` will wait for response.",
3459 suggestions: [150_000]
3466 description: "Settings for media pool.",
3469 key: :max_connections,
3471 description: "Number workers in the pool.",
3477 description: "Timeout while `hackney` will wait for response.",
3478 suggestions: [150_000]
3485 description: "Settings for upload pool.",
3488 key: :max_connections,
3490 description: "Number workers in the pool.",
3496 description: "Timeout while `hackney` will wait for response.",
3497 suggestions: [300_000]
3505 key: :restrict_unauthenticated,
3506 label: "Restrict Unauthenticated",
3509 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3514 description: "Settings for public and federated timelines.",
3519 description: "Disallow view public timeline."
3524 description: "Disallow view federated timeline."
3531 description: "Settings for user profiles.",
3536 description: "Disallow view local user profiles."
3541 description: "Disallow view remote user profiles."
3548 description: "Settings for statuses.",
3553 description: "Disallow view local statuses."
3558 description: "Disallow view remote statuses."
3566 key: Pleroma.Web.ApiSpec.CastAndValidate,
3573 "Enables strict input validation (useful in development, not recommended in production)"
3579 key: :instances_favicons,
3581 description: "Control favicons for instances",
3586 description: "Allow/disallow displaying and getting instances favicons"
3594 descriptions: "S3 service related settings",
3597 key: :access_key_id,
3599 description: "S3 access key ID",
3600 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3603 key: :secret_access_key,
3605 description: "Secret access key",
3606 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3611 description: "S3 host",
3612 suggestions: ["s3.eu-central-1.amazonaws.com"]
3620 description: "Installed frontends management",
3625 description: "Primary frontend, the one that is served for all pages by default",
3626 children: installed_frontend_options
3631 description: "Admin frontend",
3632 children: installed_frontend_options
3638 "A map containing available frontends and parameters for their installation.",
3647 key: Pleroma.Web.Preload,
3649 description: "Preload-related settings",
3653 type: {:list, :module},
3654 description: "List of preload providers to enable",
3656 Pleroma.Web.Preload.Providers.Instance,
3657 Pleroma.Web.Preload.Providers.User,
3658 Pleroma.Web.Preload.Providers.Timelines,
3659 Pleroma.Web.Preload.Providers.StatusNet