2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
19 description: "Name of the installed Admin frontend"
24 description: "reference of the installed Admin frontend to be used"
29 description: "URL of the git repository of the frontend"
35 "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`.",
36 example: "https://some.url/builds/${ref}.zip"
41 description: "The directory inside the zip file "
45 config :pleroma, :config_description, [
50 description: "Upload general settings",
55 description: "Module which will be used for uploads",
56 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
60 type: {:list, :module},
62 "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.",
63 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
69 "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`."
75 description: "Base URL for the uploads, needed if you use CDN",
77 "https://cdn-host.com"
84 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
88 label: "Proxy Options",
90 description: "Options for Pleroma.ReverseProxy",
92 redirect_on_failure: false,
93 max_body_length: 25 * 1_048_576,
95 follow_redirect: true,
101 key: :redirect_on_failure,
104 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
105 "Any error during body processing will not be redirected as the response is chunked."
108 key: :max_body_length,
111 "Limits the content length to be approximately the " <>
112 "specified length. It is validated with the `content-length` header and also verified when proxying."
118 description: "HTTP options",
123 description: "Adapter specific options",
128 label: "SSL Options",
129 description: "SSL options for HTTP adapter",
133 type: {:list, :atom},
134 description: "List of TLS versions to use",
135 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
144 type: [:string, :tuple],
145 description: "Proxy URL",
146 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
153 key: :filename_display_max_length,
155 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
161 key: Pleroma.Uploaders.Local,
163 description: "Local uploader-related settings",
168 description: "Path where user's uploads will be saved",
177 key: Pleroma.Uploaders.S3,
179 description: "S3 uploader-related settings",
184 description: "S3 bucket",
190 key: :bucket_namespace,
192 description: "S3 bucket namespace",
193 suggestions: ["pleroma"]
196 key: :public_endpoint,
198 description: "S3 endpoint",
199 suggestions: ["https://s3.amazonaws.com"]
202 key: :truncated_namespace,
205 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
206 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
209 key: :streaming_enabled,
212 "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."
218 key: Pleroma.Upload.Filter.Mogrify,
220 description: "Uploads mogrify filter settings",
224 type: [:string, {:list, :string}, {:list, :tuple}],
226 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
227 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
238 key: Pleroma.Upload.Filter.AnonymizeFilename,
240 description: "Filter replaces the filename of the upload",
246 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
247 " filename extension by using {extension}, for example custom-file-name.{extension}.",
249 "custom-file-name.{extension}"
256 key: Pleroma.Emails.Mailer,
258 description: "Mailer-related settings",
264 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
265 " or Swoosh.Adapters.Local for in-memory mailbox",
267 Swoosh.Adapters.SMTP,
268 Swoosh.Adapters.Sendgrid,
269 Swoosh.Adapters.Sendmail,
270 Swoosh.Adapters.Mandrill,
271 Swoosh.Adapters.Mailgun,
272 Swoosh.Adapters.Mailjet,
273 Swoosh.Adapters.Postmark,
274 Swoosh.Adapters.SparkPost,
275 Swoosh.Adapters.AmazonSES,
277 Swoosh.Adapters.SocketLabs,
278 Swoosh.Adapters.Gmail,
279 Swoosh.Adapters.Local
285 description: "Allow/disallow send emails"
288 group: {:subgroup, Swoosh.Adapters.SMTP},
291 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
292 suggestions: ["smtp.gmail.com"]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
299 suggestions: ["pleroma"]
302 group: {:subgroup, Swoosh.Adapters.SMTP},
305 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
306 suggestions: ["password"]
309 group: {:subgroup, Swoosh.Adapters.SMTP},
313 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
316 group: {:subgroup, Swoosh.Adapters.SMTP},
320 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
321 suggestions: [:always, :never, :if_available]
324 group: {:subgroup, Swoosh.Adapters.SMTP},
327 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
328 suggestions: [:always, :never, :if_available]
331 group: {:subgroup, Swoosh.Adapters.SMTP},
334 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
338 group: {:subgroup, Swoosh.Adapters.SMTP},
341 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
345 group: {:subgroup, Swoosh.Adapters.SMTP},
347 label: "No MX lookups",
349 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
352 group: {:subgroup, Swoosh.Adapters.Sendgrid},
356 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
357 suggestions: ["my-api-key"]
360 group: {:subgroup, Swoosh.Adapters.Sendmail},
363 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
364 suggestions: ["/usr/bin/sendmail"]
367 group: {:subgroup, Swoosh.Adapters.Sendmail},
370 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
371 suggestions: ["-N delay,failure,success"]
374 group: {:subgroup, Swoosh.Adapters.Sendmail},
377 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
380 group: {:subgroup, Swoosh.Adapters.Mandrill},
384 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
385 suggestions: ["my-api-key"]
388 group: {:subgroup, Swoosh.Adapters.Mailgun},
392 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
393 suggestions: ["my-api-key"]
396 group: {:subgroup, Swoosh.Adapters.Mailgun},
399 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
400 suggestions: ["pleroma.com"]
403 group: {:subgroup, Swoosh.Adapters.Mailjet},
407 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
408 suggestions: ["my-api-key"]
411 group: {:subgroup, Swoosh.Adapters.Mailjet},
414 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
415 suggestions: ["my-secret-key"]
418 group: {:subgroup, Swoosh.Adapters.Postmark},
422 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
423 suggestions: ["my-api-key"]
426 group: {:subgroup, Swoosh.Adapters.SparkPost},
430 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
431 suggestions: ["my-api-key"]
434 group: {:subgroup, Swoosh.Adapters.SparkPost},
437 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
438 suggestions: ["https://api.sparkpost.com/api/v1"]
441 group: {:subgroup, Swoosh.Adapters.AmazonSES},
444 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
445 suggestions: ["us-east-1", "us-east-2"]
448 group: {:subgroup, Swoosh.Adapters.AmazonSES},
451 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
452 suggestions: ["aws-access-key"]
455 group: {:subgroup, Swoosh.Adapters.AmazonSES},
458 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
459 suggestions: ["aws-secret-key"]
462 group: {:subgroup, Swoosh.Adapters.Dyn},
466 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
467 suggestions: ["my-api-key"]
470 group: {:subgroup, Swoosh.Adapters.SocketLabs},
473 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
476 group: {:subgroup, Swoosh.Adapters.SocketLabs},
480 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
483 group: {:subgroup, Swoosh.Adapters.Gmail},
486 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
493 description: "`Swoosh.Adapters.Local` adapter specific settings",
496 group: {:subgroup, Swoosh.Adapters.Local},
499 description: "Run the preview server together as part of your app"
502 group: {:subgroup, Swoosh.Adapters.Local},
505 description: "The preview server port",
513 label: "URI Schemes",
515 description: "URI schemes related settings",
519 type: {:list, :string},
520 description: "List of the scheme part that is considered valid to be an URL",
545 description: "Instance-related settings",
550 description: "Name of the instance",
557 label: "Admin Email Address",
559 description: "Email used to reach an Administrator/Moderator of the instance",
566 label: "Sender Email Address",
568 description: "Envelope FROM address for mail sent via Pleroma",
577 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
585 description: "Posts character limit (CW/Subject included in the counter)",
593 description: "Character limit of the instance chat messages",
601 description: "Hard character limit beyond which remote posts will be dropped",
609 description: "File size limit of uploads (except for avatar, background, banner)",
615 key: :avatar_upload_limit,
617 description: "File size limit of user's profile avatars",
623 key: :background_upload_limit,
625 description: "File size limit of user's profile backgrounds",
631 key: :banner_upload_limit,
633 description: "File size limit of user's profile banners",
641 description: "A map with poll limits for local polls",
645 max_option_chars: 200,
647 max_expiration: 31_536_000
654 description: "Maximum number of options",
658 key: :max_option_chars,
660 description: "Maximum number of characters per option",
664 key: :min_expiration,
666 description: "Minimum expiration time (in seconds)",
670 key: :max_expiration,
672 description: "Maximum expiration time (in seconds)",
678 key: :registrations_open,
681 "Enable registrations for anyone. Invitations require this setting to be disabled."
684 key: :invites_enabled,
687 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
690 key: :account_activation_required,
692 description: "Require users to confirm their emails before signing in"
695 key: :account_approval_required,
697 description: "Require users to be manually approved by an admin before signing in"
702 description: "Enable federation with other instances"
705 key: :federation_incoming_replies_max_depth,
706 label: "Fed. incoming replies max depth",
709 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
710 " 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.",
716 key: :federation_reachability_timeout_days,
717 label: "Fed. reachability timeout days",
720 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
728 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
734 "Makes the client API in authenticated mode-only except for user-profiles." <>
735 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
736 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
739 key: :quarantined_instances,
740 type: {:list, :string},
742 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
749 key: :managed_config,
752 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
757 description: "Instance static directory",
763 key: :allowed_post_formats,
764 type: {:list, :string},
765 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
774 key: :extended_nickname_format,
777 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
778 " This will break federation with older software for theses nicknames."
781 key: :cleanup_attachments,
784 Enable to remove associated attachments when status is removed.
785 This will not affect duplicates and attachments without status.
786 Enabling this will increase load to database when deleting statuses on larger instances.
790 key: :max_pinned_statuses,
792 description: "The maximum number of pinned statuses. 0 will disable the feature.",
800 key: :autofollowed_nicknames,
801 type: {:list, :string},
803 "Set to nicknames of (local) users that every new user should automatically follow",
812 key: :attachment_links,
814 description: "Enable to automatically add attachment link text to statuses"
817 key: :max_report_comment_size,
819 description: "The maximum size of the report comment. Default: 1000.",
825 key: :safe_dm_mentions,
826 label: "Safe DM mentions",
829 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
830 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
836 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
839 key: :remote_post_retention_days,
842 "The default amount of days to retain remote posts when pruning the database",
848 key: :user_bio_length,
850 description: "A user bio maximum length. Default: 5000.",
856 key: :user_name_length,
858 description: "A user name maximum length. Default: 100.",
864 key: :skip_thread_containment,
866 description: "Skip filtering out broken threads. Default: enabled."
869 key: :limit_to_local_content,
870 type: {:dropdown, :atom},
872 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
880 key: :max_account_fields,
882 description: "The maximum number of custom fields in the user profile. Default: 10.",
888 key: :max_remote_account_fields,
891 "The maximum number of custom fields in the remote user profile. Default: 20.",
897 key: :account_field_name_length,
899 description: "An account field name maximum length. Default: 512.",
905 key: :account_field_value_length,
907 description: "An account field value maximum length. Default: 2048.",
913 key: :registration_reason_length,
915 description: "Maximum registration reason length. Default: 500.",
921 key: :external_user_synchronization,
923 description: "Enabling following/followers counters synchronization for external users"
926 key: :multi_factor_authentication,
928 description: "Multi-factor authentication settings",
931 totp: [digits: 6, period: 30],
932 backup_codes: [number: 5, length: 16]
938 label: "TOTP settings",
940 description: "TOTP settings",
941 suggestions: [digits: 6, period: 30],
948 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
955 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
962 description: "MFA backup codes settings",
963 suggestions: [number: 5, length: 16],
969 description: "Number of backup codes to generate."
976 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
983 key: :instance_thumbnail,
986 "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.",
987 suggestions: ["/instance/thumbnail.jpeg"]
990 key: :show_reactions,
992 description: "Let favourites and emoji reactions be viewed through the API."
999 description: "Welcome messages settings",
1002 group: :direct_message,
1004 descpiption: "Direct message settings",
1009 description: "Enables sends direct message for new user after registration"
1015 "A message that will be sent to a newly registered users as a direct message",
1017 "Hi, @username! Welcome on board!"
1021 key: :sender_nickname,
1023 description: "The nickname of the local user that sends the welcome message",
1031 group: :chat_message,
1033 descpiption: "Chat message settings",
1038 description: "Enables sends chat message for new user after registration"
1044 "A message that will be sent to a newly registered users as a chat message",
1046 "Hello, welcome on board!"
1050 key: :sender_nickname,
1052 description: "The nickname of the local user that sends the welcome message",
1062 descpiption: "Email message settings",
1067 description: "Enables sends direct message for new user after registration"
1071 type: [:string, :tuple],
1073 "The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.",
1075 {"Pleroma App", "welcome@pleroma.app"}
1082 "The subject of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1083 suggestions: ["Welcome to <%= instance_name%>"]
1089 "The html content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1090 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1096 "The text content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1097 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1106 description: "Logger-related settings",
1110 type: [:atom, :tuple, :module],
1112 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1113 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1121 label: "ExSyslogger",
1122 description: "ExSyslogger-related settings",
1126 type: {:dropdown, :atom},
1127 description: "Log level",
1128 suggestions: [:debug, :info, :warn, :error]
1134 "A string that's prepended to every message, and is typically set to the app name",
1135 suggestions: ["pleroma"]
1140 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1141 suggestions: ["$metadata[$level] $message"]
1145 type: {:list, :atom},
1146 suggestions: [:request_id]
1154 label: "Console Logger",
1155 description: "Console logger settings",
1159 type: {:dropdown, :atom},
1160 description: "Log level",
1161 suggestions: [:debug, :info, :warn, :error]
1166 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1167 suggestions: ["$metadata[$level] $message"]
1171 type: {:list, :atom},
1172 suggestions: [:request_id]
1179 label: "Quack Logger",
1180 description: "Quack-related settings",
1184 type: {:dropdown, :atom},
1185 description: "Log level",
1186 suggestions: [:debug, :info, :warn, :error]
1190 type: {:list, :atom},
1191 description: "Configure which metadata you want to report on",
1208 label: "Webhook URL",
1210 description: "Configure the Slack incoming webhook",
1211 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1217 key: :frontend_configurations,
1220 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1221 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1222 "add your own configuration your settings all fields must be complete.",
1226 label: "Pleroma FE",
1228 description: "Settings for Pleroma FE",
1231 alwaysShowSubjectInput: true,
1232 background: "/static/aurora_borealis.jpg",
1233 collapseMessageWithSubject: false,
1236 hideFilteredStatuses: false,
1237 hideMutedPosts: false,
1238 hidePostStats: false,
1239 hideSitename: false,
1240 hideUserStats: false,
1241 loginMethod: "password",
1242 logo: "/static/logo.png",
1245 minimalScopesMode: false,
1246 noAttachmentLinks: false,
1247 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1248 postContentType: "text/plain",
1249 redirectRootLogin: "/main/friends",
1250 redirectRootNoLogin: "/main/all",
1252 sidebarRight: false,
1253 showFeaturesPanel: true,
1254 showInstanceSpecificPanel: false,
1255 subjectLineBehavior: "email",
1256 theme: "pleroma-dark",
1257 webPushNotifications: false
1262 key: :alwaysShowSubjectInput,
1263 label: "Always show subject input",
1265 description: "When disabled, auto-hide the subject field if it's empty"
1271 "URL of the background, unless viewing a user profile with a background that is set",
1272 suggestions: ["/images/city.jpg"]
1275 key: :collapseMessageWithSubject,
1276 label: "Collapse message with subject",
1279 "When a message has a subject (aka Content Warning), collapse it by default"
1283 label: "PleromaFE Chat",
1285 description: "Disables PleromaFE Chat component"
1291 description: "Enables green text on lines prefixed with the > character"
1294 key: :hideFilteredStatuses,
1295 label: "Hide Filtered Statuses",
1297 description: "Hides filtered statuses from timelines"
1300 key: :hideMutedPosts,
1301 label: "Hide Muted Posts",
1303 description: "Hides muted statuses from timelines"
1306 key: :hidePostStats,
1307 label: "Hide post stats",
1309 description: "Hide notices statistics (repeats, favorites, ...)"
1313 label: "Hide Sitename",
1315 description: "Hides instance name from PleromaFE banner"
1318 key: :hideUserStats,
1319 label: "Hide user stats",
1322 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1327 description: "URL of the logo, defaults to Pleroma's logo",
1328 suggestions: ["/static/logo.png"]
1332 label: "Logo margin",
1335 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1336 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1337 suggestions: [".1em"]
1344 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1345 "If you want a colorful logo you must disable logoMask."
1348 key: :minimalScopesMode,
1349 label: "Minimal scopes mode",
1352 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1353 "Also prevents replying to a DM with a public post from PleromaFE."
1356 key: :nsfwCensorImage,
1357 label: "NSFW Censor Image",
1360 "URL of the image to use for hiding NSFW media attachments in the timeline",
1361 suggestions: ["/static/img/nsfw.74818f9.png"]
1364 key: :postContentType,
1365 label: "Post Content Type",
1366 type: {:dropdown, :atom},
1367 description: "Default post formatting option",
1368 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1371 key: :redirectRootNoLogin,
1372 label: "Redirect root no login",
1375 "Relative URL which indicates where to redirect when a user isn't logged in",
1376 suggestions: ["/main/all"]
1379 key: :redirectRootLogin,
1380 label: "Redirect root login",
1383 "Relative URL which indicates where to redirect when a user is logged in",
1384 suggestions: ["/main/friends"]
1388 label: "Scope copy",
1390 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1394 label: "Sidebar on Right",
1396 description: "Change alignment of sidebar and panels to the right"
1399 key: :showFeaturesPanel,
1400 label: "Show instance features panel",
1403 "Enables panel displaying functionality of the instance on the About page"
1406 key: :showInstanceSpecificPanel,
1407 label: "Show instance specific panel",
1409 description: "Whether to show the instance's custom panel"
1412 key: :subjectLineBehavior,
1413 label: "Subject line behavior",
1415 description: "Allows changing the default behaviour of subject lines in replies.
1416 `email`: copy and preprend re:, as in email,
1417 `masto`: copy verbatim, as in Mastodon,
1418 `noop`: don't copy the subject.",
1419 suggestions: ["email", "masto", "noop"]
1424 description: "Which theme to use. Available themes are defined in styles.json",
1425 suggestions: ["pleroma-dark"]
1433 description: "Settings for Masto FE",
1436 showInstanceSpecificPanel: true
1441 key: :showInstanceSpecificPanel,
1442 label: "Show instance specific panel",
1444 description: "Whenether to show the instance's specific panel"
1455 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1459 type: {:keyword, :map},
1461 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1464 url: "/images/pleroma-fox-tan-smol.png",
1465 mime_type: "image/png"
1467 pleroma_fox_tan_shy: %{
1468 url: "/images/pleroma-fox-tan-shy.png",
1469 mime_type: "image/png"
1474 key: :default_mascot,
1477 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1483 key: :default_user_avatar,
1485 description: "URL of the default user avatar",
1486 suggestions: ["/images/avi.png"]
1495 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1499 type: {:list, :map},
1500 description: "Describe the icons of the app",
1503 src: "/static/logo.png"
1506 src: "/static/icon.png",
1510 src: "/static/icon.ico",
1511 sizes: "72x72 96x96 128x128 256x256"
1518 description: "Describe the theme color of the app",
1519 suggestions: ["#282c37", "mediumpurple"]
1522 key: :background_color,
1524 description: "Describe the background color of the app",
1525 suggestions: ["#191b22", "aliceblue"]
1535 description: "General MRF settings",
1539 type: [:module, {:list, :module}],
1541 "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.",
1542 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1546 label: "MRF transparency",
1549 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1552 key: :transparency_exclusions,
1553 label: "MRF transparency exclusions",
1554 type: {:list, :string},
1556 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1567 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1568 label: "MRF Simple",
1570 description: "Simple ingress policies",
1573 key: :media_removal,
1574 type: {:list, :string},
1575 description: "List of instances to strip media attachments from",
1576 suggestions: ["example.com", "*.example.com"]
1580 label: "Media NSFW",
1581 type: {:list, :string},
1582 description: "List of instances to tag all media as NSFW (sensitive) from",
1583 suggestions: ["example.com", "*.example.com"]
1586 key: :federated_timeline_removal,
1587 type: {:list, :string},
1589 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1590 suggestions: ["example.com", "*.example.com"]
1594 type: {:list, :string},
1595 description: "List of instances to reject activities from (except deletes)",
1596 suggestions: ["example.com", "*.example.com"]
1600 type: {:list, :string},
1601 description: "List of instances to only accept activities from (except deletes)",
1602 suggestions: ["example.com", "*.example.com"]
1605 key: :followers_only,
1606 type: {:list, :string},
1607 description: "Force posts from the given instances to be visible by followers only",
1608 suggestions: ["example.com", "*.example.com"]
1611 key: :report_removal,
1612 type: {:list, :string},
1613 description: "List of instances to reject reports from",
1614 suggestions: ["example.com", "*.example.com"]
1617 key: :avatar_removal,
1618 type: {:list, :string},
1619 description: "List of instances to strip avatars from",
1620 suggestions: ["example.com", "*.example.com"]
1623 key: :banner_removal,
1624 type: {:list, :string},
1625 description: "List of instances to strip banners from",
1626 suggestions: ["example.com", "*.example.com"]
1629 key: :reject_deletes,
1630 type: {:list, :string},
1631 description: "List of instances to reject deletions from",
1632 suggestions: ["example.com", "*.example.com"]
1638 key: :mrf_activity_expiration,
1640 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1641 label: "MRF Activity Expiration Policy",
1643 description: "Adds automatic expiration to all local activities",
1648 description: "Default global expiration time for all local activities (in days)",
1649 suggestions: [90, 365]
1657 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1658 label: "MRF Subchain",
1661 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1662 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1666 type: {:map, {:list, :string}},
1667 description: "Matches a series of regular expressions against the actor field",
1670 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1678 key: :mrf_rejectnonpublic,
1680 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1681 description: "RejectNonPublic drops posts with non-public visibility settings.",
1682 label: "MRF Reject Non Public",
1686 key: :allow_followersonly,
1687 label: "Allow followers-only",
1689 description: "Whether to allow followers-only posts"
1694 description: "Whether to allow direct messages"
1700 key: :mrf_hellthread,
1702 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1703 label: "MRF Hellthread",
1705 description: "Block messages with excessive user mentions",
1708 key: :delist_threshold,
1711 "Number of mentioned users after which the message gets removed from timelines and" <>
1712 "disables notifications. Set to 0 to disable.",
1716 key: :reject_threshold,
1719 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1728 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1729 label: "MRF Keyword",
1731 description: "Reject or Word-Replace messages with a keyword or regex",
1735 type: {:list, :string},
1737 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1738 suggestions: ["foo", ~r/foo/iu]
1741 key: :federated_timeline_removal,
1742 type: {:list, :string},
1744 "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.",
1745 suggestions: ["foo", ~r/foo/iu]
1749 type: {:list, :tuple},
1751 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1752 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1760 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1761 label: "MRF Mention",
1763 description: "Block messages which mention a specific user",
1767 type: {:list, :string},
1768 description: "A list of actors for which any post mentioning them will be dropped",
1769 suggestions: ["actor1", "actor2"]
1775 key: :mrf_vocabulary,
1777 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1778 label: "MRF Vocabulary",
1780 description: "Filter messages which belong to certain activity vocabularies",
1784 type: {:list, :string},
1786 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1787 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1791 type: {:list, :string},
1793 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1794 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1800 # key: :mrf_user_allowlist,
1802 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1805 # "The keys in this section are the domain names that the policy should apply to." <>
1806 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1808 # %{"example.org" => ["https://example.org/users/admin"]}
1816 description: "Media proxy",
1821 description: "Enables proxying of remote media to the instance's proxy"
1828 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1829 suggestions: ["https://example.com"]
1837 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1843 description: "Enables invalidate media cache"
1848 description: "Module which will be used to cache purge.",
1850 Pleroma.Web.MediaProxy.Invalidation.Script,
1851 Pleroma.Web.MediaProxy.Invalidation.Http
1858 label: "Proxy Options",
1860 description: "Options for Pleroma.ReverseProxy",
1862 redirect_on_failure: false,
1863 max_body_length: 25 * 1_048_576,
1865 follow_redirect: true,
1871 key: :redirect_on_failure,
1874 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1875 "Any error during body processing will not be redirected as the response is chunked."
1878 key: :max_body_length,
1881 "Limits the content length to be approximately the " <>
1882 "specified length. It is validated with the `content-length` header and also verified when proxying."
1888 description: "HTTP options",
1893 description: "Adapter specific options",
1898 label: "SSL Options",
1899 description: "SSL options for HTTP adapter",
1903 type: {:list, :atom},
1904 description: "List of TLS version to use",
1905 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1914 type: [:string, :tuple],
1915 description: "Proxy URL",
1916 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1924 type: {:list, :string},
1925 description: "List of hosts with scheme to bypass the mediaproxy",
1926 suggestions: ["http://example.com"]
1932 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1934 description: "HTTP invalidate settings",
1939 description: "HTTP method of request. Default: :purge"
1943 type: {:keyword, :string},
1944 description: "HTTP headers of request",
1945 suggestions: [{"x-refresh", 1}]
1950 description: "Request options",
1954 type: {:map, :string}
1962 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1964 description: "Script invalidate settings",
1969 description: "Path to shell script. Which will run purge cache.",
1970 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1978 description: "Gopher settings",
1983 description: "Enables the gopher interface"
1989 description: "IP address to bind to",
1990 suggestions: [{0, 0, 0, 0}]
1995 description: "Port to bind to",
2001 description: "Port advertised in URLs (optional, defaults to port)",
2009 label: "ActivityPub",
2011 description: "ActivityPub-related settings",
2014 key: :unfollow_blocked,
2016 description: "Whether blocks result in people getting unfollowed"
2019 key: :outgoing_blocks,
2021 description: "Whether to federate blocks to other instances"
2024 key: :sign_object_fetches,
2026 description: "Sign object fetches with HTTP signatures"
2029 key: :note_replies_output_limit,
2032 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2035 key: :follow_handshake_timeout,
2037 description: "Following handshake timeout",
2044 key: :http_security,
2045 label: "HTTP security",
2047 description: "HTTP security settings",
2052 description: "Whether the managed content security policy is enabled"
2058 description: "Whether to additionally send a Strict-Transport-Security header"
2062 label: "STS max age",
2064 description: "The maximum age for the Strict-Transport-Security header if sent",
2065 suggestions: [31_536_000]
2069 label: "CT max age",
2071 description: "The maximum age for the Expect-CT header if sent",
2072 suggestions: [2_592_000]
2075 key: :referrer_policy,
2077 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2078 suggestions: ["same-origin", "no-referrer"]
2082 label: "Report URI",
2084 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2085 suggestions: ["https://example.com/report-uri"]
2090 group: :web_push_encryption,
2091 key: :vapid_details,
2092 label: "Vapid Details",
2095 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2101 "A mailto link for the administrative contact." <>
2102 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2103 suggestions: ["mailto:moderators@pleroma.com"]
2108 description: "VAPID public key",
2109 suggestions: ["Public key"]
2114 description: "VAPID private key",
2115 suggestions: ["Private key"]
2121 key: Pleroma.Captcha,
2123 description: "Captcha-related settings",
2128 description: "Whether the captcha should be shown on registration"
2133 description: "The method/service to use for captcha",
2134 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2137 key: :seconds_valid,
2139 description: "The time in seconds for which the captcha is valid",
2146 key: Pleroma.Captcha.Kocaptcha,
2149 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2150 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2155 description: "The kocaptcha endpoint to use",
2156 suggestions: ["https://captcha.kotobank.ch"]
2162 label: "Pleroma Admin Token",
2165 "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)",
2170 description: "Admin token",
2172 "Please use a high entropy string or UUID"
2182 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2184 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2185 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2186 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2187 (see https://github.com/sorentwo/oban/issues/52).
2192 type: {:dropdown, :atom},
2193 description: "Logs verbose mode",
2194 suggestions: [false, :error, :warn, :info, :debug]
2198 type: {:keyword, :integer},
2200 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2202 activity_expiration: 10,
2203 attachments_cleanup: 5,
2205 federator_incoming: 50,
2206 federator_outgoing: 50,
2208 scheduled_activities: 10,
2214 key: :activity_expiration,
2216 description: "Activity expiration queue",
2220 key: :attachments_cleanup,
2222 description: "Attachment deletion queue",
2228 description: "Background queue",
2232 key: :federator_incoming,
2234 description: "Incoming federation queue",
2238 key: :federator_outgoing,
2240 description: "Outgoing federation queue",
2246 description: "Email sender queue, see Pleroma.Emails.Mailer",
2250 key: :scheduled_activities,
2252 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2256 key: :transmogrifier,
2258 description: "Transmogrifier queue",
2264 description: "Web push notifications queue",
2271 type: {:list, :tuple},
2272 description: "Settings for cron background jobs",
2274 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2275 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2276 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2277 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2278 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2287 description: "Includes custom worker options not interpretable directly by `Oban`",
2291 type: {:keyword, :integer},
2292 description: "Max retry attempts for failed jobs, per `Oban` queue",
2294 federator_incoming: 5,
2295 federator_outgoing: 5
2302 key: Pleroma.Web.Metadata,
2304 description: "Metadata-related settings",
2308 type: {:list, :module},
2309 description: "List of metadata providers to enable",
2311 Pleroma.Web.Metadata.Providers.OpenGraph,
2312 Pleroma.Web.Metadata.Providers.TwitterCard,
2313 Pleroma.Web.Metadata.Providers.RelMe,
2314 Pleroma.Web.Metadata.Providers.Feed
2319 label: "Unfurl NSFW",
2321 description: "When enabled NSFW attachments will be shown in previews"
2330 "If enabled the instance will parse metadata from attached links to generate link previews",
2335 description: "Enables RichMedia parsing of URLs"
2339 type: {:list, :string},
2340 description: "List of hosts which will be ignored by the metadata parser",
2341 suggestions: ["accounts.google.com", "xss.website"]
2345 label: "Ignore TLD",
2346 type: {:list, :string},
2347 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2348 suggestions: ["local", "localdomain", "lan"]
2352 type: {:list, :module},
2354 "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.",
2356 Pleroma.Web.RichMedia.Parsers.OEmbed,
2357 Pleroma.Web.RichMedia.Parsers.TwitterCard
2362 label: "TTL setters",
2363 type: {:list, :module},
2365 "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.",
2367 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2374 key: Pleroma.Formatter,
2375 label: "Auto Linker",
2378 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2382 type: [:string, :boolean],
2383 description: "Specify the class to be added to the generated link. Disable to clear.",
2384 suggestions: ["auto-linker", false]
2388 type: [:string, :boolean],
2389 description: "Override the rel attribute. Disable to clear.",
2390 suggestions: ["ugc", "noopener noreferrer", false]
2395 description: "Link URLs will open in a new window/tab."
2399 type: [:integer, :boolean],
2401 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2402 suggestions: [15, false]
2407 description: "Strip the scheme prefix."
2412 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2416 type: [:atom, :boolean],
2418 "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)",
2419 suggestions: [:no_scheme, true]
2425 key: Pleroma.ScheduledActivity,
2427 description: "Scheduled activities settings",
2430 key: :daily_user_limit,
2433 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2437 key: :total_user_limit,
2440 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2446 description: "Whether scheduled activities are sent to the job queue to be executed"
2452 key: Pleroma.ActivityExpiration,
2454 description: "Expired activity settings",
2459 description: "Whether expired activities will be sent to the job queue to be deleted"
2465 label: "Pleroma Authenticator",
2467 description: "Authenticator",
2470 key: Pleroma.Web.Auth.Authenticator,
2472 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2482 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2483 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2484 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2485 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2490 description: "Enables LDAP authentication"
2495 description: "LDAP server hostname",
2496 suggestions: ["localhosts"]
2501 description: "LDAP port, e.g. 389 or 636",
2502 suggestions: [389, 636]
2508 description: "Enable to use SSL, usually implies the port 636"
2512 label: "SSL options",
2514 description: "Additional SSL options",
2515 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2520 description: "Path to file with PEM encoded cacerts",
2521 suggestions: ["path/to/file/with/PEM/cacerts"]
2526 description: "Type of cert verification",
2527 suggestions: [:verify_peer]
2535 description: "Enable to use STARTTLS, usually implies the port 389"
2539 label: "TLS options",
2541 description: "Additional TLS options",
2542 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2547 description: "Path to file with PEM encoded cacerts",
2548 suggestions: ["path/to/file/with/PEM/cacerts"]
2553 description: "Type of cert verification",
2554 suggestions: [:verify_peer]
2561 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2562 suggestions: ["dc=example,dc=com"]
2569 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2578 description: "Authentication / authorization settings",
2581 key: :enforce_oauth_admin_scope_usage,
2582 label: "Enforce OAuth admin scope usage",
2585 "OAuth admin scope requirement toggle. " <>
2586 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2587 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2588 "`is_admin` user flag grants access to admin-specific actions."
2591 key: :auth_template,
2594 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2595 suggestions: ["show.html"]
2598 key: :oauth_consumer_template,
2599 label: "OAuth consumer template",
2602 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2603 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2604 suggestions: ["consumer.html"]
2607 key: :oauth_consumer_strategies,
2608 label: "OAuth consumer strategies",
2609 type: {:list, :string},
2611 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2612 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2613 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2614 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2620 key: :email_notifications,
2622 description: "Email notifications settings",
2628 "emails of \"what you've missed\" for users who have been inactive for a while",
2632 schedule: "0 0 * * 0",
2634 inactivity_threshold: 7
2642 description: "Globally enable or disable digest emails"
2648 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2649 suggestions: ["0 0 * * 0"]
2654 description: "Minimum interval between digest emails to one user",
2658 key: :inactivity_threshold,
2660 description: "Minimum user inactivity threshold",
2669 key: Pleroma.Emails.UserEmail,
2671 description: "Email template settings",
2676 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2677 suggestions: ["some/path/logo.png"]
2682 description: "A map with color settings for email templates.",
2685 link_color: "#d8a070",
2686 background_color: "#2C3645",
2687 content_background_color: "#1B2635",
2688 header_color: "#d8a070",
2689 text_color: "#b9b9ba",
2690 text_muted_color: "#b9b9ba"
2697 suggestions: ["#d8a070"]
2700 key: :background_color,
2702 suggestions: ["#2C3645"]
2705 key: :content_background_color,
2707 suggestions: ["#1B2635"]
2712 suggestions: ["#d8a070"]
2717 suggestions: ["#b9b9ba"]
2720 key: :text_muted_color,
2722 suggestions: ["#b9b9ba"]
2730 key: Pleroma.Emails.NewUsersDigestEmail,
2732 description: "New users admin email digest",
2737 description: "Enables new users admin digest email when `true`"
2746 description: "Configure OAuth 2 provider capabilities",
2749 key: :token_expires_in,
2751 description: "The lifetime in seconds of the access token",
2755 key: :issue_new_refresh_token,
2758 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2761 key: :clean_expired_tokens,
2763 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2773 key: :shortcode_globs,
2774 type: {:list, :string},
2775 description: "Location of custom emoji files. * can be used as a wildcard.",
2776 suggestions: ["/emoji/custom/**/*.png"]
2779 key: :pack_extensions,
2780 type: {:list, :string},
2782 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2783 suggestions: [".png", ".gif"]
2787 type: {:keyword, {:list, :string}},
2789 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2790 " and the value is the location or array of locations. * can be used as a wildcard.",
2792 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2796 key: :default_manifest,
2799 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2800 " Currently only one manifest can be added (no arrays).",
2801 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2804 key: :shared_pack_cache_seconds_per_file,
2805 label: "Shared pack cache s/file",
2808 "When an emoji pack is shared, the archive is created and cached in memory" <>
2809 " for this amount of seconds multiplied by the number of files.",
2819 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2823 type: [:tuple, {:list, :tuple}],
2824 description: "For the search requests (account & status search etc.)",
2825 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2829 type: [:tuple, {:list, :tuple}],
2830 description: "For requests to timelines (each timeline has it's own limiter)",
2831 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2834 key: :app_account_creation,
2835 type: [:tuple, {:list, :tuple}],
2836 description: "For registering user accounts from the same IP address",
2837 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2840 key: :relations_actions,
2841 type: [:tuple, {:list, :tuple}],
2842 description: "For actions on relationships with all users (follow, unfollow)",
2843 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2846 key: :relation_id_action,
2847 label: "Relation ID action",
2848 type: [:tuple, {:list, :tuple}],
2849 description: "For actions on relation with a specific user (follow, unfollow)",
2850 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2853 key: :statuses_actions,
2854 type: [:tuple, {:list, :tuple}],
2856 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2857 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2860 key: :status_id_action,
2861 label: "Status ID action",
2862 type: [:tuple, {:list, :tuple}],
2864 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2865 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2868 key: :authentication,
2869 type: [:tuple, {:list, :tuple}],
2870 description: "For authentication create / password check / user existence check requests",
2871 suggestions: [{60_000, 15}]
2880 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2881 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2886 description: "Enables SSH"
2891 description: "Dir with SSH keys",
2892 suggestions: ["/some/path/ssh_keys"]
2897 description: "Handler module",
2898 suggestions: ["Pleroma.BBS.Handler"]
2903 description: "Port to connect",
2904 suggestions: [10_022]
2907 key: :password_authenticator,
2909 description: "Authenticator module",
2910 suggestions: ["Pleroma.BBS.Authenticator"]
2916 label: "Mime Types",
2918 description: "Mime Types settings",
2925 "application/xml" => ["xml"],
2926 "application/xrd+xml" => ["xrd+xml"],
2927 "application/jrd+json" => ["jrd+json"],
2928 "application/activity+json" => ["activity+json"],
2929 "application/ld+json" => ["activity+json"]
2934 key: "application/xml",
2935 type: {:list, :string},
2936 suggestions: ["xml"]
2939 key: "application/xrd+xml",
2940 type: {:list, :string},
2941 suggestions: ["xrd+xml"]
2944 key: "application/jrd+json",
2945 type: {:list, :string},
2946 suggestions: ["jrd+json"]
2949 key: "application/activity+json",
2950 type: {:list, :string},
2951 suggestions: ["activity+json"]
2954 key: "application/ld+json",
2955 type: {:list, :string},
2956 suggestions: ["activity+json"]
2966 description: "Pleroma chat settings",
2979 description: "HTTP settings",
2984 type: [:string, :tuple],
2985 description: "Proxy URL",
2986 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2989 key: :send_user_agent,
2994 type: [:string, :atom],
2996 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2997 suggestions: ["Pleroma", :default]
3002 description: "Adapter specific options",
3008 label: "SSL Options",
3009 description: "SSL options for HTTP adapter",
3013 type: {:list, :atom},
3014 description: "List of TLS version to use",
3015 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3026 label: "Markup Settings",
3030 key: :allow_inline_images,
3034 key: :allow_headings,
3047 type: {:list, :module},
3049 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3050 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3060 key: :deny_follow_blocked,
3067 key: :mrf_normalize_markup,
3069 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3070 label: "MRF Normalize Markup",
3071 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3077 suggestions: [Pleroma.HTML.Scrubber.Default]
3087 key: :restricted_nicknames,
3088 type: {:list, :string},
3089 description: "List of nicknames users may not register with.",
3108 "ostatus_subscribe",
3124 key: :email_blacklist,
3125 type: {:list, :string},
3126 description: "List of email domains users may not register with.",
3127 suggestions: ["mailinator.com", "maildrop.cc"]
3133 label: "CORS plug config",
3139 suggestions: [86_400]
3143 type: {:list, :string},
3144 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3148 type: {:list, :string},
3151 "X-RateLimit-Reset",
3152 "X-RateLimit-Limit",
3153 "X-RateLimit-Remaining",
3164 type: {:list, :string},
3165 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3171 key: Pleroma.Plugs.RemoteIp,
3174 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3175 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3181 description: "Enable/disable the plug. Default: disabled."
3185 type: {:list, :string},
3187 "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]`."
3191 type: {:list, :string},
3193 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3197 type: {:list, :string},
3199 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3205 key: :web_cache_ttl,
3206 label: "Web cache TTL",
3209 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3215 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3216 suggestions: [30_000, nil]
3219 key: :activity_pub_question,
3221 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3222 suggestions: [30_000]
3232 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3237 description: "Enables the rendering of static HTML. Default: disabled."
3245 description: "Configure feed rendering",
3250 description: "Configure title rendering",
3255 description: "Maximum number of characters before truncating title",
3261 description: "Replacement which will be used after truncating string",
3262 suggestions: ["..."]
3270 key: :mrf_object_age,
3272 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3273 label: "MRF Object Age",
3276 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3281 description: "Required age (in seconds) of a post before actions are taken.",
3282 suggestions: [172_800]
3286 type: {:list, :atom},
3288 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3289 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3290 "`:reject` rejects the message entirely",
3291 suggestions: [:delist, :strip_followers, :reject]
3299 description: "Custom Runtime Modules",
3304 description: "A path to custom Elixir modules (such as MRF policies)."
3312 description: "Settings for notifications streamer",
3317 description: "Number of workers to send notifications",
3321 key: :overflow_workers,
3323 description: "Maximum number of workers created if pool is empty",
3330 key: :connections_pool,
3332 description: "Advanced settings for `gun` connections pool",
3335 key: :connection_acquisition_wait,
3338 "Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries. Default: 250ms.",
3342 key: :connection_acquisition_retries,
3345 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3349 key: :max_connections,
3351 description: "Maximum number of connections in the pool. Default: 250 connections.",
3355 key: :await_up_timeout,
3357 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3361 key: :reclaim_multiplier,
3364 "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",
3373 description: "Advanced settings for `gun` workers pools",
3375 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3379 description: "Settings for #{pool_name} pool.",
3384 description: "Maximum number of concurrent requests in the pool.",
3391 "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",
3400 key: :hackney_pools,
3402 description: "Advanced settings for `hackney` connections pools",
3407 description: "Settings for federation pool.",
3410 key: :max_connections,
3412 description: "Number workers in the pool.",
3418 description: "Timeout while `hackney` will wait for response.",
3419 suggestions: [150_000]
3426 description: "Settings for media 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 upload pool.",
3448 key: :max_connections,
3450 description: "Number workers in the pool.",
3456 description: "Timeout while `hackney` will wait for response.",
3457 suggestions: [300_000]
3465 key: :restrict_unauthenticated,
3468 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3473 description: "Settings for public and federated timelines.",
3478 description: "Disallow view public timeline."
3483 description: "Disallow view federated timeline."
3490 description: "Settings for user profiles.",
3495 description: "Disallow view local user profiles."
3500 description: "Disallow view remote user profiles."
3507 description: "Settings for statuses.",
3512 description: "Disallow view local statuses."
3517 description: "Disallow view remote statuses."
3525 key: Pleroma.Web.ApiSpec.CastAndValidate,
3532 "Enables strict input validation (useful in development, not recommended in production)"
3538 key: :instances_favicons,
3540 description: "Control favicons for instances",
3545 description: "Allow/disallow displaying and getting instances favicons"
3553 descriptions: "S3 service related settings",
3556 key: :access_key_id,
3558 description: "S3 access key ID",
3559 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3562 key: :secret_access_key,
3564 description: "Secret access key",
3565 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3570 description: "S3 host",
3571 suggestions: ["s3.eu-central-1.amazonaws.com"]
3579 description: "Installed frontends management",
3584 description: "Primary frontend, the one that is served for all pages by default",
3585 children: frontend_options
3590 description: "Admin frontend",
3591 children: frontend_options
3596 description: "A map containing frontends that we have some knowledge of"