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}]
127 key: Pleroma.Uploaders.Local,
129 description: "Local uploader-related settings",
134 description: "Path where user's uploads will be saved",
143 key: Pleroma.Uploaders.S3,
145 description: "S3 uploader-related settings",
150 description: "S3 bucket",
156 key: :bucket_namespace,
158 description: "S3 bucket namespace",
159 suggestions: ["pleroma"]
162 key: :public_endpoint,
164 description: "S3 endpoint",
165 suggestions: ["https://s3.amazonaws.com"]
168 key: :truncated_namespace,
171 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
172 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
175 key: :streaming_enabled,
178 "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."
184 key: Pleroma.Upload.Filter.Mogrify,
186 description: "Uploads mogrify filter settings",
190 type: [:string, {:list, :string}, {:list, :tuple}],
191 description: "List of actions for the mogrify command",
202 key: Pleroma.Upload.Filter.AnonymizeFilename,
204 description: "Filter replaces the filename of the upload",
210 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
211 " filename extension by using {extension}, for example custom-file-name.{extension}.",
213 "custom-file-name.{extension}"
220 key: Pleroma.Emails.Mailer,
222 description: "Mailer-related settings",
228 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
229 " or Swoosh.Adapters.Local for in-memory mailbox",
231 Swoosh.Adapters.SMTP,
232 Swoosh.Adapters.Sendgrid,
233 Swoosh.Adapters.Sendmail,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Mailgun,
236 Swoosh.Adapters.Mailjet,
237 Swoosh.Adapters.Postmark,
238 Swoosh.Adapters.SparkPost,
239 Swoosh.Adapters.AmazonSES,
241 Swoosh.Adapters.SocketLabs,
242 Swoosh.Adapters.Gmail,
243 Swoosh.Adapters.Local
249 description: "Allow/disallow send emails"
252 group: {:subgroup, Swoosh.Adapters.SMTP},
255 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
256 suggestions: ["smtp.gmail.com"]
259 group: {:subgroup, Swoosh.Adapters.SMTP},
262 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
263 suggestions: ["pleroma"]
266 group: {:subgroup, Swoosh.Adapters.SMTP},
269 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
270 suggestions: ["password"]
273 group: {:subgroup, Swoosh.Adapters.SMTP},
277 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
280 group: {:subgroup, Swoosh.Adapters.SMTP},
284 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
285 suggestions: [:always, :never, :if_available]
288 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",
302 group: {:subgroup, Swoosh.Adapters.SMTP},
305 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
309 group: {:subgroup, Swoosh.Adapters.SMTP},
311 label: "No MX lookups",
313 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
316 group: {:subgroup, Swoosh.Adapters.Sendgrid},
320 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
321 suggestions: ["my-api-key"]
324 group: {:subgroup, Swoosh.Adapters.Sendmail},
327 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
328 suggestions: ["/usr/bin/sendmail"]
331 group: {:subgroup, Swoosh.Adapters.Sendmail},
334 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
335 suggestions: ["-N delay,failure,success"]
338 group: {:subgroup, Swoosh.Adapters.Sendmail},
341 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
344 group: {:subgroup, Swoosh.Adapters.Mandrill},
348 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
349 suggestions: ["my-api-key"]
352 group: {:subgroup, Swoosh.Adapters.Mailgun},
356 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
357 suggestions: ["my-api-key"]
360 group: {:subgroup, Swoosh.Adapters.Mailgun},
363 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
364 suggestions: ["pleroma.com"]
367 group: {:subgroup, Swoosh.Adapters.Mailjet},
371 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
372 suggestions: ["my-api-key"]
375 group: {:subgroup, Swoosh.Adapters.Mailjet},
378 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
379 suggestions: ["my-secret-key"]
382 group: {:subgroup, Swoosh.Adapters.Postmark},
386 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
387 suggestions: ["my-api-key"]
390 group: {:subgroup, Swoosh.Adapters.SparkPost},
394 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
395 suggestions: ["my-api-key"]
398 group: {:subgroup, Swoosh.Adapters.SparkPost},
401 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
402 suggestions: ["https://api.sparkpost.com/api/v1"]
405 group: {:subgroup, Swoosh.Adapters.AmazonSES},
408 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
409 suggestions: ["us-east-1", "us-east-2"]
412 group: {:subgroup, Swoosh.Adapters.AmazonSES},
415 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
416 suggestions: ["aws-access-key"]
419 group: {:subgroup, Swoosh.Adapters.AmazonSES},
422 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
423 suggestions: ["aws-secret-key"]
426 group: {:subgroup, Swoosh.Adapters.Dyn},
430 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
431 suggestions: ["my-api-key"]
434 group: {:subgroup, Swoosh.Adapters.SocketLabs},
437 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
440 group: {:subgroup, Swoosh.Adapters.SocketLabs},
444 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
447 group: {:subgroup, Swoosh.Adapters.Gmail},
450 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
457 description: "`Swoosh.Adapters.Local` adapter specific settings",
460 group: {:subgroup, Swoosh.Adapters.Local},
463 description: "Run the preview server together as part of your app"
466 group: {:subgroup, Swoosh.Adapters.Local},
469 description: "The preview server port",
478 description: "URI schemes related settings",
482 type: {:list, :string},
483 description: "List of the scheme part that is considered valid to be an URL",
507 description: "Instance-related settings",
512 description: "Name of the instance",
519 label: "Admin Email Address",
521 description: "Email used to reach an Administrator/Moderator of the instance",
528 label: "Sender Email Address",
530 description: "Envelope FROM address for mail sent via Pleroma",
539 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
547 description: "Posts character limit (CW/Subject included in the counter)",
555 description: "Character limit of the instance chat messages",
563 description: "Hard character limit beyond which remote posts will be dropped",
571 description: "File size limit of uploads (except for avatar, background, banner)",
577 key: :avatar_upload_limit,
579 description: "File size limit of user's profile avatars",
585 key: :background_upload_limit,
587 description: "File size limit of user's profile backgrounds",
593 key: :banner_upload_limit,
595 description: "File size limit of user's profile banners",
603 description: "A map with poll limits for local polls",
607 max_option_chars: 200,
609 max_expiration: 31_536_000
616 description: "Maximum number of options",
620 key: :max_option_chars,
622 description: "Maximum number of characters per option",
626 key: :min_expiration,
628 description: "Minimum expiration time (in seconds)",
632 key: :max_expiration,
634 description: "Maximum expiration time (in seconds)",
640 key: :registrations_open,
643 "Enable registrations for anyone. Invitations require this setting to be disabled."
646 key: :invites_enabled,
649 "Enable user invitations for admins (depends on `registrations_open` being disabled)."
652 key: :account_activation_required,
654 description: "Require users to confirm their emails before signing in."
659 description: "Enable federation with other instances."
662 key: :federation_incoming_replies_max_depth,
663 label: "Fed. incoming replies max depth",
666 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
667 " 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.",
673 key: :federation_reachability_timeout_days,
674 label: "Fed. reachability timeout days",
677 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it.",
683 key: :federation_publisher_modules,
684 type: {:list, :module},
686 "List of modules for federation publishing. Module names are shortened (removed leading `Pleroma.Web.` part), but on adding custom module you need to use full name.",
688 Pleroma.Web.ActivityPub.Publisher
694 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
697 key: :rewrite_policy,
698 type: [:module, {:list, :module}],
700 "A list of enabled MRF policies. Module names are shortened (removed leading `Pleroma.Web.ActivityPub.MRF.` part), but on adding custom module you need to use full name.",
702 Generator.list_modules_in_dir(
703 "lib/pleroma/web/activity_pub/mrf",
704 "Elixir.Pleroma.Web.ActivityPub.MRF."
711 "Makes the client API in authentificated mode-only except for user-profiles." <>
712 " Useful for disabling the Local Timeline and The Whole Known Network."
715 key: :quarantined_instances,
716 type: {:list, :string},
718 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
725 key: :managed_config,
728 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
733 description: "Instance static directory",
739 key: :allowed_post_formats,
740 type: {:list, :string},
741 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
750 key: :mrf_transparency,
751 label: "MRF transparency",
754 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
757 key: :mrf_transparency_exclusions,
758 label: "MRF transparency exclusions",
759 type: {:list, :string},
761 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
767 key: :extended_nickname_format,
770 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
771 " This will break federation with older software for theses nicknames."
774 key: :cleanup_attachments,
777 Enable to remove associated attachments when status is removed.
778 This will not affect duplicates and attachments without status.
779 Enabling this will increase load to database when deleting statuses on larger instances.
783 key: :max_pinned_statuses,
785 description: "The maximum number of pinned statuses. 0 will disable the feature.",
793 key: :autofollowed_nicknames,
794 type: {:list, :string},
796 "Set to nicknames of (local) users that every new user should automatically follow",
805 key: :attachment_links,
807 description: "Enable to automatically add attachment link text to statuses"
810 key: :welcome_message,
813 "A message that will be sent to a newly registered users as a direct message",
815 "Hi, @username! Welcome on board!"
819 key: :welcome_user_nickname,
821 description: "The nickname of the local user that sends the welcome message",
827 key: :max_report_comment_size,
829 description: "The maximum size of the report comment. Default: 1000.",
835 key: :safe_dm_mentions,
838 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
839 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
845 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
848 key: :remote_post_retention_days,
851 "The default amount of days to retain remote posts when pruning the database",
857 key: :user_bio_length,
859 description: "A user bio maximum length. Default: 5000.",
865 key: :user_name_length,
867 description: "A user name maximum length. Default: 100.",
873 key: :skip_thread_containment,
875 description: "Skip filtering out broken threads. Default: enabled"
878 key: :limit_to_local_content,
879 type: {:dropdown, :atom},
881 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
889 key: :max_account_fields,
891 description: "The maximum number of custom fields in the user profile. Default: 10.",
897 key: :max_remote_account_fields,
900 "The maximum number of custom fields in the remote user profile. Default: 20.",
906 key: :account_field_name_length,
908 description: "An account field name maximum length. Default: 512.",
914 key: :account_field_value_length,
916 description: "An account field value maximum length. Default: 2048.",
922 key: :external_user_synchronization,
924 description: "Enabling following/followers counters synchronization for external users"
927 key: :multi_factor_authentication,
929 description: "Multi-factor authentication settings",
932 totp: [digits: 6, period: 30],
933 backup_codes: [number: 5, length: 16]
940 description: "TOTP settings",
941 suggestions: [digits: 6, period: 30],
948 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
955 "a period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
962 description: "MFA backup codes settings",
963 suggestions: [number: 5, length: 16],
969 description: "number of backup codes to generate."
976 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
987 description: "Logger-related settings",
991 type: [:atom, :tuple, :module],
993 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
994 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1002 description: "ExSyslogger-related settings",
1006 type: {:dropdown, :atom},
1007 description: "Log level",
1008 suggestions: [:debug, :info, :warn, :error]
1014 "A string that's prepended to every message, and is typically set to the app name",
1015 suggestions: ["pleroma"]
1020 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1021 suggestions: ["$metadata[$level] $message"]
1025 type: {:list, :atom},
1026 suggestions: [:request_id]
1034 description: "Console logger settings",
1038 type: {:dropdown, :atom},
1039 description: "Log level",
1040 suggestions: [:debug, :info, :warn, :error]
1045 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\".",
1046 suggestions: ["$metadata[$level] $message"]
1050 type: {:list, :atom},
1051 suggestions: [:request_id]
1058 description: "Quack-related settings",
1062 type: {:dropdown, :atom},
1063 description: "Log level",
1064 suggestions: [:debug, :info, :warn, :error]
1068 type: {:list, :atom},
1069 description: "Configure which metadata you want to report on",
1087 description: "Configure the Slack incoming webhook",
1088 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1094 key: :frontend_configurations,
1097 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1098 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1099 "add your own configuration your settings all fields must be complete.",
1103 label: "Pleroma FE",
1105 description: "Settings for Pleroma FE",
1108 alwaysShowSubjectInput: true,
1109 background: "/static/aurora_borealis.jpg",
1110 collapseMessageWithSubject: false,
1113 hideFilteredStatuses: false,
1114 hideMutedPosts: false,
1115 hidePostStats: false,
1116 hideSitename: false,
1117 hideUserStats: false,
1118 loginMethod: "password",
1119 logo: "/static/logo.png",
1122 minimalScopesMode: false,
1123 noAttachmentLinks: false,
1124 nsfwCensorImage: "",
1125 postContentType: "text/plain",
1126 redirectRootLogin: "/main/friends",
1127 redirectRootNoLogin: "/main/all",
1129 showFeaturesPanel: true,
1130 showInstanceSpecificPanel: false,
1131 subjectLineBehavior: "email",
1132 theme: "pleroma-dark",
1133 webPushNotifications: false
1138 key: :alwaysShowSubjectInput,
1139 label: "Always show subject input",
1141 description: "When disabled, auto-hide the subject field if it's empty"
1147 "URL of the background, unless viewing a user profile with a background that is set",
1148 suggestions: ["/images/city.jpg"]
1151 key: :collapseMessageWithSubject,
1152 label: "Collapse message with subject",
1155 "When a message has a subject (aka Content Warning), collapse it by default"
1159 label: "PleromaFE Chat",
1161 description: "Disables PleromaFE Chat component"
1167 description: "Enables green text on lines prefixed with the > character."
1170 key: :hideFilteredStatuses,
1171 label: "Hide Filtered Statuses",
1173 description: "Hides filtered statuses from timelines."
1176 key: :hideMutedPosts,
1177 label: "Hide Muted Posts",
1179 description: "Hides muted statuses from timelines."
1182 key: :hidePostStats,
1183 label: "Hide post stats",
1185 description: "Hide notices statistics (repeats, favorites, ...)"
1189 label: "Hide Sitename",
1191 description: "Hides instance name from PleromaFE banner."
1194 key: :hideUserStats,
1195 label: "Hide user stats",
1198 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1203 description: "URL of the logo, defaults to Pleroma's logo",
1204 suggestions: ["/static/logo.png"]
1208 label: "Logo margin",
1211 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1212 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1213 suggestions: [".1em"]
1220 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1221 "If you want a colorful logo you must disable logoMask."
1224 key: :minimalScopesMode,
1225 label: "Minimal scopes mode",
1228 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1229 "Also prevents replying to a DM with a public post from PleromaFE."
1232 key: :nsfwCensorImage,
1233 label: "NSFW Censor Image",
1236 "URL of the image to use for hiding NSFW media attachments in the timeline.",
1237 suggestions: ["/static/img/nsfw.png"]
1240 key: :postContentType,
1241 label: "Post Content Type",
1242 type: {:dropdown, :atom},
1243 description: "Default post formatting option.",
1244 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1247 key: :redirectRootNoLogin,
1248 label: "Redirect root no login",
1251 "Relative URL which indicates where to redirect when a user isn't logged in",
1252 suggestions: ["/main/all"]
1255 key: :redirectRootLogin,
1256 label: "Redirect root login",
1259 "Relative URL which indicates where to redirect when a user is logged in",
1260 suggestions: ["/main/friends"]
1264 label: "Scope copy",
1266 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1269 key: :showFeaturesPanel,
1270 label: "Show instance features panel",
1272 description: "Enables panel displaying functionality of the instance on the About page."
1275 key: :showInstanceSpecificPanel,
1276 label: "Show instance specific panel",
1278 description: "Whether to show the instance's custom panel"
1281 key: :subjectLineBehavior,
1282 label: "Subject line behavior",
1284 description: "Allows changing the default behaviour of subject lines in replies.
1285 `email`: copy and preprend re:, as in email,
1286 `masto`: copy verbatim, as in Mastodon,
1287 `noop`: don't copy the subject.",
1288 suggestions: ["email", "masto", "noop"]
1293 description: "Which theme to use. Available themes are defined in styles.json",
1294 suggestions: ["pleroma-dark"]
1302 description: "Settings for Masto FE",
1305 showInstanceSpecificPanel: true
1310 key: :showInstanceSpecificPanel,
1311 label: "Show instance specific panel",
1313 description: "Whenether to show the instance's specific panel"
1324 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1328 type: {:keyword, :map},
1330 "Keyword of mascots, each element must contain both an url and a mime_type key",
1333 url: "/images/pleroma-fox-tan-smol.png",
1334 mime_type: "image/png"
1336 pleroma_fox_tan_shy: %{
1337 url: "/images/pleroma-fox-tan-shy.png",
1338 mime_type: "image/png"
1343 key: :default_mascot,
1346 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1358 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE",
1362 type: {:list, :map},
1363 description: "Describe the icons of the app",
1366 src: "/static/logo.png"
1369 src: "/static/icon.png",
1373 src: "/static/icon.ico",
1374 sizes: "72x72 96x96 128x128 256x256"
1381 description: "Describe the theme color of the app",
1382 suggestions: ["#282c37", "mediumpurple"]
1385 key: :background_color,
1387 description: "Describe the background color of the app",
1388 suggestions: ["#191b22", "aliceblue"]
1395 label: "MRF simple",
1397 description: "Message Rewrite Facility",
1400 key: :media_removal,
1401 type: {:list, :string},
1402 description: "List of instances to strip media attachments from",
1403 suggestions: ["example.com", "*.example.com"]
1407 label: "Media NSFW",
1408 type: {:list, :string},
1409 description: "List of instances to tag all media as NSFW (sensitive) from",
1410 suggestions: ["example.com", "*.example.com"]
1413 key: :federated_timeline_removal,
1414 type: {:list, :string},
1416 "List of instances to remove from Federated (aka The Whole Known Network) Timeline",
1417 suggestions: ["example.com", "*.example.com"]
1421 type: {:list, :string},
1422 description: "List of instances to reject activities from (except deletes)",
1423 suggestions: ["example.com", "*.example.com"]
1427 type: {:list, :string},
1428 description: "List of instances to only accept activities from (except deletes)",
1429 suggestions: ["example.com", "*.example.com"]
1432 key: :report_removal,
1433 type: {:list, :string},
1434 description: "List of instances to reject reports from",
1435 suggestions: ["example.com", "*.example.com"]
1438 key: :avatar_removal,
1439 type: {:list, :string},
1440 description: "List of instances to strip avatars from",
1441 suggestions: ["example.com", "*.example.com"]
1444 key: :banner_removal,
1445 type: {:list, :string},
1446 description: "List of instances to strip banners from",
1447 suggestions: ["example.com", "*.example.com"]
1450 key: :reject_deletes,
1451 type: {:list, :string},
1452 description: "List of instances to reject deletions from",
1453 suggestions: ["example.com", "*.example.com"]
1460 label: "MRF subchain",
1463 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1464 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1469 description: "Matches a series of regular expressions against the actor field",
1472 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1480 key: :mrf_rejectnonpublic,
1482 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1483 label: "MRF reject non public",
1487 key: :allow_followersonly,
1488 label: "Allow followers-only",
1490 description: "Whether to allow followers-only posts"
1495 description: "Whether to allow direct messages"
1501 key: :mrf_hellthread,
1502 label: "MRF hellthread",
1504 description: "Block messages with too much mentions",
1507 key: :delist_threshold,
1510 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1511 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1515 key: :reject_threshold,
1518 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1526 label: "MRF keyword",
1528 description: "Reject or Word-Replace messages with a keyword or regex",
1532 type: [:string, :regex],
1534 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1535 suggestions: ["foo", ~r/foo/iu]
1538 key: :federated_timeline_removal,
1539 type: [:string, :regex],
1541 "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.",
1542 suggestions: ["foo", ~r/foo/iu]
1546 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1548 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1549 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1556 label: "MRF mention",
1558 description: "Block messages which mention a user",
1562 type: {:list, :string},
1563 description: "A list of actors for which any post mentioning them will be dropped.",
1564 suggestions: ["actor1", "actor2"]
1570 key: :mrf_vocabulary,
1571 label: "MRF vocabulary",
1573 description: "Filter messages which belong to certain activity vocabularies",
1577 type: {:list, :string},
1579 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1580 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1584 type: {:list, :string},
1586 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1587 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1593 # key: :mrf_user_allowlist,
1596 # "The keys in this section are the domain names that the policy should apply to." <>
1597 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1599 # ["example.org": ["https://example.org/users/admin"]],
1601 # ["example.org": ["https://example.org/users/admin"]]
1609 description: "Media proxy",
1614 description: "Enables proxying of remote media to the instance's proxy"
1620 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1621 suggestions: ["https://example.com"]
1626 description: "Options for Pleroma.ReverseProxy",
1628 redirect_on_failure: false,
1629 max_body_length: 25 * 1_048_576,
1631 follow_redirect: true,
1637 key: :redirect_on_failure,
1640 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1641 "Any error during body processing will not be redirected as the response is chunked."
1644 key: :max_body_length,
1647 "Limits the content length to be approximately the " <>
1648 "specified length. It is validated with the `content-length` header and also verified when proxying."
1653 description: "HTTP options",
1658 description: "Adapter specific options",
1663 label: "SSL Options",
1664 description: "SSL options for HTTP adapter",
1668 type: {:list, :atom},
1669 description: "List of TLS version to use",
1670 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1679 type: [:string, :tuple],
1680 description: "Proxy URL",
1681 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1689 type: {:list, :string},
1690 description: "List of domains to bypass the mediaproxy",
1691 suggestions: ["example.com"]
1699 description: "Gopher settings",
1704 description: "Enables the gopher interface"
1709 description: "IP address to bind to",
1710 suggestions: [{0, 0, 0, 0}]
1715 description: "Port to bind to",
1721 description: "Port advertised in urls (optional, defaults to port)",
1730 description: "ActivityPub-related settings",
1733 key: :unfollow_blocked,
1735 description: "Whether blocks result in people getting unfollowed"
1738 key: :outgoing_blocks,
1740 description: "Whether to federate blocks to other instances"
1743 key: :sign_object_fetches,
1745 description: "Sign object fetches with HTTP signatures"
1748 key: :note_replies_output_limit,
1751 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1754 key: :follow_handshake_timeout,
1756 description: "Following handshake timeout",
1763 key: :http_security,
1765 description: "HTTP security settings",
1770 description: "Whether the managed content security policy is enabled"
1776 description: "Whether to additionally send a Strict-Transport-Security header"
1780 label: "STS max age",
1782 description: "The maximum age for the Strict-Transport-Security header if sent",
1783 suggestions: [31_536_000]
1787 label: "CT max age",
1789 description: "The maximum age for the Expect-CT header if sent",
1790 suggestions: [2_592_000]
1793 key: :referrer_policy,
1795 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1796 suggestions: ["same-origin", "no-referrer"]
1800 label: "Report URI",
1802 description: "Adds the specified url to report-uri and report-to group in CSP header",
1803 suggestions: ["https://example.com/report-uri"]
1808 group: :web_push_encryption,
1809 key: :vapid_details,
1812 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1818 "A mailto link for the administrative contact." <>
1819 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1820 suggestions: ["mailto:moderators@pleroma.com"]
1825 description: "VAPID public key",
1826 suggestions: ["Public key"]
1831 description: "VAPID private key",
1832 suggestions: ["Private key"]
1838 key: Pleroma.Captcha,
1840 description: "Captcha-related settings",
1845 description: "Whether the captcha should be shown on registration"
1850 description: "The method/service to use for captcha",
1851 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1854 key: :seconds_valid,
1856 description: "The time in seconds for which the captcha is valid",
1863 key: Pleroma.Captcha.Kocaptcha,
1866 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1867 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1872 description: "The kocaptcha endpoint to use",
1873 suggestions: ["https://captcha.kotobank.ch"]
1881 "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",
1886 description: "Token",
1887 suggestions: ["We recommend a secure random string or UUID"]
1896 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1898 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1899 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1900 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1901 (see https://github.com/sorentwo/oban/issues/52).
1907 description: "Application's Ecto repo",
1908 suggestions: [Pleroma.Repo]
1912 type: {:dropdown, :atom},
1913 description: "Logs verbose mode",
1914 suggestions: [false, :error, :warn, :info, :debug]
1918 type: [:atom, :tuple],
1920 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1921 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1925 type: {:keyword, :integer},
1927 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1929 activity_expiration: 10,
1930 attachments_cleanup: 5,
1932 federator_incoming: 50,
1933 federator_outgoing: 50,
1935 scheduled_activities: 10,
1941 key: :activity_expiration,
1943 description: "Activity expiration queue",
1947 key: :attachments_cleanup,
1949 description: "Attachment deletion queue",
1955 description: "Background queue",
1959 key: :federator_incoming,
1961 description: "Incoming federation queue",
1965 key: :federator_outgoing,
1967 description: "Outgoing federation queue",
1973 description: "Email sender queue, see Pleroma.Emails.Mailer",
1977 key: :scheduled_activities,
1979 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1983 key: :transmogrifier,
1985 description: "Transmogrifier queue",
1991 description: "Web push notifications queue",
1998 type: {:list, :tuple},
1999 description: "Settings for cron background jobs",
2001 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2002 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2003 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2004 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2005 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2014 description: "Includes custom worker options not interpretable directly by `Oban`",
2018 type: {:keyword, :integer},
2019 description: "Max retry attempts for failed jobs, per `Oban` queue",
2021 federator_incoming: 5,
2022 federator_outgoing: 5
2029 key: Pleroma.Web.Metadata,
2031 description: "Metadata-related settings",
2035 type: {:list, :module},
2036 description: "List of metadata providers to enable",
2038 Pleroma.Web.Metadata.Providers.OpenGraph,
2039 Pleroma.Web.Metadata.Providers.TwitterCard,
2040 Pleroma.Web.Metadata.Providers.RelMe,
2041 Pleroma.Web.Metadata.Providers.Feed
2046 label: "Unfurl NSFW",
2048 description: "When enabled NSFW attachments will be shown in previews"
2057 "If enabled the instance will parse metadata from attached links to generate link previews.",
2062 description: "Enables RichMedia parsing of URLs."
2066 type: {:list, :string},
2067 description: "List of hosts which will be ignored by the metadata parser.",
2068 suggestions: ["accounts.google.com", "xss.website"]
2072 label: "Ignore TLD",
2073 type: {:list, :string},
2074 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
2075 suggestions: ["local", "localdomain", "lan"]
2079 type: {:list, :module},
2081 "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.",
2083 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
2084 Pleroma.Web.RichMedia.Parsers.OEmbed,
2085 Pleroma.Web.RichMedia.Parsers.OGP,
2086 Pleroma.Web.RichMedia.Parsers.TwitterCard
2091 label: "TTL setters",
2092 type: {:list, :module},
2094 "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.",
2096 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2102 group: :auto_linker,
2105 description: "Configuration for the auto_linker library",
2109 type: [:string, false],
2110 description: "Specify the class to be added to the generated link. Disable to clear",
2111 suggestions: ["auto-linker", false]
2115 type: [:string, false],
2116 description: "Override the rel attribute. Disable to clear",
2117 suggestions: ["ugc", "noopener noreferrer", false]
2122 description: "Link urls will open in new window/tab"
2126 type: [:integer, false],
2128 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2129 suggestions: [15, false]
2134 description: "Strip the scheme prefix"
2139 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2145 key: Pleroma.ScheduledActivity,
2147 description: "Scheduled activities settings",
2150 key: :daily_user_limit,
2153 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2157 key: :total_user_limit,
2160 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2166 description: "Whether scheduled activities are sent to the job queue to be executed"
2172 key: Pleroma.ActivityExpiration,
2174 description: "Expired activity settings",
2179 description: "Whether expired activities will be sent to the job queue to be deleted"
2186 description: "Authenticator",
2189 key: Pleroma.Web.Auth.Authenticator,
2191 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2200 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2201 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2202 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2203 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2208 description: "Enables LDAP authentication"
2213 description: "LDAP server hostname",
2214 suggestions: ["localhosts"]
2219 description: "LDAP port, e.g. 389 or 636",
2220 suggestions: [389, 636]
2226 description: "Enable to use SSL, usually implies the port 636"
2230 label: "SSL options",
2232 description: "Additional SSL options",
2233 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2238 description: "Path to file with PEM encoded cacerts",
2239 suggestions: ["path/to/file/with/PEM/cacerts"]
2244 description: "Type of cert verification",
2245 suggestions: [:verify_peer]
2253 description: "Enable to use STARTTLS, usually implies the port 389"
2257 label: "TLS options",
2259 description: "Additional TLS options",
2260 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2265 description: "Path to file with PEM encoded cacerts",
2266 suggestions: ["path/to/file/with/PEM/cacerts"]
2271 description: "Type of cert verification",
2272 suggestions: [:verify_peer]
2279 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2280 suggestions: ["dc=example,dc=com"]
2286 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2295 description: "Authentication / authorization settings",
2298 key: :enforce_oauth_admin_scope_usage,
2301 "OAuth admin scope requirement toggle. " <>
2302 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2303 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2304 "`is_admin` user flag grants access to admin-specific actions."
2307 key: :auth_template,
2310 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2311 suggestions: ["show.html"]
2314 key: :oauth_consumer_template,
2317 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2318 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2319 suggestions: ["consumer.html"]
2322 key: :oauth_consumer_strategies,
2323 type: {:list, :string},
2325 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2326 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2327 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2328 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2334 key: :email_notifications,
2336 description: "Email notifications settings",
2342 "emails of \"what you've missed\" for users who have been inactive for a while",
2346 schedule: "0 0 * * 0",
2348 inactivity_threshold: 7
2356 description: "Globally enable or disable digest emails"
2362 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2363 suggestions: ["0 0 * * 0"]
2368 description: "Minimum interval between digest emails to one user",
2372 key: :inactivity_threshold,
2374 description: "Minimum user inactivity threshold",
2383 key: Pleroma.Emails.UserEmail,
2385 description: "Email template settings",
2390 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2391 suggestions: ["some/path/logo.png"]
2396 description: "a map with color settings for email templates.",
2399 link_color: "#d8a070",
2400 background_color: "#2C3645",
2401 content_background_color: "#1B2635",
2402 header_color: "#d8a070",
2403 text_color: "#b9b9ba",
2404 text_muted_color: "#b9b9ba"
2411 suggestions: ["#d8a070"]
2414 key: :background_color,
2416 suggestions: ["#2C3645"]
2419 key: :content_background_color,
2421 suggestions: ["#1B2635"]
2426 suggestions: ["#d8a070"]
2431 suggestions: ["#b9b9ba"]
2434 key: :text_muted_color,
2436 suggestions: ["#b9b9ba"]
2444 key: Pleroma.Emails.NewUsersDigestEmail,
2446 description: "New users admin email digest",
2451 description: "enables new users admin digest email when `true`",
2452 suggestions: [false]
2460 description: "Configure OAuth 2 provider capabilities",
2463 key: :token_expires_in,
2465 description: "The lifetime in seconds of the access token",
2469 key: :issue_new_refresh_token,
2472 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2475 key: :clean_expired_tokens,
2477 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2487 key: :shortcode_globs,
2488 type: {:list, :string},
2489 description: "Location of custom emoji files. * can be used as a wildcard.",
2490 suggestions: ["/emoji/custom/**/*.png"]
2493 key: :pack_extensions,
2494 type: {:list, :string},
2496 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2497 suggestions: [".png", ".gif"]
2501 type: {:keyword, :string, {:list, :string}},
2503 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2504 " and the value is the location or array of locations. * can be used as a wildcard.",
2506 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2510 key: :default_manifest,
2513 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2514 " Currently only one manifest can be added (no arrays).",
2515 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2518 key: :shared_pack_cache_seconds_per_file,
2519 label: "Shared pack cache s/file",
2522 "When an emoji pack is shared, the archive is created and cached in memory" <>
2523 " for this amount of seconds multiplied by the number of files.",
2533 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2537 type: [:tuple, {:list, :tuple}],
2538 description: "For the search requests (account & status search etc.)",
2539 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2543 type: [:tuple, {:list, :tuple}],
2544 description: "For requests to timelines (each timeline has it's own limiter)",
2545 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2548 key: :app_account_creation,
2549 type: [:tuple, {:list, :tuple}],
2550 description: "For registering user accounts from the same IP address",
2551 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2554 key: :relations_actions,
2555 type: [:tuple, {:list, :tuple}],
2556 description: "For actions on relationships with all users (follow, unfollow)",
2557 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2560 key: :relation_id_action,
2561 type: [:tuple, {:list, :tuple}],
2562 description: "For actions on relation with a specific user (follow, unfollow)",
2563 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2566 key: :statuses_actions,
2567 type: [:tuple, {:list, :tuple}],
2569 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2570 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2573 key: :status_id_action,
2574 type: [:tuple, {:list, :tuple}],
2576 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2577 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2580 key: :authentication,
2581 type: [:tuple, {:list, :tuple}],
2582 description: "For authentication create / password check / user existence check requests",
2583 suggestions: [{60_000, 15}]
2591 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2592 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2597 description: "Enables SSH"
2602 description: "Dir with SSH keys",
2603 suggestions: ["/some/path/ssh_keys"]
2608 description: "Handler module",
2609 suggestions: ["Pleroma.BBS.Handler"]
2614 description: "Port to connect",
2615 suggestions: [10_022]
2618 key: :password_authenticator,
2620 description: "Authenticator module",
2621 suggestions: ["Pleroma.BBS.Authenticator"]
2628 description: "Mime types",
2635 "application/xml" => ["xml"],
2636 "application/xrd+xml" => ["xrd+xml"],
2637 "application/jrd+json" => ["jrd+json"],
2638 "application/activity+json" => ["activity+json"],
2639 "application/ld+json" => ["activity+json"]
2644 key: "application/xml",
2645 type: {:list, :string},
2646 suggestions: ["xml"]
2649 key: "application/xrd+xml",
2650 type: {:list, :string},
2651 suggestions: ["xrd+xml"]
2654 key: "application/jrd+json",
2655 type: {:list, :string},
2656 suggestions: ["jrd+json"]
2659 key: "application/activity+json",
2660 type: {:list, :string},
2661 suggestions: ["activity+json"]
2664 key: "application/ld+json",
2665 type: {:list, :string},
2666 suggestions: ["activity+json"]
2676 description: "Pleroma chat settings",
2685 group: :http_signatures,
2687 description: "HTTP Signatures settings",
2692 suggestions: [Pleroma.Signature]
2700 description: "HTTP settings",
2705 type: [:string, :tuple],
2706 description: "Proxy URL",
2707 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2710 key: :send_user_agent,
2715 type: [:string, :atom],
2717 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2718 suggestions: ["Pleroma", :default]
2723 description: "Adapter specific options",
2729 label: "SSL Options",
2730 description: "SSL options for HTTP adapter",
2734 type: {:list, :atom},
2735 description: "List of TLS version to use",
2736 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2750 key: :allow_inline_images,
2754 key: :allow_headings,
2767 type: {:list, :module},
2769 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2770 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2780 key: :deny_follow_blocked,
2787 key: :mrf_normalize_markup,
2788 label: "MRF normalize markup",
2789 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2795 suggestions: [Pleroma.HTML.Scrubber.Default]
2805 key: :restricted_nicknames,
2806 type: {:list, :string},
2825 "ostatus_subscribe",
2849 suggestions: [86_400]
2853 type: {:list, :string},
2854 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2858 type: {:list, :string},
2861 "X-RateLimit-Reset",
2862 "X-RateLimit-Limit",
2863 "X-RateLimit-Remaining",
2874 type: {:list, :string},
2875 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2881 key: Pleroma.Plugs.RemoteIp,
2884 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2885 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2891 description: "Enable/disable the plug. Default: disabled."
2895 type: {:list, :string},
2897 "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]`."
2901 type: {:list, :string},
2903 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2907 type: {:list, :string},
2909 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2915 key: :web_cache_ttl,
2918 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2924 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2925 suggestions: [30_000, nil]
2928 key: :activity_pub_question,
2930 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2931 suggestions: [30_000]
2940 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2945 description: "Enables the rendering of static HTML. Default: disabled."
2953 description: "Configure feed rendering",
2958 description: "Configure title rendering.",
2963 description: "Maximum number of characters before truncating title.",
2969 description: "Replacement which will be used after truncating string.",
2970 suggestions: ["..."]
2978 key: :mrf_object_age,
2980 description: "Rejects or delists posts based on their age when received.",
2985 description: "Required age (in seconds) of a post before actions are taken.",
2986 suggestions: [172_800]
2990 type: {:list, :atom},
2992 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2993 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2994 "`:reject` rejects the message entirely",
2995 suggestions: [:delist, :strip_followers, :reject]
3003 description: "Custom Runtime Modules",
3008 description: "A path to custom Elixir modules (such as MRF policies)."
3016 description: "Settings for notifications streamer",
3021 description: "Number of workers to send notifications.",
3025 key: :overflow_workers,
3027 description: "Maximum number of workers created if pool is empty.",
3034 key: :connections_pool,
3036 description: "Advanced settings for `gun` connections pool",
3039 key: :checkin_timeout,
3041 description: "Timeout to checkin connection from pool. Default: 250ms.",
3045 key: :max_connections,
3047 description: "Maximum number of connections in the pool. Default: 250 connections.",
3054 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3058 key: :retry_timeout,
3061 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3065 key: :await_up_timeout,
3067 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3076 description: "Advanced settings for `gun` workers pools",
3081 description: "Settings for federation pool.",
3086 description: "Number workers in the pool.",
3092 description: "Number of additional workers if pool is under load.",
3098 description: "Timeout while `gun` will wait for response.",
3099 suggestions: [150_000]
3106 description: "Settings for media pool.",
3111 description: "Number workers in the pool.",
3117 description: "Number of additional workers if pool is under load.",
3123 description: "Timeout while `gun` will wait for response.",
3124 suggestions: [150_000]
3131 description: "Settings for upload pool.",
3136 description: "Number workers in the pool.",
3142 description: "Number of additional workers if pool is under load.",
3148 description: "Timeout while `gun` will wait for response.",
3149 suggestions: [300_000]
3156 description: "Settings for default pool.",
3161 description: "Number workers in the pool.",
3167 description: "Number of additional workers if pool is under load.",
3173 description: "Timeout while `gun` will wait for response.",
3174 suggestions: [10_000]
3182 key: :hackney_pools,
3184 description: "Advanced settings for `hackney` connections pools",
3189 description: "Settings for federation pool.",
3192 key: :max_connections,
3194 description: "Number workers in the pool.",
3200 description: "Timeout while `hackney` will wait for response.",
3201 suggestions: [150_000]
3208 description: "Settings for media pool.",
3211 key: :max_connections,
3213 description: "Number workers in the pool.",
3219 description: "Timeout while `hackney` will wait for response.",
3220 suggestions: [150_000]
3227 description: "Settings for upload pool.",
3230 key: :max_connections,
3232 description: "Number workers in the pool.",
3238 description: "Timeout while `hackney` will wait for response.",
3239 suggestions: [300_000]
3247 key: :restrict_unauthenticated,
3250 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3255 description: "Settings for public and federated timelines.",
3260 description: "Disallow view public timeline."
3265 description: "Disallow view federated timeline."
3272 description: "Settings for user profiles.",
3277 description: "Disallow view local user profiles."
3282 description: "Disallow view remote user profiles."
3289 description: "Settings for statuses.",
3294 description: "Disallow view local statuses."
3299 description: "Disallow view remote statuses."
3307 key: Pleroma.Web.ApiSpec.CastAndValidate,
3314 "Enables strict input validation (useful in development, not recommended in production)",
3315 suggestions: [false]