2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
26 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
30 type: {:list, :module},
32 "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.",
33 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
39 "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`."
45 description: "Base URL for the uploads, needed if you use CDN",
47 "https://cdn-host.com"
54 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
58 label: "Proxy Options",
60 description: "Options for Pleroma.ReverseProxy",
62 redirect_on_failure: false,
63 max_body_length: 25 * 1_048_576,
65 follow_redirect: true,
71 key: :redirect_on_failure,
74 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
75 "Any error during body processing will not be redirected as the response is chunked."
78 key: :max_body_length,
81 "Limits the content length to be approximately the " <>
82 "specified length. It is validated with the `content-length` header and also verified when proxying."
88 description: "HTTP options",
93 description: "Adapter specific options",
99 description: "SSL options for HTTP adapter",
103 type: {:list, :atom},
104 description: "List of TLS versions to use",
105 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
114 type: [:string, :tuple],
115 description: "Proxy URL",
116 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
123 key: :filename_display_max_length,
125 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
131 key: Pleroma.Uploaders.Local,
133 description: "Local uploader-related settings",
138 description: "Path where user's uploads will be saved",
147 key: Pleroma.Uploaders.S3,
149 description: "S3 uploader-related settings",
154 description: "S3 bucket",
160 key: :bucket_namespace,
162 description: "S3 bucket namespace",
163 suggestions: ["pleroma"]
166 key: :public_endpoint,
168 description: "S3 endpoint",
169 suggestions: ["https://s3.amazonaws.com"]
172 key: :truncated_namespace,
175 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
176 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
179 key: :streaming_enabled,
182 "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."
188 key: Pleroma.Upload.Filter.Mogrify,
190 description: "Uploads mogrify filter settings",
194 type: [:string, {:list, :string}, {:list, :tuple}],
196 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
197 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
208 key: Pleroma.Upload.Filter.AnonymizeFilename,
210 description: "Filter replaces the filename of the upload",
216 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
217 " filename extension by using {extension}, for example custom-file-name.{extension}.",
219 "custom-file-name.{extension}"
226 key: Pleroma.Emails.Mailer,
228 description: "Mailer-related settings",
234 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
235 " or Swoosh.Adapters.Local for in-memory mailbox",
237 Swoosh.Adapters.SMTP,
238 Swoosh.Adapters.Sendgrid,
239 Swoosh.Adapters.Sendmail,
240 Swoosh.Adapters.Mandrill,
241 Swoosh.Adapters.Mailgun,
242 Swoosh.Adapters.Mailjet,
243 Swoosh.Adapters.Postmark,
244 Swoosh.Adapters.SparkPost,
245 Swoosh.Adapters.AmazonSES,
247 Swoosh.Adapters.SocketLabs,
248 Swoosh.Adapters.Gmail,
249 Swoosh.Adapters.Local
255 description: "Allow/disallow send emails"
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
262 suggestions: ["smtp.gmail.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
269 suggestions: ["pleroma"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
275 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
276 suggestions: ["password"]
279 group: {:subgroup, Swoosh.Adapters.SMTP},
283 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
286 group: {:subgroup, Swoosh.Adapters.SMTP},
290 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
291 suggestions: [:always, :never, :if_available]
294 group: {:subgroup, Swoosh.Adapters.SMTP},
297 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
298 suggestions: [:always, :never, :if_available]
301 group: {:subgroup, Swoosh.Adapters.SMTP},
304 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
308 group: {:subgroup, Swoosh.Adapters.SMTP},
311 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
315 group: {:subgroup, Swoosh.Adapters.SMTP},
317 label: "No MX lookups",
319 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
322 group: {:subgroup, Swoosh.Adapters.Sendgrid},
326 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
327 suggestions: ["my-api-key"]
330 group: {:subgroup, Swoosh.Adapters.Sendmail},
333 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
334 suggestions: ["/usr/bin/sendmail"]
337 group: {:subgroup, Swoosh.Adapters.Sendmail},
340 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
341 suggestions: ["-N delay,failure,success"]
344 group: {:subgroup, Swoosh.Adapters.Sendmail},
347 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
350 group: {:subgroup, Swoosh.Adapters.Mandrill},
354 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
355 suggestions: ["my-api-key"]
358 group: {:subgroup, Swoosh.Adapters.Mailgun},
362 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
363 suggestions: ["my-api-key"]
366 group: {:subgroup, Swoosh.Adapters.Mailgun},
369 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
370 suggestions: ["pleroma.com"]
373 group: {:subgroup, Swoosh.Adapters.Mailjet},
377 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
378 suggestions: ["my-api-key"]
381 group: {:subgroup, Swoosh.Adapters.Mailjet},
384 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
385 suggestions: ["my-secret-key"]
388 group: {:subgroup, Swoosh.Adapters.Postmark},
392 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
393 suggestions: ["my-api-key"]
396 group: {:subgroup, Swoosh.Adapters.SparkPost},
400 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
401 suggestions: ["my-api-key"]
404 group: {:subgroup, Swoosh.Adapters.SparkPost},
407 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
408 suggestions: ["https://api.sparkpost.com/api/v1"]
411 group: {:subgroup, Swoosh.Adapters.AmazonSES},
414 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
415 suggestions: ["us-east-1", "us-east-2"]
418 group: {:subgroup, Swoosh.Adapters.AmazonSES},
421 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
422 suggestions: ["aws-access-key"]
425 group: {:subgroup, Swoosh.Adapters.AmazonSES},
428 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
429 suggestions: ["aws-secret-key"]
432 group: {:subgroup, Swoosh.Adapters.Dyn},
436 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
437 suggestions: ["my-api-key"]
440 group: {:subgroup, Swoosh.Adapters.SocketLabs},
443 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
446 group: {:subgroup, Swoosh.Adapters.SocketLabs},
450 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
453 group: {:subgroup, Swoosh.Adapters.Gmail},
456 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
463 description: "`Swoosh.Adapters.Local` adapter specific settings",
466 group: {:subgroup, Swoosh.Adapters.Local},
469 description: "Run the preview server together as part of your app"
472 group: {:subgroup, Swoosh.Adapters.Local},
475 description: "The preview server port",
483 label: "URI Schemes",
485 description: "URI schemes related settings",
489 type: {:list, :string},
490 description: "List of the scheme part that is considered valid to be an URL",
515 description: "Instance-related settings",
520 description: "Name of the instance",
527 label: "Admin Email Address",
529 description: "Email used to reach an Administrator/Moderator of the instance",
536 label: "Sender Email Address",
538 description: "Envelope FROM address for mail sent via Pleroma",
547 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
555 description: "Posts character limit (CW/Subject included in the counter)",
563 description: "Character limit of the instance chat messages",
571 description: "Hard character limit beyond which remote posts will be dropped",
579 description: "File size limit of uploads (except for avatar, background, banner)",
585 key: :avatar_upload_limit,
587 description: "File size limit of user's profile avatars",
593 key: :background_upload_limit,
595 description: "File size limit of user's profile backgrounds",
601 key: :banner_upload_limit,
603 description: "File size limit of user's profile banners",
611 description: "A map with poll limits for local polls",
615 max_option_chars: 200,
617 max_expiration: 31_536_000
624 description: "Maximum number of options",
628 key: :max_option_chars,
630 description: "Maximum number of characters per option",
634 key: :min_expiration,
636 description: "Minimum expiration time (in seconds)",
640 key: :max_expiration,
642 description: "Maximum expiration time (in seconds)",
648 key: :registrations_open,
651 "Enable registrations for anyone. Invitations require this setting to be disabled."
654 key: :invites_enabled,
657 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
660 key: :account_activation_required,
662 description: "Require users to confirm their emails before signing in"
667 description: "Enable federation with other instances"
670 key: :federation_incoming_replies_max_depth,
671 label: "Fed. incoming replies max depth",
674 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
675 " 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.",
681 key: :federation_reachability_timeout_days,
682 label: "Fed. reachability timeout days",
685 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
693 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
699 "Makes the client API in authenticated mode-only except for user-profiles." <>
700 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
701 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
704 key: :quarantined_instances,
705 type: {:list, :string},
707 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
714 key: :managed_config,
717 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
722 description: "Instance static directory",
728 key: :allowed_post_formats,
729 type: {:list, :string},
730 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
739 key: :extended_nickname_format,
742 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
743 " This will break federation with older software for theses nicknames."
746 key: :cleanup_attachments,
749 Enable to remove associated attachments when status is removed.
750 This will not affect duplicates and attachments without status.
751 Enabling this will increase load to database when deleting statuses on larger instances.
755 key: :max_pinned_statuses,
757 description: "The maximum number of pinned statuses. 0 will disable the feature.",
765 key: :autofollowed_nicknames,
766 type: {:list, :string},
768 "Set to nicknames of (local) users that every new user should automatically follow",
777 key: :attachment_links,
779 description: "Enable to automatically add attachment link text to statuses"
782 key: :max_report_comment_size,
784 description: "The maximum size of the report comment. Default: 1000.",
790 key: :safe_dm_mentions,
791 label: "Safe DM mentions",
794 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
795 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
801 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
804 key: :remote_post_retention_days,
807 "The default amount of days to retain remote posts when pruning the database",
813 key: :user_bio_length,
815 description: "A user bio maximum length. Default: 5000.",
821 key: :user_name_length,
823 description: "A user name maximum length. Default: 100.",
829 key: :skip_thread_containment,
831 description: "Skip filtering out broken threads. Default: enabled."
834 key: :limit_to_local_content,
835 type: {:dropdown, :atom},
837 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
845 key: :max_account_fields,
847 description: "The maximum number of custom fields in the user profile. Default: 10.",
853 key: :max_remote_account_fields,
856 "The maximum number of custom fields in the remote user profile. Default: 20.",
862 key: :account_field_name_length,
864 description: "An account field name maximum length. Default: 512.",
870 key: :account_field_value_length,
872 description: "An account field value maximum length. Default: 2048.",
878 key: :external_user_synchronization,
880 description: "Enabling following/followers counters synchronization for external users"
883 key: :multi_factor_authentication,
885 description: "Multi-factor authentication settings",
888 totp: [digits: 6, period: 30],
889 backup_codes: [number: 5, length: 16]
895 label: "TOTP settings",
897 description: "TOTP settings",
898 suggestions: [digits: 6, period: 30],
905 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
912 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
919 description: "MFA backup codes settings",
920 suggestions: [number: 5, length: 16],
926 description: "Number of backup codes to generate."
933 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
940 key: :instance_thumbnail,
943 "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.",
944 suggestions: ["/instance/thumbnail.jpeg"]
951 description: "Welcome messages settings",
954 group: :direct_message,
956 descpiption: "Direct message settings",
961 description: "Enables sends direct message for new user after registration"
967 "A message that will be sent to a newly registered users as a direct message",
969 "Hi, @username! Welcome on board!"
973 key: :sender_nickname,
975 description: "The nickname of the local user that sends the welcome message",
985 descpiption: "Email message settings",
990 description: "Enables sends direct message for new user after registration"
993 key: :sender_nickname,
995 description: "The nickname of the local user that sends the welcome email",
1004 "The subject of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1005 suggestions: ["Welcome to <%= instance_name%>"]
1011 "The html content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1012 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1018 "The text content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1019 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1028 description: "Logger-related settings",
1032 type: [:atom, :tuple, :module],
1034 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1035 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1043 label: "ExSyslogger",
1044 description: "ExSyslogger-related settings",
1048 type: {:dropdown, :atom},
1049 description: "Log level",
1050 suggestions: [:debug, :info, :warn, :error]
1056 "A string that's prepended to every message, and is typically set to the app name",
1057 suggestions: ["pleroma"]
1062 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1063 suggestions: ["$metadata[$level] $message"]
1067 type: {:list, :atom},
1068 suggestions: [:request_id]
1076 label: "Console Logger",
1077 description: "Console logger settings",
1081 type: {:dropdown, :atom},
1082 description: "Log level",
1083 suggestions: [:debug, :info, :warn, :error]
1088 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1089 suggestions: ["$metadata[$level] $message"]
1093 type: {:list, :atom},
1094 suggestions: [:request_id]
1101 label: "Quack Logger",
1102 description: "Quack-related settings",
1106 type: {:dropdown, :atom},
1107 description: "Log level",
1108 suggestions: [:debug, :info, :warn, :error]
1112 type: {:list, :atom},
1113 description: "Configure which metadata you want to report on",
1130 label: "Webhook URL",
1132 description: "Configure the Slack incoming webhook",
1133 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1139 key: :frontend_configurations,
1142 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1143 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1144 "add your own configuration your settings all fields must be complete.",
1148 label: "Pleroma FE",
1150 description: "Settings for Pleroma FE",
1153 alwaysShowSubjectInput: true,
1154 background: "/static/aurora_borealis.jpg",
1155 collapseMessageWithSubject: false,
1158 hideFilteredStatuses: false,
1159 hideMutedPosts: false,
1160 hidePostStats: false,
1161 hideSitename: false,
1162 hideUserStats: false,
1163 loginMethod: "password",
1164 logo: "/static/logo.png",
1167 minimalScopesMode: false,
1168 noAttachmentLinks: false,
1169 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1170 postContentType: "text/plain",
1171 redirectRootLogin: "/main/friends",
1172 redirectRootNoLogin: "/main/all",
1174 sidebarRight: false,
1175 showFeaturesPanel: true,
1176 showInstanceSpecificPanel: false,
1177 subjectLineBehavior: "email",
1178 theme: "pleroma-dark",
1179 webPushNotifications: false
1184 key: :alwaysShowSubjectInput,
1185 label: "Always show subject input",
1187 description: "When disabled, auto-hide the subject field if it's empty"
1193 "URL of the background, unless viewing a user profile with a background that is set",
1194 suggestions: ["/images/city.jpg"]
1197 key: :collapseMessageWithSubject,
1198 label: "Collapse message with subject",
1201 "When a message has a subject (aka Content Warning), collapse it by default"
1205 label: "PleromaFE Chat",
1207 description: "Disables PleromaFE Chat component"
1213 description: "Enables green text on lines prefixed with the > character"
1216 key: :hideFilteredStatuses,
1217 label: "Hide Filtered Statuses",
1219 description: "Hides filtered statuses from timelines"
1222 key: :hideMutedPosts,
1223 label: "Hide Muted Posts",
1225 description: "Hides muted statuses from timelines"
1228 key: :hidePostStats,
1229 label: "Hide post stats",
1231 description: "Hide notices statistics (repeats, favorites, ...)"
1235 label: "Hide Sitename",
1237 description: "Hides instance name from PleromaFE banner"
1240 key: :hideUserStats,
1241 label: "Hide user stats",
1244 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1249 description: "URL of the logo, defaults to Pleroma's logo",
1250 suggestions: ["/static/logo.png"]
1254 label: "Logo margin",
1257 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1258 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1259 suggestions: [".1em"]
1266 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1267 "If you want a colorful logo you must disable logoMask."
1270 key: :minimalScopesMode,
1271 label: "Minimal scopes mode",
1274 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1275 "Also prevents replying to a DM with a public post from PleromaFE."
1278 key: :nsfwCensorImage,
1279 label: "NSFW Censor Image",
1282 "URL of the image to use for hiding NSFW media attachments in the timeline",
1283 suggestions: ["/static/img/nsfw.74818f9.png"]
1286 key: :postContentType,
1287 label: "Post Content Type",
1288 type: {:dropdown, :atom},
1289 description: "Default post formatting option",
1290 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1293 key: :redirectRootNoLogin,
1294 label: "Redirect root no login",
1297 "Relative URL which indicates where to redirect when a user isn't logged in",
1298 suggestions: ["/main/all"]
1301 key: :redirectRootLogin,
1302 label: "Redirect root login",
1305 "Relative URL which indicates where to redirect when a user is logged in",
1306 suggestions: ["/main/friends"]
1310 label: "Scope copy",
1312 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1316 label: "Sidebar on Right",
1318 description: "Change alignment of sidebar and panels to the right"
1321 key: :showFeaturesPanel,
1322 label: "Show instance features panel",
1325 "Enables panel displaying functionality of the instance on the About page"
1328 key: :showInstanceSpecificPanel,
1329 label: "Show instance specific panel",
1331 description: "Whether to show the instance's custom panel"
1334 key: :subjectLineBehavior,
1335 label: "Subject line behavior",
1337 description: "Allows changing the default behaviour of subject lines in replies.
1338 `email`: copy and preprend re:, as in email,
1339 `masto`: copy verbatim, as in Mastodon,
1340 `noop`: don't copy the subject.",
1341 suggestions: ["email", "masto", "noop"]
1346 description: "Which theme to use. Available themes are defined in styles.json",
1347 suggestions: ["pleroma-dark"]
1355 description: "Settings for Masto FE",
1358 showInstanceSpecificPanel: true
1363 key: :showInstanceSpecificPanel,
1364 label: "Show instance specific panel",
1366 description: "Whenether to show the instance's specific panel"
1377 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1381 type: {:keyword, :map},
1383 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1386 url: "/images/pleroma-fox-tan-smol.png",
1387 mime_type: "image/png"
1389 pleroma_fox_tan_shy: %{
1390 url: "/images/pleroma-fox-tan-shy.png",
1391 mime_type: "image/png"
1396 key: :default_mascot,
1399 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1405 key: :default_user_avatar,
1407 description: "URL of the default user avatar",
1408 suggestions: ["/images/avi.png"]
1417 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1421 type: {:list, :map},
1422 description: "Describe the icons of the app",
1425 src: "/static/logo.png"
1428 src: "/static/icon.png",
1432 src: "/static/icon.ico",
1433 sizes: "72x72 96x96 128x128 256x256"
1440 description: "Describe the theme color of the app",
1441 suggestions: ["#282c37", "mediumpurple"]
1444 key: :background_color,
1446 description: "Describe the background color of the app",
1447 suggestions: ["#191b22", "aliceblue"]
1457 description: "General MRF settings",
1461 type: [:module, {:list, :module}],
1463 "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.",
1464 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1468 label: "MRF transparency",
1471 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1474 key: :transparency_exclusions,
1475 label: "MRF transparency exclusions",
1476 type: {:list, :string},
1478 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1489 label: "MRF Simple",
1491 description: "Simple ingress policies",
1494 key: :media_removal,
1495 type: {:list, :string},
1496 description: "List of instances to strip media attachments from",
1497 suggestions: ["example.com", "*.example.com"]
1501 label: "Media NSFW",
1502 type: {:list, :string},
1503 description: "List of instances to tag all media as NSFW (sensitive) from",
1504 suggestions: ["example.com", "*.example.com"]
1507 key: :federated_timeline_removal,
1508 type: {:list, :string},
1510 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1511 suggestions: ["example.com", "*.example.com"]
1515 type: {:list, :string},
1516 description: "List of instances to reject activities from (except deletes)",
1517 suggestions: ["example.com", "*.example.com"]
1521 type: {:list, :string},
1522 description: "List of instances to only accept activities from (except deletes)",
1523 suggestions: ["example.com", "*.example.com"]
1526 key: :report_removal,
1527 type: {:list, :string},
1528 description: "List of instances to reject reports from",
1529 suggestions: ["example.com", "*.example.com"]
1532 key: :avatar_removal,
1533 type: {:list, :string},
1534 description: "List of instances to strip avatars from",
1535 suggestions: ["example.com", "*.example.com"]
1538 key: :banner_removal,
1539 type: {:list, :string},
1540 description: "List of instances to strip banners from",
1541 suggestions: ["example.com", "*.example.com"]
1544 key: :reject_deletes,
1545 type: {:list, :string},
1546 description: "List of instances to reject deletions from",
1547 suggestions: ["example.com", "*.example.com"]
1553 key: :mrf_activity_expiration,
1555 label: "MRF Activity Expiration Policy",
1557 description: "Adds automatic expiration to all local activities",
1562 description: "Default global expiration time for all local activities (in days)",
1563 suggestions: [90, 365]
1571 label: "MRF Subchain",
1574 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1575 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1579 type: {:map, {:list, :string}},
1580 description: "Matches a series of regular expressions against the actor field",
1583 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1591 key: :mrf_rejectnonpublic,
1593 description: "RejectNonPublic drops posts with non-public visibility settings.",
1594 label: "MRF Reject Non Public",
1598 key: :allow_followersonly,
1599 label: "Allow followers-only",
1601 description: "Whether to allow followers-only posts"
1606 description: "Whether to allow direct messages"
1612 key: :mrf_hellthread,
1614 label: "MRF Hellthread",
1616 description: "Block messages with excessive user mentions",
1619 key: :delist_threshold,
1622 "Number of mentioned users after which the message gets removed from timelines and" <>
1623 "disables notifications. Set to 0 to disable.",
1627 key: :reject_threshold,
1630 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1639 label: "MRF Keyword",
1641 description: "Reject or Word-Replace messages with a keyword or regex",
1645 type: {:list, :string},
1647 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1648 suggestions: ["foo", ~r/foo/iu]
1651 key: :federated_timeline_removal,
1652 type: {:list, :string},
1654 "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.",
1655 suggestions: ["foo", ~r/foo/iu]
1659 type: {:list, :tuple},
1661 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1662 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1670 label: "MRF Mention",
1672 description: "Block messages which mention a specific user",
1676 type: {:list, :string},
1677 description: "A list of actors for which any post mentioning them will be dropped",
1678 suggestions: ["actor1", "actor2"]
1684 key: :mrf_vocabulary,
1686 label: "MRF Vocabulary",
1688 description: "Filter messages which belong to certain activity vocabularies",
1692 type: {:list, :string},
1694 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1695 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1699 type: {:list, :string},
1701 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1702 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1708 # key: :mrf_user_allowlist,
1711 # "The keys in this section are the domain names that the policy should apply to." <>
1712 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1714 # %{"example.org" => ["https://example.org/users/admin"]}
1722 description: "Media proxy",
1727 description: "Enables proxying of remote media to the instance's proxy"
1734 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1735 suggestions: ["https://example.com"]
1743 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1749 description: "Enables invalidate media cache"
1754 description: "Module which will be used to cache purge.",
1756 Pleroma.Web.MediaProxy.Invalidation.Script,
1757 Pleroma.Web.MediaProxy.Invalidation.Http
1764 label: "Proxy Options",
1766 description: "Options for Pleroma.ReverseProxy",
1768 redirect_on_failure: false,
1769 max_body_length: 25 * 1_048_576,
1771 follow_redirect: true,
1777 key: :redirect_on_failure,
1780 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1781 "Any error during body processing will not be redirected as the response is chunked."
1784 key: :max_body_length,
1787 "Limits the content length to be approximately the " <>
1788 "specified length. It is validated with the `content-length` header and also verified when proxying."
1794 description: "HTTP options",
1799 description: "Adapter specific options",
1804 label: "SSL Options",
1805 description: "SSL options for HTTP adapter",
1809 type: {:list, :atom},
1810 description: "List of TLS version to use",
1811 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1820 type: [:string, :tuple],
1821 description: "Proxy URL",
1822 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1830 type: {:list, :string},
1831 description: "List of hosts with scheme to bypass the mediaproxy",
1832 suggestions: ["http://example.com"]
1838 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1840 description: "HTTP invalidate settings",
1845 description: "HTTP method of request. Default: :purge"
1849 type: {:keyword, :string},
1850 description: "HTTP headers of request",
1851 suggestions: [{"x-refresh", 1}]
1856 description: "Request options",
1860 type: {:map, :string}
1868 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1870 description: "Script invalidate settings",
1875 description: "Path to shell script. Which will run purge cache.",
1876 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1884 description: "Gopher settings",
1889 description: "Enables the gopher interface"
1895 description: "IP address to bind to",
1896 suggestions: [{0, 0, 0, 0}]
1901 description: "Port to bind to",
1907 description: "Port advertised in URLs (optional, defaults to port)",
1915 label: "ActivityPub",
1917 description: "ActivityPub-related settings",
1920 key: :unfollow_blocked,
1922 description: "Whether blocks result in people getting unfollowed"
1925 key: :outgoing_blocks,
1927 description: "Whether to federate blocks to other instances"
1930 key: :sign_object_fetches,
1932 description: "Sign object fetches with HTTP signatures"
1935 key: :note_replies_output_limit,
1938 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1941 key: :follow_handshake_timeout,
1943 description: "Following handshake timeout",
1950 key: :http_security,
1951 label: "HTTP security",
1953 description: "HTTP security settings",
1958 description: "Whether the managed content security policy is enabled"
1964 description: "Whether to additionally send a Strict-Transport-Security header"
1968 label: "STS max age",
1970 description: "The maximum age for the Strict-Transport-Security header if sent",
1971 suggestions: [31_536_000]
1975 label: "CT max age",
1977 description: "The maximum age for the Expect-CT header if sent",
1978 suggestions: [2_592_000]
1981 key: :referrer_policy,
1983 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1984 suggestions: ["same-origin", "no-referrer"]
1988 label: "Report URI",
1990 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1991 suggestions: ["https://example.com/report-uri"]
1996 group: :web_push_encryption,
1997 key: :vapid_details,
1998 label: "Vapid Details",
2001 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2007 "A mailto link for the administrative contact." <>
2008 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2009 suggestions: ["mailto:moderators@pleroma.com"]
2014 description: "VAPID public key",
2015 suggestions: ["Public key"]
2020 description: "VAPID private key",
2021 suggestions: ["Private key"]
2027 key: Pleroma.Captcha,
2029 description: "Captcha-related settings",
2034 description: "Whether the captcha should be shown on registration"
2039 description: "The method/service to use for captcha",
2040 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2043 key: :seconds_valid,
2045 description: "The time in seconds for which the captcha is valid",
2052 key: Pleroma.Captcha.Kocaptcha,
2055 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2056 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2061 description: "The kocaptcha endpoint to use",
2062 suggestions: ["https://captcha.kotobank.ch"]
2068 label: "Pleroma Admin Token",
2071 "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)",
2076 description: "Admin token",
2078 "Please use a high entropy string or UUID"
2088 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2090 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2091 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2092 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2093 (see https://github.com/sorentwo/oban/issues/52).
2098 type: {:dropdown, :atom},
2099 description: "Logs verbose mode",
2100 suggestions: [false, :error, :warn, :info, :debug]
2104 type: {:keyword, :integer},
2106 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2108 activity_expiration: 10,
2109 attachments_cleanup: 5,
2111 federator_incoming: 50,
2112 federator_outgoing: 50,
2114 scheduled_activities: 10,
2120 key: :activity_expiration,
2122 description: "Activity expiration queue",
2126 key: :attachments_cleanup,
2128 description: "Attachment deletion queue",
2134 description: "Background queue",
2138 key: :federator_incoming,
2140 description: "Incoming federation queue",
2144 key: :federator_outgoing,
2146 description: "Outgoing federation queue",
2152 description: "Email sender queue, see Pleroma.Emails.Mailer",
2156 key: :scheduled_activities,
2158 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2162 key: :transmogrifier,
2164 description: "Transmogrifier queue",
2170 description: "Web push notifications queue",
2177 type: {:list, :tuple},
2178 description: "Settings for cron background jobs",
2180 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2181 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2182 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2183 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2184 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2193 description: "Includes custom worker options not interpretable directly by `Oban`",
2197 type: {:keyword, :integer},
2198 description: "Max retry attempts for failed jobs, per `Oban` queue",
2200 federator_incoming: 5,
2201 federator_outgoing: 5
2208 key: Pleroma.Web.Metadata,
2210 description: "Metadata-related settings",
2214 type: {:list, :module},
2215 description: "List of metadata providers to enable",
2217 Pleroma.Web.Metadata.Providers.OpenGraph,
2218 Pleroma.Web.Metadata.Providers.TwitterCard,
2219 Pleroma.Web.Metadata.Providers.RelMe,
2220 Pleroma.Web.Metadata.Providers.Feed
2225 label: "Unfurl NSFW",
2227 description: "When enabled NSFW attachments will be shown in previews"
2236 "If enabled the instance will parse metadata from attached links to generate link previews",
2241 description: "Enables RichMedia parsing of URLs"
2245 type: {:list, :string},
2246 description: "List of hosts which will be ignored by the metadata parser",
2247 suggestions: ["accounts.google.com", "xss.website"]
2251 label: "Ignore TLD",
2252 type: {:list, :string},
2253 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2254 suggestions: ["local", "localdomain", "lan"]
2258 type: {:list, :module},
2260 "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.",
2262 Pleroma.Web.RichMedia.Parsers.OEmbed,
2263 Pleroma.Web.RichMedia.Parsers.TwitterCard
2268 label: "TTL setters",
2269 type: {:list, :module},
2271 "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.",
2273 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2279 group: :auto_linker,
2281 label: "Auto Linker",
2283 description: "Configuration for the auto_linker library",
2287 type: [:string, false],
2288 description: "Specify the class to be added to the generated link. Disable to clear.",
2289 suggestions: ["auto-linker", false]
2293 type: [:string, false],
2294 description: "Override the rel attribute. Disable to clear.",
2295 suggestions: ["ugc", "noopener noreferrer", false]
2300 description: "Link URLs will open in new window/tab"
2304 type: [:integer, false],
2306 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2307 suggestions: [15, false]
2312 description: "Strip the scheme prefix"
2317 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2323 key: Pleroma.ScheduledActivity,
2325 description: "Scheduled activities settings",
2328 key: :daily_user_limit,
2331 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2335 key: :total_user_limit,
2338 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2344 description: "Whether scheduled activities are sent to the job queue to be executed"
2350 key: Pleroma.ActivityExpiration,
2352 description: "Expired activity settings",
2357 description: "Whether expired activities will be sent to the job queue to be deleted"
2363 label: "Pleroma Authenticator",
2365 description: "Authenticator",
2368 key: Pleroma.Web.Auth.Authenticator,
2370 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2380 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2381 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2382 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2383 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2388 description: "Enables LDAP authentication"
2393 description: "LDAP server hostname",
2394 suggestions: ["localhosts"]
2399 description: "LDAP port, e.g. 389 or 636",
2400 suggestions: [389, 636]
2406 description: "Enable to use SSL, usually implies the port 636"
2410 label: "SSL options",
2412 description: "Additional SSL options",
2413 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2418 description: "Path to file with PEM encoded cacerts",
2419 suggestions: ["path/to/file/with/PEM/cacerts"]
2424 description: "Type of cert verification",
2425 suggestions: [:verify_peer]
2433 description: "Enable to use STARTTLS, usually implies the port 389"
2437 label: "TLS options",
2439 description: "Additional TLS options",
2440 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2445 description: "Path to file with PEM encoded cacerts",
2446 suggestions: ["path/to/file/with/PEM/cacerts"]
2451 description: "Type of cert verification",
2452 suggestions: [:verify_peer]
2459 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2460 suggestions: ["dc=example,dc=com"]
2467 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2476 description: "Authentication / authorization settings",
2479 key: :enforce_oauth_admin_scope_usage,
2480 label: "Enforce OAuth admin scope usage",
2483 "OAuth admin scope requirement toggle. " <>
2484 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2485 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2486 "`is_admin` user flag grants access to admin-specific actions."
2489 key: :auth_template,
2492 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2493 suggestions: ["show.html"]
2496 key: :oauth_consumer_template,
2497 label: "OAuth consumer template",
2500 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2501 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2502 suggestions: ["consumer.html"]
2505 key: :oauth_consumer_strategies,
2506 label: "OAuth consumer strategies",
2507 type: {:list, :string},
2509 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2510 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2511 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2512 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2518 key: :email_notifications,
2520 description: "Email notifications settings",
2526 "emails of \"what you've missed\" for users who have been inactive for a while",
2530 schedule: "0 0 * * 0",
2532 inactivity_threshold: 7
2540 description: "Globally enable or disable digest emails"
2546 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2547 suggestions: ["0 0 * * 0"]
2552 description: "Minimum interval between digest emails to one user",
2556 key: :inactivity_threshold,
2558 description: "Minimum user inactivity threshold",
2567 key: Pleroma.Emails.UserEmail,
2569 description: "Email template settings",
2574 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2575 suggestions: ["some/path/logo.png"]
2580 description: "A map with color settings for email templates.",
2583 link_color: "#d8a070",
2584 background_color: "#2C3645",
2585 content_background_color: "#1B2635",
2586 header_color: "#d8a070",
2587 text_color: "#b9b9ba",
2588 text_muted_color: "#b9b9ba"
2595 suggestions: ["#d8a070"]
2598 key: :background_color,
2600 suggestions: ["#2C3645"]
2603 key: :content_background_color,
2605 suggestions: ["#1B2635"]
2610 suggestions: ["#d8a070"]
2615 suggestions: ["#b9b9ba"]
2618 key: :text_muted_color,
2620 suggestions: ["#b9b9ba"]
2628 key: Pleroma.Emails.NewUsersDigestEmail,
2630 description: "New users admin email digest",
2635 description: "Enables new users admin digest email when `true`"
2644 description: "Configure OAuth 2 provider capabilities",
2647 key: :token_expires_in,
2649 description: "The lifetime in seconds of the access token",
2653 key: :issue_new_refresh_token,
2656 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2659 key: :clean_expired_tokens,
2661 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2671 key: :shortcode_globs,
2672 type: {:list, :string},
2673 description: "Location of custom emoji files. * can be used as a wildcard.",
2674 suggestions: ["/emoji/custom/**/*.png"]
2677 key: :pack_extensions,
2678 type: {:list, :string},
2680 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2681 suggestions: [".png", ".gif"]
2685 type: {:keyword, {:list, :string}},
2687 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2688 " and the value is the location or array of locations. * can be used as a wildcard.",
2690 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2694 key: :default_manifest,
2697 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2698 " Currently only one manifest can be added (no arrays).",
2699 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2702 key: :shared_pack_cache_seconds_per_file,
2703 label: "Shared pack cache s/file",
2706 "When an emoji pack is shared, the archive is created and cached in memory" <>
2707 " for this amount of seconds multiplied by the number of files.",
2717 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2721 type: [:tuple, {:list, :tuple}],
2722 description: "For the search requests (account & status search etc.)",
2723 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2727 type: [:tuple, {:list, :tuple}],
2728 description: "For requests to timelines (each timeline has it's own limiter)",
2729 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2732 key: :app_account_creation,
2733 type: [:tuple, {:list, :tuple}],
2734 description: "For registering user accounts from the same IP address",
2735 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2738 key: :relations_actions,
2739 type: [:tuple, {:list, :tuple}],
2740 description: "For actions on relationships with all users (follow, unfollow)",
2741 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2744 key: :relation_id_action,
2745 label: "Relation ID action",
2746 type: [:tuple, {:list, :tuple}],
2747 description: "For actions on relation with a specific user (follow, unfollow)",
2748 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2751 key: :statuses_actions,
2752 type: [:tuple, {:list, :tuple}],
2754 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2755 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2758 key: :status_id_action,
2759 label: "Status ID action",
2760 type: [:tuple, {:list, :tuple}],
2762 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2763 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2766 key: :authentication,
2767 type: [:tuple, {:list, :tuple}],
2768 description: "For authentication create / password check / user existence check requests",
2769 suggestions: [{60_000, 15}]
2778 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2779 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2784 description: "Enables SSH"
2789 description: "Dir with SSH keys",
2790 suggestions: ["/some/path/ssh_keys"]
2795 description: "Handler module",
2796 suggestions: ["Pleroma.BBS.Handler"]
2801 description: "Port to connect",
2802 suggestions: [10_022]
2805 key: :password_authenticator,
2807 description: "Authenticator module",
2808 suggestions: ["Pleroma.BBS.Authenticator"]
2814 label: "Mime Types",
2816 description: "Mime Types settings",
2823 "application/xml" => ["xml"],
2824 "application/xrd+xml" => ["xrd+xml"],
2825 "application/jrd+json" => ["jrd+json"],
2826 "application/activity+json" => ["activity+json"],
2827 "application/ld+json" => ["activity+json"]
2832 key: "application/xml",
2833 type: {:list, :string},
2834 suggestions: ["xml"]
2837 key: "application/xrd+xml",
2838 type: {:list, :string},
2839 suggestions: ["xrd+xml"]
2842 key: "application/jrd+json",
2843 type: {:list, :string},
2844 suggestions: ["jrd+json"]
2847 key: "application/activity+json",
2848 type: {:list, :string},
2849 suggestions: ["activity+json"]
2852 key: "application/ld+json",
2853 type: {:list, :string},
2854 suggestions: ["activity+json"]
2864 description: "Pleroma chat settings",
2877 description: "HTTP settings",
2882 type: [:string, :tuple],
2883 description: "Proxy URL",
2884 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2887 key: :send_user_agent,
2892 type: [:string, :atom],
2894 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2895 suggestions: ["Pleroma", :default]
2900 description: "Adapter specific options",
2906 label: "SSL Options",
2907 description: "SSL options for HTTP adapter",
2911 type: {:list, :atom},
2912 description: "List of TLS version to use",
2913 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2924 label: "Markup Settings",
2928 key: :allow_inline_images,
2932 key: :allow_headings,
2945 type: {:list, :module},
2947 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2948 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2958 key: :deny_follow_blocked,
2966 key: :mrf_normalize_markup,
2967 label: "MRF Normalize Markup",
2968 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2974 suggestions: [Pleroma.HTML.Scrubber.Default]
2984 key: :restricted_nicknames,
2985 type: {:list, :string},
3004 "ostatus_subscribe",
3023 label: "CORS plug config",
3029 suggestions: [86_400]
3033 type: {:list, :string},
3034 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3038 type: {:list, :string},
3041 "X-RateLimit-Reset",
3042 "X-RateLimit-Limit",
3043 "X-RateLimit-Remaining",
3054 type: {:list, :string},
3055 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3061 key: Pleroma.Plugs.RemoteIp,
3064 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3065 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3071 description: "Enable/disable the plug. Default: disabled."
3075 type: {:list, :string},
3077 "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]`."
3081 type: {:list, :string},
3083 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3087 type: {:list, :string},
3089 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3095 key: :web_cache_ttl,
3096 label: "Web cache TTL",
3099 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3105 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3106 suggestions: [30_000, nil]
3109 key: :activity_pub_question,
3111 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3112 suggestions: [30_000]
3122 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3127 description: "Enables the rendering of static HTML. Default: disabled."
3135 description: "Configure feed rendering",
3140 description: "Configure title rendering",
3145 description: "Maximum number of characters before truncating title",
3151 description: "Replacement which will be used after truncating string",
3152 suggestions: ["..."]
3160 key: :mrf_object_age,
3161 label: "MRF Object Age",
3165 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3170 description: "Required age (in seconds) of a post before actions are taken.",
3171 suggestions: [172_800]
3175 type: {:list, :atom},
3177 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3178 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3179 "`:reject` rejects the message entirely",
3180 suggestions: [:delist, :strip_followers, :reject]
3188 description: "Custom Runtime Modules",
3193 description: "A path to custom Elixir modules (such as MRF policies)."
3201 description: "Settings for notifications streamer",
3206 description: "Number of workers to send notifications",
3210 key: :overflow_workers,
3212 description: "Maximum number of workers created if pool is empty",
3219 key: :connections_pool,
3221 description: "Advanced settings for `gun` connections pool",
3224 key: :connection_acquisition_wait,
3227 "Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries. Default: 250ms.",
3231 key: :connection_acquisition_retries,
3234 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3238 key: :max_connections,
3240 description: "Maximum number of connections in the pool. Default: 250 connections.",
3244 key: :await_up_timeout,
3246 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3250 key: :reclaim_multiplier,
3253 "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",
3262 description: "Advanced settings for `gun` workers pools",
3264 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3268 description: "Settings for #{pool_name} pool.",
3273 description: "Maximum number of concurrent requests in the pool.",
3280 "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",
3289 key: :hackney_pools,
3291 description: "Advanced settings for `hackney` connections pools",
3296 description: "Settings for federation pool.",
3299 key: :max_connections,
3301 description: "Number workers in the pool.",
3307 description: "Timeout while `hackney` will wait for response.",
3308 suggestions: [150_000]
3315 description: "Settings for media pool.",
3318 key: :max_connections,
3320 description: "Number workers in the pool.",
3326 description: "Timeout while `hackney` will wait for response.",
3327 suggestions: [150_000]
3334 description: "Settings for upload pool.",
3337 key: :max_connections,
3339 description: "Number workers in the pool.",
3345 description: "Timeout while `hackney` will wait for response.",
3346 suggestions: [300_000]
3354 key: :restrict_unauthenticated,
3357 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3362 description: "Settings for public and federated timelines.",
3367 description: "Disallow view public timeline."
3372 description: "Disallow view federated timeline."
3379 description: "Settings for user profiles.",
3384 description: "Disallow view local user profiles."
3389 description: "Disallow view remote user profiles."
3396 description: "Settings for statuses.",
3401 description: "Disallow view local statuses."
3406 description: "Disallow view remote statuses."
3414 key: Pleroma.Web.ApiSpec.CastAndValidate,
3421 "Enables strict input validation (useful in development, not recommended in production)"
3427 key: :instances_favicons,
3429 description: "Control favicons for instances",
3434 description: "Allow/disallow displaying and getting instances favicons"
3442 descriptions: "S3 service related settings",
3445 key: :access_key_id,
3447 description: "S3 access key ID",
3448 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3451 key: :secret_access_key,
3453 description: "Secret access key",
3454 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3459 description: "S3 host",
3460 suggestions: ["s3.eu-central-1.amazonaws.com"]