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"
665 key: :account_approval_required,
667 description: "Require users to be manually approved by an admin before signing in"
672 description: "Enable federation with other instances"
675 key: :federation_incoming_replies_max_depth,
676 label: "Fed. incoming replies max depth",
679 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
680 " 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.",
686 key: :federation_reachability_timeout_days,
687 label: "Fed. reachability timeout days",
690 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
698 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
704 "Makes the client API in authenticated mode-only except for user-profiles." <>
705 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
706 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
709 key: :quarantined_instances,
710 type: {:list, :string},
712 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
719 key: :managed_config,
722 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
727 description: "Instance static directory",
733 key: :allowed_post_formats,
734 type: {:list, :string},
735 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
744 key: :extended_nickname_format,
747 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
748 " This will break federation with older software for theses nicknames."
751 key: :cleanup_attachments,
754 Enable to remove associated attachments when status is removed.
755 This will not affect duplicates and attachments without status.
756 Enabling this will increase load to database when deleting statuses on larger instances.
760 key: :max_pinned_statuses,
762 description: "The maximum number of pinned statuses. 0 will disable the feature.",
770 key: :autofollowed_nicknames,
771 type: {:list, :string},
773 "Set to nicknames of (local) users that every new user should automatically follow",
782 key: :attachment_links,
784 description: "Enable to automatically add attachment link text to statuses"
787 key: :welcome_message,
790 "A message that will be sent to a newly registered users as a direct message",
792 "Hi, @username! Welcome on board!"
796 key: :welcome_user_nickname,
798 description: "The nickname of the local user that sends the welcome message",
804 key: :max_report_comment_size,
806 description: "The maximum size of the report comment. Default: 1000.",
812 key: :safe_dm_mentions,
813 label: "Safe DM mentions",
816 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
817 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
823 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
826 key: :remote_post_retention_days,
829 "The default amount of days to retain remote posts when pruning the database",
835 key: :user_bio_length,
837 description: "A user bio maximum length. Default: 5000.",
843 key: :user_name_length,
845 description: "A user name maximum length. Default: 100.",
851 key: :skip_thread_containment,
853 description: "Skip filtering out broken threads. Default: enabled."
856 key: :limit_to_local_content,
857 type: {:dropdown, :atom},
859 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
867 key: :max_account_fields,
869 description: "The maximum number of custom fields in the user profile. Default: 10.",
875 key: :max_remote_account_fields,
878 "The maximum number of custom fields in the remote user profile. Default: 20.",
884 key: :account_field_name_length,
886 description: "An account field name maximum length. Default: 512.",
892 key: :account_field_value_length,
894 description: "An account field value maximum length. Default: 2048.",
900 key: :external_user_synchronization,
902 description: "Enabling following/followers counters synchronization for external users"
905 key: :multi_factor_authentication,
907 description: "Multi-factor authentication settings",
910 totp: [digits: 6, period: 30],
911 backup_codes: [number: 5, length: 16]
917 label: "TOTP settings",
919 description: "TOTP settings",
920 suggestions: [digits: 6, period: 30],
927 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
934 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
941 description: "MFA backup codes settings",
942 suggestions: [number: 5, length: 16],
948 description: "Number of backup codes to generate."
955 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
962 key: :instance_thumbnail,
965 "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.",
966 suggestions: ["/instance/thumbnail.jpeg"]
973 description: "Logger-related settings",
977 type: [:atom, :tuple, :module],
979 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
980 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
988 label: "ExSyslogger",
989 description: "ExSyslogger-related settings",
993 type: {:dropdown, :atom},
994 description: "Log level",
995 suggestions: [:debug, :info, :warn, :error]
1001 "A string that's prepended to every message, and is typically set to the app name",
1002 suggestions: ["pleroma"]
1007 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1008 suggestions: ["$metadata[$level] $message"]
1012 type: {:list, :atom},
1013 suggestions: [:request_id]
1021 label: "Console Logger",
1022 description: "Console logger settings",
1026 type: {:dropdown, :atom},
1027 description: "Log level",
1028 suggestions: [:debug, :info, :warn, :error]
1033 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1034 suggestions: ["$metadata[$level] $message"]
1038 type: {:list, :atom},
1039 suggestions: [:request_id]
1046 label: "Quack Logger",
1047 description: "Quack-related settings",
1051 type: {:dropdown, :atom},
1052 description: "Log level",
1053 suggestions: [:debug, :info, :warn, :error]
1057 type: {:list, :atom},
1058 description: "Configure which metadata you want to report on",
1075 label: "Webhook URL",
1077 description: "Configure the Slack incoming webhook",
1078 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1084 key: :frontend_configurations,
1087 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1088 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1089 "add your own configuration your settings all fields must be complete.",
1093 label: "Pleroma FE",
1095 description: "Settings for Pleroma FE",
1098 alwaysShowSubjectInput: true,
1099 background: "/static/aurora_borealis.jpg",
1100 collapseMessageWithSubject: false,
1103 hideFilteredStatuses: false,
1104 hideMutedPosts: false,
1105 hidePostStats: false,
1106 hideSitename: false,
1107 hideUserStats: false,
1108 loginMethod: "password",
1109 logo: "/static/logo.png",
1112 minimalScopesMode: false,
1113 noAttachmentLinks: false,
1114 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1115 postContentType: "text/plain",
1116 redirectRootLogin: "/main/friends",
1117 redirectRootNoLogin: "/main/all",
1119 sidebarRight: false,
1120 showFeaturesPanel: true,
1121 showInstanceSpecificPanel: false,
1122 subjectLineBehavior: "email",
1123 theme: "pleroma-dark",
1124 webPushNotifications: false
1129 key: :alwaysShowSubjectInput,
1130 label: "Always show subject input",
1132 description: "When disabled, auto-hide the subject field if it's empty"
1138 "URL of the background, unless viewing a user profile with a background that is set",
1139 suggestions: ["/images/city.jpg"]
1142 key: :collapseMessageWithSubject,
1143 label: "Collapse message with subject",
1146 "When a message has a subject (aka Content Warning), collapse it by default"
1150 label: "PleromaFE Chat",
1152 description: "Disables PleromaFE Chat component"
1158 description: "Enables green text on lines prefixed with the > character"
1161 key: :hideFilteredStatuses,
1162 label: "Hide Filtered Statuses",
1164 description: "Hides filtered statuses from timelines"
1167 key: :hideMutedPosts,
1168 label: "Hide Muted Posts",
1170 description: "Hides muted statuses from timelines"
1173 key: :hidePostStats,
1174 label: "Hide post stats",
1176 description: "Hide notices statistics (repeats, favorites, ...)"
1180 label: "Hide Sitename",
1182 description: "Hides instance name from PleromaFE banner"
1185 key: :hideUserStats,
1186 label: "Hide user stats",
1189 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1194 description: "URL of the logo, defaults to Pleroma's logo",
1195 suggestions: ["/static/logo.png"]
1199 label: "Logo margin",
1202 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1203 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1204 suggestions: [".1em"]
1211 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1212 "If you want a colorful logo you must disable logoMask."
1215 key: :minimalScopesMode,
1216 label: "Minimal scopes mode",
1219 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1220 "Also prevents replying to a DM with a public post from PleromaFE."
1223 key: :nsfwCensorImage,
1224 label: "NSFW Censor Image",
1227 "URL of the image to use for hiding NSFW media attachments in the timeline",
1228 suggestions: ["/static/img/nsfw.74818f9.png"]
1231 key: :postContentType,
1232 label: "Post Content Type",
1233 type: {:dropdown, :atom},
1234 description: "Default post formatting option",
1235 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1238 key: :redirectRootNoLogin,
1239 label: "Redirect root no login",
1242 "Relative URL which indicates where to redirect when a user isn't logged in",
1243 suggestions: ["/main/all"]
1246 key: :redirectRootLogin,
1247 label: "Redirect root login",
1250 "Relative URL which indicates where to redirect when a user is logged in",
1251 suggestions: ["/main/friends"]
1255 label: "Scope copy",
1257 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1261 label: "Sidebar on Right",
1263 description: "Change alignment of sidebar and panels to the right"
1266 key: :showFeaturesPanel,
1267 label: "Show instance features panel",
1270 "Enables panel displaying functionality of the instance on the About page"
1273 key: :showInstanceSpecificPanel,
1274 label: "Show instance specific panel",
1276 description: "Whether to show the instance's custom panel"
1279 key: :subjectLineBehavior,
1280 label: "Subject line behavior",
1282 description: "Allows changing the default behaviour of subject lines in replies.
1283 `email`: copy and preprend re:, as in email,
1284 `masto`: copy verbatim, as in Mastodon,
1285 `noop`: don't copy the subject.",
1286 suggestions: ["email", "masto", "noop"]
1291 description: "Which theme to use. Available themes are defined in styles.json",
1292 suggestions: ["pleroma-dark"]
1300 description: "Settings for Masto FE",
1303 showInstanceSpecificPanel: true
1308 key: :showInstanceSpecificPanel,
1309 label: "Show instance specific panel",
1311 description: "Whenether to show the instance's specific panel"
1322 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1326 type: {:keyword, :map},
1328 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1331 url: "/images/pleroma-fox-tan-smol.png",
1332 mime_type: "image/png"
1334 pleroma_fox_tan_shy: %{
1335 url: "/images/pleroma-fox-tan-shy.png",
1336 mime_type: "image/png"
1341 key: :default_mascot,
1344 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1350 key: :default_user_avatar,
1352 description: "URL of the default user avatar",
1353 suggestions: ["/images/avi.png"]
1362 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1366 type: {:list, :map},
1367 description: "Describe the icons of the app",
1370 src: "/static/logo.png"
1373 src: "/static/icon.png",
1377 src: "/static/icon.ico",
1378 sizes: "72x72 96x96 128x128 256x256"
1385 description: "Describe the theme color of the app",
1386 suggestions: ["#282c37", "mediumpurple"]
1389 key: :background_color,
1391 description: "Describe the background color of the app",
1392 suggestions: ["#191b22", "aliceblue"]
1402 description: "General MRF settings",
1406 type: [:module, {:list, :module}],
1408 "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.",
1409 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1413 label: "MRF transparency",
1416 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1419 key: :transparency_exclusions,
1420 label: "MRF transparency exclusions",
1421 type: {:list, :string},
1423 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1434 label: "MRF Simple",
1436 description: "Simple ingress policies",
1439 key: :media_removal,
1440 type: {:list, :string},
1441 description: "List of instances to strip media attachments from",
1442 suggestions: ["example.com", "*.example.com"]
1446 label: "Media NSFW",
1447 type: {:list, :string},
1448 description: "List of instances to tag all media as NSFW (sensitive) from",
1449 suggestions: ["example.com", "*.example.com"]
1452 key: :federated_timeline_removal,
1453 type: {:list, :string},
1455 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1456 suggestions: ["example.com", "*.example.com"]
1460 type: {:list, :string},
1461 description: "List of instances to reject activities from (except deletes)",
1462 suggestions: ["example.com", "*.example.com"]
1466 type: {:list, :string},
1467 description: "List of instances to only accept activities from (except deletes)",
1468 suggestions: ["example.com", "*.example.com"]
1471 key: :report_removal,
1472 type: {:list, :string},
1473 description: "List of instances to reject reports from",
1474 suggestions: ["example.com", "*.example.com"]
1477 key: :avatar_removal,
1478 type: {:list, :string},
1479 description: "List of instances to strip avatars from",
1480 suggestions: ["example.com", "*.example.com"]
1483 key: :banner_removal,
1484 type: {:list, :string},
1485 description: "List of instances to strip banners from",
1486 suggestions: ["example.com", "*.example.com"]
1489 key: :reject_deletes,
1490 type: {:list, :string},
1491 description: "List of instances to reject deletions from",
1492 suggestions: ["example.com", "*.example.com"]
1498 key: :mrf_activity_expiration,
1500 label: "MRF Activity Expiration Policy",
1502 description: "Adds automatic expiration to all local activities",
1507 description: "Default global expiration time for all local activities (in days)",
1508 suggestions: [90, 365]
1516 label: "MRF Subchain",
1519 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1520 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1524 type: {:map, {:list, :string}},
1525 description: "Matches a series of regular expressions against the actor field",
1528 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1536 key: :mrf_rejectnonpublic,
1538 description: "RejectNonPublic drops posts with non-public visibility settings.",
1539 label: "MRF Reject Non Public",
1543 key: :allow_followersonly,
1544 label: "Allow followers-only",
1546 description: "Whether to allow followers-only posts"
1551 description: "Whether to allow direct messages"
1557 key: :mrf_hellthread,
1559 label: "MRF Hellthread",
1561 description: "Block messages with excessive user mentions",
1564 key: :delist_threshold,
1567 "Number of mentioned users after which the message gets removed from timelines and" <>
1568 "disables notifications. Set to 0 to disable.",
1572 key: :reject_threshold,
1575 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1584 label: "MRF Keyword",
1586 description: "Reject or Word-Replace messages with a keyword or regex",
1590 type: {:list, :string},
1592 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1593 suggestions: ["foo", ~r/foo/iu]
1596 key: :federated_timeline_removal,
1597 type: {:list, :string},
1599 "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.",
1600 suggestions: ["foo", ~r/foo/iu]
1604 type: {:list, :tuple},
1606 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1607 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1615 label: "MRF Mention",
1617 description: "Block messages which mention a specific user",
1621 type: {:list, :string},
1622 description: "A list of actors for which any post mentioning them will be dropped",
1623 suggestions: ["actor1", "actor2"]
1629 key: :mrf_vocabulary,
1631 label: "MRF Vocabulary",
1633 description: "Filter messages which belong to certain activity vocabularies",
1637 type: {:list, :string},
1639 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1640 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1644 type: {:list, :string},
1646 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1647 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1653 # key: :mrf_user_allowlist,
1656 # "The keys in this section are the domain names that the policy should apply to." <>
1657 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1659 # %{"example.org" => ["https://example.org/users/admin"]}
1667 description: "Media proxy",
1672 description: "Enables proxying of remote media to the instance's proxy"
1679 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1680 suggestions: ["https://example.com"]
1688 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1694 description: "Enables invalidate media cache"
1699 description: "Module which will be used to cache purge.",
1701 Pleroma.Web.MediaProxy.Invalidation.Script,
1702 Pleroma.Web.MediaProxy.Invalidation.Http
1709 label: "Proxy Options",
1711 description: "Options for Pleroma.ReverseProxy",
1713 redirect_on_failure: false,
1714 max_body_length: 25 * 1_048_576,
1716 follow_redirect: true,
1722 key: :redirect_on_failure,
1725 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1726 "Any error during body processing will not be redirected as the response is chunked."
1729 key: :max_body_length,
1732 "Limits the content length to be approximately the " <>
1733 "specified length. It is validated with the `content-length` header and also verified when proxying."
1739 description: "HTTP options",
1744 description: "Adapter specific options",
1749 label: "SSL Options",
1750 description: "SSL options for HTTP adapter",
1754 type: {:list, :atom},
1755 description: "List of TLS version to use",
1756 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1765 type: [:string, :tuple],
1766 description: "Proxy URL",
1767 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1775 type: {:list, :string},
1776 description: "List of hosts with scheme to bypass the mediaproxy",
1777 suggestions: ["http://example.com"]
1783 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1785 description: "HTTP invalidate settings",
1790 description: "HTTP method of request. Default: :purge"
1794 type: {:keyword, :string},
1795 description: "HTTP headers of request",
1796 suggestions: [{"x-refresh", 1}]
1801 description: "Request options",
1805 type: {:map, :string}
1813 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1815 description: "Script invalidate settings",
1820 description: "Path to shell script. Which will run purge cache.",
1821 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1829 description: "Gopher settings",
1834 description: "Enables the gopher interface"
1840 description: "IP address to bind to",
1841 suggestions: [{0, 0, 0, 0}]
1846 description: "Port to bind to",
1852 description: "Port advertised in URLs (optional, defaults to port)",
1860 label: "ActivityPub",
1862 description: "ActivityPub-related settings",
1865 key: :unfollow_blocked,
1867 description: "Whether blocks result in people getting unfollowed"
1870 key: :outgoing_blocks,
1872 description: "Whether to federate blocks to other instances"
1875 key: :sign_object_fetches,
1877 description: "Sign object fetches with HTTP signatures"
1880 key: :note_replies_output_limit,
1883 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1886 key: :follow_handshake_timeout,
1888 description: "Following handshake timeout",
1895 key: :http_security,
1896 label: "HTTP security",
1898 description: "HTTP security settings",
1903 description: "Whether the managed content security policy is enabled"
1909 description: "Whether to additionally send a Strict-Transport-Security header"
1913 label: "STS max age",
1915 description: "The maximum age for the Strict-Transport-Security header if sent",
1916 suggestions: [31_536_000]
1920 label: "CT max age",
1922 description: "The maximum age for the Expect-CT header if sent",
1923 suggestions: [2_592_000]
1926 key: :referrer_policy,
1928 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1929 suggestions: ["same-origin", "no-referrer"]
1933 label: "Report URI",
1935 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1936 suggestions: ["https://example.com/report-uri"]
1941 group: :web_push_encryption,
1942 key: :vapid_details,
1943 label: "Vapid Details",
1946 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1952 "A mailto link for the administrative contact." <>
1953 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1954 suggestions: ["mailto:moderators@pleroma.com"]
1959 description: "VAPID public key",
1960 suggestions: ["Public key"]
1965 description: "VAPID private key",
1966 suggestions: ["Private key"]
1972 key: Pleroma.Captcha,
1974 description: "Captcha-related settings",
1979 description: "Whether the captcha should be shown on registration"
1984 description: "The method/service to use for captcha",
1985 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1988 key: :seconds_valid,
1990 description: "The time in seconds for which the captcha is valid",
1997 key: Pleroma.Captcha.Kocaptcha,
2000 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2001 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2006 description: "The kocaptcha endpoint to use",
2007 suggestions: ["https://captcha.kotobank.ch"]
2013 label: "Pleroma Admin Token",
2016 "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)",
2021 description: "Admin token",
2023 "Please use a high entropy string or UUID"
2033 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2035 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2036 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2037 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2038 (see https://github.com/sorentwo/oban/issues/52).
2043 type: {:dropdown, :atom},
2044 description: "Logs verbose mode",
2045 suggestions: [false, :error, :warn, :info, :debug]
2049 type: {:keyword, :integer},
2051 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2053 activity_expiration: 10,
2054 attachments_cleanup: 5,
2056 federator_incoming: 50,
2057 federator_outgoing: 50,
2059 scheduled_activities: 10,
2065 key: :activity_expiration,
2067 description: "Activity expiration queue",
2071 key: :attachments_cleanup,
2073 description: "Attachment deletion queue",
2079 description: "Background queue",
2083 key: :federator_incoming,
2085 description: "Incoming federation queue",
2089 key: :federator_outgoing,
2091 description: "Outgoing federation queue",
2097 description: "Email sender queue, see Pleroma.Emails.Mailer",
2101 key: :scheduled_activities,
2103 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2107 key: :transmogrifier,
2109 description: "Transmogrifier queue",
2115 description: "Web push notifications queue",
2122 type: {:list, :tuple},
2123 description: "Settings for cron background jobs",
2125 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2126 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2127 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2128 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2129 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2138 description: "Includes custom worker options not interpretable directly by `Oban`",
2142 type: {:keyword, :integer},
2143 description: "Max retry attempts for failed jobs, per `Oban` queue",
2145 federator_incoming: 5,
2146 federator_outgoing: 5
2153 key: Pleroma.Web.Metadata,
2155 description: "Metadata-related settings",
2159 type: {:list, :module},
2160 description: "List of metadata providers to enable",
2162 Pleroma.Web.Metadata.Providers.OpenGraph,
2163 Pleroma.Web.Metadata.Providers.TwitterCard,
2164 Pleroma.Web.Metadata.Providers.RelMe,
2165 Pleroma.Web.Metadata.Providers.Feed
2170 label: "Unfurl NSFW",
2172 description: "When enabled NSFW attachments will be shown in previews"
2181 "If enabled the instance will parse metadata from attached links to generate link previews",
2186 description: "Enables RichMedia parsing of URLs"
2190 type: {:list, :string},
2191 description: "List of hosts which will be ignored by the metadata parser",
2192 suggestions: ["accounts.google.com", "xss.website"]
2196 label: "Ignore TLD",
2197 type: {:list, :string},
2198 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2199 suggestions: ["local", "localdomain", "lan"]
2203 type: {:list, :module},
2205 "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.",
2207 Pleroma.Web.RichMedia.Parsers.OEmbed,
2208 Pleroma.Web.RichMedia.Parsers.TwitterCard
2213 label: "TTL setters",
2214 type: {:list, :module},
2216 "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.",
2218 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2224 group: :auto_linker,
2226 label: "Auto Linker",
2228 description: "Configuration for the auto_linker library",
2232 type: [:string, false],
2233 description: "Specify the class to be added to the generated link. Disable to clear.",
2234 suggestions: ["auto-linker", false]
2238 type: [:string, false],
2239 description: "Override the rel attribute. Disable to clear.",
2240 suggestions: ["ugc", "noopener noreferrer", false]
2245 description: "Link URLs will open in new window/tab"
2249 type: [:integer, false],
2251 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2252 suggestions: [15, false]
2257 description: "Strip the scheme prefix"
2262 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2268 key: Pleroma.ScheduledActivity,
2270 description: "Scheduled activities settings",
2273 key: :daily_user_limit,
2276 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2280 key: :total_user_limit,
2283 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2289 description: "Whether scheduled activities are sent to the job queue to be executed"
2295 key: Pleroma.ActivityExpiration,
2297 description: "Expired activity settings",
2302 description: "Whether expired activities will be sent to the job queue to be deleted"
2308 label: "Pleroma Authenticator",
2310 description: "Authenticator",
2313 key: Pleroma.Web.Auth.Authenticator,
2315 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2325 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2326 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2327 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2328 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2333 description: "Enables LDAP authentication"
2338 description: "LDAP server hostname",
2339 suggestions: ["localhosts"]
2344 description: "LDAP port, e.g. 389 or 636",
2345 suggestions: [389, 636]
2351 description: "Enable to use SSL, usually implies the port 636"
2355 label: "SSL options",
2357 description: "Additional SSL options",
2358 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2363 description: "Path to file with PEM encoded cacerts",
2364 suggestions: ["path/to/file/with/PEM/cacerts"]
2369 description: "Type of cert verification",
2370 suggestions: [:verify_peer]
2378 description: "Enable to use STARTTLS, usually implies the port 389"
2382 label: "TLS options",
2384 description: "Additional TLS options",
2385 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2390 description: "Path to file with PEM encoded cacerts",
2391 suggestions: ["path/to/file/with/PEM/cacerts"]
2396 description: "Type of cert verification",
2397 suggestions: [:verify_peer]
2404 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2405 suggestions: ["dc=example,dc=com"]
2412 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2421 description: "Authentication / authorization settings",
2424 key: :enforce_oauth_admin_scope_usage,
2425 label: "Enforce OAuth admin scope usage",
2428 "OAuth admin scope requirement toggle. " <>
2429 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2430 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2431 "`is_admin` user flag grants access to admin-specific actions."
2434 key: :auth_template,
2437 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2438 suggestions: ["show.html"]
2441 key: :oauth_consumer_template,
2442 label: "OAuth consumer template",
2445 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2446 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2447 suggestions: ["consumer.html"]
2450 key: :oauth_consumer_strategies,
2451 label: "OAuth consumer strategies",
2452 type: {:list, :string},
2454 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2455 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2456 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2457 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2463 key: :email_notifications,
2465 description: "Email notifications settings",
2471 "emails of \"what you've missed\" for users who have been inactive for a while",
2475 schedule: "0 0 * * 0",
2477 inactivity_threshold: 7
2485 description: "Globally enable or disable digest emails"
2491 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2492 suggestions: ["0 0 * * 0"]
2497 description: "Minimum interval between digest emails to one user",
2501 key: :inactivity_threshold,
2503 description: "Minimum user inactivity threshold",
2512 key: Pleroma.Emails.UserEmail,
2514 description: "Email template settings",
2519 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2520 suggestions: ["some/path/logo.png"]
2525 description: "A map with color settings for email templates.",
2528 link_color: "#d8a070",
2529 background_color: "#2C3645",
2530 content_background_color: "#1B2635",
2531 header_color: "#d8a070",
2532 text_color: "#b9b9ba",
2533 text_muted_color: "#b9b9ba"
2540 suggestions: ["#d8a070"]
2543 key: :background_color,
2545 suggestions: ["#2C3645"]
2548 key: :content_background_color,
2550 suggestions: ["#1B2635"]
2555 suggestions: ["#d8a070"]
2560 suggestions: ["#b9b9ba"]
2563 key: :text_muted_color,
2565 suggestions: ["#b9b9ba"]
2573 key: Pleroma.Emails.NewUsersDigestEmail,
2575 description: "New users admin email digest",
2580 description: "Enables new users admin digest email when `true`"
2589 description: "Configure OAuth 2 provider capabilities",
2592 key: :token_expires_in,
2594 description: "The lifetime in seconds of the access token",
2598 key: :issue_new_refresh_token,
2601 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2604 key: :clean_expired_tokens,
2606 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2616 key: :shortcode_globs,
2617 type: {:list, :string},
2618 description: "Location of custom emoji files. * can be used as a wildcard.",
2619 suggestions: ["/emoji/custom/**/*.png"]
2622 key: :pack_extensions,
2623 type: {:list, :string},
2625 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2626 suggestions: [".png", ".gif"]
2630 type: {:keyword, {:list, :string}},
2632 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2633 " and the value is the location or array of locations. * can be used as a wildcard.",
2635 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2639 key: :default_manifest,
2642 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2643 " Currently only one manifest can be added (no arrays).",
2644 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2647 key: :shared_pack_cache_seconds_per_file,
2648 label: "Shared pack cache s/file",
2651 "When an emoji pack is shared, the archive is created and cached in memory" <>
2652 " for this amount of seconds multiplied by the number of files.",
2662 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2666 type: [:tuple, {:list, :tuple}],
2667 description: "For the search requests (account & status search etc.)",
2668 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2672 type: [:tuple, {:list, :tuple}],
2673 description: "For requests to timelines (each timeline has it's own limiter)",
2674 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2677 key: :app_account_creation,
2678 type: [:tuple, {:list, :tuple}],
2679 description: "For registering user accounts from the same IP address",
2680 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2683 key: :relations_actions,
2684 type: [:tuple, {:list, :tuple}],
2685 description: "For actions on relationships with all users (follow, unfollow)",
2686 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2689 key: :relation_id_action,
2690 label: "Relation ID action",
2691 type: [:tuple, {:list, :tuple}],
2692 description: "For actions on relation with a specific user (follow, unfollow)",
2693 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2696 key: :statuses_actions,
2697 type: [:tuple, {:list, :tuple}],
2699 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2700 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2703 key: :status_id_action,
2704 label: "Status ID action",
2705 type: [:tuple, {:list, :tuple}],
2707 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2708 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2711 key: :authentication,
2712 type: [:tuple, {:list, :tuple}],
2713 description: "For authentication create / password check / user existence check requests",
2714 suggestions: [{60_000, 15}]
2723 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2724 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2729 description: "Enables SSH"
2734 description: "Dir with SSH keys",
2735 suggestions: ["/some/path/ssh_keys"]
2740 description: "Handler module",
2741 suggestions: ["Pleroma.BBS.Handler"]
2746 description: "Port to connect",
2747 suggestions: [10_022]
2750 key: :password_authenticator,
2752 description: "Authenticator module",
2753 suggestions: ["Pleroma.BBS.Authenticator"]
2759 label: "Mime Types",
2761 description: "Mime Types settings",
2768 "application/xml" => ["xml"],
2769 "application/xrd+xml" => ["xrd+xml"],
2770 "application/jrd+json" => ["jrd+json"],
2771 "application/activity+json" => ["activity+json"],
2772 "application/ld+json" => ["activity+json"]
2777 key: "application/xml",
2778 type: {:list, :string},
2779 suggestions: ["xml"]
2782 key: "application/xrd+xml",
2783 type: {:list, :string},
2784 suggestions: ["xrd+xml"]
2787 key: "application/jrd+json",
2788 type: {:list, :string},
2789 suggestions: ["jrd+json"]
2792 key: "application/activity+json",
2793 type: {:list, :string},
2794 suggestions: ["activity+json"]
2797 key: "application/ld+json",
2798 type: {:list, :string},
2799 suggestions: ["activity+json"]
2809 description: "Pleroma chat settings",
2822 description: "HTTP settings",
2827 type: [:string, :tuple],
2828 description: "Proxy URL",
2829 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2832 key: :send_user_agent,
2837 type: [:string, :atom],
2839 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2840 suggestions: ["Pleroma", :default]
2845 description: "Adapter specific options",
2851 label: "SSL Options",
2852 description: "SSL options for HTTP adapter",
2856 type: {:list, :atom},
2857 description: "List of TLS version to use",
2858 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2869 label: "Markup Settings",
2873 key: :allow_inline_images,
2877 key: :allow_headings,
2890 type: {:list, :module},
2892 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2893 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2903 key: :deny_follow_blocked,
2911 key: :mrf_normalize_markup,
2912 label: "MRF Normalize Markup",
2913 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2919 suggestions: [Pleroma.HTML.Scrubber.Default]
2929 key: :restricted_nicknames,
2930 type: {:list, :string},
2949 "ostatus_subscribe",
2968 label: "CORS plug config",
2974 suggestions: [86_400]
2978 type: {:list, :string},
2979 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2983 type: {:list, :string},
2986 "X-RateLimit-Reset",
2987 "X-RateLimit-Limit",
2988 "X-RateLimit-Remaining",
2999 type: {:list, :string},
3000 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3006 key: Pleroma.Plugs.RemoteIp,
3009 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3010 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3016 description: "Enable/disable the plug. Default: disabled."
3020 type: {:list, :string},
3022 "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]`."
3026 type: {:list, :string},
3028 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3032 type: {:list, :string},
3034 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3040 key: :web_cache_ttl,
3041 label: "Web cache TTL",
3044 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3050 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3051 suggestions: [30_000, nil]
3054 key: :activity_pub_question,
3056 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3057 suggestions: [30_000]
3067 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3072 description: "Enables the rendering of static HTML. Default: disabled."
3080 description: "Configure feed rendering",
3085 description: "Configure title rendering",
3090 description: "Maximum number of characters before truncating title",
3096 description: "Replacement which will be used after truncating string",
3097 suggestions: ["..."]
3105 key: :mrf_object_age,
3106 label: "MRF Object Age",
3110 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3115 description: "Required age (in seconds) of a post before actions are taken.",
3116 suggestions: [172_800]
3120 type: {:list, :atom},
3122 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3123 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3124 "`:reject` rejects the message entirely",
3125 suggestions: [:delist, :strip_followers, :reject]
3133 description: "Custom Runtime Modules",
3138 description: "A path to custom Elixir modules (such as MRF policies)."
3146 description: "Settings for notifications streamer",
3151 description: "Number of workers to send notifications",
3155 key: :overflow_workers,
3157 description: "Maximum number of workers created if pool is empty",
3164 key: :connections_pool,
3166 description: "Advanced settings for `gun` connections pool",
3169 key: :checkin_timeout,
3171 description: "Timeout to checkin connection from pool. Default: 250ms.",
3175 key: :max_connections,
3177 description: "Maximum number of connections in the pool. Default: 250 connections.",
3184 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3188 key: :retry_timeout,
3191 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3195 key: :await_up_timeout,
3197 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3206 description: "Advanced settings for `gun` workers pools",
3211 description: "Settings for federation pool.",
3216 description: "Number workers in the pool.",
3222 description: "Number of additional workers if pool is under load.",
3228 description: "Timeout while `gun` will wait for response.",
3229 suggestions: [150_000]
3236 description: "Settings for media pool.",
3241 description: "Number workers in the pool.",
3247 description: "Number of additional workers if pool is under load.",
3253 description: "Timeout while `gun` will wait for response.",
3254 suggestions: [150_000]
3261 description: "Settings for upload pool.",
3266 description: "Number workers in the pool.",
3272 description: "Number of additional workers if pool is under load.",
3278 description: "Timeout while `gun` will wait for response.",
3279 suggestions: [300_000]
3286 description: "Settings for default pool.",
3291 description: "Number workers in the pool.",
3297 description: "Number of additional workers if pool is under load.",
3303 description: "Timeout while `gun` will wait for response.",
3304 suggestions: [10_000]
3312 key: :hackney_pools,
3314 description: "Advanced settings for `hackney` connections pools",
3319 description: "Settings for federation pool.",
3322 key: :max_connections,
3324 description: "Number workers in the pool.",
3330 description: "Timeout while `hackney` will wait for response.",
3331 suggestions: [150_000]
3338 description: "Settings for media pool.",
3341 key: :max_connections,
3343 description: "Number workers in the pool.",
3349 description: "Timeout while `hackney` will wait for response.",
3350 suggestions: [150_000]
3357 description: "Settings for upload pool.",
3360 key: :max_connections,
3362 description: "Number workers in the pool.",
3368 description: "Timeout while `hackney` will wait for response.",
3369 suggestions: [300_000]
3377 key: :restrict_unauthenticated,
3380 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3385 description: "Settings for public and federated timelines.",
3390 description: "Disallow view public timeline."
3395 description: "Disallow view federated timeline."
3402 description: "Settings for user profiles.",
3407 description: "Disallow view local user profiles."
3412 description: "Disallow view remote user profiles."
3419 description: "Settings for statuses.",
3424 description: "Disallow view local statuses."
3429 description: "Disallow view remote statuses."
3437 key: Pleroma.Web.ApiSpec.CastAndValidate,
3444 "Enables strict input validation (useful in development, not recommended in production)"
3450 key: :instances_favicons,
3452 description: "Control favicons for instances",
3457 description: "Allow/disallow displaying and getting instances favicons"
3465 descriptions: "S3 service related settings",
3468 key: :access_key_id,
3470 description: "S3 access key ID",
3471 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3474 key: :secret_access_key,
3476 description: "Secret access key",
3477 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3482 description: "S3 host",
3483 suggestions: ["s3.eu-central-1.amazonaws.com"]