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: [Pleroma.Uploaders.Local, Pleroma.Uploaders.S3]
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.",
34 Generator.list_modules_in_dir(
35 "lib/pleroma/upload/filter",
36 "Elixir.Pleroma.Upload.Filter."
43 "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`."
48 description: "Base url for the uploads, needed if you use CDN",
50 "https://cdn-host.com"
57 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
62 description: "Options for Pleroma.ReverseProxy",
64 redirect_on_failure: false,
65 max_body_length: 25 * 1_048_576,
67 follow_redirect: true,
73 key: :redirect_on_failure,
76 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
77 "Any error during body processing will not be redirected as the response is chunked."
80 key: :max_body_length,
83 "Limits the content length to be approximately the " <>
84 "specified length. It is validated with the `content-length` header and also verified when proxying."
89 description: "HTTP options",
94 description: "Adapter specific options",
100 description: "SSL options for HTTP adapter",
104 type: {:list, :atom},
105 description: "List of TLS versions to use",
106 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
115 type: [:string, :tuple],
116 description: "Proxy URL",
117 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
124 key: :filename_display_max_length,
126 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
132 key: Pleroma.Uploaders.Local,
134 description: "Local uploader-related settings",
139 description: "Path where user's uploads will be saved",
148 key: Pleroma.Uploaders.S3,
150 description: "S3 uploader-related settings",
155 description: "S3 bucket",
161 key: :bucket_namespace,
163 description: "S3 bucket namespace",
164 suggestions: ["pleroma"]
167 key: :public_endpoint,
169 description: "S3 endpoint",
170 suggestions: ["https://s3.amazonaws.com"]
173 key: :truncated_namespace,
176 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
177 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
180 key: :streaming_enabled,
183 "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."
189 key: Pleroma.Upload.Filter.Mogrify,
191 description: "Uploads mogrify filter settings",
195 type: [:string, {:list, :string}, {:list, :tuple}],
197 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
198 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
209 key: Pleroma.Upload.Filter.AnonymizeFilename,
211 description: "Filter replaces the filename of the upload",
217 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
218 " filename extension by using {extension}, for example custom-file-name.{extension}.",
220 "custom-file-name.{extension}"
227 key: Pleroma.Emails.Mailer,
229 description: "Mailer-related settings",
235 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
236 " or Swoosh.Adapters.Local for in-memory mailbox",
238 Swoosh.Adapters.SMTP,
239 Swoosh.Adapters.Sendgrid,
240 Swoosh.Adapters.Sendmail,
241 Swoosh.Adapters.Mandrill,
242 Swoosh.Adapters.Mailgun,
243 Swoosh.Adapters.Mailjet,
244 Swoosh.Adapters.Postmark,
245 Swoosh.Adapters.SparkPost,
246 Swoosh.Adapters.AmazonSES,
248 Swoosh.Adapters.SocketLabs,
249 Swoosh.Adapters.Gmail,
250 Swoosh.Adapters.Local
256 description: "Allow/disallow send emails"
259 group: {:subgroup, Swoosh.Adapters.SMTP},
262 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
263 suggestions: ["smtp.gmail.com"]
266 group: {:subgroup, Swoosh.Adapters.SMTP},
269 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
270 suggestions: ["pleroma"]
273 group: {:subgroup, Swoosh.Adapters.SMTP},
276 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
277 suggestions: ["password"]
280 group: {:subgroup, Swoosh.Adapters.SMTP},
284 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
287 group: {:subgroup, Swoosh.Adapters.SMTP},
291 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
292 suggestions: [:always, :never, :if_available]
295 group: {:subgroup, Swoosh.Adapters.SMTP},
298 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
299 suggestions: [:always, :never, :if_available]
302 group: {:subgroup, Swoosh.Adapters.SMTP},
305 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
309 group: {:subgroup, Swoosh.Adapters.SMTP},
312 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
316 group: {:subgroup, Swoosh.Adapters.SMTP},
318 label: "No MX lookups",
320 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
323 group: {:subgroup, Swoosh.Adapters.Sendgrid},
327 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
328 suggestions: ["my-api-key"]
331 group: {:subgroup, Swoosh.Adapters.Sendmail},
334 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
335 suggestions: ["/usr/bin/sendmail"]
338 group: {:subgroup, Swoosh.Adapters.Sendmail},
341 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
342 suggestions: ["-N delay,failure,success"]
345 group: {:subgroup, Swoosh.Adapters.Sendmail},
348 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
351 group: {:subgroup, Swoosh.Adapters.Mandrill},
355 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
356 suggestions: ["my-api-key"]
359 group: {:subgroup, Swoosh.Adapters.Mailgun},
363 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
364 suggestions: ["my-api-key"]
367 group: {:subgroup, Swoosh.Adapters.Mailgun},
370 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
371 suggestions: ["pleroma.com"]
374 group: {:subgroup, Swoosh.Adapters.Mailjet},
378 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
379 suggestions: ["my-api-key"]
382 group: {:subgroup, Swoosh.Adapters.Mailjet},
385 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
386 suggestions: ["my-secret-key"]
389 group: {:subgroup, Swoosh.Adapters.Postmark},
393 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
394 suggestions: ["my-api-key"]
397 group: {:subgroup, Swoosh.Adapters.SparkPost},
401 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
402 suggestions: ["my-api-key"]
405 group: {:subgroup, Swoosh.Adapters.SparkPost},
408 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
409 suggestions: ["https://api.sparkpost.com/api/v1"]
412 group: {:subgroup, Swoosh.Adapters.AmazonSES},
415 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
416 suggestions: ["us-east-1", "us-east-2"]
419 group: {:subgroup, Swoosh.Adapters.AmazonSES},
422 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
423 suggestions: ["aws-access-key"]
426 group: {:subgroup, Swoosh.Adapters.AmazonSES},
429 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
430 suggestions: ["aws-secret-key"]
433 group: {:subgroup, Swoosh.Adapters.Dyn},
437 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
438 suggestions: ["my-api-key"]
441 group: {:subgroup, Swoosh.Adapters.SocketLabs},
444 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
447 group: {:subgroup, Swoosh.Adapters.SocketLabs},
451 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
454 group: {:subgroup, Swoosh.Adapters.Gmail},
457 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
464 description: "`Swoosh.Adapters.Local` adapter specific settings",
467 group: {:subgroup, Swoosh.Adapters.Local},
470 description: "Run the preview server together as part of your app"
473 group: {:subgroup, Swoosh.Adapters.Local},
476 description: "The preview server port",
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",
514 description: "Instance-related settings",
519 description: "Name of the instance",
526 label: "Admin Email Address",
528 description: "Email used to reach an Administrator/Moderator of the instance",
535 label: "Sender Email Address",
537 description: "Envelope FROM address for mail sent via Pleroma",
546 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
554 description: "Posts character limit (CW/Subject included in the counter)",
562 description: "Character limit of the instance chat messages",
570 description: "Hard character limit beyond which remote posts will be dropped",
578 description: "File size limit of uploads (except for avatar, background, banner)",
584 key: :avatar_upload_limit,
586 description: "File size limit of user's profile avatars",
592 key: :background_upload_limit,
594 description: "File size limit of user's profile backgrounds",
600 key: :banner_upload_limit,
602 description: "File size limit of user's profile banners",
610 description: "A map with poll limits for local polls",
614 max_option_chars: 200,
616 max_expiration: 31_536_000
623 description: "Maximum number of options",
627 key: :max_option_chars,
629 description: "Maximum number of characters per option",
633 key: :min_expiration,
635 description: "Minimum expiration time (in seconds)",
639 key: :max_expiration,
641 description: "Maximum expiration time (in seconds)",
647 key: :registrations_open,
650 "Enable registrations for anyone. Invitations require this setting to be disabled."
653 key: :invites_enabled,
656 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
659 key: :account_activation_required,
661 description: "Require users to confirm their emails before signing in."
666 description: "Enable federation with other instances."
669 key: :federation_incoming_replies_max_depth,
670 label: "Fed. incoming replies max depth",
673 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
674 " 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.",
680 key: :federation_reachability_timeout_days,
681 label: "Fed. reachability timeout days",
684 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
692 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
698 "Makes the client API in authentificated mode-only except for user-profiles." <>
699 " Useful for disabling the Local Timeline and The Whole Known Network."
702 key: :quarantined_instances,
703 type: {:list, :string},
705 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
712 key: :managed_config,
715 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
720 description: "Instance static directory",
726 key: :allowed_post_formats,
727 type: {:list, :string},
728 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
737 key: :extended_nickname_format,
740 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
741 " This will break federation with older software for theses nicknames."
744 key: :cleanup_attachments,
747 Enable to remove associated attachments when status is removed.
748 This will not affect duplicates and attachments without status.
749 Enabling this will increase load to database when deleting statuses on larger instances.
753 key: :max_pinned_statuses,
755 description: "The maximum number of pinned statuses. 0 will disable the feature.",
763 key: :autofollowed_nicknames,
764 type: {:list, :string},
766 "Set to nicknames of (local) users that every new user should automatically follow",
775 key: :attachment_links,
777 description: "Enable to automatically add attachment link text to statuses"
780 key: :welcome_message,
783 "A message that will be sent to a newly registered users as a direct message",
785 "Hi, @username! Welcome on board!"
789 key: :welcome_user_nickname,
791 description: "The nickname of the local user that sends the welcome message",
797 key: :max_report_comment_size,
799 description: "The maximum size of the report comment. Default: 1000.",
805 key: :safe_dm_mentions,
808 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
809 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
815 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
818 key: :remote_post_retention_days,
821 "The default amount of days to retain remote posts when pruning the database",
827 key: :user_bio_length,
829 description: "A user bio maximum length. Default: 5000.",
835 key: :user_name_length,
837 description: "A user name maximum length. Default: 100.",
843 key: :skip_thread_containment,
845 description: "Skip filtering out broken threads. Default: enabled"
848 key: :limit_to_local_content,
849 type: {:dropdown, :atom},
851 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
859 key: :max_account_fields,
861 description: "The maximum number of custom fields in the user profile. Default: 10.",
867 key: :max_remote_account_fields,
870 "The maximum number of custom fields in the remote user profile. Default: 20.",
876 key: :account_field_name_length,
878 description: "An account field name maximum length. Default: 512.",
884 key: :account_field_value_length,
886 description: "An account field value maximum length. Default: 2048.",
892 key: :external_user_synchronization,
894 description: "Enabling following/followers counters synchronization for external users"
897 key: :multi_factor_authentication,
899 description: "Multi-factor authentication settings",
902 totp: [digits: 6, period: 30],
903 backup_codes: [number: 5, length: 16]
910 description: "TOTP settings",
911 suggestions: [digits: 6, period: 30],
918 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
925 "a period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
932 description: "MFA backup codes settings",
933 suggestions: [number: 5, length: 16],
939 description: "number of backup codes to generate."
946 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
953 key: :instance_thumbnail,
956 "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.",
957 suggestions: ["/instance/thumbnail.jpeg"]
964 description: "Logger-related settings",
968 type: [:atom, :tuple, :module],
970 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
971 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
979 description: "ExSyslogger-related settings",
983 type: {:dropdown, :atom},
984 description: "Log level",
985 suggestions: [:debug, :info, :warn, :error]
991 "A string that's prepended to every message, and is typically set to the app name",
992 suggestions: ["pleroma"]
997 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
998 suggestions: ["$metadata[$level] $message"]
1002 type: {:list, :atom},
1003 suggestions: [:request_id]
1011 description: "Console logger settings",
1015 type: {:dropdown, :atom},
1016 description: "Log level",
1017 suggestions: [:debug, :info, :warn, :error]
1022 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1023 suggestions: ["$metadata[$level] $message"]
1027 type: {:list, :atom},
1028 suggestions: [:request_id]
1035 description: "Quack-related settings",
1039 type: {:dropdown, :atom},
1040 description: "Log level",
1041 suggestions: [:debug, :info, :warn, :error]
1045 type: {:list, :atom},
1046 description: "Configure which metadata you want to report on",
1064 description: "Configure the Slack incoming webhook",
1065 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1071 key: :frontend_configurations,
1074 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1075 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1076 "add your own configuration your settings all fields must be complete.",
1080 label: "Pleroma FE",
1082 description: "Settings for Pleroma FE",
1085 alwaysShowSubjectInput: true,
1086 background: "/static/aurora_borealis.jpg",
1087 collapseMessageWithSubject: false,
1090 hideFilteredStatuses: false,
1091 hideMutedPosts: false,
1092 hidePostStats: false,
1093 hideSitename: false,
1094 hideUserStats: false,
1095 loginMethod: "password",
1096 logo: "/static/logo.png",
1099 minimalScopesMode: false,
1100 noAttachmentLinks: false,
1101 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1102 postContentType: "text/plain",
1103 redirectRootLogin: "/main/friends",
1104 redirectRootNoLogin: "/main/all",
1106 sidebarRight: false,
1107 showFeaturesPanel: true,
1108 showInstanceSpecificPanel: false,
1109 subjectLineBehavior: "email",
1110 theme: "pleroma-dark",
1111 webPushNotifications: false
1116 key: :alwaysShowSubjectInput,
1117 label: "Always show subject input",
1119 description: "When disabled, auto-hide the subject field if it's empty"
1125 "URL of the background, unless viewing a user profile with a background that is set",
1126 suggestions: ["/images/city.jpg"]
1129 key: :collapseMessageWithSubject,
1130 label: "Collapse message with subject",
1133 "When a message has a subject (aka Content Warning), collapse it by default"
1137 label: "PleromaFE Chat",
1139 description: "Disables PleromaFE Chat component"
1145 description: "Enables green text on lines prefixed with the > character."
1148 key: :hideFilteredStatuses,
1149 label: "Hide Filtered Statuses",
1151 description: "Hides filtered statuses from timelines."
1154 key: :hideMutedPosts,
1155 label: "Hide Muted Posts",
1157 description: "Hides muted statuses from timelines."
1160 key: :hidePostStats,
1161 label: "Hide post stats",
1163 description: "Hide notices statistics (repeats, favorites, ...)"
1167 label: "Hide Sitename",
1169 description: "Hides instance name from PleromaFE banner."
1172 key: :hideUserStats,
1173 label: "Hide user stats",
1176 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1181 description: "URL of the logo, defaults to Pleroma's logo",
1182 suggestions: ["/static/logo.png"]
1186 label: "Logo margin",
1189 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1190 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1191 suggestions: [".1em"]
1198 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1199 "If you want a colorful logo you must disable logoMask."
1202 key: :minimalScopesMode,
1203 label: "Minimal scopes mode",
1206 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1207 "Also prevents replying to a DM with a public post from PleromaFE."
1210 key: :nsfwCensorImage,
1211 label: "NSFW Censor Image",
1214 "URL of the image to use for hiding NSFW media attachments in the timeline.",
1215 suggestions: ["/static/img/nsfw.74818f9.png"]
1218 key: :postContentType,
1219 label: "Post Content Type",
1220 type: {:dropdown, :atom},
1221 description: "Default post formatting option.",
1222 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1225 key: :redirectRootNoLogin,
1226 label: "Redirect root no login",
1229 "Relative URL which indicates where to redirect when a user isn't logged in",
1230 suggestions: ["/main/all"]
1233 key: :redirectRootLogin,
1234 label: "Redirect root login",
1237 "Relative URL which indicates where to redirect when a user is logged in",
1238 suggestions: ["/main/friends"]
1242 label: "Scope copy",
1244 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1248 label: "Sidebar on Right",
1250 description: "Change alignment of sidebar and panels to the right."
1253 key: :showFeaturesPanel,
1254 label: "Show instance features panel",
1257 "Enables panel displaying functionality of the instance on the About page."
1260 key: :showInstanceSpecificPanel,
1261 label: "Show instance specific panel",
1263 description: "Whether to show the instance's custom panel"
1266 key: :subjectLineBehavior,
1267 label: "Subject line behavior",
1269 description: "Allows changing the default behaviour of subject lines in replies.
1270 `email`: copy and preprend re:, as in email,
1271 `masto`: copy verbatim, as in Mastodon,
1272 `noop`: don't copy the subject.",
1273 suggestions: ["email", "masto", "noop"]
1278 description: "Which theme to use. Available themes are defined in styles.json",
1279 suggestions: ["pleroma-dark"]
1287 description: "Settings for Masto FE",
1290 showInstanceSpecificPanel: true
1295 key: :showInstanceSpecificPanel,
1296 label: "Show instance specific panel",
1298 description: "Whenether to show the instance's specific panel"
1309 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1313 type: {:keyword, :map},
1315 "Keyword of mascots, each element must contain both an url and a mime_type key",
1318 url: "/images/pleroma-fox-tan-smol.png",
1319 mime_type: "image/png"
1321 pleroma_fox_tan_shy: %{
1322 url: "/images/pleroma-fox-tan-shy.png",
1323 mime_type: "image/png"
1328 key: :default_mascot,
1331 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1337 key: :default_user_avatar,
1339 description: "URL of the default user avatar.",
1340 suggestions: ["/images/avi.png"]
1349 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1353 type: {:list, :map},
1354 description: "Describe the icons of the app",
1357 src: "/static/logo.png"
1360 src: "/static/icon.png",
1364 src: "/static/icon.ico",
1365 sizes: "72x72 96x96 128x128 256x256"
1372 description: "Describe the theme color of the app",
1373 suggestions: ["#282c37", "mediumpurple"]
1376 key: :background_color,
1378 description: "Describe the background color of the app",
1379 suggestions: ["#191b22", "aliceblue"]
1387 label: "MRF simple",
1389 description: "Message Rewrite Facility",
1392 key: :media_removal,
1393 type: {:list, :string},
1394 description: "List of instances to strip media attachments from",
1395 suggestions: ["example.com", "*.example.com"]
1399 label: "Media NSFW",
1400 type: {:list, :string},
1401 description: "List of instances to tag all media as NSFW (sensitive) from",
1402 suggestions: ["example.com", "*.example.com"]
1405 key: :federated_timeline_removal,
1406 type: {:list, :string},
1408 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1409 suggestions: ["example.com", "*.example.com"]
1413 type: {:list, :string},
1414 description: "List of instances to reject activities from (except deletes)",
1415 suggestions: ["example.com", "*.example.com"]
1419 type: {:list, :string},
1420 description: "List of instances to only accept activities from (except deletes)",
1421 suggestions: ["example.com", "*.example.com"]
1424 key: :report_removal,
1425 type: {:list, :string},
1426 description: "List of instances to reject reports from",
1427 suggestions: ["example.com", "*.example.com"]
1430 key: :avatar_removal,
1431 type: {:list, :string},
1432 description: "List of instances to strip avatars from",
1433 suggestions: ["example.com", "*.example.com"]
1436 key: :banner_removal,
1437 type: {:list, :string},
1438 description: "List of instances to strip banners from",
1439 suggestions: ["example.com", "*.example.com"]
1442 key: :reject_deletes,
1443 type: {:list, :string},
1444 description: "List of instances to reject deletions from",
1445 suggestions: ["example.com", "*.example.com"]
1451 key: :mrf_activity_expiration,
1453 label: "MRF Activity Expiration Policy",
1455 description: "Adds expiration to all local Create Note activities",
1460 description: "Default global expiration time for all local Create activities (in days)",
1461 suggestions: [90, 365]
1469 label: "MRF subchain",
1472 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1473 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1478 description: "Matches a series of regular expressions against the actor field",
1481 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1489 key: :mrf_rejectnonpublic,
1492 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1493 label: "MRF reject non public",
1497 key: :allow_followersonly,
1498 label: "Allow followers-only",
1500 description: "Whether to allow followers-only posts"
1505 description: "Whether to allow direct messages"
1511 key: :mrf_hellthread,
1513 label: "MRF hellthread",
1515 description: "Block messages with too much mentions",
1518 key: :delist_threshold,
1521 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1522 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1526 key: :reject_threshold,
1529 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1538 label: "MRF keyword",
1540 description: "Reject or Word-Replace messages with a keyword or regex",
1544 type: [:string, :regex],
1546 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1547 suggestions: ["foo", ~r/foo/iu]
1550 key: :federated_timeline_removal,
1551 type: [:string, :regex],
1553 "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.",
1554 suggestions: ["foo", ~r/foo/iu]
1558 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1560 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1561 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1568 label: "MRF mention",
1570 description: "Block messages which mention a user",
1574 type: {:list, :string},
1575 description: "A list of actors for which any post mentioning them will be dropped.",
1576 suggestions: ["actor1", "actor2"]
1582 key: :mrf_vocabulary,
1584 label: "MRF vocabulary",
1586 description: "Filter messages which belong to certain activity vocabularies",
1590 type: {:list, :string},
1592 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1593 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1597 type: {:list, :string},
1599 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1600 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1606 # key: :mrf_user_allowlist,
1609 # "The keys in this section are the domain names that the policy should apply to." <>
1610 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1612 # %{"example.org" => ["https://example.org/users/admin"]}
1620 description: "Media proxy",
1625 description: "Enables proxying of remote media to the instance's proxy"
1631 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1632 suggestions: ["https://example.com"]
1640 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1646 description: "Enables invalidate media cache"
1651 description: "Module which will be used to cache purge.",
1653 Pleroma.Web.MediaProxy.Invalidation.Script,
1654 Pleroma.Web.MediaProxy.Invalidation.Http
1662 description: "Options for Pleroma.ReverseProxy",
1664 redirect_on_failure: false,
1665 max_body_length: 25 * 1_048_576,
1667 follow_redirect: true,
1673 key: :redirect_on_failure,
1676 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1677 "Any error during body processing will not be redirected as the response is chunked."
1680 key: :max_body_length,
1683 "Limits the content length to be approximately the " <>
1684 "specified length. It is validated with the `content-length` header and also verified when proxying."
1689 description: "HTTP options",
1694 description: "Adapter specific options",
1699 label: "SSL Options",
1700 description: "SSL options for HTTP adapter",
1704 type: {:list, :atom},
1705 description: "List of TLS version to use",
1706 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1715 type: [:string, :tuple],
1716 description: "Proxy URL",
1717 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1725 type: {:list, :string},
1726 description: "List of domains to bypass the mediaproxy",
1727 suggestions: ["example.com"]
1733 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1735 description: "HTTP invalidate settings",
1740 description: "HTTP method of request. Default: :purge"
1744 type: {:list, :tuple},
1745 description: "HTTP headers of request.",
1746 suggestions: [{"x-refresh", 1}]
1751 description: "Request options.",
1752 suggestions: [params: %{ts: "xxx"}]
1758 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1760 description: "Script invalidate settings",
1765 description: "Path to shell script. Which will run purge cache.",
1766 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1774 description: "Gopher settings",
1779 description: "Enables the gopher interface"
1784 description: "IP address to bind to",
1785 suggestions: [{0, 0, 0, 0}]
1790 description: "Port to bind to",
1796 description: "Port advertised in urls (optional, defaults to port)",
1805 description: "ActivityPub-related settings",
1808 key: :unfollow_blocked,
1810 description: "Whether blocks result in people getting unfollowed"
1813 key: :outgoing_blocks,
1815 description: "Whether to federate blocks to other instances"
1818 key: :sign_object_fetches,
1820 description: "Sign object fetches with HTTP signatures"
1823 key: :note_replies_output_limit,
1826 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1829 key: :follow_handshake_timeout,
1831 description: "Following handshake timeout",
1838 key: :http_security,
1840 description: "HTTP security settings",
1845 description: "Whether the managed content security policy is enabled"
1851 description: "Whether to additionally send a Strict-Transport-Security header"
1855 label: "STS max age",
1857 description: "The maximum age for the Strict-Transport-Security header if sent",
1858 suggestions: [31_536_000]
1862 label: "CT max age",
1864 description: "The maximum age for the Expect-CT header if sent",
1865 suggestions: [2_592_000]
1868 key: :referrer_policy,
1870 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1871 suggestions: ["same-origin", "no-referrer"]
1875 label: "Report URI",
1877 description: "Adds the specified url to report-uri and report-to group in CSP header",
1878 suggestions: ["https://example.com/report-uri"]
1883 group: :web_push_encryption,
1884 key: :vapid_details,
1887 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1893 "A mailto link for the administrative contact." <>
1894 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1895 suggestions: ["mailto:moderators@pleroma.com"]
1900 description: "VAPID public key",
1901 suggestions: ["Public key"]
1906 description: "VAPID private key",
1907 suggestions: ["Private key"]
1913 key: Pleroma.Captcha,
1915 description: "Captcha-related settings",
1920 description: "Whether the captcha should be shown on registration"
1925 description: "The method/service to use for captcha",
1926 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1929 key: :seconds_valid,
1931 description: "The time in seconds for which the captcha is valid",
1938 key: Pleroma.Captcha.Kocaptcha,
1941 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1942 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1947 description: "The kocaptcha endpoint to use",
1948 suggestions: ["https://captcha.kotobank.ch"]
1956 "Allows to set a token that can be used to authenticate with the admin api without using an actual user by giving it as the `admin_token` parameter",
1961 description: "Token",
1962 suggestions: ["We recommend a secure random string or UUID"]
1971 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1973 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1974 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1975 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1976 (see https://github.com/sorentwo/oban/issues/52).
1981 type: {:dropdown, :atom},
1982 description: "Logs verbose mode",
1983 suggestions: [false, :error, :warn, :info, :debug]
1987 type: [:atom, :tuple],
1989 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1990 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1994 type: {:keyword, :integer},
1996 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1998 activity_expiration: 10,
1999 attachments_cleanup: 5,
2001 federator_incoming: 50,
2002 federator_outgoing: 50,
2004 scheduled_activities: 10,
2010 key: :activity_expiration,
2012 description: "Activity expiration queue",
2016 key: :attachments_cleanup,
2018 description: "Attachment deletion queue",
2024 description: "Background queue",
2028 key: :federator_incoming,
2030 description: "Incoming federation queue",
2034 key: :federator_outgoing,
2036 description: "Outgoing federation queue",
2042 description: "Email sender queue, see Pleroma.Emails.Mailer",
2046 key: :scheduled_activities,
2048 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2052 key: :transmogrifier,
2054 description: "Transmogrifier queue",
2060 description: "Web push notifications queue",
2067 type: {:list, :tuple},
2068 description: "Settings for cron background jobs",
2070 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2071 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2072 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2073 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2074 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2083 description: "Includes custom worker options not interpretable directly by `Oban`",
2087 type: {:keyword, :integer},
2088 description: "Max retry attempts for failed jobs, per `Oban` queue",
2090 federator_incoming: 5,
2091 federator_outgoing: 5
2098 key: Pleroma.Web.Metadata,
2100 description: "Metadata-related settings",
2104 type: {:list, :module},
2105 description: "List of metadata providers to enable",
2107 Pleroma.Web.Metadata.Providers.OpenGraph,
2108 Pleroma.Web.Metadata.Providers.TwitterCard,
2109 Pleroma.Web.Metadata.Providers.RelMe,
2110 Pleroma.Web.Metadata.Providers.Feed
2115 label: "Unfurl NSFW",
2117 description: "When enabled NSFW attachments will be shown in previews"
2126 "If enabled the instance will parse metadata from attached links to generate link previews.",
2131 description: "Enables RichMedia parsing of URLs."
2135 type: {:list, :string},
2136 description: "List of hosts which will be ignored by the metadata parser.",
2137 suggestions: ["accounts.google.com", "xss.website"]
2141 label: "Ignore TLD",
2142 type: {:list, :string},
2143 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2144 suggestions: ["local", "localdomain", "lan"]
2148 type: {:list, :module},
2150 "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.",
2152 Pleroma.Web.RichMedia.Parsers.OEmbed,
2153 Pleroma.Web.RichMedia.Parsers.TwitterCard
2158 label: "TTL setters",
2159 type: {:list, :module},
2161 "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.",
2163 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2169 group: :auto_linker,
2172 description: "Configuration for the auto_linker library",
2176 type: [:string, false],
2177 description: "Specify the class to be added to the generated link. Disable to clear",
2178 suggestions: ["auto-linker", false]
2182 type: [:string, false],
2183 description: "Override the rel attribute. Disable to clear",
2184 suggestions: ["ugc", "noopener noreferrer", false]
2189 description: "Link urls will open in new window/tab"
2193 type: [:integer, false],
2195 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2196 suggestions: [15, false]
2201 description: "Strip the scheme prefix"
2206 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2212 key: Pleroma.ScheduledActivity,
2214 description: "Scheduled activities settings",
2217 key: :daily_user_limit,
2220 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2224 key: :total_user_limit,
2227 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2233 description: "Whether scheduled activities are sent to the job queue to be executed"
2239 key: Pleroma.ActivityExpiration,
2241 description: "Expired activity settings",
2246 description: "Whether expired activities will be sent to the job queue to be deleted"
2253 description: "Authenticator",
2256 key: Pleroma.Web.Auth.Authenticator,
2258 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2267 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2268 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2269 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2270 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2275 description: "Enables LDAP authentication"
2280 description: "LDAP server hostname",
2281 suggestions: ["localhosts"]
2286 description: "LDAP port, e.g. 389 or 636",
2287 suggestions: [389, 636]
2293 description: "Enable to use SSL, usually implies the port 636"
2297 label: "SSL options",
2299 description: "Additional SSL options",
2300 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2305 description: "Path to file with PEM encoded cacerts",
2306 suggestions: ["path/to/file/with/PEM/cacerts"]
2311 description: "Type of cert verification",
2312 suggestions: [:verify_peer]
2320 description: "Enable to use STARTTLS, usually implies the port 389"
2324 label: "TLS options",
2326 description: "Additional TLS options",
2327 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2332 description: "Path to file with PEM encoded cacerts",
2333 suggestions: ["path/to/file/with/PEM/cacerts"]
2338 description: "Type of cert verification",
2339 suggestions: [:verify_peer]
2346 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2347 suggestions: ["dc=example,dc=com"]
2353 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2362 description: "Authentication / authorization settings",
2365 key: :enforce_oauth_admin_scope_usage,
2368 "OAuth admin scope requirement toggle. " <>
2369 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2370 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2371 "`is_admin` user flag grants access to admin-specific actions."
2374 key: :auth_template,
2377 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2378 suggestions: ["show.html"]
2381 key: :oauth_consumer_template,
2384 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2385 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2386 suggestions: ["consumer.html"]
2389 key: :oauth_consumer_strategies,
2390 type: {:list, :string},
2392 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2393 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2394 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2395 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2401 key: :email_notifications,
2403 description: "Email notifications settings",
2409 "emails of \"what you've missed\" for users who have been inactive for a while",
2413 schedule: "0 0 * * 0",
2415 inactivity_threshold: 7
2423 description: "Globally enable or disable digest emails"
2429 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2430 suggestions: ["0 0 * * 0"]
2435 description: "Minimum interval between digest emails to one user",
2439 key: :inactivity_threshold,
2441 description: "Minimum user inactivity threshold",
2450 key: Pleroma.Emails.UserEmail,
2452 description: "Email template settings",
2457 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2458 suggestions: ["some/path/logo.png"]
2463 description: "a map with color settings for email templates.",
2466 link_color: "#d8a070",
2467 background_color: "#2C3645",
2468 content_background_color: "#1B2635",
2469 header_color: "#d8a070",
2470 text_color: "#b9b9ba",
2471 text_muted_color: "#b9b9ba"
2478 suggestions: ["#d8a070"]
2481 key: :background_color,
2483 suggestions: ["#2C3645"]
2486 key: :content_background_color,
2488 suggestions: ["#1B2635"]
2493 suggestions: ["#d8a070"]
2498 suggestions: ["#b9b9ba"]
2501 key: :text_muted_color,
2503 suggestions: ["#b9b9ba"]
2511 key: Pleroma.Emails.NewUsersDigestEmail,
2513 description: "New users admin email digest",
2518 description: "enables new users admin digest email when `true`",
2519 suggestions: [false]
2527 description: "Configure OAuth 2 provider capabilities",
2530 key: :token_expires_in,
2532 description: "The lifetime in seconds of the access token",
2536 key: :issue_new_refresh_token,
2539 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2542 key: :clean_expired_tokens,
2544 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2554 key: :shortcode_globs,
2555 type: {:list, :string},
2556 description: "Location of custom emoji files. * can be used as a wildcard.",
2557 suggestions: ["/emoji/custom/**/*.png"]
2560 key: :pack_extensions,
2561 type: {:list, :string},
2563 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2564 suggestions: [".png", ".gif"]
2568 type: {:keyword, :string, {:list, :string}},
2570 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2571 " and the value is the location or array of locations. * can be used as a wildcard.",
2573 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2577 key: :default_manifest,
2580 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2581 " Currently only one manifest can be added (no arrays).",
2582 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2585 key: :shared_pack_cache_seconds_per_file,
2586 label: "Shared pack cache s/file",
2589 "When an emoji pack is shared, the archive is created and cached in memory" <>
2590 " for this amount of seconds multiplied by the number of files.",
2600 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2604 type: [:tuple, {:list, :tuple}],
2605 description: "For the search requests (account & status search etc.)",
2606 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2610 type: [:tuple, {:list, :tuple}],
2611 description: "For requests to timelines (each timeline has it's own limiter)",
2612 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2615 key: :app_account_creation,
2616 type: [:tuple, {:list, :tuple}],
2617 description: "For registering user accounts from the same IP address",
2618 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2621 key: :relations_actions,
2622 type: [:tuple, {:list, :tuple}],
2623 description: "For actions on relationships with all users (follow, unfollow)",
2624 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2627 key: :relation_id_action,
2628 type: [:tuple, {:list, :tuple}],
2629 description: "For actions on relation with a specific user (follow, unfollow)",
2630 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2633 key: :statuses_actions,
2634 type: [:tuple, {:list, :tuple}],
2636 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2637 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2640 key: :status_id_action,
2641 type: [:tuple, {:list, :tuple}],
2643 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2644 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2647 key: :authentication,
2648 type: [:tuple, {:list, :tuple}],
2649 description: "For authentication create / password check / user existence check requests",
2650 suggestions: [{60_000, 15}]
2658 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2659 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2664 description: "Enables SSH"
2669 description: "Dir with SSH keys",
2670 suggestions: ["/some/path/ssh_keys"]
2675 description: "Handler module",
2676 suggestions: ["Pleroma.BBS.Handler"]
2681 description: "Port to connect",
2682 suggestions: [10_022]
2685 key: :password_authenticator,
2687 description: "Authenticator module",
2688 suggestions: ["Pleroma.BBS.Authenticator"]
2695 description: "Mime types",
2702 "application/xml" => ["xml"],
2703 "application/xrd+xml" => ["xrd+xml"],
2704 "application/jrd+json" => ["jrd+json"],
2705 "application/activity+json" => ["activity+json"],
2706 "application/ld+json" => ["activity+json"]
2711 key: "application/xml",
2712 type: {:list, :string},
2713 suggestions: ["xml"]
2716 key: "application/xrd+xml",
2717 type: {:list, :string},
2718 suggestions: ["xrd+xml"]
2721 key: "application/jrd+json",
2722 type: {:list, :string},
2723 suggestions: ["jrd+json"]
2726 key: "application/activity+json",
2727 type: {:list, :string},
2728 suggestions: ["activity+json"]
2731 key: "application/ld+json",
2732 type: {:list, :string},
2733 suggestions: ["activity+json"]
2743 description: "Pleroma chat settings",
2755 description: "HTTP settings",
2760 type: [:string, :tuple],
2761 description: "Proxy URL",
2762 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2765 key: :send_user_agent,
2770 type: [:string, :atom],
2772 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2773 suggestions: ["Pleroma", :default]
2778 description: "Adapter specific options",
2784 label: "SSL Options",
2785 description: "SSL options for HTTP adapter",
2789 type: {:list, :atom},
2790 description: "List of TLS version to use",
2791 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2805 key: :allow_inline_images,
2809 key: :allow_headings,
2822 type: {:list, :module},
2824 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2825 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2835 key: :deny_follow_blocked,
2843 key: :mrf_normalize_markup,
2844 label: "MRF normalize markup",
2845 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2851 suggestions: [Pleroma.HTML.Scrubber.Default]
2861 key: :restricted_nicknames,
2862 type: {:list, :string},
2881 "ostatus_subscribe",
2905 suggestions: [86_400]
2909 type: {:list, :string},
2910 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2914 type: {:list, :string},
2917 "X-RateLimit-Reset",
2918 "X-RateLimit-Limit",
2919 "X-RateLimit-Remaining",
2930 type: {:list, :string},
2931 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2937 key: Pleroma.Plugs.RemoteIp,
2940 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2941 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2947 description: "Enable/disable the plug. Default: disabled."
2951 type: {:list, :string},
2953 "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]`."
2957 type: {:list, :string},
2959 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2963 type: {:list, :string},
2965 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2971 key: :web_cache_ttl,
2974 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2980 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2981 suggestions: [30_000, nil]
2984 key: :activity_pub_question,
2986 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2987 suggestions: [30_000]
2996 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
3001 description: "Enables the rendering of static HTML. Default: disabled."
3009 description: "Configure feed rendering",
3014 description: "Configure title rendering.",
3019 description: "Maximum number of characters before truncating title.",
3025 description: "Replacement which will be used after truncating string.",
3026 suggestions: ["..."]
3034 key: :mrf_object_age,
3037 description: "Rejects or delists posts based on their age when received.",
3042 description: "Required age (in seconds) of a post before actions are taken.",
3043 suggestions: [172_800]
3047 type: {:list, :atom},
3049 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3050 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
3051 "`:reject` rejects the message entirely",
3052 suggestions: [:delist, :strip_followers, :reject]
3060 description: "Custom Runtime Modules",
3065 description: "A path to custom Elixir modules (such as MRF policies)."
3073 description: "Settings for notifications streamer",
3078 description: "Number of workers to send notifications.",
3082 key: :overflow_workers,
3084 description: "Maximum number of workers created if pool is empty.",
3091 key: :connections_pool,
3093 description: "Advanced settings for `gun` connections pool",
3096 key: :checkin_timeout,
3098 description: "Timeout to checkin connection from pool. Default: 250ms.",
3102 key: :max_connections,
3104 description: "Maximum number of connections in the pool. Default: 250 connections.",
3111 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3115 key: :retry_timeout,
3118 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3122 key: :await_up_timeout,
3124 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3133 description: "Advanced settings for `gun` workers pools",
3138 description: "Settings for federation pool.",
3143 description: "Number workers in the pool.",
3149 description: "Number of additional workers if pool is under load.",
3155 description: "Timeout while `gun` will wait for response.",
3156 suggestions: [150_000]
3163 description: "Settings for media pool.",
3168 description: "Number workers in the pool.",
3174 description: "Number of additional workers if pool is under load.",
3180 description: "Timeout while `gun` will wait for response.",
3181 suggestions: [150_000]
3188 description: "Settings for upload pool.",
3193 description: "Number workers in the pool.",
3199 description: "Number of additional workers if pool is under load.",
3205 description: "Timeout while `gun` will wait for response.",
3206 suggestions: [300_000]
3213 description: "Settings for default pool.",
3218 description: "Number workers in the pool.",
3224 description: "Number of additional workers if pool is under load.",
3230 description: "Timeout while `gun` will wait for response.",
3231 suggestions: [10_000]
3239 key: :hackney_pools,
3241 description: "Advanced settings for `hackney` connections pools",
3246 description: "Settings for federation pool.",
3249 key: :max_connections,
3251 description: "Number workers in the pool.",
3257 description: "Timeout while `hackney` will wait for response.",
3258 suggestions: [150_000]
3265 description: "Settings for media pool.",
3268 key: :max_connections,
3270 description: "Number workers in the pool.",
3276 description: "Timeout while `hackney` will wait for response.",
3277 suggestions: [150_000]
3284 description: "Settings for upload pool.",
3287 key: :max_connections,
3289 description: "Number workers in the pool.",
3295 description: "Timeout while `hackney` will wait for response.",
3296 suggestions: [300_000]
3304 key: :restrict_unauthenticated,
3307 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3312 description: "Settings for public and federated timelines.",
3317 description: "Disallow view public timeline."
3322 description: "Disallow view federated timeline."
3329 description: "Settings for user profiles.",
3334 description: "Disallow view local user profiles."
3339 description: "Disallow view remote user profiles."
3346 description: "Settings for statuses.",
3351 description: "Disallow view local statuses."
3356 description: "Disallow view remote statuses."
3364 key: Pleroma.Web.ApiSpec.CastAndValidate,
3371 "Enables strict input validation (useful in development, not recommended in production)",
3372 suggestions: [false]
3381 description: "General MRF settings",
3385 type: [:module, {:list, :module}],
3387 "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.",
3389 Generator.list_modules_in_dir(
3390 "lib/pleroma/web/activity_pub/mrf",
3391 "Elixir.Pleroma.Web.ActivityPub.MRF."
3396 label: "MRF transparency",
3399 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
3402 key: :transparency_exclusions,
3403 label: "MRF transparency exclusions",
3404 type: {:list, :string},
3406 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",