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`."
49 description: "Base URL for the uploads, needed if you use CDN",
51 "https://cdn-host.com"
58 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
62 label: "Proxy Options",
64 description: "Options for Pleroma.ReverseProxy",
66 redirect_on_failure: false,
67 max_body_length: 25 * 1_048_576,
69 follow_redirect: true,
75 key: :redirect_on_failure,
78 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
79 "Any error during body processing will not be redirected as the response is chunked."
82 key: :max_body_length,
85 "Limits the content length to be approximately the " <>
86 "specified length. It is validated with the `content-length` header and also verified when proxying."
92 description: "HTTP options",
97 description: "Adapter specific options",
102 label: "SSL Options",
103 description: "SSL options for HTTP adapter",
107 type: {:list, :atom},
108 description: "List of TLS versions to use",
109 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
118 type: [:string, :tuple],
119 description: "Proxy URL",
120 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
127 key: :filename_display_max_length,
129 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
135 key: Pleroma.Uploaders.Local,
137 description: "Local uploader-related settings",
142 description: "Path where user's uploads will be saved",
151 key: Pleroma.Uploaders.S3,
153 description: "S3 uploader-related settings",
158 description: "S3 bucket",
164 key: :bucket_namespace,
166 description: "S3 bucket namespace",
167 suggestions: ["pleroma"]
170 key: :public_endpoint,
172 description: "S3 endpoint",
173 suggestions: ["https://s3.amazonaws.com"]
176 key: :truncated_namespace,
179 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
180 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
183 key: :streaming_enabled,
186 "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."
192 key: Pleroma.Upload.Filter.Mogrify,
194 description: "Uploads mogrify filter settings",
198 type: [:string, {:list, :string}, {:list, :tuple}],
200 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
201 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
212 key: Pleroma.Upload.Filter.AnonymizeFilename,
214 description: "Filter replaces the filename of the upload",
220 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
221 " filename extension by using {extension}, for example custom-file-name.{extension}.",
223 "custom-file-name.{extension}"
230 key: Pleroma.Emails.Mailer,
232 description: "Mailer-related settings",
238 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
239 " or Swoosh.Adapters.Local for in-memory mailbox",
241 Swoosh.Adapters.SMTP,
242 Swoosh.Adapters.Sendgrid,
243 Swoosh.Adapters.Sendmail,
244 Swoosh.Adapters.Mandrill,
245 Swoosh.Adapters.Mailgun,
246 Swoosh.Adapters.Mailjet,
247 Swoosh.Adapters.Postmark,
248 Swoosh.Adapters.SparkPost,
249 Swoosh.Adapters.AmazonSES,
251 Swoosh.Adapters.SocketLabs,
252 Swoosh.Adapters.Gmail,
253 Swoosh.Adapters.Local
259 description: "Allow/disallow send emails"
262 group: {:subgroup, Swoosh.Adapters.SMTP},
265 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
266 suggestions: ["smtp.gmail.com"]
269 group: {:subgroup, Swoosh.Adapters.SMTP},
272 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
273 suggestions: ["pleroma"]
276 group: {:subgroup, Swoosh.Adapters.SMTP},
279 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
280 suggestions: ["password"]
283 group: {:subgroup, Swoosh.Adapters.SMTP},
287 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
290 group: {:subgroup, Swoosh.Adapters.SMTP},
294 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
295 suggestions: [:always, :never, :if_available]
298 group: {:subgroup, Swoosh.Adapters.SMTP},
301 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
302 suggestions: [:always, :never, :if_available]
305 group: {:subgroup, Swoosh.Adapters.SMTP},
308 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
312 group: {:subgroup, Swoosh.Adapters.SMTP},
315 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
319 group: {:subgroup, Swoosh.Adapters.SMTP},
321 label: "No MX lookups",
323 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
326 group: {:subgroup, Swoosh.Adapters.Sendgrid},
330 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
331 suggestions: ["my-api-key"]
334 group: {:subgroup, Swoosh.Adapters.Sendmail},
337 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
338 suggestions: ["/usr/bin/sendmail"]
341 group: {:subgroup, Swoosh.Adapters.Sendmail},
344 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
345 suggestions: ["-N delay,failure,success"]
348 group: {:subgroup, Swoosh.Adapters.Sendmail},
351 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
354 group: {:subgroup, Swoosh.Adapters.Mandrill},
358 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
359 suggestions: ["my-api-key"]
362 group: {:subgroup, Swoosh.Adapters.Mailgun},
366 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
367 suggestions: ["my-api-key"]
370 group: {:subgroup, Swoosh.Adapters.Mailgun},
373 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
374 suggestions: ["pleroma.com"]
377 group: {:subgroup, Swoosh.Adapters.Mailjet},
381 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
382 suggestions: ["my-api-key"]
385 group: {:subgroup, Swoosh.Adapters.Mailjet},
388 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
389 suggestions: ["my-secret-key"]
392 group: {:subgroup, Swoosh.Adapters.Postmark},
396 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
397 suggestions: ["my-api-key"]
400 group: {:subgroup, Swoosh.Adapters.SparkPost},
404 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
405 suggestions: ["my-api-key"]
408 group: {:subgroup, Swoosh.Adapters.SparkPost},
411 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
412 suggestions: ["https://api.sparkpost.com/api/v1"]
415 group: {:subgroup, Swoosh.Adapters.AmazonSES},
418 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
419 suggestions: ["us-east-1", "us-east-2"]
422 group: {:subgroup, Swoosh.Adapters.AmazonSES},
425 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
426 suggestions: ["aws-access-key"]
429 group: {:subgroup, Swoosh.Adapters.AmazonSES},
432 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
433 suggestions: ["aws-secret-key"]
436 group: {:subgroup, Swoosh.Adapters.Dyn},
440 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
441 suggestions: ["my-api-key"]
444 group: {:subgroup, Swoosh.Adapters.SocketLabs},
447 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
450 group: {:subgroup, Swoosh.Adapters.SocketLabs},
454 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
457 group: {:subgroup, Swoosh.Adapters.Gmail},
460 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
467 description: "`Swoosh.Adapters.Local` adapter specific settings",
470 group: {:subgroup, Swoosh.Adapters.Local},
473 description: "Run the preview server together as part of your app"
476 group: {:subgroup, Swoosh.Adapters.Local},
479 description: "The preview server port",
487 label: "URI Schemes",
489 description: "URI schemes related settings",
493 type: {:list, :string},
494 description: "List of the scheme part that is considered valid to be an URL",
519 description: "Instance-related settings",
524 description: "Name of the instance",
531 label: "Admin Email Address",
533 description: "Email used to reach an Administrator/Moderator of the instance",
540 label: "Sender Email Address",
542 description: "Envelope FROM address for mail sent via Pleroma",
551 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
559 description: "Posts character limit (CW/Subject included in the counter)",
567 description: "Character limit of the instance chat messages",
575 description: "Hard character limit beyond which remote posts will be dropped",
583 description: "File size limit of uploads (except for avatar, background, banner)",
589 key: :avatar_upload_limit,
591 description: "File size limit of user's profile avatars",
597 key: :background_upload_limit,
599 description: "File size limit of user's profile backgrounds",
605 key: :banner_upload_limit,
607 description: "File size limit of user's profile banners",
615 description: "A map with poll limits for local polls",
619 max_option_chars: 200,
621 max_expiration: 31_536_000
628 description: "Maximum number of options",
632 key: :max_option_chars,
634 description: "Maximum number of characters per option",
638 key: :min_expiration,
640 description: "Minimum expiration time (in seconds)",
644 key: :max_expiration,
646 description: "Maximum expiration time (in seconds)",
652 key: :registrations_open,
655 "Enable registrations for anyone. Invitations require this setting to be disabled."
658 key: :invites_enabled,
661 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
664 key: :account_activation_required,
666 description: "Require users to confirm their emails before signing in"
671 description: "Enable federation with other instances"
674 key: :federation_incoming_replies_max_depth,
675 label: "Fed. incoming replies max depth",
678 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
679 " 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.",
685 key: :federation_reachability_timeout_days,
686 label: "Fed. reachability timeout days",
689 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
697 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
703 "Makes the client API in authenticated mode-only except for user-profiles." <>
704 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
705 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
708 key: :quarantined_instances,
709 type: {:list, :string},
711 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
718 key: :managed_config,
721 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
726 description: "Instance static directory",
732 key: :allowed_post_formats,
733 type: {:list, :string},
734 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
743 key: :extended_nickname_format,
746 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
747 " This will break federation with older software for theses nicknames."
750 key: :cleanup_attachments,
753 Enable to remove associated attachments when status is removed.
754 This will not affect duplicates and attachments without status.
755 Enabling this will increase load to database when deleting statuses on larger instances.
759 key: :max_pinned_statuses,
761 description: "The maximum number of pinned statuses. 0 will disable the feature.",
769 key: :autofollowed_nicknames,
770 type: {:list, :string},
772 "Set to nicknames of (local) users that every new user should automatically follow",
781 key: :attachment_links,
783 description: "Enable to automatically add attachment link text to statuses"
786 key: :welcome_message,
789 "A message that will be sent to a newly registered users as a direct message",
791 "Hi, @username! Welcome on board!"
795 key: :welcome_user_nickname,
797 description: "The nickname of the local user that sends the welcome message",
803 key: :max_report_comment_size,
805 description: "The maximum size of the report comment. Default: 1000.",
811 key: :safe_dm_mentions,
812 label: "Safe DM mentions",
815 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
816 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
822 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
825 key: :remote_post_retention_days,
828 "The default amount of days to retain remote posts when pruning the database",
834 key: :user_bio_length,
836 description: "A user bio maximum length. Default: 5000.",
842 key: :user_name_length,
844 description: "A user name maximum length. Default: 100.",
850 key: :skip_thread_containment,
852 description: "Skip filtering out broken threads. Default: enabled."
855 key: :limit_to_local_content,
856 type: {:dropdown, :atom},
858 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
866 key: :max_account_fields,
868 description: "The maximum number of custom fields in the user profile. Default: 10.",
874 key: :max_remote_account_fields,
877 "The maximum number of custom fields in the remote user profile. Default: 20.",
883 key: :account_field_name_length,
885 description: "An account field name maximum length. Default: 512.",
891 key: :account_field_value_length,
893 description: "An account field value maximum length. Default: 2048.",
899 key: :external_user_synchronization,
901 description: "Enabling following/followers counters synchronization for external users"
904 key: :multi_factor_authentication,
906 description: "Multi-factor authentication settings",
909 totp: [digits: 6, period: 30],
910 backup_codes: [number: 5, length: 16]
916 label: "TOTP settings",
918 description: "TOTP settings",
919 suggestions: [digits: 6, period: 30],
926 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
933 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
940 description: "MFA backup codes settings",
941 suggestions: [number: 5, length: 16],
947 description: "Number of backup codes to generate."
954 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
961 key: :instance_thumbnail,
964 "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.",
965 suggestions: ["/instance/thumbnail.jpeg"]
972 description: "Logger-related settings",
976 type: [:atom, :tuple, :module],
978 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
979 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
987 label: "ExSyslogger",
988 description: "ExSyslogger-related settings",
992 type: {:dropdown, :atom},
993 description: "Log level",
994 suggestions: [:debug, :info, :warn, :error]
1000 "A string that's prepended to every message, and is typically set to the app name",
1001 suggestions: ["pleroma"]
1006 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1007 suggestions: ["$metadata[$level] $message"]
1011 type: {:list, :atom},
1012 suggestions: [:request_id]
1020 label: "Console Logger",
1021 description: "Console logger settings",
1025 type: {:dropdown, :atom},
1026 description: "Log level",
1027 suggestions: [:debug, :info, :warn, :error]
1032 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1033 suggestions: ["$metadata[$level] $message"]
1037 type: {:list, :atom},
1038 suggestions: [:request_id]
1045 label: "Quack Logger",
1046 description: "Quack-related settings",
1050 type: {:dropdown, :atom},
1051 description: "Log level",
1052 suggestions: [:debug, :info, :warn, :error]
1056 type: {:list, :atom},
1057 description: "Configure which metadata you want to report on",
1075 description: "Configure the Slack incoming webhook",
1076 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1082 key: :frontend_configurations,
1085 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1086 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1087 "add your own configuration your settings all fields must be complete.",
1091 label: "Pleroma FE",
1093 description: "Settings for Pleroma FE",
1096 alwaysShowSubjectInput: true,
1097 background: "/static/aurora_borealis.jpg",
1098 collapseMessageWithSubject: false,
1101 hideFilteredStatuses: false,
1102 hideMutedPosts: false,
1103 hidePostStats: false,
1104 hideSitename: false,
1105 hideUserStats: false,
1106 loginMethod: "password",
1107 logo: "/static/logo.png",
1110 minimalScopesMode: false,
1111 noAttachmentLinks: false,
1112 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1113 postContentType: "text/plain",
1114 redirectRootLogin: "/main/friends",
1115 redirectRootNoLogin: "/main/all",
1117 sidebarRight: false,
1118 showFeaturesPanel: true,
1119 showInstanceSpecificPanel: false,
1120 subjectLineBehavior: "email",
1121 theme: "pleroma-dark",
1122 webPushNotifications: false
1127 key: :alwaysShowSubjectInput,
1128 label: "Always show subject input",
1130 description: "When disabled, auto-hide the subject field if it's empty"
1136 "URL of the background, unless viewing a user profile with a background that is set",
1137 suggestions: ["/images/city.jpg"]
1140 key: :collapseMessageWithSubject,
1141 label: "Collapse message with subject",
1144 "When a message has a subject (aka Content Warning), collapse it by default"
1148 label: "PleromaFE Chat",
1150 description: "Disables PleromaFE Chat component"
1156 description: "Enables green text on lines prefixed with the > character"
1159 key: :hideFilteredStatuses,
1160 label: "Hide Filtered Statuses",
1162 description: "Hides filtered statuses from timelines"
1165 key: :hideMutedPosts,
1166 label: "Hide Muted Posts",
1168 description: "Hides muted statuses from timelines"
1171 key: :hidePostStats,
1172 label: "Hide post stats",
1174 description: "Hide notices statistics (repeats, favorites, ...)"
1178 label: "Hide Sitename",
1180 description: "Hides instance name from PleromaFE banner"
1183 key: :hideUserStats,
1184 label: "Hide user stats",
1187 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1192 description: "URL of the logo, defaults to Pleroma's logo",
1193 suggestions: ["/static/logo.png"]
1197 label: "Logo margin",
1200 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1201 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1202 suggestions: [".1em"]
1209 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1210 "If you want a colorful logo you must disable logoMask."
1213 key: :minimalScopesMode,
1214 label: "Minimal scopes mode",
1217 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1218 "Also prevents replying to a DM with a public post from PleromaFE."
1221 key: :nsfwCensorImage,
1222 label: "NSFW Censor Image",
1225 "URL of the image to use for hiding NSFW media attachments in the timeline",
1226 suggestions: ["/static/img/nsfw.74818f9.png"]
1229 key: :postContentType,
1230 label: "Post Content Type",
1231 type: {:dropdown, :atom},
1232 description: "Default post formatting option",
1233 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1236 key: :redirectRootNoLogin,
1237 label: "Redirect root no login",
1240 "Relative URL which indicates where to redirect when a user isn't logged in",
1241 suggestions: ["/main/all"]
1244 key: :redirectRootLogin,
1245 label: "Redirect root login",
1248 "Relative URL which indicates where to redirect when a user is logged in",
1249 suggestions: ["/main/friends"]
1253 label: "Scope copy",
1255 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1259 label: "Sidebar on Right",
1261 description: "Change alignment of sidebar and panels to the right"
1264 key: :showFeaturesPanel,
1265 label: "Show instance features panel",
1268 "Enables panel displaying functionality of the instance on the About page"
1271 key: :showInstanceSpecificPanel,
1272 label: "Show instance specific panel",
1274 description: "Whether to show the instance's custom panel"
1277 key: :subjectLineBehavior,
1278 label: "Subject line behavior",
1280 description: "Allows changing the default behaviour of subject lines in replies.
1281 `email`: copy and preprend re:, as in email,
1282 `masto`: copy verbatim, as in Mastodon,
1283 `noop`: don't copy the subject.",
1284 suggestions: ["email", "masto", "noop"]
1289 description: "Which theme to use. Available themes are defined in styles.json",
1290 suggestions: ["pleroma-dark"]
1298 description: "Settings for Masto FE",
1301 showInstanceSpecificPanel: true
1306 key: :showInstanceSpecificPanel,
1307 label: "Show instance specific panel",
1309 description: "Whenether to show the instance's specific panel"
1320 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1324 type: {:keyword, :map},
1326 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1329 url: "/images/pleroma-fox-tan-smol.png",
1330 mime_type: "image/png"
1332 pleroma_fox_tan_shy: %{
1333 url: "/images/pleroma-fox-tan-shy.png",
1334 mime_type: "image/png"
1339 key: :default_mascot,
1342 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1348 key: :default_user_avatar,
1350 description: "URL of the default user avatar",
1351 suggestions: ["/images/avi.png"]
1360 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1364 type: {:list, :map},
1365 description: "Describe the icons of the app",
1368 src: "/static/logo.png"
1371 src: "/static/icon.png",
1375 src: "/static/icon.ico",
1376 sizes: "72x72 96x96 128x128 256x256"
1383 description: "Describe the theme color of the app",
1384 suggestions: ["#282c37", "mediumpurple"]
1387 key: :background_color,
1389 description: "Describe the background color of the app",
1390 suggestions: ["#191b22", "aliceblue"]
1400 description: "General MRF settings",
1404 type: [:module, {:list, :module}],
1406 "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.",
1408 Generator.list_modules_in_dir(
1409 "lib/pleroma/web/activity_pub/mrf",
1410 "Elixir.Pleroma.Web.ActivityPub.MRF."
1415 label: "MRF transparency",
1418 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1421 key: :transparency_exclusions,
1422 label: "MRF transparency exclusions",
1423 type: {:list, :string},
1425 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1436 label: "MRF Simple",
1438 description: "Simple ingress policies",
1441 key: :media_removal,
1442 type: {:list, :string},
1443 description: "List of instances to strip media attachments from",
1444 suggestions: ["example.com", "*.example.com"]
1448 label: "Media NSFW",
1449 type: {:list, :string},
1450 description: "List of instances to tag all media as NSFW (sensitive) from",
1451 suggestions: ["example.com", "*.example.com"]
1454 key: :federated_timeline_removal,
1455 type: {:list, :string},
1457 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1458 suggestions: ["example.com", "*.example.com"]
1462 type: {:list, :string},
1463 description: "List of instances to reject activities from (except deletes)",
1464 suggestions: ["example.com", "*.example.com"]
1468 type: {:list, :string},
1469 description: "List of instances to only accept activities from (except deletes)",
1470 suggestions: ["example.com", "*.example.com"]
1473 key: :report_removal,
1474 type: {:list, :string},
1475 description: "List of instances to reject reports from",
1476 suggestions: ["example.com", "*.example.com"]
1479 key: :avatar_removal,
1480 type: {:list, :string},
1481 description: "List of instances to strip avatars from",
1482 suggestions: ["example.com", "*.example.com"]
1485 key: :banner_removal,
1486 type: {:list, :string},
1487 description: "List of instances to strip banners from",
1488 suggestions: ["example.com", "*.example.com"]
1491 key: :reject_deletes,
1492 type: {:list, :string},
1493 description: "List of instances to reject deletions from",
1494 suggestions: ["example.com", "*.example.com"]
1500 key: :mrf_activity_expiration,
1502 label: "MRF Activity Expiration Policy",
1504 description: "Adds automatic expiration to all local activities",
1509 description: "Default global expiration time for all local activities (in days)",
1510 suggestions: [90, 365]
1518 label: "MRF Subchain",
1521 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1522 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1527 description: "Matches a series of regular expressions against the actor field",
1530 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1538 key: :mrf_rejectnonpublic,
1540 description: "RejectNonPublic drops posts with non-public visibility settings.",
1541 label: "MRF Reject Non Public",
1545 key: :allow_followersonly,
1546 label: "Allow followers-only",
1548 description: "Whether to allow followers-only posts"
1553 description: "Whether to allow direct messages"
1559 key: :mrf_hellthread,
1561 label: "MRF Hellthread",
1563 description: "Block messages with excessive user mentions",
1566 key: :delist_threshold,
1569 "Number of mentioned users after which the message gets removed from timelines and" <>
1570 "disables notifications. Set to 0 to disable.",
1574 key: :reject_threshold,
1577 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1586 label: "MRF Keyword",
1588 description: "Reject or Word-Replace messages with a keyword or regex",
1592 type: [:string, :regex],
1594 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1595 suggestions: ["foo", ~r/foo/iu]
1598 key: :federated_timeline_removal,
1599 type: [:string, :regex],
1601 "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.",
1602 suggestions: ["foo", ~r/foo/iu]
1606 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1608 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1609 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1617 label: "MRF Mention",
1619 description: "Block messages which mention a specific user",
1623 type: {:list, :string},
1624 description: "A list of actors for which any post mentioning them will be dropped",
1625 suggestions: ["actor1", "actor2"]
1631 key: :mrf_vocabulary,
1633 label: "MRF Vocabulary",
1635 description: "Filter messages which belong to certain activity vocabularies",
1639 type: {:list, :string},
1641 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1642 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1646 type: {:list, :string},
1648 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1649 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1655 # key: :mrf_user_allowlist,
1658 # "The keys in this section are the domain names that the policy should apply to." <>
1659 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1661 # %{"example.org" => ["https://example.org/users/admin"]}
1669 description: "Media proxy",
1674 description: "Enables proxying of remote media to the instance's proxy"
1681 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1682 suggestions: ["https://example.com"]
1690 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1696 description: "Enables invalidate media cache"
1701 description: "Module which will be used to cache purge.",
1703 Pleroma.Web.MediaProxy.Invalidation.Script,
1704 Pleroma.Web.MediaProxy.Invalidation.Http
1711 label: "Proxy Options",
1713 description: "Options for Pleroma.ReverseProxy",
1715 redirect_on_failure: false,
1716 max_body_length: 25 * 1_048_576,
1718 follow_redirect: true,
1724 key: :redirect_on_failure,
1727 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1728 "Any error during body processing will not be redirected as the response is chunked."
1731 key: :max_body_length,
1734 "Limits the content length to be approximately the " <>
1735 "specified length. It is validated with the `content-length` header and also verified when proxying."
1741 description: "HTTP options",
1746 description: "Adapter specific options",
1751 label: "SSL Options",
1752 description: "SSL options for HTTP adapter",
1756 type: {:list, :atom},
1757 description: "List of TLS version to use",
1758 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1767 type: [:string, :tuple],
1768 description: "Proxy URL",
1769 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1777 type: {:list, :string},
1778 description: "List of domains to bypass the mediaproxy",
1779 suggestions: ["example.com"]
1785 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1787 description: "HTTP invalidate settings",
1792 description: "HTTP method of request. Default: :purge"
1796 type: {:list, :tuple},
1797 description: "HTTP headers of request.",
1798 suggestions: [{"x-refresh", 1}]
1803 description: "Request options.",
1804 suggestions: [params: %{ts: "xxx"}]
1810 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1812 description: "Script invalidate settings",
1817 description: "Path to shell script. Which will run purge cache.",
1818 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1826 description: "Gopher settings",
1831 description: "Enables the gopher interface"
1837 description: "IP address to bind to",
1838 suggestions: [{0, 0, 0, 0}]
1843 description: "Port to bind to",
1849 description: "Port advertised in URLs (optional, defaults to port)",
1857 label: "ActivityPub",
1859 description: "ActivityPub-related settings",
1862 key: :unfollow_blocked,
1864 description: "Whether blocks result in people getting unfollowed"
1867 key: :outgoing_blocks,
1869 description: "Whether to federate blocks to other instances"
1872 key: :sign_object_fetches,
1874 description: "Sign object fetches with HTTP signatures"
1877 key: :note_replies_output_limit,
1880 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1883 key: :follow_handshake_timeout,
1885 description: "Following handshake timeout",
1892 key: :http_security,
1893 label: "HTTP security",
1895 description: "HTTP security settings",
1900 description: "Whether the managed content security policy is enabled"
1906 description: "Whether to additionally send a Strict-Transport-Security header"
1910 label: "STS max age",
1912 description: "The maximum age for the Strict-Transport-Security header if sent",
1913 suggestions: [31_536_000]
1917 label: "CT max age",
1919 description: "The maximum age for the Expect-CT header if sent",
1920 suggestions: [2_592_000]
1923 key: :referrer_policy,
1925 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1926 suggestions: ["same-origin", "no-referrer"]
1930 label: "Report URI",
1932 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1933 suggestions: ["https://example.com/report-uri"]
1938 group: :web_push_encryption,
1939 key: :vapid_details,
1940 label: "Vapid Details",
1943 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1949 "A mailto link for the administrative contact." <>
1950 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1951 suggestions: ["mailto:moderators@pleroma.com"]
1956 description: "VAPID public key",
1957 suggestions: ["Public key"]
1962 description: "VAPID private key",
1963 suggestions: ["Private key"]
1969 key: Pleroma.Captcha,
1971 description: "Captcha-related settings",
1976 description: "Whether the captcha should be shown on registration"
1981 description: "The method/service to use for captcha",
1982 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1985 key: :seconds_valid,
1987 description: "The time in seconds for which the captcha is valid",
1994 key: Pleroma.Captcha.Kocaptcha,
1997 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1998 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2003 description: "The kocaptcha endpoint to use",
2004 suggestions: ["https://captcha.kotobank.ch"]
2010 label: "Pleroma Admin Token",
2013 "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",
2018 description: "Admin token",
2019 suggestions: ["We recommend a secure random string or UUID"]
2028 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2030 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2031 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2032 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2033 (see https://github.com/sorentwo/oban/issues/52).
2038 type: {:dropdown, :atom},
2039 description: "Logs verbose mode",
2040 suggestions: [false, :error, :warn, :info, :debug]
2044 type: {:keyword, :integer},
2046 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2048 activity_expiration: 10,
2049 attachments_cleanup: 5,
2051 federator_incoming: 50,
2052 federator_outgoing: 50,
2054 scheduled_activities: 10,
2060 key: :activity_expiration,
2062 description: "Activity expiration queue",
2066 key: :attachments_cleanup,
2068 description: "Attachment deletion queue",
2074 description: "Background queue",
2078 key: :federator_incoming,
2080 description: "Incoming federation queue",
2084 key: :federator_outgoing,
2086 description: "Outgoing federation queue",
2092 description: "Email sender queue, see Pleroma.Emails.Mailer",
2096 key: :scheduled_activities,
2098 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2102 key: :transmogrifier,
2104 description: "Transmogrifier queue",
2110 description: "Web push notifications queue",
2117 type: {:list, :tuple},
2118 description: "Settings for cron background jobs",
2120 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2121 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2122 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2123 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2124 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2133 description: "Includes custom worker options not interpretable directly by `Oban`",
2137 type: {:keyword, :integer},
2138 description: "Max retry attempts for failed jobs, per `Oban` queue",
2140 federator_incoming: 5,
2141 federator_outgoing: 5
2148 key: Pleroma.Web.Metadata,
2150 description: "Metadata-related settings",
2154 type: {:list, :module},
2155 description: "List of metadata providers to enable",
2157 Pleroma.Web.Metadata.Providers.OpenGraph,
2158 Pleroma.Web.Metadata.Providers.TwitterCard,
2159 Pleroma.Web.Metadata.Providers.RelMe,
2160 Pleroma.Web.Metadata.Providers.Feed
2165 label: "Unfurl NSFW",
2167 description: "When enabled NSFW attachments will be shown in previews"
2176 "If enabled the instance will parse metadata from attached links to generate link previews",
2181 description: "Enables RichMedia parsing of URLs"
2185 type: {:list, :string},
2186 description: "List of hosts which will be ignored by the metadata parser",
2187 suggestions: ["accounts.google.com", "xss.website"]
2191 label: "Ignore TLD",
2192 type: {:list, :string},
2193 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2194 suggestions: ["local", "localdomain", "lan"]
2198 type: {:list, :module},
2200 "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.",
2202 Pleroma.Web.RichMedia.Parsers.OEmbed,
2203 Pleroma.Web.RichMedia.Parsers.TwitterCard
2208 label: "TTL setters",
2209 type: {:list, :module},
2211 "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.",
2213 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2219 group: :auto_linker,
2221 label: "Auto Linker",
2223 description: "Configuration for the auto_linker library",
2227 type: [:string, false],
2228 description: "Specify the class to be added to the generated link. Disable to clear.",
2229 suggestions: ["auto-linker", false]
2233 type: [:string, false],
2234 description: "Override the rel attribute. Disable to clear.",
2235 suggestions: ["ugc", "noopener noreferrer", false]
2240 description: "Link URLs will open in new window/tab"
2244 type: [:integer, false],
2246 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2247 suggestions: [15, false]
2252 description: "Strip the scheme prefix"
2257 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2263 key: Pleroma.ScheduledActivity,
2265 description: "Scheduled activities settings",
2268 key: :daily_user_limit,
2271 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2275 key: :total_user_limit,
2278 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2284 description: "Whether scheduled activities are sent to the job queue to be executed"
2290 key: Pleroma.ActivityExpiration,
2292 description: "Expired activity settings",
2297 description: "Whether expired activities will be sent to the job queue to be deleted"
2303 label: "Pleroma Authenticator",
2305 description: "Authenticator",
2308 key: Pleroma.Web.Auth.Authenticator,
2310 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2320 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2321 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2322 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2323 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2328 description: "Enables LDAP authentication"
2333 description: "LDAP server hostname",
2334 suggestions: ["localhosts"]
2339 description: "LDAP port, e.g. 389 or 636",
2340 suggestions: [389, 636]
2346 description: "Enable to use SSL, usually implies the port 636"
2350 label: "SSL options",
2352 description: "Additional SSL options",
2353 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2358 description: "Path to file with PEM encoded cacerts",
2359 suggestions: ["path/to/file/with/PEM/cacerts"]
2364 description: "Type of cert verification",
2365 suggestions: [:verify_peer]
2373 description: "Enable to use STARTTLS, usually implies the port 389"
2377 label: "TLS options",
2379 description: "Additional TLS options",
2380 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2385 description: "Path to file with PEM encoded cacerts",
2386 suggestions: ["path/to/file/with/PEM/cacerts"]
2391 description: "Type of cert verification",
2392 suggestions: [:verify_peer]
2399 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2400 suggestions: ["dc=example,dc=com"]
2407 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2416 description: "Authentication / authorization settings",
2419 key: :enforce_oauth_admin_scope_usage,
2420 label: "Enforce OAuth admin scope usage",
2423 "OAuth admin scope requirement toggle. " <>
2424 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2425 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2426 "`is_admin` user flag grants access to admin-specific actions."
2429 key: :auth_template,
2432 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2433 suggestions: ["show.html"]
2436 key: :oauth_consumer_template,
2437 label: "OAuth consumer template",
2440 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2441 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2442 suggestions: ["consumer.html"]
2445 key: :oauth_consumer_strategies,
2446 label: "OAuth consumer strategies",
2447 type: {:list, :string},
2449 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2450 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2451 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2452 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2458 key: :email_notifications,
2460 description: "Email notifications settings",
2466 "emails of \"what you've missed\" for users who have been inactive for a while",
2470 schedule: "0 0 * * 0",
2472 inactivity_threshold: 7
2480 description: "Globally enable or disable digest emails"
2486 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2487 suggestions: ["0 0 * * 0"]
2492 description: "Minimum interval between digest emails to one user",
2496 key: :inactivity_threshold,
2498 description: "Minimum user inactivity threshold",
2507 key: Pleroma.Emails.UserEmail,
2509 description: "Email template settings",
2514 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2515 suggestions: ["some/path/logo.png"]
2520 description: "a map with color settings for email templates.",
2523 link_color: "#d8a070",
2524 background_color: "#2C3645",
2525 content_background_color: "#1B2635",
2526 header_color: "#d8a070",
2527 text_color: "#b9b9ba",
2528 text_muted_color: "#b9b9ba"
2535 suggestions: ["#d8a070"]
2538 key: :background_color,
2540 suggestions: ["#2C3645"]
2543 key: :content_background_color,
2545 suggestions: ["#1B2635"]
2550 suggestions: ["#d8a070"]
2555 suggestions: ["#b9b9ba"]
2558 key: :text_muted_color,
2560 suggestions: ["#b9b9ba"]
2568 key: Pleroma.Emails.NewUsersDigestEmail,
2570 description: "New users admin email digest",
2575 description: "Enables new users admin digest email when `true`",
2576 suggestions: [false]
2585 description: "Configure OAuth 2 provider capabilities",
2588 key: :token_expires_in,
2590 description: "The lifetime in seconds of the access token",
2594 key: :issue_new_refresh_token,
2597 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2600 key: :clean_expired_tokens,
2602 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2612 key: :shortcode_globs,
2613 type: {:list, :string},
2614 description: "Location of custom emoji files. * can be used as a wildcard.",
2615 suggestions: ["/emoji/custom/**/*.png"]
2618 key: :pack_extensions,
2619 type: {:list, :string},
2621 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2622 suggestions: [".png", ".gif"]
2626 type: {:keyword, :string, {:list, :string}},
2628 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2629 " and the value is the location or array of locations. * can be used as a wildcard.",
2631 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2635 key: :default_manifest,
2638 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2639 " Currently only one manifest can be added (no arrays).",
2640 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2643 key: :shared_pack_cache_seconds_per_file,
2644 label: "Shared pack cache s/file",
2647 "When an emoji pack is shared, the archive is created and cached in memory" <>
2648 " for this amount of seconds multiplied by the number of files.",
2658 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2662 type: [:tuple, {:list, :tuple}],
2663 description: "For the search requests (account & status search etc.)",
2664 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2668 type: [:tuple, {:list, :tuple}],
2669 description: "For requests to timelines (each timeline has it's own limiter)",
2670 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2673 key: :app_account_creation,
2674 type: [:tuple, {:list, :tuple}],
2675 description: "For registering user accounts from the same IP address",
2676 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2679 key: :relations_actions,
2680 type: [:tuple, {:list, :tuple}],
2681 description: "For actions on relationships with all users (follow, unfollow)",
2682 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2685 key: :relation_id_action,
2686 label: "Relation ID action",
2687 type: [:tuple, {:list, :tuple}],
2688 description: "For actions on relation with a specific user (follow, unfollow)",
2689 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2692 key: :statuses_actions,
2693 type: [:tuple, {:list, :tuple}],
2695 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2696 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2699 key: :status_id_action,
2700 label: "Status ID action",
2701 type: [:tuple, {:list, :tuple}],
2703 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2704 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2707 key: :authentication,
2708 type: [:tuple, {:list, :tuple}],
2709 description: "For authentication create / password check / user existence check requests",
2710 suggestions: [{60_000, 15}]
2719 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2720 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2725 description: "Enables SSH"
2730 description: "Dir with SSH keys",
2731 suggestions: ["/some/path/ssh_keys"]
2736 description: "Handler module",
2737 suggestions: ["Pleroma.BBS.Handler"]
2742 description: "Port to connect",
2743 suggestions: [10_022]
2746 key: :password_authenticator,
2748 description: "Authenticator module",
2749 suggestions: ["Pleroma.BBS.Authenticator"]
2755 label: "Mime Types",
2757 description: "Mime Types settings",
2764 "application/xml" => ["xml"],
2765 "application/xrd+xml" => ["xrd+xml"],
2766 "application/jrd+json" => ["jrd+json"],
2767 "application/activity+json" => ["activity+json"],
2768 "application/ld+json" => ["activity+json"]
2773 key: "application/xml",
2774 type: {:list, :string},
2775 suggestions: ["xml"]
2778 key: "application/xrd+xml",
2779 type: {:list, :string},
2780 suggestions: ["xrd+xml"]
2783 key: "application/jrd+json",
2784 type: {:list, :string},
2785 suggestions: ["jrd+json"]
2788 key: "application/activity+json",
2789 type: {:list, :string},
2790 suggestions: ["activity+json"]
2793 key: "application/ld+json",
2794 type: {:list, :string},
2795 suggestions: ["activity+json"]
2805 description: "Pleroma chat settings",
2818 description: "HTTP settings",
2823 type: [:string, :tuple],
2824 description: "Proxy URL",
2825 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2828 key: :send_user_agent,
2833 type: [:string, :atom],
2835 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2836 suggestions: ["Pleroma", :default]
2841 description: "Adapter specific options",
2847 label: "SSL Options",
2848 description: "SSL options for HTTP adapter",
2852 type: {:list, :atom},
2853 description: "List of TLS version to use",
2854 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2865 label: "Markup Settings",
2869 key: :allow_inline_images,
2873 key: :allow_headings,
2886 type: {:list, :module},
2888 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2889 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2899 key: :deny_follow_blocked,
2907 key: :mrf_normalize_markup,
2908 label: "MRF Normalize Markup",
2909 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2915 suggestions: [Pleroma.HTML.Scrubber.Default]
2925 key: :restricted_nicknames,
2926 type: {:list, :string},
2945 "ostatus_subscribe",
2964 label: "CORS plug config",
2970 suggestions: [86_400]
2974 type: {:list, :string},
2975 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2979 type: {:list, :string},
2982 "X-RateLimit-Reset",
2983 "X-RateLimit-Limit",
2984 "X-RateLimit-Remaining",
2995 type: {:list, :string},
2996 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3002 key: Pleroma.Plugs.RemoteIp,
3005 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3006 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3012 description: "Enable/disable the plug. Default: disabled."
3016 type: {:list, :string},
3018 "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]`."
3022 type: {:list, :string},
3024 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3028 type: {:list, :string},
3030 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3036 key: :web_cache_ttl,
3037 label: "Web cache TTL",
3040 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3046 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3047 suggestions: [30_000, nil]
3050 key: :activity_pub_question,
3052 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3053 suggestions: [30_000]
3063 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3068 description: "Enables the rendering of static HTML. Default: disabled."
3076 description: "Configure feed rendering",
3081 description: "Configure title rendering",
3086 description: "Maximum number of characters before truncating title",
3092 description: "Replacement which will be used after truncating string",
3093 suggestions: ["..."]
3101 key: :mrf_object_age,
3102 label: "MRF Object Age",
3106 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3111 description: "Required age (in seconds) of a post before actions are taken.",
3112 suggestions: [172_800]
3116 type: {:list, :atom},
3118 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3119 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3120 "`:reject` rejects the message entirely",
3121 suggestions: [:delist, :strip_followers, :reject]
3129 description: "Custom Runtime Modules",
3134 description: "A path to custom Elixir modules (such as MRF policies)."
3142 description: "Settings for notifications streamer",
3147 description: "Number of workers to send notifications",
3151 key: :overflow_workers,
3153 description: "Maximum number of workers created if pool is empty",
3160 key: :connections_pool,
3162 description: "Advanced settings for `gun` connections pool",
3165 key: :checkin_timeout,
3167 description: "Timeout to checkin connection from pool. Default: 250ms.",
3171 key: :max_connections,
3173 description: "Maximum number of connections in the pool. Default: 250 connections.",
3180 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3184 key: :retry_timeout,
3187 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3191 key: :await_up_timeout,
3193 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3202 description: "Advanced settings for `gun` workers pools",
3207 description: "Settings for federation pool.",
3212 description: "Number workers in the pool.",
3218 description: "Number of additional workers if pool is under load.",
3224 description: "Timeout while `gun` will wait for response.",
3225 suggestions: [150_000]
3232 description: "Settings for media pool.",
3237 description: "Number workers in the pool.",
3243 description: "Number of additional workers if pool is under load.",
3249 description: "Timeout while `gun` will wait for response.",
3250 suggestions: [150_000]
3257 description: "Settings for upload pool.",
3262 description: "Number workers in the pool.",
3268 description: "Number of additional workers if pool is under load.",
3274 description: "Timeout while `gun` will wait for response.",
3275 suggestions: [300_000]
3282 description: "Settings for default pool.",
3287 description: "Number workers in the pool.",
3293 description: "Number of additional workers if pool is under load.",
3299 description: "Timeout while `gun` will wait for response.",
3300 suggestions: [10_000]
3308 key: :hackney_pools,
3310 description: "Advanced settings for `hackney` connections pools",
3315 description: "Settings for federation pool.",
3318 key: :max_connections,
3320 description: "Number workers in the pool.",
3326 description: "Timeout while `hackney` will wait for response.",
3327 suggestions: [150_000]
3334 description: "Settings for media pool.",
3337 key: :max_connections,
3339 description: "Number workers in the pool.",
3345 description: "Timeout while `hackney` will wait for response.",
3346 suggestions: [150_000]
3353 description: "Settings for upload pool.",
3356 key: :max_connections,
3358 description: "Number workers in the pool.",
3364 description: "Timeout while `hackney` will wait for response.",
3365 suggestions: [300_000]
3373 key: :restrict_unauthenticated,
3376 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3381 description: "Settings for public and federated timelines.",
3386 description: "Disallow view public timeline."
3391 description: "Disallow view federated timeline."
3398 description: "Settings for user profiles.",
3403 description: "Disallow view local user profiles."
3408 description: "Disallow view remote user profiles."
3415 description: "Settings for statuses.",
3420 description: "Disallow view local statuses."
3425 description: "Disallow view remote statuses."
3433 key: Pleroma.Web.ApiSpec.CastAndValidate,
3440 "Enables strict input validation (useful in development, not recommended in production)",
3441 suggestions: [false]
3447 key: :instances_favicons,
3449 description: "Control favicons for instances",
3454 description: "Allow/disallow displaying and getting instances favicons"